ultracart_api 3.6.18 → 3.6.22
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +18 -4
- data/docs/AddLibraryItemRequest.md +2 -2
- data/docs/AffiliateLedger.md +3 -2
- data/docs/ApplyLibraryItemRequest.md +1 -0
- data/docs/ApplyLibraryItemResponse.md +1 -1
- data/docs/ExperimentVariation.md +2 -0
- data/docs/ExperimentVariationStat.md +18 -0
- data/docs/Item.md +1 -0
- data/docs/ItemAutoOrderStep.md +1 -1
- data/docs/ItemFulfillmentAddon.md +11 -0
- data/docs/ItemShippingDistributionCenter.md +1 -0
- data/docs/OrderItem.md +0 -1
- data/docs/StorefrontApi.md +243 -0
- data/docs/Twilio.md +11 -0
- data/docs/TwilioResponse.md +13 -0
- data/docs/TwiliosResponse.md +12 -0
- data/lib/ultracart_api/api/storefront_api.rb +265 -0
- data/lib/ultracart_api/models/add_library_item_request.rb +2 -2
- data/lib/ultracart_api/models/affiliate_ledger.rb +13 -3
- data/lib/ultracart_api/models/apply_library_item_request.rb +11 -1
- data/lib/ultracart_api/models/apply_library_item_response.rb +1 -1
- data/lib/ultracart_api/models/experiment_variation.rb +23 -1
- data/lib/ultracart_api/models/experiment_variation_stat.rb +285 -0
- data/lib/ultracart_api/models/item.rb +13 -1
- data/lib/ultracart_api/models/item_auto_order_step.rb +3 -3
- data/lib/ultracart_api/models/item_fulfillment_addon.rb +215 -0
- data/lib/ultracart_api/models/item_shipping_distribution_center.rb +11 -1
- data/lib/ultracart_api/models/order_item.rb +1 -11
- data/lib/ultracart_api/models/order_query.rb +2 -2
- data/lib/ultracart_api/models/twilio.rb +213 -0
- data/lib/ultracart_api/models/twilio_response.rb +230 -0
- data/lib/ultracart_api/models/twilios_response.rb +223 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +5 -0
- metadata +12 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0e0d1010ed6cb46efaedc24597b10a8d726b6f410d57be9588c5d7d9d221e165
|
4
|
+
data.tar.gz: 85f9f12a12fa7ea888dc0a49c385489cf5b558367868199241a8038d84ad84ce
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fe058363686562d6670d83daec25b3ce09d05857dea39ea3810fd311ee68ab69e57d29a8cc5a0d9482d3857a048414a06b492f37beef6b8a4e969b5eb82f8555
|
7
|
+
data.tar.gz: 961e02f4fa1e15c90ec871395942599e120c3b649e71492d0d155073c37a171a7799d480f53c79b2d4f7638634a0989399a6bb5dc917a5a40e7ad84eaefb5d39
|
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.6.
|
10
|
+
- Package version: 3.6.22
|
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.6.
|
27
|
+
gem install ./ultracart_api-3.6.22.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.6.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.6.22.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.6.
|
35
|
+
gem 'ultracart_api', '~> 3.6.22'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -223,6 +223,7 @@ Class | Method | HTTP request | Description
|
|
223
223
|
*UltracartClient::StorefrontApi* | [**clone_email_campaign**](docs/StorefrontApi.md#clone_email_campaign) | **POST** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/clone | Clone email campaign
|
224
224
|
*UltracartClient::StorefrontApi* | [**clone_email_flow**](docs/StorefrontApi.md#clone_email_flow) | **POST** /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone | Clone email flow
|
225
225
|
*UltracartClient::StorefrontApi* | [**create_email_sending_domain**](docs/StorefrontApi.md#create_email_sending_domain) | **POST** /storefront/email/sending_domains/{domain}/create | Create email campaign
|
226
|
+
*UltracartClient::StorefrontApi* | [**create_twilio_account**](docs/StorefrontApi.md#create_twilio_account) | **POST** /storefront/twilio/accounts | Create Twilio account
|
226
227
|
*UltracartClient::StorefrontApi* | [**delete_email_campaign_folder**](docs/StorefrontApi.md#delete_email_campaign_folder) | **DELETE** /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} | Delete email campaignFolder
|
227
228
|
*UltracartClient::StorefrontApi* | [**delete_email_commseq_stat**](docs/StorefrontApi.md#delete_email_commseq_stat) | **DELETE** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Delete communication sequence stats
|
228
229
|
*UltracartClient::StorefrontApi* | [**delete_email_email**](docs/StorefrontApi.md#delete_email_email) | **DELETE** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Delete email email
|
@@ -236,6 +237,7 @@ Class | Method | HTTP request | Description
|
|
236
237
|
*UltracartClient::StorefrontApi* | [**delete_library_item**](docs/StorefrontApi.md#delete_library_item) | **DELETE** /storefront/code_library/{library_item_oid} | Delete library item
|
237
238
|
*UltracartClient::StorefrontApi* | [**delete_library_item_published_versions**](docs/StorefrontApi.md#delete_library_item_published_versions) | **DELETE** /storefront/code_library/{library_item_oid}/published_versions | Delete all published versions for a library item, including anything in review.
|
238
239
|
*UltracartClient::StorefrontApi* | [**delete_screen_recording_segment**](docs/StorefrontApi.md#delete_screen_recording_segment) | **DELETE** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} | Delete screen recording segment
|
240
|
+
*UltracartClient::StorefrontApi* | [**delete_twilio_account**](docs/StorefrontApi.md#delete_twilio_account) | **DELETE** /storefront/twilio/accounts/{esp_twilio_uuid} | delete Twilio account
|
239
241
|
*UltracartClient::StorefrontApi* | [**duplicate_library_item**](docs/StorefrontApi.md#duplicate_library_item) | **POST** /storefront/code_library/{library_item_oid}/duplicate | Duplicate library item.
|
240
242
|
*UltracartClient::StorefrontApi* | [**favorite_screen_recording**](docs/StorefrontApi.md#favorite_screen_recording) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Update favorite flag on screen recording
|
241
243
|
*UltracartClient::StorefrontApi* | [**geocode_address**](docs/StorefrontApi.md#geocode_address) | **POST** /storefront/{storefront_oid}/email/geocode | Obtain lat/long for an address
|
@@ -316,6 +318,8 @@ Class | Method | HTTP request | Description
|
|
316
318
|
*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
|
317
319
|
*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
|
318
320
|
*UltracartClient::StorefrontApi* | [**get_transaction_email_screenshots**](docs/StorefrontApi.md#get_transaction_email_screenshots) | **GET** /storefront/{storefront_oid}/transaction_email/list/{email_id}/screenshots | Get transactional email screenshots
|
321
|
+
*UltracartClient::StorefrontApi* | [**get_twilio_account**](docs/StorefrontApi.md#get_twilio_account) | **GET** /storefront/twilio/accounts/{esp_twilio_uuid} | Get Twilio account
|
322
|
+
*UltracartClient::StorefrontApi* | [**get_twilio_accounts**](docs/StorefrontApi.md#get_twilio_accounts) | **GET** /storefront/twilio/accounts | Get all Twilio accounts
|
319
323
|
*UltracartClient::StorefrontApi* | [**global_unsubscribe**](docs/StorefrontApi.md#global_unsubscribe) | **POST** /storefront/{storefront_oid}/email/globalUnsubscribe | Globally unsubscribe a customer
|
320
324
|
*UltracartClient::StorefrontApi* | [**import_email_third_party_provider_list**](docs/StorefrontApi.md#import_email_third_party_provider_list) | **POST** /storefront/{storefront_oid}/email/third_party_providers/import | Import a third party provider list
|
321
325
|
*UltracartClient::StorefrontApi* | [**insert_email_campaign**](docs/StorefrontApi.md#insert_email_campaign) | **POST** /storefront/{storefront_oid}/email/campaigns | Insert email campaign
|
@@ -369,6 +373,7 @@ Class | Method | HTTP request | Description
|
|
369
373
|
*UltracartClient::StorefrontApi* | [**update_screen_recording_settings**](docs/StorefrontApi.md#update_screen_recording_settings) | **POST** /storefront/{storefront_oid}/screen_recordings/settings | Update screen recording settings
|
370
374
|
*UltracartClient::StorefrontApi* | [**update_screen_recording_tags**](docs/StorefrontApi.md#update_screen_recording_tags) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags | Update tags on a screen recording
|
371
375
|
*UltracartClient::StorefrontApi* | [**update_transaction_email**](docs/StorefrontApi.md#update_transaction_email) | **PUT** /storefront/{storefront_oid}/transaction_email/list/{email_id} | Updates a transaction email object
|
376
|
+
*UltracartClient::StorefrontApi* | [**update_twilio_account**](docs/StorefrontApi.md#update_twilio_account) | **PUT** /storefront/twilio/accounts/{esp_twilio_uuid} | Update Twilio account
|
372
377
|
*UltracartClient::TaxApi* | [**delete_tax_provider_self_city**](docs/TaxApi.md#delete_tax_provider_self_city) | **DELETE** /tax/providers/self/city/{city} | Deletes a Self tax provider city
|
373
378
|
*UltracartClient::TaxApi* | [**delete_tax_provider_self_country**](docs/TaxApi.md#delete_tax_provider_self_country) | **DELETE** /tax/providers/self/country/{countryCode} | Deletes a Self tax provider country
|
374
379
|
*UltracartClient::TaxApi* | [**delete_tax_provider_self_county**](docs/TaxApi.md#delete_tax_provider_self_county) | **DELETE** /tax/providers/self/county/{county} | Deletes a Self tax provider county
|
@@ -725,6 +730,7 @@ Class | Method | HTTP request | Description
|
|
725
730
|
- [UltracartClient::Experiment](docs/Experiment.md)
|
726
731
|
- [UltracartClient::ExperimentResponse](docs/ExperimentResponse.md)
|
727
732
|
- [UltracartClient::ExperimentVariation](docs/ExperimentVariation.md)
|
733
|
+
- [UltracartClient::ExperimentVariationStat](docs/ExperimentVariationStat.md)
|
728
734
|
- [UltracartClient::ExperimentsResponse](docs/ExperimentsResponse.md)
|
729
735
|
- [UltracartClient::FulfillmentInventory](docs/FulfillmentInventory.md)
|
730
736
|
- [UltracartClient::FulfillmentShipment](docs/FulfillmentShipment.md)
|
@@ -772,6 +778,7 @@ Class | Method | HTTP request | Description
|
|
772
778
|
- [UltracartClient::ItemEbayMarketPlaceAnalysis](docs/ItemEbayMarketPlaceAnalysis.md)
|
773
779
|
- [UltracartClient::ItemEmailNotifications](docs/ItemEmailNotifications.md)
|
774
780
|
- [UltracartClient::ItemEnrollment123](docs/ItemEnrollment123.md)
|
781
|
+
- [UltracartClient::ItemFulfillmentAddon](docs/ItemFulfillmentAddon.md)
|
775
782
|
- [UltracartClient::ItemGiftCertificate](docs/ItemGiftCertificate.md)
|
776
783
|
- [UltracartClient::ItemGoogleProductSearch](docs/ItemGoogleProductSearch.md)
|
777
784
|
- [UltracartClient::ItemIdentifiers](docs/ItemIdentifiers.md)
|
@@ -1031,6 +1038,9 @@ Class | Method | HTTP request | Description
|
|
1031
1038
|
- [UltracartClient::TransactionGateway](docs/TransactionGateway.md)
|
1032
1039
|
- [UltracartClient::TransactionGatewaysRequest](docs/TransactionGatewaysRequest.md)
|
1033
1040
|
- [UltracartClient::TransactionGatewaysResponse](docs/TransactionGatewaysResponse.md)
|
1041
|
+
- [UltracartClient::Twilio](docs/Twilio.md)
|
1042
|
+
- [UltracartClient::TwilioResponse](docs/TwilioResponse.md)
|
1043
|
+
- [UltracartClient::TwiliosResponse](docs/TwiliosResponse.md)
|
1034
1044
|
- [UltracartClient::UltraCartConfig](docs/UltraCartConfig.md)
|
1035
1045
|
- [UltracartClient::UploadCouponCodesRequest](docs/UploadCouponCodesRequest.md)
|
1036
1046
|
- [UltracartClient::UploadCouponCodesResponse](docs/UploadCouponCodesResponse.md)
|
@@ -1118,6 +1128,10 @@ Not every change is committed to every SDK.
|
|
1118
1128
|
|
1119
1129
|
| Version | Date | Comments |
|
1120
1130
|
| --: | :-: | --- |
|
1131
|
+
| 3.6.22 | 11/23/2021 | new storefront methods for twilio configuration |
|
1132
|
+
| 3.6.21 | 11/08/2021 | item shipping distribution center level CostOfGoodsSold |
|
1133
|
+
| 3.6.20 | 11/05/2021 | additional item auto order step types |
|
1134
|
+
| 3.6.19 | 10/05/2021 | item fulfillment add ons |
|
1121
1135
|
| 3.6.18 | 09/30/2021 | terms if auto order flag added |
|
1122
1136
|
| 3.6.16 | 09/30/2021 | item exclude from sitemap field |
|
1123
1137
|
| 3.6.15 | 09/28/2021 | added refund_claim_id to insurance object |
|
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**attributes** | [**Array<LibraryItemAttribute>**](LibraryItemAttribute.md) | Attributes associated with the library item to contain additional configuration. | [optional]
|
7
7
|
**cjson** | **String** | Cjson to be added to library | [optional]
|
8
|
-
**content_type** | **String** | flow, campaign, cjson, email, transactional_email or upsell | [optional]
|
8
|
+
**content_type** | **String** | flow, campaign, cjson, email, transactional_email, postcard or upsell | [optional]
|
9
9
|
**description** | **String** | description of library item | [optional]
|
10
10
|
**email_name** | **String** | Required if content_type is transactional_email. This is the name of the email template (html, not text). This name should have a .vm file extension. An example is auto_order_cancel_html.vm | [optional]
|
11
11
|
**email_path** | **String** | Required if content_type is transactional_email. This is the full path to the email template stored in the file system. This defines which StoreFront contains the desired email template. An example is /themes/Elements/core/emails/auto_order_cancel_html.vm | [optional]
|
@@ -13,6 +13,6 @@ Name | Type | Description | Notes
|
|
13
13
|
**storefront_oid** | **Integer** | StoreFront oid where content originates necessary for tracking down relative assets | [optional]
|
14
14
|
**title** | **String** | title of library item, usually the name of the flow or campaign, or description of cjson | [optional]
|
15
15
|
**upsell_offer_oid** | **Integer** | Required if content_type is upsell. This is object identifier of a StoreFront Upsell Offer. | [optional]
|
16
|
-
**uuid** | **String** | UUID of communication flow, campaign, email, or null if this item is something else. transactional_email do not have a uuid because they are singleton objects within a storefront and easily identifiable by name | [optional]
|
16
|
+
**uuid** | **String** | UUID of communication flow, campaign, email, postcard, or null if this item is something else. transactional_email do not have a uuid because they are singleton objects within a storefront and easily identifiable by name | [optional]
|
17
17
|
|
18
18
|
|
data/docs/AffiliateLedger.md
CHANGED
@@ -4,6 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**affiliate_click_oid** | **Integer** | Unique object identifier for the click associated with this ledger entry | [optional]
|
7
|
+
**affiliate_ledger_oid** | **Integer** | Affiliate ledger object ID associated with this ledger | [optional]
|
7
8
|
**affiliate_link_oid** | **Integer** | Unique object identifier for the link that this click is associated with | [optional]
|
8
9
|
**affiliate_oid** | **Integer** | Affiliate object ID associated with this transaction | [optional]
|
9
10
|
**assigned_by_user** | **String** | User that assigned the transaction if it was done manually | [optional]
|
@@ -14,12 +15,12 @@ Name | Type | Description | Notes
|
|
14
15
|
**order_id** | **String** | Order ID associated with this transaction | [optional]
|
15
16
|
**original_transaction_dts** | **String** | Date/time of the original transaction for reversals | [optional]
|
16
17
|
**sub_id** | **String** | Sub ID associated with transaction (from the click) | [optional]
|
17
|
-
**tier_number** | **
|
18
|
+
**tier_number** | **Integer** | Tier number that this transaction earned | [optional]
|
18
19
|
**transaction_amount** | **Float** | Transaction amount | [optional]
|
19
20
|
**transaction_amount_paid** | **Float** | Amount of the transaction that has been paid out. | [optional]
|
20
21
|
**transaction_dts** | **String** | Date/time that the transaction was made | [optional]
|
21
22
|
**transaction_memo** | **String** | Memo explaining the transaction | [optional]
|
22
|
-
**transaction_percentage** | **
|
23
|
+
**transaction_percentage** | **Float** | Percentage associated with this transaction | [optional]
|
23
24
|
**transaction_state** | **String** | Transaction state | [optional]
|
24
25
|
|
25
26
|
|
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**email_uuid** | **String** | Normal emails are applied to an existing email object, so when requesting a library item to be applied to an email, supply the email uuid. This is only for normal emails. Transactional emails do not have a uuid. | [optional]
|
7
7
|
**library_item_oid** | **Integer** | Library item oid that you wish to apply to the given StoreFront | [optional]
|
8
|
+
**postcard_uuid** | **String** | The postcard uuid you wish to apply to a given StoreFront. | [optional]
|
8
9
|
**storefront_oid** | **Integer** | StoreFront oid where content originates necessary for tracking down relative assets | [optional]
|
9
10
|
|
10
11
|
|
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**attributes** | [**Array<LibraryItemAttribute>**](LibraryItemAttribute.md) | Attributes from the library item | [optional]
|
7
7
|
**cjson** | **String** | Cjson from library item, only populated if this library item was a cjson snippet or marketing email (not transactional) | [optional]
|
8
|
-
**content_type** | **String** | flow, campaign, cjson, upsell, transactional_email or email | [optional]
|
8
|
+
**content_type** | **String** | flow, campaign, cjson, upsell, postcard, transactional_email or email | [optional]
|
9
9
|
**email_template_vm_path** | **String** | If a marketing email was applied, this is the path to the template encapsulating the cjson. This is needed for the UltraCart UI. | [optional]
|
10
10
|
**error** | [**Error**](Error.md) | | [optional]
|
11
11
|
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
data/docs/ExperimentVariation.md
CHANGED
@@ -9,10 +9,12 @@ Name | Type | Description | Notes
|
|
9
9
|
**average_order_value** | **Float** | Average order value for this variation | [optional]
|
10
10
|
**bounce_count** | **Integer** | Total bounce count for this variation | [optional]
|
11
11
|
**conversion_rate** | **Float** | Conversion rate for this variation | [optional]
|
12
|
+
**daily_statistics** | [**Array<ExperimentVariationStat>**](ExperimentVariationStat.md) | Array of daily statistics for this variation | [optional]
|
12
13
|
**duration_seconds_sum** | **Integer** | Total number of seconds spent on the site for this variation | [optional]
|
13
14
|
**event_count** | **Integer** | Total event ocunt for this variation | [optional]
|
14
15
|
**initiate_checkout_count** | **Integer** | Total initiate checkout count for this variation | [optional]
|
15
16
|
**order_count** | **Integer** | Total order count for this variation | [optional]
|
17
|
+
**order_item_count** | **Integer** | Total order item count for this variation | [optional]
|
16
18
|
**original_traffic_percentage** | **Float** | Percentage of the traffic the variation originally started out with | [optional]
|
17
19
|
**page_view_count** | **Integer** | Total page view count for this variation | [optional]
|
18
20
|
**revenue** | **Float** | Total revenue for this variation | [optional]
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# UltracartClient::ExperimentVariationStat
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**add_to_cart_count** | **Integer** | Total add to cart count for this variation | [optional]
|
7
|
+
**bounce_count** | **Integer** | Total bounce count for this variation | [optional]
|
8
|
+
**duration_seconds_sum** | **Integer** | Total number of seconds spent on the site for this variation | [optional]
|
9
|
+
**event_count** | **Integer** | Total event count for this variation | [optional]
|
10
|
+
**initiate_checkout_count** | **Integer** | Total initiate checkout count for this variation | [optional]
|
11
|
+
**order_count** | **Integer** | Total order count for this variation | [optional]
|
12
|
+
**order_item_count** | **Integer** | Total order item count for this variation | [optional]
|
13
|
+
**page_view_count** | **Integer** | Total page view count for this variation | [optional]
|
14
|
+
**revenue** | **Float** | Total revenue for this variation | [optional]
|
15
|
+
**session_count** | **Integer** | Total sessions for this variation | [optional]
|
16
|
+
**stat_dts** | **String** | Date/time that the statistic was created | [optional]
|
17
|
+
|
18
|
+
|
data/docs/Item.md
CHANGED
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
|
|
18
18
|
**ebay** | [**ItemEbay**](ItemEbay.md) | | [optional]
|
19
19
|
**email_notifications** | [**ItemEmailNotifications**](ItemEmailNotifications.md) | | [optional]
|
20
20
|
**enrollment123** | [**ItemEnrollment123**](ItemEnrollment123.md) | | [optional]
|
21
|
+
**fulfillment_addons** | [**Array<ItemFulfillmentAddon>**](ItemFulfillmentAddon.md) | Fulfillment Add-ons | [optional]
|
21
22
|
**gift_certificate** | [**ItemGiftCertificate**](ItemGiftCertificate.md) | | [optional]
|
22
23
|
**google_product_search** | [**ItemGoogleProductSearch**](ItemGoogleProductSearch.md) | | [optional]
|
23
24
|
**identifiers** | [**ItemIdentifiers**](ItemIdentifiers.md) | | [optional]
|
data/docs/ItemAutoOrderStep.md
CHANGED
@@ -17,6 +17,6 @@ Name | Type | Description | Notes
|
|
17
17
|
**schedule** | **String** | Frequency of the rebill | [optional]
|
18
18
|
**subscribe_email_list_name** | **String** | Email list name to subscribe the customer to when the rebill occurs | [optional]
|
19
19
|
**subscribe_email_list_oid** | **Integer** | Email list identifier to subscribe the customer to when this rebill occurs | [optional]
|
20
|
-
**type** | **String** | Type of step (item or pause) | [optional]
|
20
|
+
**type** | **String** | Type of step (item, kit only, loop or pause) | [optional]
|
21
21
|
|
22
22
|
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# UltracartClient::ItemFulfillmentAddon
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**add_item_id** | **String** | Add Item Id | [optional]
|
7
|
+
**add_item_oid** | **Integer** | Add Item object identifier | [optional]
|
8
|
+
**once_per_order** | **BOOLEAN** | Quantity | [optional]
|
9
|
+
**quantity** | **Integer** | Quantity | [optional]
|
10
|
+
|
11
|
+
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
**allocated_to_placed_orders** | **Float** | Allocated to placed orders | [optional]
|
7
7
|
**allocated_to_shopping_carts** | **Float** | Allocated to shopping carts | [optional]
|
8
8
|
**available_to_allocate** | **Float** | Available to allocate | [optional]
|
9
|
+
**cogs** | **Float** | Cost of goods sold override at the distribution center level | [optional]
|
9
10
|
**desired_inventory_level** | **Float** | Desired inventory level | [optional]
|
10
11
|
**distribution_center_code** | **String** | Distribution center code | [optional]
|
11
12
|
**distribution_center_oid** | **Integer** | Distribution center object identifier | [optional]
|
data/docs/OrderItem.md
CHANGED
@@ -52,7 +52,6 @@ Name | Type | Description | Notes
|
|
52
52
|
**taxable_cost** | [**Currency**](Currency.md) | | [optional]
|
53
53
|
**total_cost_with_discount** | [**Currency**](Currency.md) | | [optional]
|
54
54
|
**total_refunded** | [**Currency**](Currency.md) | | [optional]
|
55
|
-
**tracking_number** | **String** | Tracking number, if null or missing, use order level tracking number(s). Used if there are multiple shipments for one order | [optional]
|
56
55
|
**transmitted_to_distribution_center_dts** | **String** | Date/time that this item was transmitted to the distribution center | [optional]
|
57
56
|
**unit_cost_with_discount** | [**Currency**](Currency.md) | | [optional]
|
58
57
|
**upsell** | **BOOLEAN** | True if this item was added to the order as part of an upsell | [optional]
|
data/docs/StorefrontApi.md
CHANGED
@@ -13,6 +13,7 @@ Method | HTTP request | Description
|
|
13
13
|
[**clone_email_campaign**](StorefrontApi.md#clone_email_campaign) | **POST** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/clone | Clone email campaign
|
14
14
|
[**clone_email_flow**](StorefrontApi.md#clone_email_flow) | **POST** /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone | Clone email flow
|
15
15
|
[**create_email_sending_domain**](StorefrontApi.md#create_email_sending_domain) | **POST** /storefront/email/sending_domains/{domain}/create | Create email campaign
|
16
|
+
[**create_twilio_account**](StorefrontApi.md#create_twilio_account) | **POST** /storefront/twilio/accounts | Create Twilio account
|
16
17
|
[**delete_email_campaign_folder**](StorefrontApi.md#delete_email_campaign_folder) | **DELETE** /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} | Delete email campaignFolder
|
17
18
|
[**delete_email_commseq_stat**](StorefrontApi.md#delete_email_commseq_stat) | **DELETE** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Delete communication sequence stats
|
18
19
|
[**delete_email_email**](StorefrontApi.md#delete_email_email) | **DELETE** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Delete email email
|
@@ -26,6 +27,7 @@ Method | HTTP request | Description
|
|
26
27
|
[**delete_library_item**](StorefrontApi.md#delete_library_item) | **DELETE** /storefront/code_library/{library_item_oid} | Delete library item
|
27
28
|
[**delete_library_item_published_versions**](StorefrontApi.md#delete_library_item_published_versions) | **DELETE** /storefront/code_library/{library_item_oid}/published_versions | Delete all published versions for a library item, including anything in review.
|
28
29
|
[**delete_screen_recording_segment**](StorefrontApi.md#delete_screen_recording_segment) | **DELETE** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} | Delete screen recording segment
|
30
|
+
[**delete_twilio_account**](StorefrontApi.md#delete_twilio_account) | **DELETE** /storefront/twilio/accounts/{esp_twilio_uuid} | delete Twilio account
|
29
31
|
[**duplicate_library_item**](StorefrontApi.md#duplicate_library_item) | **POST** /storefront/code_library/{library_item_oid}/duplicate | Duplicate library item.
|
30
32
|
[**favorite_screen_recording**](StorefrontApi.md#favorite_screen_recording) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Update favorite flag on screen recording
|
31
33
|
[**geocode_address**](StorefrontApi.md#geocode_address) | **POST** /storefront/{storefront_oid}/email/geocode | Obtain lat/long for an address
|
@@ -106,6 +108,8 @@ Method | HTTP request | Description
|
|
106
108
|
[**get_transaction_email**](StorefrontApi.md#get_transaction_email) | **GET** /storefront/{storefront_oid}/transaction_email/list/{email_id} | Gets a transaction email object
|
107
109
|
[**get_transaction_email_list**](StorefrontApi.md#get_transaction_email_list) | **GET** /storefront/{storefront_oid}/transaction_email/list | Gets a list of transaction email names
|
108
110
|
[**get_transaction_email_screenshots**](StorefrontApi.md#get_transaction_email_screenshots) | **GET** /storefront/{storefront_oid}/transaction_email/list/{email_id}/screenshots | Get transactional email screenshots
|
111
|
+
[**get_twilio_account**](StorefrontApi.md#get_twilio_account) | **GET** /storefront/twilio/accounts/{esp_twilio_uuid} | Get Twilio account
|
112
|
+
[**get_twilio_accounts**](StorefrontApi.md#get_twilio_accounts) | **GET** /storefront/twilio/accounts | Get all Twilio accounts
|
109
113
|
[**global_unsubscribe**](StorefrontApi.md#global_unsubscribe) | **POST** /storefront/{storefront_oid}/email/globalUnsubscribe | Globally unsubscribe a customer
|
110
114
|
[**import_email_third_party_provider_list**](StorefrontApi.md#import_email_third_party_provider_list) | **POST** /storefront/{storefront_oid}/email/third_party_providers/import | Import a third party provider list
|
111
115
|
[**insert_email_campaign**](StorefrontApi.md#insert_email_campaign) | **POST** /storefront/{storefront_oid}/email/campaigns | Insert email campaign
|
@@ -159,6 +163,7 @@ Method | HTTP request | Description
|
|
159
163
|
[**update_screen_recording_settings**](StorefrontApi.md#update_screen_recording_settings) | **POST** /storefront/{storefront_oid}/screen_recordings/settings | Update screen recording settings
|
160
164
|
[**update_screen_recording_tags**](StorefrontApi.md#update_screen_recording_tags) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags | Update tags on a screen recording
|
161
165
|
[**update_transaction_email**](StorefrontApi.md#update_transaction_email) | **PUT** /storefront/{storefront_oid}/transaction_email/list/{email_id} | Updates a transaction email object
|
166
|
+
[**update_twilio_account**](StorefrontApi.md#update_twilio_account) | **PUT** /storefront/twilio/accounts/{esp_twilio_uuid} | Update Twilio account
|
162
167
|
|
163
168
|
|
164
169
|
# **add_to_library**
|
@@ -625,6 +630,54 @@ Name | Type | Description | Notes
|
|
625
630
|
|
626
631
|
|
627
632
|
|
633
|
+
# **create_twilio_account**
|
634
|
+
> TwilioResponse create_twilio_account(twilio)
|
635
|
+
|
636
|
+
Create Twilio account
|
637
|
+
|
638
|
+
### Example
|
639
|
+
```ruby
|
640
|
+
# load the gem
|
641
|
+
require 'ultracart_api'
|
642
|
+
|
643
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
644
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
645
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
646
|
+
|
647
|
+
|
648
|
+
twilio = UltracartClient::Twilio.new # Twilio | Twilio
|
649
|
+
|
650
|
+
|
651
|
+
begin
|
652
|
+
#Create Twilio account
|
653
|
+
result = api_instance.create_twilio_account(twilio)
|
654
|
+
p result
|
655
|
+
rescue UltracartClient::ApiError => e
|
656
|
+
puts "Exception when calling StorefrontApi->create_twilio_account: #{e}"
|
657
|
+
end
|
658
|
+
```
|
659
|
+
|
660
|
+
### Parameters
|
661
|
+
|
662
|
+
Name | Type | Description | Notes
|
663
|
+
------------- | ------------- | ------------- | -------------
|
664
|
+
**twilio** | [**Twilio**](Twilio.md)| Twilio |
|
665
|
+
|
666
|
+
### Return type
|
667
|
+
|
668
|
+
[**TwilioResponse**](TwilioResponse.md)
|
669
|
+
|
670
|
+
### Authorization
|
671
|
+
|
672
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
673
|
+
|
674
|
+
### HTTP request headers
|
675
|
+
|
676
|
+
- **Content-Type**: application/json
|
677
|
+
- **Accept**: application/json
|
678
|
+
|
679
|
+
|
680
|
+
|
628
681
|
# **delete_email_campaign_folder**
|
629
682
|
> BaseResponse delete_email_campaign_folder(storefront_oid, email_campaign_folder_uuid)
|
630
683
|
|
@@ -1278,6 +1331,54 @@ nil (empty response body)
|
|
1278
1331
|
|
1279
1332
|
|
1280
1333
|
|
1334
|
+
# **delete_twilio_account**
|
1335
|
+
> BaseResponse delete_twilio_account(esp_twilio_uuid)
|
1336
|
+
|
1337
|
+
delete Twilio account
|
1338
|
+
|
1339
|
+
### Example
|
1340
|
+
```ruby
|
1341
|
+
# load the gem
|
1342
|
+
require 'ultracart_api'
|
1343
|
+
|
1344
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
1345
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
1346
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
1347
|
+
|
1348
|
+
|
1349
|
+
esp_twilio_uuid = 'esp_twilio_uuid_example' # String |
|
1350
|
+
|
1351
|
+
|
1352
|
+
begin
|
1353
|
+
#delete Twilio account
|
1354
|
+
result = api_instance.delete_twilio_account(esp_twilio_uuid)
|
1355
|
+
p result
|
1356
|
+
rescue UltracartClient::ApiError => e
|
1357
|
+
puts "Exception when calling StorefrontApi->delete_twilio_account: #{e}"
|
1358
|
+
end
|
1359
|
+
```
|
1360
|
+
|
1361
|
+
### Parameters
|
1362
|
+
|
1363
|
+
Name | Type | Description | Notes
|
1364
|
+
------------- | ------------- | ------------- | -------------
|
1365
|
+
**esp_twilio_uuid** | **String**| |
|
1366
|
+
|
1367
|
+
### Return type
|
1368
|
+
|
1369
|
+
[**BaseResponse**](BaseResponse.md)
|
1370
|
+
|
1371
|
+
### Authorization
|
1372
|
+
|
1373
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1374
|
+
|
1375
|
+
### HTTP request headers
|
1376
|
+
|
1377
|
+
- **Content-Type**: application/json
|
1378
|
+
- **Accept**: application/json
|
1379
|
+
|
1380
|
+
|
1381
|
+
|
1281
1382
|
# **duplicate_library_item**
|
1282
1383
|
> LibraryItemResponse duplicate_library_item(library_item_oid)
|
1283
1384
|
|
@@ -5374,6 +5475,97 @@ Name | Type | Description | Notes
|
|
5374
5475
|
|
5375
5476
|
|
5376
5477
|
|
5478
|
+
# **get_twilio_account**
|
5479
|
+
> TwilioResponse get_twilio_account(esp_twilio_uuid)
|
5480
|
+
|
5481
|
+
Get Twilio account
|
5482
|
+
|
5483
|
+
### Example
|
5484
|
+
```ruby
|
5485
|
+
# load the gem
|
5486
|
+
require 'ultracart_api'
|
5487
|
+
|
5488
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
5489
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
5490
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
5491
|
+
|
5492
|
+
|
5493
|
+
esp_twilio_uuid = 'esp_twilio_uuid_example' # String |
|
5494
|
+
|
5495
|
+
|
5496
|
+
begin
|
5497
|
+
#Get Twilio account
|
5498
|
+
result = api_instance.get_twilio_account(esp_twilio_uuid)
|
5499
|
+
p result
|
5500
|
+
rescue UltracartClient::ApiError => e
|
5501
|
+
puts "Exception when calling StorefrontApi->get_twilio_account: #{e}"
|
5502
|
+
end
|
5503
|
+
```
|
5504
|
+
|
5505
|
+
### Parameters
|
5506
|
+
|
5507
|
+
Name | Type | Description | Notes
|
5508
|
+
------------- | ------------- | ------------- | -------------
|
5509
|
+
**esp_twilio_uuid** | **String**| |
|
5510
|
+
|
5511
|
+
### Return type
|
5512
|
+
|
5513
|
+
[**TwilioResponse**](TwilioResponse.md)
|
5514
|
+
|
5515
|
+
### Authorization
|
5516
|
+
|
5517
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
5518
|
+
|
5519
|
+
### HTTP request headers
|
5520
|
+
|
5521
|
+
- **Content-Type**: application/json
|
5522
|
+
- **Accept**: application/json
|
5523
|
+
|
5524
|
+
|
5525
|
+
|
5526
|
+
# **get_twilio_accounts**
|
5527
|
+
> TwiliosResponse get_twilio_accounts
|
5528
|
+
|
5529
|
+
Get all Twilio accounts
|
5530
|
+
|
5531
|
+
### Example
|
5532
|
+
```ruby
|
5533
|
+
# load the gem
|
5534
|
+
require 'ultracart_api'
|
5535
|
+
|
5536
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
5537
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
5538
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
5539
|
+
|
5540
|
+
|
5541
|
+
|
5542
|
+
begin
|
5543
|
+
#Get all Twilio accounts
|
5544
|
+
result = api_instance.get_twilio_accounts
|
5545
|
+
p result
|
5546
|
+
rescue UltracartClient::ApiError => e
|
5547
|
+
puts "Exception when calling StorefrontApi->get_twilio_accounts: #{e}"
|
5548
|
+
end
|
5549
|
+
```
|
5550
|
+
|
5551
|
+
### Parameters
|
5552
|
+
This endpoint does not need any parameter.
|
5553
|
+
|
5554
|
+
### Return type
|
5555
|
+
|
5556
|
+
[**TwiliosResponse**](TwiliosResponse.md)
|
5557
|
+
|
5558
|
+
### Authorization
|
5559
|
+
|
5560
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
5561
|
+
|
5562
|
+
### HTTP request headers
|
5563
|
+
|
5564
|
+
- **Content-Type**: application/json
|
5565
|
+
- **Accept**: application/json
|
5566
|
+
|
5567
|
+
|
5568
|
+
|
5377
5569
|
# **global_unsubscribe**
|
5378
5570
|
> EmailGlobalUnsubscribeResponse global_unsubscribe(storefront_oid, unsubscribe)
|
5379
5571
|
|
@@ -8179,3 +8371,54 @@ Name | Type | Description | Notes
|
|
8179
8371
|
|
8180
8372
|
|
8181
8373
|
|
8374
|
+
# **update_twilio_account**
|
8375
|
+
> TwilioResponse update_twilio_account(esp_twilio_uuid, twilio)
|
8376
|
+
|
8377
|
+
Update Twilio account
|
8378
|
+
|
8379
|
+
### Example
|
8380
|
+
```ruby
|
8381
|
+
# load the gem
|
8382
|
+
require 'ultracart_api'
|
8383
|
+
|
8384
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
8385
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
8386
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
8387
|
+
|
8388
|
+
|
8389
|
+
esp_twilio_uuid = 'esp_twilio_uuid_example' # String |
|
8390
|
+
|
8391
|
+
twilio = UltracartClient::Twilio.new # Twilio | Twilio
|
8392
|
+
|
8393
|
+
|
8394
|
+
begin
|
8395
|
+
#Update Twilio account
|
8396
|
+
result = api_instance.update_twilio_account(esp_twilio_uuid, twilio)
|
8397
|
+
p result
|
8398
|
+
rescue UltracartClient::ApiError => e
|
8399
|
+
puts "Exception when calling StorefrontApi->update_twilio_account: #{e}"
|
8400
|
+
end
|
8401
|
+
```
|
8402
|
+
|
8403
|
+
### Parameters
|
8404
|
+
|
8405
|
+
Name | Type | Description | Notes
|
8406
|
+
------------- | ------------- | ------------- | -------------
|
8407
|
+
**esp_twilio_uuid** | **String**| |
|
8408
|
+
**twilio** | [**Twilio**](Twilio.md)| Twilio |
|
8409
|
+
|
8410
|
+
### Return type
|
8411
|
+
|
8412
|
+
[**TwilioResponse**](TwilioResponse.md)
|
8413
|
+
|
8414
|
+
### Authorization
|
8415
|
+
|
8416
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
8417
|
+
|
8418
|
+
### HTTP request headers
|
8419
|
+
|
8420
|
+
- **Content-Type**: application/json
|
8421
|
+
- **Accept**: application/json
|
8422
|
+
|
8423
|
+
|
8424
|
+
|
data/docs/Twilio.md
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# UltracartClient::Twilio
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**account_sid** | **String** | | [optional]
|
7
|
+
**auth_token** | **String** | | [optional]
|
8
|
+
**esp_twilio_uuid** | **String** | | [optional]
|
9
|
+
**phone_numbers** | **Array<String>** | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# UltracartClient::TwilioResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**diagnostics** | **String** | | [optional]
|
7
|
+
**error** | [**Error**](Error.md) | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**twilio** | [**Twilio**](Twilio.md) | | [optional]
|
11
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::TwiliosResponse
|
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
|
+
**twilios** | [**Array<Twilio>**](Twilio.md) | | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|