ultracart_api 4.0.52.rc → 4.0.55.rc

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9934de6bf631146a417c171eccb5221176b363b6885ed827b59895d09819394c
4
- data.tar.gz: 5051d974c29f7ae6f8066b3b631578e2d7f70e976cc176fcb8e16bb38a0728a3
3
+ metadata.gz: 243d3a3106e3395a57819fec0cfc4180771d55adfeb2b0337ccb39e6e516d731
4
+ data.tar.gz: 03e523e78037dbe4d2acf01c9af181fe53eacc30b554de9d44a7d062969d4986
5
5
  SHA512:
6
- metadata.gz: 5dfc20d26a058aafdcc50ff8d06feeb9cc3002f403577b3fc087d0bba703614ee12462a8a6f99ae41befaedc52e18a69cd29382bb41e47d091e79d8eeee0b802
7
- data.tar.gz: c51ec7e764de01427f7bc6f4ab3fbb0abcdb6bc19964f8ab1acb0d2240f5718533f3425e2fe347cdefbc8e1910a42891a22e800fb830d032ece49e28843110e9
6
+ metadata.gz: f87d4115dc85836f6ae24728155befc19601cbe759551d6c9775f84dbcacca318f4f8847786df0421e579a0948f79ac1e7b827e60bf17664d2f03d55cae54f7f
7
+ data.tar.gz: 647ab8d91ad13ca599665588c4cdb4ac3ee6d00311941e1e45dc44ffd4b5bc4b2e2273e2c08ba048adec3812bbcee7fcee6cdd1462287bd0abd79efc03882892
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.52.rc
10
+ - Package version: 4.0.55.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.52.rc.gem
27
+ gem install ./ultracart_api-4.0.55.rc.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ultracart_api-4.0.52.rc.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./ultracart_api-4.0.55.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.52.rc'
36
+ gem 'ultracart_api', '~> 4.0.55.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
@@ -570,6 +572,7 @@ Class | Method | HTTP request | Description
570
572
  - [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
571
573
  - [UltracartClient::ConversationEventQueuePosition](docs/ConversationEventQueuePosition.md)
572
574
  - [UltracartClient::ConversationEventRRWeb](docs/ConversationEventRRWeb.md)
575
+ - [UltracartClient::ConversationEventReadMessage](docs/ConversationEventReadMessage.md)
573
576
  - [UltracartClient::ConversationEventTyping](docs/ConversationEventTyping.md)
574
577
  - [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
575
578
  - [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
@@ -624,6 +627,7 @@ Class | Method | HTTP request | Description
624
627
  - [UltracartClient::CouponItemSearchResult](docs/CouponItemSearchResult.md)
625
628
  - [UltracartClient::CouponItemSearchResultsResponse](docs/CouponItemSearchResultsResponse.md)
626
629
  - [UltracartClient::CouponMultipleAmountsOffItems](docs/CouponMultipleAmountsOffItems.md)
630
+ - [UltracartClient::CouponNoDiscount](docs/CouponNoDiscount.md)
627
631
  - [UltracartClient::CouponPercentOffItemWithItemsQuantityPurchase](docs/CouponPercentOffItemWithItemsQuantityPurchase.md)
628
632
  - [UltracartClient::CouponPercentOffItems](docs/CouponPercentOffItems.md)
629
633
  - [UltracartClient::CouponPercentOffItemsAndFreeShipping](docs/CouponPercentOffItemsAndFreeShipping.md)
@@ -665,6 +669,7 @@ Class | Method | HTTP request | Description
665
669
  - [UltracartClient::CustomerLoyalty](docs/CustomerLoyalty.md)
666
670
  - [UltracartClient::CustomerLoyaltyLedger](docs/CustomerLoyaltyLedger.md)
667
671
  - [UltracartClient::CustomerLoyaltyRedemption](docs/CustomerLoyaltyRedemption.md)
672
+ - [UltracartClient::CustomerMagicLinkResponse](docs/CustomerMagicLinkResponse.md)
668
673
  - [UltracartClient::CustomerMergeRequest](docs/CustomerMergeRequest.md)
669
674
  - [UltracartClient::CustomerOrdersSummary](docs/CustomerOrdersSummary.md)
670
675
  - [UltracartClient::CustomerPricingTier](docs/CustomerPricingTier.md)
@@ -1052,6 +1057,8 @@ Class | Method | HTTP request | Description
1052
1057
  - [UltracartClient::SovosConfig](docs/SovosConfig.md)
1053
1058
  - [UltracartClient::StateProvince](docs/StateProvince.md)
1054
1059
  - [UltracartClient::StepWaiting](docs/StepWaiting.md)
1060
+ - [UltracartClient::StoreFront](docs/StoreFront.md)
1061
+ - [UltracartClient::StoreFrontsResponse](docs/StoreFrontsResponse.md)
1055
1062
  - [UltracartClient::TaxCity](docs/TaxCity.md)
1056
1063
  - [UltracartClient::TaxCountry](docs/TaxCountry.md)
1057
1064
  - [UltracartClient::TaxCountryCode](docs/TaxCountryCode.md)
@@ -1180,6 +1187,9 @@ Not every change is committed to every SDK.
1180
1187
 
1181
1188
  | Version | Date | Comments |
1182
1189
  | --: | :-: | --- |
1190
+ | 4.0.55-RC | 08/12/2022 | internal code to allow merchant login as customer |
1191
+ | 4.0.54-RC | 08/11/2022 | fix entry_dts type on gift certificate ledger |
1192
+ | 4.0.53-RC | 08/10/2022 | conversation event refactoring |
1183
1193
  | 4.0.52-RC | 08/05/2022 | conversation adjustments for ES integration |
1184
1194
  | 4.0.51-RC | 08/05/2022 | conversations query by medium and stats fixes |
1185
1195
  | 4.0.50-RC | 08/03/2022 | conversation summary participants |
@@ -0,0 +1,22 @@
1
+ # UltracartClient::ConversationEventReadMessage
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **conversation_message_uuid** | **String** | | [optional] |
8
+ | **message_dts** | **String** | Message date/time | [optional] |
9
+ | **message_epoch** | **Integer** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::ConversationEventReadMessage.new(
17
+ conversation_message_uuid: null,
18
+ message_dts: null,
19
+ message_epoch: null
20
+ )
21
+ ```
22
+
@@ -12,6 +12,7 @@
12
12
  | **media_urls** | **Array<String>** | | [optional] |
13
13
  | **merchant_id** | **String** | | [optional] |
14
14
  | **message_dts** | **String** | Message date/time | [optional] |
15
+ | **message_epoch** | **Integer** | Message epoch milliseconds | [optional] |
15
16
  | **transport_statuses** | [**Array<ConversationMessageTransportStatus>**](ConversationMessageTransportStatus.md) | | [optional] |
16
17
  | **type** | **String** | Message type | [optional] |
17
18
  | **upload_keys** | **Array<String>** | | [optional] |
@@ -30,6 +31,7 @@ instance = UltracartClient::ConversationMessage.new(
30
31
  media_urls: null,
31
32
  merchant_id: null,
32
33
  message_dts: null,
34
+ message_epoch: null,
33
35
  transport_statuses: null,
34
36
  type: null,
35
37
  upload_keys: null
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **conversation_participant_arn** | **String** | | [optional] |
8
- | **status** | **String** | | [optional] |
8
+ | **status** | **String** | The status of the message transport | [optional] |
9
9
 
10
10
  ## Example
11
11
 
@@ -11,6 +11,7 @@
11
11
  | **last_message_dts** | **String** | Last message date/time | [optional] |
12
12
  | **left_dts** | **String** | Left conversation date/time | [optional] |
13
13
  | **status** | **String** | | [optional] |
14
+ | **unread_messages** | **Integer** | | [optional] |
14
15
 
15
16
  ## Example
16
17
 
@@ -24,7 +25,8 @@ instance = UltracartClient::ConversationParticipant.new(
24
25
  joined_dts: null,
25
26
  last_message_dts: null,
26
27
  left_dts: null,
27
- status: null
28
+ status: null,
29
+ unread_messages: null
28
30
  )
29
31
  ```
30
32
 
@@ -11,6 +11,7 @@
11
11
  | **event_participant_update** | [**ConversationSummary**](ConversationSummary.md) | | [optional] |
12
12
  | **event_queue_position** | [**ConversationEventQueuePosition**](ConversationEventQueuePosition.md) | | [optional] |
13
13
  | **event_queue_status_update** | [**ConversationWebchatQueueStatus**](ConversationWebchatQueueStatus.md) | | [optional] |
14
+ | **event_read_message** | [**ConversationEventReadMessage**](ConversationEventReadMessage.md) | | [optional] |
14
15
  | **event_rrweb** | [**ConversationEventRRWeb**](ConversationEventRRWeb.md) | | [optional] |
15
16
  | **event_type** | **String** | Type of event | [optional] |
16
17
  | **event_typing** | [**ConversationEventTyping**](ConversationEventTyping.md) | | [optional] |
@@ -31,6 +32,7 @@ instance = UltracartClient::ConversationWebsocketMessage.new(
31
32
  event_participant_update: null,
32
33
  event_queue_position: null,
33
34
  event_queue_status_update: null,
35
+ event_read_message: null,
34
36
  event_rrweb: null,
35
37
  event_type: null,
36
38
  event_typing: null,
data/docs/Coupon.md CHANGED
@@ -39,7 +39,7 @@
39
39
  | **merchant_code** | **String** | Merchant code of coupon up to 20 characters. | [optional] |
40
40
  | **merchant_notes** | **String** | Internal notes about this coupon. These are not visible to customer. | [optional] |
41
41
  | **multiple_amounts_off_items** | [**CouponMultipleAmountsOffItems**](CouponMultipleAmountsOffItems.md) | | [optional] |
42
- | **no_discount** | **Object** | | [optional] |
42
+ | **no_discount** | [**CouponNoDiscount**](CouponNoDiscount.md) | | [optional] |
43
43
  | **percent_off_item_with_items_quantity_purchase** | [**CouponPercentOffItemWithItemsQuantityPurchase**](CouponPercentOffItemWithItemsQuantityPurchase.md) | | [optional] |
44
44
  | **percent_off_items** | [**CouponPercentOffItems**](CouponPercentOffItems.md) | | [optional] |
45
45
  | **percent_off_items_and_free_shipping** | [**CouponPercentOffItemsAndFreeShipping**](CouponPercentOffItemsAndFreeShipping.md) | | [optional] |
@@ -0,0 +1,18 @@
1
+ # UltracartClient::CouponNoDiscount
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **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] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ultracart_api'
13
+
14
+ instance = UltracartClient::CouponNoDiscount.new(
15
+ ignore_this_property: null
16
+ )
17
+ ```
18
+
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
+
@@ -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&lt;StoreFront&gt;**](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
+
@@ -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
@@ -6894,6 +6894,62 @@ module UltracartClient
6894
6894
  return data, status_code, headers
6895
6895
  end
6896
6896
 
6897
+ # Get storefronts (internal use only for security reasons)
6898
+ # @param [Hash] opts the optional parameters
6899
+ # @return [StoreFrontsResponse]
6900
+ def get_store_fronts(opts = {})
6901
+ data, _status_code, _headers = get_store_fronts_with_http_info(opts)
6902
+ data
6903
+ end
6904
+
6905
+ # Get storefronts (internal use only for security reasons)
6906
+ # @param [Hash] opts the optional parameters
6907
+ # @return [Array<(StoreFrontsResponse, Integer, Hash)>] StoreFrontsResponse data, response status code and response headers
6908
+ def get_store_fronts_with_http_info(opts = {})
6909
+ if @api_client.config.debugging
6910
+ @api_client.config.logger.debug 'Calling API: StorefrontApi.get_store_fronts ...'
6911
+ end
6912
+ # resource path
6913
+ local_var_path = '/storefront/'
6914
+
6915
+ # query parameters
6916
+ query_params = opts[:query_params] || {}
6917
+
6918
+ # header parameters
6919
+ header_params = opts[:header_params] || {}
6920
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
6921
+ # HTTP header 'Accept' (if needed)
6922
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6923
+
6924
+ # form parameters
6925
+ form_params = opts[:form_params] || {}
6926
+
6927
+ # http body (model)
6928
+ post_body = opts[:debug_body]
6929
+
6930
+ # return_type
6931
+ return_type = opts[:debug_return_type] || 'StoreFrontsResponse'
6932
+
6933
+ # auth_names
6934
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
6935
+
6936
+ new_options = opts.merge(
6937
+ :operation => :"StorefrontApi.get_store_fronts",
6938
+ :header_params => header_params,
6939
+ :query_params => query_params,
6940
+ :form_params => form_params,
6941
+ :body => post_body,
6942
+ :auth_names => auth_names,
6943
+ :return_type => return_type
6944
+ )
6945
+
6946
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6947
+ if @api_client.config.debugging
6948
+ @api_client.config.logger.debug "API called: StorefrontApi#get_store_fronts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6949
+ end
6950
+ return data, status_code, headers
6951
+ end
6952
+
6897
6953
  # Get thumbnail parameters
6898
6954
  # @param thumbnail_parameters [ThumbnailParametersRequest] Thumbnail Parameters
6899
6955
  # @param [Hash] opts the optional parameters