Class: Stripe::V2::Signals::AccountSignal

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/v2/signals/account_signal.rb

Overview

An automatically evaluated signal on an account. Each Account Signal object corresponds to exactly one signal type, indicated by type. Only the type-specific field is populated; other type-specific payload fields are null. If an account has multiple signals, Stripe creates separate account signal objects.

Defined Under Namespace

Classes: AccountDetails, FraudulentMerchant, FraudulentWebsite, MerchantDelinquency, PaymentDelinquencyExposure, UserAccountSharing, UserMultiAccounting

Constant Summary collapse

OBJECT_NAME = 
"v2.signals.account_signal"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#account_details ⇒ Object (readonly)

The account or customer this signal is associated with.



252
253
254
 
# File 'lib/stripe/resources/v2/signals/account_signal.rb', line 252

def 
  @account_details
end

#account_evaluation ⇒ Object (readonly)

The account evaluation that produced this signal, if applicable.



254
255
256
 
# File 'lib/stripe/resources/v2/signals/account_signal.rb', line 254

def 
  @account_evaluation
end

#created ⇒ Object (readonly)

Timestamp at which the signal was created.



256
257
258
 
# File 'lib/stripe/resources/v2/signals/account_signal.rb', line 256

def created
  @created
end

#fraudulent_merchant ⇒ Object (readonly)

Data for the fraudulent merchant signal. Present only when type is fraudulent_merchant.



258
259
260
 
# File 'lib/stripe/resources/v2/signals/account_signal.rb', line 258

def fraudulent_merchant
  @fraudulent_merchant
end

#fraudulent_website ⇒ Object (readonly)

Data for the fraudulent website signal. Present only when type is fraudulent_website.



260
261
262
 
# File 'lib/stripe/resources/v2/signals/account_signal.rb', line 260

def fraudulent_website
  @fraudulent_website
end

#id ⇒ Object (readonly)

Unique identifier for the account signal.



262
263
264
 
# File 'lib/stripe/resources/v2/signals/account_signal.rb', line 262

def id
  @id
end

#livemode ⇒ Object (readonly)

Has the value true if the object exists in live mode or the value false if the object exists in test mode.



264
265
266
 
# File 'lib/stripe/resources/v2/signals/account_signal.rb', line 264

def livemode
  @livemode
end

#merchant_delinquency ⇒ Object (readonly)

Data for the merchant delinquency signal. Present only when type is merchant_delinquency.



266
267
268
 
# File 'lib/stripe/resources/v2/signals/account_signal.rb', line 266

def merchant_delinquency
  @merchant_delinquency
end

#object ⇒ Object (readonly)

String representing the object's type. Objects of the same type share the same value of the object field.



268
269
270
 
# File 'lib/stripe/resources/v2/signals/account_signal.rb', line 268

def object
  @object
end

#payment_delinquency_exposure ⇒ Object (readonly)

Data for the payment delinquency exposure signal. Present only when type is payment_delinquency_exposure.



270
271
272
 
# File 'lib/stripe/resources/v2/signals/account_signal.rb', line 270

def payment_delinquency_exposure
  @payment_delinquency_exposure
end

#type ⇒ Object (readonly)

The type of signal.



272
273
274
 
# File 'lib/stripe/resources/v2/signals/account_signal.rb', line 272

def type
  @type
end

#user_account_sharing ⇒ Object (readonly)

Data for the user account-sharing signal. Present only when type is user_account_sharing.



274
275
276
 
# File 'lib/stripe/resources/v2/signals/account_signal.rb', line 274

def 
  @user_account_sharing
end

#user_multi_accounting ⇒ Object (readonly)

Data for the user multi-accounting signal. Present only when type is user_multi_accounting.



276
277
278
 
# File 'lib/stripe/resources/v2/signals/account_signal.rb', line 276

def user_multi_accounting
  @user_multi_accounting
end

Class Method Details

.field_encodings ⇒ Object 



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/stripe/resources/v2/signals/account_signal.rb', line 294

def self.field_encodings
  @field_encodings = {
    fraudulent_merchant: { kind: :object, fields: { probability: :decimal_string } },
    merchant_delinquency: { kind: :object, fields: { probability: :decimal_string } },
    payment_delinquency_exposure: {
      kind: :object,
      fields: {
        additional_details: {
          kind: :object,
          fields: { gross_exposure_amount: { kind: :object, fields: { value: :int64_string } } },
        },
        exposure_amount: { kind: :object, fields: { value: :int64_string } },
      },
    },
    user_account_sharing: { kind: :object, fields: { score: :decimal_string } },
    user_multi_accounting: { kind: :object, fields: { score: :decimal_string } },
  }
end

.field_remappings ⇒ Object 



290
291
292
 
# File 'lib/stripe/resources/v2/signals/account_signal.rb', line 290

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/stripe/resources/v2/signals/account_signal.rb', line 278

def self.inner_class_types
  @inner_class_types = {
    account_details: AccountDetails,
    fraudulent_merchant: FraudulentMerchant,
    fraudulent_website: FraudulentWebsite,
    merchant_delinquency: MerchantDelinquency,
    payment_delinquency_exposure: PaymentDelinquencyExposure,
    user_account_sharing: UserAccountSharing,
    user_multi_accounting: UserMultiAccounting,
  }
end

.object_name ⇒ Object 



13
14
15
 
# File 'lib/stripe/resources/v2/signals/account_signal.rb', line 13

def self.object_name
  "v2.signals.account_signal"
end