Module: Dinie::Kyc

Defined in:

sig/dinie/generated/types/kyc/common.rbs,
sig/dinie/generated/types/kyc/uploads.rbs,
sig/dinie/generated/types/kyc/submitted.rbs,
sig/dinie/generated/types/kyc/attachment.rbs,
sig/dinie/generated/types/kyc/requirements.rbs

Defined Under Namespace

Modules: ReviewStatus, SubjectType Classes: ArticlesOfAssociationRequirement, Attachment, AttachmentResponse, CompanyDocumentRequirement, EiMeiDocumentsRequirement, EireliIncorporationStatementRequirement, EmailRequirement, IdentityRequirement, IncomeStatementRequirement, ProofOfAddressRequirement, Requirement, SelfieRequirement, Subject, Submitted, UploadForm

Constant Summary

FILE_UPLOAD_EVIDENCE_TYPES =

Returns:

• (Array[String])

Class Method Summary

• .deserialize_identity_submitted ⇒ Submitted

  Hydrate the identity submitted oneOf by dispatching on the const evidence_type.

• .deserialize_requirement ⇒ Requirement

  Hydrate any wire requirement by dispatching on the explicit requirement_type discriminator.

• .deserialize_submitted ⇒ Submitted

  Hydrate any non-identity *Submitted (the uniform DS-FAMILY path).

• .dispatch_error ⇒ Dinie::Error

  The shared error for an unknown discriminator value (never a silent nil).

• .serialize_upload ⇒ UploadForm

  Serialize a KYC upload to its UploadForm (the scalar field-map + optional binary file) by dispatching on the explicit evidence_type discriminator.

Class Method Details

.deserialize_identity_submitted ⇒ Submitted

Hydrate the identity submitted oneOf by dispatching on the const evidence_type.

Parameters:

• raw (Hash[Symbol, untyped])

Returns:

• (Submitted)

# File 'sig/dinie/generated/types/kyc/submitted.rbs', line 19

def self.deserialize_identity_submitted: (Hash[Symbol, untyped] raw) -> Submitted

.deserialize_requirement ⇒ Requirement

Hydrate any wire requirement by dispatching on the explicit requirement_type discriminator.

Parameters:

• raw (Hash[Symbol, untyped])

Returns:

• (Requirement)

# File 'sig/dinie/generated/types/kyc/requirements.rbs', line 115

def self.deserialize_requirement: (Hash[Symbol, untyped] raw) -> Requirement

.deserialize_submitted ⇒ Submitted

Hydrate any non-identity *Submitted (the uniform DS-FAMILY path).

Parameters:

• raw (Hash[Symbol, untyped])

Returns:

• (Submitted)

# File 'sig/dinie/generated/types/kyc/submitted.rbs', line 16

def self.deserialize_submitted: (Hash[Symbol, untyped] raw) -> Submitted

.dispatch_error ⇒ Dinie::Error

The shared error for an unknown discriminator value (never a silent nil).

Parameters:

• union (String)
• discriminator (String)
• value (Object)

Returns:

• (Dinie::Error)

# File 'sig/dinie/generated/types/kyc/common.rbs', line 40

def self.dispatch_error: (String union, String discriminator, untyped value) -> Dinie::Error

.serialize_upload ⇒ UploadForm

Serialize a KYC upload to its UploadForm (the scalar field-map + optional binary file) by dispatching on the explicit evidence_type discriminator. (Called from the customers resource via a **upload splat — see the §21.3 note on the splat idiom + Steep's static keyword check.)

Parameters:

• evidence_type: (String)
• requirement_id: (String)
• attachment_type: (String)
• file: (Object)
• value: (String)

Returns:

• (UploadForm)

# File 'sig/dinie/generated/types/kyc/uploads.rbs', line 22

def self.serialize_upload: (evidence_type: String, requirement_id: String, attachment_type: String, ?file: untyped, ?value: String) -> UploadForm