ultracart_api 4.1.96 → 4.1.97
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +9 -3
- data/docs/FraudApi.md +58 -4
- data/docs/FraudLookupAffiliate.md +20 -0
- data/docs/FraudLookupGateway.md +22 -0
- data/docs/FraudLookupTheme.md +22 -0
- data/docs/FraudLookupValues.md +16 -6
- data/docs/FraudRuleFromOrderRequest.md +30 -0
- data/docs/FraudRuleInsertRequest.md +13 -13
- data/docs/FraudRulePublic.md +25 -25
- data/docs/FraudRuleSearchRequest.md +16 -16
- data/lib/ultracart_api/api/fraud_api.rb +73 -4
- data/lib/ultracart_api/models/fraud_lookup_affiliate.rb +230 -0
- data/lib/ultracart_api/models/fraud_lookup_gateway.rb +240 -0
- data/lib/ultracart_api/models/fraud_lookup_theme.rb +240 -0
- data/lib/ultracart_api/models/fraud_lookup_values.rb +83 -13
- data/lib/ultracart_api/models/fraud_rule_from_order_request.rb +314 -0
- data/lib/ultracart_api/models/fraud_rule_insert_request.rb +25 -8
- data/lib/ultracart_api/models/fraud_rule_public.rb +28 -2
- data/lib/ultracart_api/models/fraud_rule_search_request.rb +16 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +4 -0
- metadata +9 -1
|
@@ -15,21 +15,27 @@ require 'time'
|
|
|
15
15
|
|
|
16
16
|
module UltracartClient
|
|
17
17
|
class FraudRulePublic
|
|
18
|
+
# Affiliate oid for the 'affiliate matches' rule type.
|
|
18
19
|
attr_accessor :affiliate_oid
|
|
19
20
|
|
|
21
|
+
# Monetary or score threshold for amount/score/percentage rule types.
|
|
20
22
|
attr_accessor :amount_threshold
|
|
21
23
|
|
|
24
|
+
# Note automatically appended to the order's merchant note when this rule fires.
|
|
22
25
|
attr_accessor :auto_note
|
|
23
26
|
|
|
24
27
|
attr_accessor :avs_match_type
|
|
25
28
|
|
|
29
|
+
# AVS response codes for the 'address street and zip avs' rule type.
|
|
26
30
|
attr_accessor :avs_response_codes
|
|
27
31
|
|
|
28
32
|
# Masked credit card number for rules tied to a specific card
|
|
29
33
|
attr_accessor :card_number
|
|
30
34
|
|
|
35
|
+
# Integer count threshold for count/quantity/hours rule types.
|
|
31
36
|
attr_accessor :count_threshold
|
|
32
37
|
|
|
38
|
+
# ISO country code for the 'address not in country' rule type.
|
|
33
39
|
attr_accessor :country_code
|
|
34
40
|
|
|
35
41
|
attr_accessor :created_by
|
|
@@ -40,6 +46,7 @@ module UltracartClient
|
|
|
40
46
|
# Credit card BINs blocked by the 'credit card block bin' rule type.
|
|
41
47
|
attr_accessor :credit_card_bins
|
|
42
48
|
|
|
49
|
+
# Message shown in the A/R review screen when this rule fires.
|
|
43
50
|
attr_accessor :decline_message
|
|
44
51
|
|
|
45
52
|
# Human-readable description of the rule
|
|
@@ -48,6 +55,7 @@ module UltracartClient
|
|
|
48
55
|
# HTML version of the rule description
|
|
49
56
|
attr_accessor :description_html
|
|
50
57
|
|
|
58
|
+
# Email address for the 'address email' rule type.
|
|
51
59
|
attr_accessor :email
|
|
52
60
|
|
|
53
61
|
# Action taken when this rule fires.
|
|
@@ -56,36 +64,51 @@ module UltracartClient
|
|
|
56
64
|
# UltraCart unique identifier for this fraud rule
|
|
57
65
|
attr_accessor :fraud_rule_oid
|
|
58
66
|
|
|
67
|
+
# Gateway response code key for the 'gateway response' rule type.
|
|
59
68
|
attr_accessor :gateway_response_codes
|
|
60
69
|
|
|
70
|
+
# Gateway response code value for the 'gateway response' rule type.
|
|
61
71
|
attr_accessor :gateway_response_value
|
|
62
72
|
|
|
73
|
+
# IP address or subnet for 'exempt ip' and 'ip matches' rule types.
|
|
63
74
|
attr_accessor :ip_address
|
|
64
75
|
|
|
65
76
|
attr_accessor :ip_range_type
|
|
66
77
|
|
|
78
|
+
# Item filters restricting this rule to orders containing one or more of these items.
|
|
67
79
|
attr_accessor :item_filters
|
|
68
80
|
|
|
81
|
+
# Merchant item id for the 'item matches' rule type.
|
|
69
82
|
attr_accessor :merchant_item_id
|
|
70
83
|
|
|
84
|
+
# Value the rule sets on order custom field 1 (only meaningful for 'Process Payment and Modify').
|
|
71
85
|
attr_accessor :modify_custom_field1
|
|
72
86
|
|
|
87
|
+
# Value the rule sets on order custom field 2 (only meaningful for 'Process Payment and Modify').
|
|
73
88
|
attr_accessor :modify_custom_field2
|
|
74
89
|
|
|
90
|
+
# Value the rule sets on order custom field 3 (only meaningful for 'Process Payment and Modify').
|
|
75
91
|
attr_accessor :modify_custom_field3
|
|
76
92
|
|
|
93
|
+
# Value the rule sets on order custom field 4 (only meaningful for 'Process Payment and Modify').
|
|
77
94
|
attr_accessor :modify_custom_field4
|
|
78
95
|
|
|
96
|
+
# Value the rule sets on order custom field 5 (only meaningful for 'Process Payment and Modify').
|
|
79
97
|
attr_accessor :modify_custom_field5
|
|
80
98
|
|
|
99
|
+
# Value the rule sets on order custom field 6 (only meaningful for 'Process Payment and Modify').
|
|
81
100
|
attr_accessor :modify_custom_field6
|
|
82
101
|
|
|
102
|
+
# Value the rule sets on order custom field 7 (only meaningful for 'Process Payment and Modify').
|
|
83
103
|
attr_accessor :modify_custom_field7
|
|
84
104
|
|
|
105
|
+
# When true, the rule strips the affiliate from the order (only meaningful for 'Process Payment and Modify').
|
|
85
106
|
attr_accessor :modify_skip_affiliate
|
|
86
107
|
|
|
108
|
+
# When true, the rule suppresses the affiliate network pixel (only meaningful for 'Process Payment and Modify').
|
|
87
109
|
attr_accessor :modify_skip_affiliate_network_pixel
|
|
88
110
|
|
|
111
|
+
# Gateway filters restricting this rule to orders processed by one of these rotating transaction gateways.
|
|
89
112
|
attr_accessor :rotating_transaction_gateway_filters
|
|
90
113
|
|
|
91
114
|
# Group containing this rule type (eg 'creditCardRules'). Deliberately not constrained by allowableValues on the response so SDK consumers do not hard-fail on an unexpected value if a future rule_type slips through the server-side mapping. Search REQUESTS still restrict rule_group to the known set.
|
|
@@ -94,6 +117,7 @@ module UltracartClient
|
|
|
94
117
|
# Rule type.
|
|
95
118
|
attr_accessor :rule_type
|
|
96
119
|
|
|
120
|
+
# Storefront filters restricting this rule to orders placed on one of these storefronts.
|
|
97
121
|
attr_accessor :storefront_filters
|
|
98
122
|
|
|
99
123
|
attr_accessor :user_action
|
|
@@ -181,7 +205,7 @@ module UltracartClient
|
|
|
181
205
|
:'country_code' => :'String',
|
|
182
206
|
:'created_by' => :'String',
|
|
183
207
|
:'created_dts' => :'String',
|
|
184
|
-
:'credit_card_bins' => :'
|
|
208
|
+
:'credit_card_bins' => :'Array<String>',
|
|
185
209
|
:'decline_message' => :'String',
|
|
186
210
|
:'description' => :'String',
|
|
187
211
|
:'description_html' => :'String',
|
|
@@ -273,7 +297,9 @@ module UltracartClient
|
|
|
273
297
|
end
|
|
274
298
|
|
|
275
299
|
if attributes.key?(:'credit_card_bins')
|
|
276
|
-
|
|
300
|
+
if (value = attributes[:'credit_card_bins']).is_a?(Array)
|
|
301
|
+
self.credit_card_bins = value
|
|
302
|
+
end
|
|
277
303
|
end
|
|
278
304
|
|
|
279
305
|
if attributes.key?(:'decline_message')
|
|
@@ -21,6 +21,7 @@ module UltracartClient
|
|
|
21
21
|
# Lower bound on amount/score/percentage thresholds (rules backed by the same numeric column).
|
|
22
22
|
attr_accessor :amount_threshold_begin
|
|
23
23
|
|
|
24
|
+
# Upper bound on amount/score/percentage thresholds (rules backed by the same numeric column).
|
|
24
25
|
attr_accessor :amount_threshold_end
|
|
25
26
|
|
|
26
27
|
# Wildcard search on the rule's auto_note. Use '*' for wildcards.
|
|
@@ -29,8 +30,10 @@ module UltracartClient
|
|
|
29
30
|
# Lower bound on count thresholds (rules backed by the same integer count column).
|
|
30
31
|
attr_accessor :count_threshold_begin
|
|
31
32
|
|
|
33
|
+
# Upper bound on count thresholds (rules backed by the same integer count column).
|
|
32
34
|
attr_accessor :count_threshold_end
|
|
33
35
|
|
|
36
|
+
# Filter to rules created by this user login.
|
|
34
37
|
attr_accessor :created_by
|
|
35
38
|
|
|
36
39
|
# Rule creation date begin (MM/dd/yyyy)
|
|
@@ -47,29 +50,40 @@ module UltracartClient
|
|
|
47
50
|
|
|
48
51
|
attr_accessor :failure_action
|
|
49
52
|
|
|
53
|
+
# Filter to rules with this rotating transaction gateway code in their rotating_transaction_gateway_filters list.
|
|
50
54
|
attr_accessor :gateway_code
|
|
51
55
|
|
|
56
|
+
# Filter to rules with this merchant item id in their item_filters list.
|
|
52
57
|
attr_accessor :merchant_item_id
|
|
53
58
|
|
|
54
59
|
# Wildcard search on the rule's secondary modifier (eg 'address'/'subnet', gateway codes, avs match types).
|
|
55
60
|
attr_accessor :modifier_value
|
|
56
61
|
|
|
62
|
+
# Wildcard search on rules' modify_custom_field1 value.
|
|
57
63
|
attr_accessor :modify_custom_field1
|
|
58
64
|
|
|
65
|
+
# Wildcard search on rules' modify_custom_field2 value.
|
|
59
66
|
attr_accessor :modify_custom_field2
|
|
60
67
|
|
|
68
|
+
# Wildcard search on rules' modify_custom_field3 value.
|
|
61
69
|
attr_accessor :modify_custom_field3
|
|
62
70
|
|
|
71
|
+
# Wildcard search on rules' modify_custom_field4 value.
|
|
63
72
|
attr_accessor :modify_custom_field4
|
|
64
73
|
|
|
74
|
+
# Wildcard search on rules' modify_custom_field5 value.
|
|
65
75
|
attr_accessor :modify_custom_field5
|
|
66
76
|
|
|
77
|
+
# Wildcard search on rules' modify_custom_field6 value.
|
|
67
78
|
attr_accessor :modify_custom_field6
|
|
68
79
|
|
|
80
|
+
# Wildcard search on rules' modify_custom_field7 value.
|
|
69
81
|
attr_accessor :modify_custom_field7
|
|
70
82
|
|
|
83
|
+
# Filter to rules whose modify_skip_affiliate flag matches this value.
|
|
71
84
|
attr_accessor :modify_skip_affiliate
|
|
72
85
|
|
|
86
|
+
# Filter to rules whose modify_skip_affiliate_network_pixel flag matches this value.
|
|
73
87
|
attr_accessor :modify_skip_affiliate_network_pixel
|
|
74
88
|
|
|
75
89
|
# Rule group to filter by.
|
|
@@ -81,11 +95,13 @@ module UltracartClient
|
|
|
81
95
|
# Include rules from accounts linked to this merchant. Defaults to false.
|
|
82
96
|
attr_accessor :search_linked_accounts
|
|
83
97
|
|
|
98
|
+
# Filter to rules with this storefront hostname in their screen_branding_theme_filters list.
|
|
84
99
|
attr_accessor :storefront_hostname
|
|
85
100
|
|
|
86
101
|
# Wildcard search on the rule's text parameter (email / ip / bin / country / item id / avs codes - the backend disambiguates by rule_type).
|
|
87
102
|
attr_accessor :text_value
|
|
88
103
|
|
|
104
|
+
# Filter to rules with this screen branding theme code in their screen_branding_theme_filters list.
|
|
89
105
|
attr_accessor :theme_code
|
|
90
106
|
|
|
91
107
|
attr_accessor :user_action
|
data/lib/ultracart_api.rb
CHANGED
|
@@ -602,8 +602,12 @@ require 'ultracart_api/models/file_manager_page_response'
|
|
|
602
602
|
require 'ultracart_api/models/file_manager_upload_request'
|
|
603
603
|
require 'ultracart_api/models/file_manager_upload_url_response'
|
|
604
604
|
require 'ultracart_api/models/fraud_decline_email_request'
|
|
605
|
+
require 'ultracart_api/models/fraud_lookup_affiliate'
|
|
606
|
+
require 'ultracart_api/models/fraud_lookup_gateway'
|
|
607
|
+
require 'ultracart_api/models/fraud_lookup_theme'
|
|
605
608
|
require 'ultracart_api/models/fraud_lookup_values'
|
|
606
609
|
require 'ultracart_api/models/fraud_lookup_values_response'
|
|
610
|
+
require 'ultracart_api/models/fraud_rule_from_order_request'
|
|
607
611
|
require 'ultracart_api/models/fraud_rule_insert_request'
|
|
608
612
|
require 'ultracart_api/models/fraud_rule_item_filter'
|
|
609
613
|
require 'ultracart_api/models/fraud_rule_public'
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: ultracart_api
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 4.1.
|
|
4
|
+
version: 4.1.97
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- UltraCart
|
|
@@ -656,8 +656,12 @@ files:
|
|
|
656
656
|
- docs/FileManagerUploadUrlResponse.md
|
|
657
657
|
- docs/FraudApi.md
|
|
658
658
|
- docs/FraudDeclineEmailRequest.md
|
|
659
|
+
- docs/FraudLookupAffiliate.md
|
|
660
|
+
- docs/FraudLookupGateway.md
|
|
661
|
+
- docs/FraudLookupTheme.md
|
|
659
662
|
- docs/FraudLookupValues.md
|
|
660
663
|
- docs/FraudLookupValuesResponse.md
|
|
664
|
+
- docs/FraudRuleFromOrderRequest.md
|
|
661
665
|
- docs/FraudRuleInsertRequest.md
|
|
662
666
|
- docs/FraudRuleItemFilter.md
|
|
663
667
|
- docs/FraudRulePublic.md
|
|
@@ -1693,8 +1697,12 @@ files:
|
|
|
1693
1697
|
- lib/ultracart_api/models/file_manager_upload_request.rb
|
|
1694
1698
|
- lib/ultracart_api/models/file_manager_upload_url_response.rb
|
|
1695
1699
|
- lib/ultracart_api/models/fraud_decline_email_request.rb
|
|
1700
|
+
- lib/ultracart_api/models/fraud_lookup_affiliate.rb
|
|
1701
|
+
- lib/ultracart_api/models/fraud_lookup_gateway.rb
|
|
1702
|
+
- lib/ultracart_api/models/fraud_lookup_theme.rb
|
|
1696
1703
|
- lib/ultracart_api/models/fraud_lookup_values.rb
|
|
1697
1704
|
- lib/ultracart_api/models/fraud_lookup_values_response.rb
|
|
1705
|
+
- lib/ultracart_api/models/fraud_rule_from_order_request.rb
|
|
1698
1706
|
- lib/ultracart_api/models/fraud_rule_insert_request.rb
|
|
1699
1707
|
- lib/ultracart_api/models/fraud_rule_item_filter.rb
|
|
1700
1708
|
- lib/ultracart_api/models/fraud_rule_public.rb
|