Class: Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/lithic/models/auth_rules/v2_retrieve_features_response.rb

Defined Under Namespace

Modules: Scope Classes: Filters, Value

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(filters:, period:, scope:, value:) ⇒ Object

Parameters:



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/lithic/models/auth_rules/v2_retrieve_features_response.rb', line 26

class Feature < Lithic::Internal::Type::BaseModel
  # @!attribute filters
  #
  #   @return [Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Filters]
  required :filters, -> { Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Filters }

  # @!attribute period
  #   Velocity over the current day since 00:00 / 12 AM in Eastern Time
  #
  #   @return [Lithic::Models::AuthRules::VelocityLimitPeriod::TrailingWindowObject, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowDay, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowWeek, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowMonth, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowYear]
  required :period, union: -> { Lithic::AuthRules::VelocityLimitPeriod }

  # @!attribute scope
  #   The scope the velocity is calculated for
  #
  #   @return [Symbol, Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Scope]
  required :scope, enum: -> { Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Scope }

  # @!attribute value
  #
  #   @return [Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Value]
  required :value, -> { Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Value }

  # @!method initialize(filters:, period:, scope:, value:)
  #   @param filters [Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Filters]
  #
  #   @param period [Lithic::Models::AuthRules::VelocityLimitPeriod::TrailingWindowObject, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowDay, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowWeek, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowMonth, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowYear] Velocity over the current day since 00:00 / 12 AM in Eastern Time
  #
  #   @param scope [Symbol, Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Scope] The scope the velocity is calculated for
  #
  #   @param value [Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Value]

  # @see Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature#filters
  class Filters < Lithic::Internal::Type::BaseModel
    # @!attribute exclude_countries
    #   ISO-3166-1 alpha-3 Country Codes to exclude from the velocity calculation.
    #   Transactions matching any of the provided will be excluded from the calculated
    #   velocity.
    #
    #   @return [Array<String>, nil]
    optional :exclude_countries, Lithic::Internal::Type::ArrayOf[String], nil?: true

    # @!attribute exclude_mccs
    #   Merchant Category Codes to exclude from the velocity calculation. Transactions
    #   matching this MCC will be excluded from the calculated velocity.
    #
    #   @return [Array<String>, nil]
    optional :exclude_mccs, Lithic::Internal::Type::ArrayOf[String], nil?: true

    # @!attribute include_countries
    #   ISO-3166-1 alpha-3 Country Codes to include in the velocity calculation.
    #   Transactions not matching any of the provided will not be included in the
    #   calculated velocity.
    #
    #   @return [Array<String>, nil]
    optional :include_countries, Lithic::Internal::Type::ArrayOf[String], nil?: true

    # @!attribute include_mccs
    #   Merchant Category Codes to include in the velocity calculation. Transactions not
    #   matching this MCC will not be included in the calculated velocity.
    #
    #   @return [Array<String>, nil]
    optional :include_mccs, Lithic::Internal::Type::ArrayOf[String], nil?: true

    # @!attribute include_pan_entry_modes
    #   PAN entry modes to include in the velocity calculation. Transactions not
    #   matching any of the provided will not be included in the calculated velocity.
    #
    #   @return [Array<Symbol, Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Filters::IncludePanEntryMode>, nil]
    optional :include_pan_entry_modes,
             -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Filters::IncludePanEntryMode] },
             nil?: true

    # @!method initialize(exclude_countries: nil, exclude_mccs: nil, include_countries: nil, include_mccs: nil, include_pan_entry_modes: nil)
    #   Some parameter documentations has been truncated, see
    #   {Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Filters} for
    #   more details.
    #
    #   @param exclude_countries [Array<String>, nil] ISO-3166-1 alpha-3 Country Codes to exclude from the velocity calculation. Trans
    #
    #   @param exclude_mccs [Array<String>, nil] Merchant Category Codes to exclude from the velocity calculation. Transactions m
    #
    #   @param include_countries [Array<String>, nil] ISO-3166-1 alpha-3 Country Codes to include in the velocity calculation. Transac
    #
    #   @param include_mccs [Array<String>, nil] Merchant Category Codes to include in the velocity calculation. Transactions not
    #
    #   @param include_pan_entry_modes [Array<Symbol, Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Filters::IncludePanEntryMode>, nil] PAN entry modes to include in the velocity calculation. Transactions not matchin

    module IncludePanEntryMode
      extend Lithic::Internal::Type::Enum

      AUTO_ENTRY = :AUTO_ENTRY
      BAR_CODE = :BAR_CODE
      CONTACTLESS = :CONTACTLESS
      CREDENTIAL_ON_FILE = :CREDENTIAL_ON_FILE
      ECOMMERCE = :ECOMMERCE
      ERROR_KEYED = :ERROR_KEYED
      ERROR_MAGNETIC_STRIPE = :ERROR_MAGNETIC_STRIPE
      ICC = :ICC
      KEY_ENTERED = :KEY_ENTERED
      MAGNETIC_STRIPE = :MAGNETIC_STRIPE
      MANUAL = :MANUAL
      OCR = :OCR
      SECURE_CARDLESS = :SECURE_CARDLESS
      UNSPECIFIED = :UNSPECIFIED
      UNKNOWN = :UNKNOWN

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end

  # The scope the velocity is calculated for
  #
  # @see Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature#scope
  module Scope
    extend Lithic::Internal::Type::Enum

    CARD = :CARD
     = :ACCOUNT

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature#value
  class Value < Lithic::Internal::Type::BaseModel
    # @!attribute amount
    #   Amount (in cents) for the given Auth Rule that is used as input for calculating
    #   the rule. For Velocity Limit rules this would be the calculated Velocity. For
    #   Conditional Rules using CARD*TRANSACTION_COUNT*\* this will be 0
    #
    #   @return [Integer]
    required :amount, Integer

    # @!attribute count
    #   Number of velocity impacting transactions matching the given scope, period and
    #   filters
    #
    #   @return [Integer]
    required :count, Integer

    # @!method initialize(amount:, count:)
    #   Some parameter documentations has been truncated, see
    #   {Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Value} for more
    #   details.
    #
    #   @param amount [Integer] Amount (in cents) for the given Auth Rule that is used as input for calculating
    #
    #   @param count [Integer] Number of velocity impacting transactions matching the given scope, period and f
  end
end

Instance Attribute Details

#filters ⇒ Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Filters

Returns:



30
 
# File 'lib/lithic/models/auth_rules/v2_retrieve_features_response.rb', line 30

required :filters, -> { Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Filters }

#period ⇒ Lithic::Models::AuthRules::VelocityLimitPeriod::TrailingWindowObject, ...

Velocity over the current day since 00:00 / 12 AM in Eastern Time

Returns:



36
 
# File 'lib/lithic/models/auth_rules/v2_retrieve_features_response.rb', line 36

required :period, union: -> { Lithic::AuthRules::VelocityLimitPeriod }

#scope ⇒ Symbol, Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Scope

The scope the velocity is calculated for

Returns:



42
 
# File 'lib/lithic/models/auth_rules/v2_retrieve_features_response.rb', line 42

required :scope, enum: -> { Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Scope }

#value ⇒ Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Value

Returns:



47
 
# File 'lib/lithic/models/auth_rules/v2_retrieve_features_response.rb', line 47

required :value, -> { Lithic::Models::AuthRules::V2RetrieveFeaturesResponse::Feature::Value }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/auth_rules/v2_retrieve_features_response.rb', line 133