ultracart_api 3.6.19 → 3.6.20

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: e780308fdcb7b1900c2c5b51dc4d4562daee3e43110446d9f2558d7a0f9b5fae
4
- data.tar.gz: 1d7f977ff69f64aeb769218b5ad1db3d9afb1770c5b53a62561496bcfe9cbb6d
3
+ metadata.gz: 61c8e96b2f46ca6516a120ed0d431b0bcee9cf5c8fce33f3b62ba7940c128464
4
+ data.tar.gz: 66e42a45d6b49eea14efcb85df7d922871099d0e043d44067ac95af46db534b7
5
5
  SHA512:
6
- metadata.gz: 19f157ea633b68093336b4f391c92309cd42669c8dc569b9be627e678fd70d8872869851fce24c048c8493e08c20b579393b193ba7aaa5d8e398a8332aa45346
7
- data.tar.gz: a90a546f713519ebee3848ab17a23ea308eb6a3e7a7cf8ce029108a657549e6a9270bd1e11a64194967bf663edca2ccb19e75492479d972b585966dac00803a2
6
+ metadata.gz: d331239aef79b0f34c18fbd4da6e72182e5e4716a04187bdf8f60e46a528a6699518f56953488ef8e25a92f20b9fbafde4a4f09ff85856a0da35948118d9d19e
7
+ data.tar.gz: 71ea21a3c7df6fde98d521c6343d8cbe9bf224359ce1a2f6df75c45e84368629c5e33c1f81ed088dc692d945a2b55d31d08525020a5ed6aab412d883283596ef
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.19
10
+ - Package version: 3.6.20
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.19.gem
27
+ gem install ./ultracart_api-3.6.20.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.6.19.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.6.20.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.19'
35
+ gem 'ultracart_api', '~> 3.6.20'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -725,6 +725,7 @@ Class | Method | HTTP request | Description
725
725
  - [UltracartClient::Experiment](docs/Experiment.md)
726
726
  - [UltracartClient::ExperimentResponse](docs/ExperimentResponse.md)
727
727
  - [UltracartClient::ExperimentVariation](docs/ExperimentVariation.md)
728
+ - [UltracartClient::ExperimentVariationStat](docs/ExperimentVariationStat.md)
728
729
  - [UltracartClient::ExperimentsResponse](docs/ExperimentsResponse.md)
729
730
  - [UltracartClient::FulfillmentInventory](docs/FulfillmentInventory.md)
730
731
  - [UltracartClient::FulfillmentShipment](docs/FulfillmentShipment.md)
@@ -1119,6 +1120,7 @@ Not every change is committed to every SDK.
1119
1120
 
1120
1121
  | Version | Date | Comments |
1121
1122
  | --: | :-: | --- |
1123
+ | 3.6.20 | 11/05/2021 | additional item auto order step types |
1122
1124
  | 3.6.19 | 10/05/2021 | item fulfillment add ons |
1123
1125
  | 3.6.18 | 09/30/2021 | terms if auto order flag added |
1124
1126
  | 3.6.16 | 09/30/2021 | item exclude from sitemap field |
@@ -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
 
@@ -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** | **String** | Tier number that this transaction earned | [optional]
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** | **String** | Percentage associated with this transaction | [optional]
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]
@@ -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
+
@@ -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
 
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]
@@ -20,7 +20,7 @@ module UltracartClient
20
20
  # Cjson to be added to library
21
21
  attr_accessor :cjson
22
22
 
23
- # flow, campaign, cjson, email, transactional_email or upsell
23
+ # flow, campaign, cjson, email, transactional_email, postcard or upsell
24
24
  attr_accessor :content_type
25
25
 
26
26
  # description of library item
@@ -44,7 +44,7 @@ module UltracartClient
44
44
  # Required if content_type is upsell. This is object identifier of a StoreFront Upsell Offer.
45
45
  attr_accessor :upsell_offer_oid
46
46
 
47
- # 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
47
+ # 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
48
48
  attr_accessor :uuid
49
49
 
50
50
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -17,6 +17,9 @@ module UltracartClient
17
17
  # Unique object identifier for the click associated with this ledger entry
18
18
  attr_accessor :affiliate_click_oid
19
19
 
20
+ # Affiliate ledger object ID associated with this ledger
21
+ attr_accessor :affiliate_ledger_oid
22
+
20
23
  # Unique object identifier for the link that this click is associated with
21
24
  attr_accessor :affiliate_link_oid
22
25
 
@@ -91,6 +94,7 @@ module UltracartClient
91
94
  def self.attribute_map
92
95
  {
93
96
  :'affiliate_click_oid' => :'affiliate_click_oid',
97
+ :'affiliate_ledger_oid' => :'affiliate_ledger_oid',
94
98
  :'affiliate_link_oid' => :'affiliate_link_oid',
95
99
  :'affiliate_oid' => :'affiliate_oid',
96
100
  :'assigned_by_user' => :'assigned_by_user',
@@ -115,6 +119,7 @@ module UltracartClient
115
119
  def self.swagger_types
116
120
  {
117
121
  :'affiliate_click_oid' => :'Integer',
122
+ :'affiliate_ledger_oid' => :'Integer',
118
123
  :'affiliate_link_oid' => :'Integer',
119
124
  :'affiliate_oid' => :'Integer',
120
125
  :'assigned_by_user' => :'String',
@@ -125,12 +130,12 @@ module UltracartClient
125
130
  :'order_id' => :'String',
126
131
  :'original_transaction_dts' => :'String',
127
132
  :'sub_id' => :'String',
128
- :'tier_number' => :'String',
133
+ :'tier_number' => :'Integer',
129
134
  :'transaction_amount' => :'Float',
130
135
  :'transaction_amount_paid' => :'Float',
131
136
  :'transaction_dts' => :'String',
132
137
  :'transaction_memo' => :'String',
133
- :'transaction_percentage' => :'String',
138
+ :'transaction_percentage' => :'Float',
134
139
  :'transaction_state' => :'String'
135
140
  }
136
141
  end
@@ -147,6 +152,10 @@ module UltracartClient
147
152
  self.affiliate_click_oid = attributes[:'affiliate_click_oid']
148
153
  end
149
154
 
155
+ if attributes.has_key?(:'affiliate_ledger_oid')
156
+ self.affiliate_ledger_oid = attributes[:'affiliate_ledger_oid']
157
+ end
158
+
150
159
  if attributes.has_key?(:'affiliate_link_oid')
151
160
  self.affiliate_link_oid = attributes[:'affiliate_link_oid']
152
161
  end
@@ -247,6 +256,7 @@ module UltracartClient
247
256
  return true if self.equal?(o)
248
257
  self.class == o.class &&
249
258
  affiliate_click_oid == o.affiliate_click_oid &&
259
+ affiliate_ledger_oid == o.affiliate_ledger_oid &&
250
260
  affiliate_link_oid == o.affiliate_link_oid &&
251
261
  affiliate_oid == o.affiliate_oid &&
252
262
  assigned_by_user == o.assigned_by_user &&
@@ -275,7 +285,7 @@ module UltracartClient
275
285
  # Calculates hash code according to all attributes.
276
286
  # @return [Fixnum] Hash code
277
287
  def hash
278
- [affiliate_click_oid, affiliate_link_oid, affiliate_oid, assigned_by_user, click, item_id, link, order, order_id, original_transaction_dts, sub_id, tier_number, transaction_amount, transaction_amount_paid, transaction_dts, transaction_memo, transaction_percentage, transaction_state].hash
288
+ [affiliate_click_oid, affiliate_ledger_oid, affiliate_link_oid, affiliate_oid, assigned_by_user, click, item_id, link, order, order_id, original_transaction_dts, sub_id, tier_number, transaction_amount, transaction_amount_paid, transaction_dts, transaction_memo, transaction_percentage, transaction_state].hash
279
289
  end
280
290
 
281
291
  # Builds the object from hash
@@ -20,6 +20,9 @@ module UltracartClient
20
20
  # Library item oid that you wish to apply to the given StoreFront
21
21
  attr_accessor :library_item_oid
22
22
 
23
+ # The postcard uuid you wish to apply to a given StoreFront.
24
+ attr_accessor :postcard_uuid
25
+
23
26
  # StoreFront oid where content originates necessary for tracking down relative assets
24
27
  attr_accessor :storefront_oid
25
28
 
@@ -28,6 +31,7 @@ module UltracartClient
28
31
  {
29
32
  :'email_uuid' => :'email_uuid',
30
33
  :'library_item_oid' => :'library_item_oid',
34
+ :'postcard_uuid' => :'postcard_uuid',
31
35
  :'storefront_oid' => :'storefront_oid'
32
36
  }
33
37
  end
@@ -37,6 +41,7 @@ module UltracartClient
37
41
  {
38
42
  :'email_uuid' => :'String',
39
43
  :'library_item_oid' => :'Integer',
44
+ :'postcard_uuid' => :'String',
40
45
  :'storefront_oid' => :'Integer'
41
46
  }
42
47
  end
@@ -57,6 +62,10 @@ module UltracartClient
57
62
  self.library_item_oid = attributes[:'library_item_oid']
58
63
  end
59
64
 
65
+ if attributes.has_key?(:'postcard_uuid')
66
+ self.postcard_uuid = attributes[:'postcard_uuid']
67
+ end
68
+
60
69
  if attributes.has_key?(:'storefront_oid')
61
70
  self.storefront_oid = attributes[:'storefront_oid']
62
71
  end
@@ -82,6 +91,7 @@ module UltracartClient
82
91
  self.class == o.class &&
83
92
  email_uuid == o.email_uuid &&
84
93
  library_item_oid == o.library_item_oid &&
94
+ postcard_uuid == o.postcard_uuid &&
85
95
  storefront_oid == o.storefront_oid
86
96
  end
87
97
 
@@ -94,7 +104,7 @@ module UltracartClient
94
104
  # Calculates hash code according to all attributes.
95
105
  # @return [Fixnum] Hash code
96
106
  def hash
97
- [email_uuid, library_item_oid, storefront_oid].hash
107
+ [email_uuid, library_item_oid, postcard_uuid, storefront_oid].hash
98
108
  end
99
109
 
100
110
  # Builds the object from hash
@@ -20,7 +20,7 @@ module UltracartClient
20
20
  # Cjson from library item, only populated if this library item was a cjson snippet or marketing email (not transactional)
21
21
  attr_accessor :cjson
22
22
 
23
- # flow, campaign, cjson, upsell, transactional_email or email
23
+ # flow, campaign, cjson, upsell, postcard, transactional_email or email
24
24
  attr_accessor :content_type
25
25
 
26
26
  # If a marketing email was applied, this is the path to the template encapsulating the cjson. This is needed for the UltraCart UI.
@@ -32,6 +32,9 @@ module UltracartClient
32
32
  # Conversion rate for this variation
33
33
  attr_accessor :conversion_rate
34
34
 
35
+ # Array of daily statistics for this variation
36
+ attr_accessor :daily_statistics
37
+
35
38
  # Total number of seconds spent on the site for this variation
36
39
  attr_accessor :duration_seconds_sum
37
40
 
@@ -44,6 +47,9 @@ module UltracartClient
44
47
  # Total order count for this variation
45
48
  attr_accessor :order_count
46
49
 
50
+ # Total order item count for this variation
51
+ attr_accessor :order_item_count
52
+
47
53
  # Percentage of the traffic the variation originally started out with
48
54
  attr_accessor :original_traffic_percentage
49
55
 
@@ -80,10 +86,12 @@ module UltracartClient
80
86
  :'average_order_value' => :'average_order_value',
81
87
  :'bounce_count' => :'bounce_count',
82
88
  :'conversion_rate' => :'conversion_rate',
89
+ :'daily_statistics' => :'daily_statistics',
83
90
  :'duration_seconds_sum' => :'duration_seconds_sum',
84
91
  :'event_count' => :'event_count',
85
92
  :'initiate_checkout_count' => :'initiate_checkout_count',
86
93
  :'order_count' => :'order_count',
94
+ :'order_item_count' => :'order_item_count',
87
95
  :'original_traffic_percentage' => :'original_traffic_percentage',
88
96
  :'page_view_count' => :'page_view_count',
89
97
  :'revenue' => :'revenue',
@@ -105,10 +113,12 @@ module UltracartClient
105
113
  :'average_order_value' => :'Float',
106
114
  :'bounce_count' => :'Integer',
107
115
  :'conversion_rate' => :'Float',
116
+ :'daily_statistics' => :'Array<ExperimentVariationStat>',
108
117
  :'duration_seconds_sum' => :'Integer',
109
118
  :'event_count' => :'Integer',
110
119
  :'initiate_checkout_count' => :'Integer',
111
120
  :'order_count' => :'Integer',
121
+ :'order_item_count' => :'Integer',
112
122
  :'original_traffic_percentage' => :'Float',
113
123
  :'page_view_count' => :'Integer',
114
124
  :'revenue' => :'Float',
@@ -153,6 +163,12 @@ module UltracartClient
153
163
  self.conversion_rate = attributes[:'conversion_rate']
154
164
  end
155
165
 
166
+ if attributes.has_key?(:'daily_statistics')
167
+ if (value = attributes[:'daily_statistics']).is_a?(Array)
168
+ self.daily_statistics = value
169
+ end
170
+ end
171
+
156
172
  if attributes.has_key?(:'duration_seconds_sum')
157
173
  self.duration_seconds_sum = attributes[:'duration_seconds_sum']
158
174
  end
@@ -169,6 +185,10 @@ module UltracartClient
169
185
  self.order_count = attributes[:'order_count']
170
186
  end
171
187
 
188
+ if attributes.has_key?(:'order_item_count')
189
+ self.order_item_count = attributes[:'order_item_count']
190
+ end
191
+
172
192
  if attributes.has_key?(:'original_traffic_percentage')
173
193
  self.original_traffic_percentage = attributes[:'original_traffic_percentage']
174
194
  end
@@ -230,10 +250,12 @@ module UltracartClient
230
250
  average_order_value == o.average_order_value &&
231
251
  bounce_count == o.bounce_count &&
232
252
  conversion_rate == o.conversion_rate &&
253
+ daily_statistics == o.daily_statistics &&
233
254
  duration_seconds_sum == o.duration_seconds_sum &&
234
255
  event_count == o.event_count &&
235
256
  initiate_checkout_count == o.initiate_checkout_count &&
236
257
  order_count == o.order_count &&
258
+ order_item_count == o.order_item_count &&
237
259
  original_traffic_percentage == o.original_traffic_percentage &&
238
260
  page_view_count == o.page_view_count &&
239
261
  revenue == o.revenue &&
@@ -254,7 +276,7 @@ module UltracartClient
254
276
  # Calculates hash code according to all attributes.
255
277
  # @return [Fixnum] Hash code
256
278
  def hash
257
- [add_to_cart_count, average_duration_seconds, average_objective_per_session, average_order_value, bounce_count, conversion_rate, duration_seconds_sum, event_count, initiate_checkout_count, order_count, original_traffic_percentage, page_view_count, revenue, session_count, traffic_percentage, url, variation_name, variation_number, winner].hash
279
+ [add_to_cart_count, average_duration_seconds, average_objective_per_session, average_order_value, bounce_count, conversion_rate, daily_statistics, duration_seconds_sum, event_count, initiate_checkout_count, order_count, order_item_count, original_traffic_percentage, page_view_count, revenue, session_count, traffic_percentage, url, variation_name, variation_number, winner].hash
258
280
  end
259
281
 
260
282
  # Builds the object from hash
@@ -0,0 +1,285 @@
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 ExperimentVariationStat
17
+ # Total add to cart count for this variation
18
+ attr_accessor :add_to_cart_count
19
+
20
+ # Total bounce count for this variation
21
+ attr_accessor :bounce_count
22
+
23
+ # Total number of seconds spent on the site for this variation
24
+ attr_accessor :duration_seconds_sum
25
+
26
+ # Total event count for this variation
27
+ attr_accessor :event_count
28
+
29
+ # Total initiate checkout count for this variation
30
+ attr_accessor :initiate_checkout_count
31
+
32
+ # Total order count for this variation
33
+ attr_accessor :order_count
34
+
35
+ # Total order item count for this variation
36
+ attr_accessor :order_item_count
37
+
38
+ # Total page view count for this variation
39
+ attr_accessor :page_view_count
40
+
41
+ # Total revenue for this variation
42
+ attr_accessor :revenue
43
+
44
+ # Total sessions for this variation
45
+ attr_accessor :session_count
46
+
47
+ # Date/time that the statistic was created
48
+ attr_accessor :stat_dts
49
+
50
+ # Attribute mapping from ruby-style variable name to JSON key.
51
+ def self.attribute_map
52
+ {
53
+ :'add_to_cart_count' => :'add_to_cart_count',
54
+ :'bounce_count' => :'bounce_count',
55
+ :'duration_seconds_sum' => :'duration_seconds_sum',
56
+ :'event_count' => :'event_count',
57
+ :'initiate_checkout_count' => :'initiate_checkout_count',
58
+ :'order_count' => :'order_count',
59
+ :'order_item_count' => :'order_item_count',
60
+ :'page_view_count' => :'page_view_count',
61
+ :'revenue' => :'revenue',
62
+ :'session_count' => :'session_count',
63
+ :'stat_dts' => :'stat_dts'
64
+ }
65
+ end
66
+
67
+ # Attribute type mapping.
68
+ def self.swagger_types
69
+ {
70
+ :'add_to_cart_count' => :'Integer',
71
+ :'bounce_count' => :'Integer',
72
+ :'duration_seconds_sum' => :'Integer',
73
+ :'event_count' => :'Integer',
74
+ :'initiate_checkout_count' => :'Integer',
75
+ :'order_count' => :'Integer',
76
+ :'order_item_count' => :'Integer',
77
+ :'page_view_count' => :'Integer',
78
+ :'revenue' => :'Float',
79
+ :'session_count' => :'Integer',
80
+ :'stat_dts' => :'String'
81
+ }
82
+ end
83
+
84
+ # Initializes the object
85
+ # @param [Hash] attributes Model attributes in the form of hash
86
+ def initialize(attributes = {})
87
+ return unless attributes.is_a?(Hash)
88
+
89
+ # convert string to symbol for hash key
90
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
91
+
92
+ if attributes.has_key?(:'add_to_cart_count')
93
+ self.add_to_cart_count = attributes[:'add_to_cart_count']
94
+ end
95
+
96
+ if attributes.has_key?(:'bounce_count')
97
+ self.bounce_count = attributes[:'bounce_count']
98
+ end
99
+
100
+ if attributes.has_key?(:'duration_seconds_sum')
101
+ self.duration_seconds_sum = attributes[:'duration_seconds_sum']
102
+ end
103
+
104
+ if attributes.has_key?(:'event_count')
105
+ self.event_count = attributes[:'event_count']
106
+ end
107
+
108
+ if attributes.has_key?(:'initiate_checkout_count')
109
+ self.initiate_checkout_count = attributes[:'initiate_checkout_count']
110
+ end
111
+
112
+ if attributes.has_key?(:'order_count')
113
+ self.order_count = attributes[:'order_count']
114
+ end
115
+
116
+ if attributes.has_key?(:'order_item_count')
117
+ self.order_item_count = attributes[:'order_item_count']
118
+ end
119
+
120
+ if attributes.has_key?(:'page_view_count')
121
+ self.page_view_count = attributes[:'page_view_count']
122
+ end
123
+
124
+ if attributes.has_key?(:'revenue')
125
+ self.revenue = attributes[:'revenue']
126
+ end
127
+
128
+ if attributes.has_key?(:'session_count')
129
+ self.session_count = attributes[:'session_count']
130
+ end
131
+
132
+ if attributes.has_key?(:'stat_dts')
133
+ self.stat_dts = attributes[:'stat_dts']
134
+ end
135
+ end
136
+
137
+ # Show invalid properties with the reasons. Usually used together with valid?
138
+ # @return Array for valid properties with the reasons
139
+ def list_invalid_properties
140
+ invalid_properties = Array.new
141
+ invalid_properties
142
+ end
143
+
144
+ # Check to see if the all the properties in the model are valid
145
+ # @return true if the model is valid
146
+ def valid?
147
+ true
148
+ end
149
+
150
+ # Checks equality by comparing each attribute.
151
+ # @param [Object] Object to be compared
152
+ def ==(o)
153
+ return true if self.equal?(o)
154
+ self.class == o.class &&
155
+ add_to_cart_count == o.add_to_cart_count &&
156
+ bounce_count == o.bounce_count &&
157
+ duration_seconds_sum == o.duration_seconds_sum &&
158
+ event_count == o.event_count &&
159
+ initiate_checkout_count == o.initiate_checkout_count &&
160
+ order_count == o.order_count &&
161
+ order_item_count == o.order_item_count &&
162
+ page_view_count == o.page_view_count &&
163
+ revenue == o.revenue &&
164
+ session_count == o.session_count &&
165
+ stat_dts == o.stat_dts
166
+ end
167
+
168
+ # @see the `==` method
169
+ # @param [Object] Object to be compared
170
+ def eql?(o)
171
+ self == o
172
+ end
173
+
174
+ # Calculates hash code according to all attributes.
175
+ # @return [Fixnum] Hash code
176
+ def hash
177
+ [add_to_cart_count, bounce_count, duration_seconds_sum, event_count, initiate_checkout_count, order_count, order_item_count, page_view_count, revenue, session_count, stat_dts].hash
178
+ end
179
+
180
+ # Builds the object from hash
181
+ # @param [Hash] attributes Model attributes in the form of hash
182
+ # @return [Object] Returns the model itself
183
+ def build_from_hash(attributes)
184
+ return nil unless attributes.is_a?(Hash)
185
+ self.class.swagger_types.each_pair do |key, type|
186
+ if type =~ /\AArray<(.*)>/i
187
+ # check to ensure the input is an array given that the attribute
188
+ # is documented as an array but the input is not
189
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
190
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
191
+ end
192
+ elsif !attributes[self.class.attribute_map[key]].nil?
193
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
194
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
195
+ end
196
+
197
+ self
198
+ end
199
+
200
+ # Deserializes the data based on type
201
+ # @param string type Data type
202
+ # @param string value Value to be deserialized
203
+ # @return [Object] Deserialized data
204
+ def _deserialize(type, value)
205
+ case type.to_sym
206
+ when :DateTime
207
+ DateTime.parse(value)
208
+ when :Date
209
+ Date.parse(value)
210
+ when :String
211
+ value.to_s
212
+ when :Integer
213
+ value.to_i
214
+ when :Float
215
+ value.to_f
216
+ when :BOOLEAN
217
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
218
+ true
219
+ else
220
+ false
221
+ end
222
+ when :Object
223
+ # generic object (usually a Hash), return directly
224
+ value
225
+ when /\AArray<(?<inner_type>.+)>\z/
226
+ inner_type = Regexp.last_match[:inner_type]
227
+ value.map { |v| _deserialize(inner_type, v) }
228
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
229
+ k_type = Regexp.last_match[:k_type]
230
+ v_type = Regexp.last_match[:v_type]
231
+ {}.tap do |hash|
232
+ value.each do |k, v|
233
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
234
+ end
235
+ end
236
+ else # model
237
+ temp_model = UltracartClient.const_get(type).new
238
+ temp_model.build_from_hash(value)
239
+ end
240
+ end
241
+
242
+ # Returns the string representation of the object
243
+ # @return [String] String presentation of the object
244
+ def to_s
245
+ to_hash.to_s
246
+ end
247
+
248
+ # to_body is an alias to to_hash (backward compatibility)
249
+ # @return [Hash] Returns the object in the form of hash
250
+ def to_body
251
+ to_hash
252
+ end
253
+
254
+ # Returns the object in the form of hash
255
+ # @return [Hash] Returns the object in the form of hash
256
+ def to_hash
257
+ hash = {}
258
+ self.class.attribute_map.each_pair do |attr, param|
259
+ value = self.send(attr)
260
+ next if value.nil?
261
+ hash[param] = _to_hash(value)
262
+ end
263
+ hash
264
+ end
265
+
266
+ # Outputs non-array value in the form of hash
267
+ # For object, use to_hash. Otherwise, just return the value
268
+ # @param [Object] value Any valid value
269
+ # @return [Hash] Returns the value in the form of hash
270
+ def _to_hash(value)
271
+ if value.is_a?(Array)
272
+ value.compact.map { |v| _to_hash(v) }
273
+ elsif value.is_a?(Hash)
274
+ {}.tap do |hash|
275
+ value.each { |k, v| hash[k] = _to_hash(v) }
276
+ end
277
+ elsif value.respond_to? :to_hash
278
+ value.to_hash
279
+ else
280
+ value
281
+ end
282
+ end
283
+
284
+ end
285
+ end
@@ -56,7 +56,7 @@ module UltracartClient
56
56
  # Email list identifier to subscribe the customer to when this rebill occurs
57
57
  attr_accessor :subscribe_email_list_oid
58
58
 
59
- # Type of step (item or pause)
59
+ # Type of step (item, kit only, loop or pause)
60
60
  attr_accessor :type
61
61
 
62
62
  class EnumAttributeValidator
@@ -211,7 +211,7 @@ module UltracartClient
211
211
  # @return true if the model is valid
212
212
  def valid?
213
213
  return false if !@recurring_merchant_item_id.nil? && @recurring_merchant_item_id.to_s.length > 20
214
- type_validator = EnumAttributeValidator.new('String', ['item', 'pause'])
214
+ type_validator = EnumAttributeValidator.new('String', ['item', 'pause', 'loop', 'kit only'])
215
215
  return false unless type_validator.valid?(@type)
216
216
  true
217
217
  end
@@ -229,7 +229,7 @@ module UltracartClient
229
229
  # Custom attribute writer method checking allowed values (enum).
230
230
  # @param [Object] type Object to be assigned
231
231
  def type=(type)
232
- validator = EnumAttributeValidator.new('String', ['item', 'pause'])
232
+ validator = EnumAttributeValidator.new('String', ['item', 'pause', 'loop', 'kit only'])
233
233
  unless validator.valid?(type)
234
234
  fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
235
235
  end
@@ -151,9 +151,6 @@ module UltracartClient
151
151
 
152
152
  attr_accessor :total_refunded
153
153
 
154
- # Tracking number, if null or missing, use order level tracking number(s). Used if there are multiple shipments for one order
155
- attr_accessor :tracking_number
156
-
157
154
  # Date/time that this item was transmitted to the distribution center
158
155
  attr_accessor :transmitted_to_distribution_center_dts
159
156
 
@@ -218,7 +215,6 @@ module UltracartClient
218
215
  :'taxable_cost' => :'taxable_cost',
219
216
  :'total_cost_with_discount' => :'total_cost_with_discount',
220
217
  :'total_refunded' => :'total_refunded',
221
- :'tracking_number' => :'tracking_number',
222
218
  :'transmitted_to_distribution_center_dts' => :'transmitted_to_distribution_center_dts',
223
219
  :'unit_cost_with_discount' => :'unit_cost_with_discount',
224
220
  :'upsell' => :'upsell',
@@ -279,7 +275,6 @@ module UltracartClient
279
275
  :'taxable_cost' => :'Currency',
280
276
  :'total_cost_with_discount' => :'Currency',
281
277
  :'total_refunded' => :'Currency',
282
- :'tracking_number' => :'String',
283
278
  :'transmitted_to_distribution_center_dts' => :'String',
284
279
  :'unit_cost_with_discount' => :'Currency',
285
280
  :'upsell' => :'BOOLEAN',
@@ -500,10 +495,6 @@ module UltracartClient
500
495
  self.total_refunded = attributes[:'total_refunded']
501
496
  end
502
497
 
503
- if attributes.has_key?(:'tracking_number')
504
- self.tracking_number = attributes[:'tracking_number']
505
- end
506
-
507
498
  if attributes.has_key?(:'transmitted_to_distribution_center_dts')
508
499
  self.transmitted_to_distribution_center_dts = attributes[:'transmitted_to_distribution_center_dts']
509
500
  end
@@ -682,7 +673,6 @@ module UltracartClient
682
673
  taxable_cost == o.taxable_cost &&
683
674
  total_cost_with_discount == o.total_cost_with_discount &&
684
675
  total_refunded == o.total_refunded &&
685
- tracking_number == o.tracking_number &&
686
676
  transmitted_to_distribution_center_dts == o.transmitted_to_distribution_center_dts &&
687
677
  unit_cost_with_discount == o.unit_cost_with_discount &&
688
678
  upsell == o.upsell &&
@@ -699,7 +689,7 @@ module UltracartClient
699
689
  # Calculates hash code according to all attributes.
700
690
  # @return [Fixnum] Hash code
701
691
  def hash
702
- [accounting_code, activation_codes, arbitrary_unit_cost, auto_order_last_rebill_dts, auto_order_schedule, barcode, channel_partner_item_id, cogs, component_unit_value, cost, country_code_of_origin, customs_description, description, discount, discount_quantity, discount_shipping_weight, distribution_center_code, edi, exclude_coupon, free_shipping, hazmat, height, item_reference_oid, kit, kit_component, length, manufacturer_sku, max_days_time_in_transit, merchant_item_id, mix_and_match_group_name, mix_and_match_group_oid, no_shipping_discount, options, packed_by_user, perishable_class, pricing_tier_name, properties, quantity, quantity_refunded, quickbooks_class, ship_separately, shipped_by_user, shipped_dts, special_product_type, tags, tax_free, taxable_cost, total_cost_with_discount, total_refunded, tracking_number, transmitted_to_distribution_center_dts, unit_cost_with_discount, upsell, weight, width].hash
692
+ [accounting_code, activation_codes, arbitrary_unit_cost, auto_order_last_rebill_dts, auto_order_schedule, barcode, channel_partner_item_id, cogs, component_unit_value, cost, country_code_of_origin, customs_description, description, discount, discount_quantity, discount_shipping_weight, distribution_center_code, edi, exclude_coupon, free_shipping, hazmat, height, item_reference_oid, kit, kit_component, length, manufacturer_sku, max_days_time_in_transit, merchant_item_id, mix_and_match_group_name, mix_and_match_group_oid, no_shipping_discount, options, packed_by_user, perishable_class, pricing_tier_name, properties, quantity, quantity_refunded, quickbooks_class, ship_separately, shipped_by_user, shipped_dts, special_product_type, tags, tax_free, taxable_cost, total_cost_with_discount, total_refunded, transmitted_to_distribution_center_dts, unit_cost_with_discount, upsell, weight, width].hash
703
693
  end
704
694
 
705
695
  # Builds the object from hash
@@ -475,7 +475,7 @@ module UltracartClient
475
475
  return false if !@email.nil? && @email.to_s.length > 100
476
476
  return false if !@first_name.nil? && @first_name.to_s.length > 30
477
477
  return false if !@last_name.nil? && @last_name.to_s.length > 30
478
- payment_method_validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'eCheck', 'Google Shopping', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer'])
478
+ payment_method_validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'eCheck', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer'])
479
479
  return false unless payment_method_validator.valid?(@payment_method)
480
480
  return false if !@phone.nil? && @phone.to_s.length > 25
481
481
  return false if !@postal_code.nil? && @postal_code.to_s.length > 20
@@ -568,7 +568,7 @@ module UltracartClient
568
568
  # Custom attribute writer method checking allowed values (enum).
569
569
  # @param [Object] payment_method Object to be assigned
570
570
  def payment_method=(payment_method)
571
- validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'eCheck', 'Google Shopping', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer'])
571
+ validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'eCheck', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer'])
572
572
  unless validator.valid?(payment_method)
573
573
  fail ArgumentError, 'invalid value for "payment_method", must be one of #{validator.allowable_values}.'
574
574
  end
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '3.6.19'
14
+ VERSION = '3.6.20'
15
15
  end
data/lib/ultracart_api.rb CHANGED
@@ -322,6 +322,7 @@ require 'ultracart_api/models/error_response'
322
322
  require 'ultracart_api/models/experiment'
323
323
  require 'ultracart_api/models/experiment_response'
324
324
  require 'ultracart_api/models/experiment_variation'
325
+ require 'ultracart_api/models/experiment_variation_stat'
325
326
  require 'ultracart_api/models/experiments_response'
326
327
  require 'ultracart_api/models/fulfillment_inventory'
327
328
  require 'ultracart_api/models/fulfillment_shipment'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ultracart_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.6.19
4
+ version: 3.6.20
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-10-05 00:00:00.000000000 Z
11
+ date: 2021-11-05 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -513,6 +513,7 @@ files:
513
513
  - docs/Experiment.md
514
514
  - docs/ExperimentResponse.md
515
515
  - docs/ExperimentVariation.md
516
+ - docs/ExperimentVariationStat.md
516
517
  - docs/ExperimentsResponse.md
517
518
  - docs/FulfillmentApi.md
518
519
  - docs/FulfillmentInventory.md
@@ -1180,6 +1181,7 @@ files:
1180
1181
  - lib/ultracart_api/models/experiment.rb
1181
1182
  - lib/ultracart_api/models/experiment_response.rb
1182
1183
  - lib/ultracart_api/models/experiment_variation.rb
1184
+ - lib/ultracart_api/models/experiment_variation_stat.rb
1183
1185
  - lib/ultracart_api/models/experiments_response.rb
1184
1186
  - lib/ultracart_api/models/fulfillment_inventory.rb
1185
1187
  - lib/ultracart_api/models/fulfillment_shipment.rb