Class: EInvoiceAPI::Models::LookupRetrieveResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/e_invoice_api/models/lookup_retrieve_response.rb

Overview

See Also:

Defined Under Namespace

Classes: BusinessCard, DNSInfo, QueryMetadata, ServiceMetadata

Instance Attribute 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(identifier_scheme: , identifier_value: , sml_domain: , timestamp: , version: ) ⇒ Object

Metadata about the query that was performed

Parameters:

  • identifier_scheme (String) (defaults to: ) —

    Scheme of the identifier, typically ‘iso6523-actorid-upis’

  • identifier_value (String) (defaults to: ) —

    The actual Peppol ID value being queried

  • sml_domain (String) (defaults to: ) —

    Domain of the SML (Service Metadata Locator) used for the lookup

  • timestamp (String) (defaults to: ) —

    ISO 8601 timestamp of when the query was executed

  • version (String) (defaults to: ) —

    Version of the API used for the lookup




# File 'lib/e_invoice_api/models/lookup_retrieve_response.rb', line 61

Instance Attribute Details

#business_card ⇒ EInvoiceAPI::Models::LookupRetrieveResponse::BusinessCard

Business card information for the Peppol participant

Returns:



11
12
13
 
# File 'lib/e_invoice_api/models/lookup_retrieve_response.rb', line 11

required :business_card,
-> { EInvoiceAPI::Models::LookupRetrieveResponse::BusinessCard },
api_name: :businessCard

#certificates ⇒ Array<EInvoiceAPI::Models::Certificate>

List of certificates found for the Peppol participant

Returns:



19
 
# File 'lib/e_invoice_api/models/lookup_retrieve_response.rb', line 19

required :certificates, -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Certificate] }

#dns_info ⇒ EInvoiceAPI::Models::LookupRetrieveResponse::DNSInfo

Information about the DNS lookup performed

Returns:



25
 
# File 'lib/e_invoice_api/models/lookup_retrieve_response.rb', line 25

required :dns_info, -> { EInvoiceAPI::Models::LookupRetrieveResponse::DNSInfo }, api_name: :dnsInfo

#errors ⇒ Array<String>

List of error messages if any errors occurred during the lookup

Returns:

  • (Array<String>) 


31
 
# File 'lib/e_invoice_api/models/lookup_retrieve_response.rb', line 31

required :errors, EInvoiceAPI::Internal::Type::ArrayOf[String]

#execution_time_ms ⇒ Float

Total execution time of the lookup operation in milliseconds

Returns:

  • (Float) 


37
 
# File 'lib/e_invoice_api/models/lookup_retrieve_response.rb', line 37

required :execution_time_ms, Float, api_name: :executionTimeMs

#query_metadata ⇒ EInvoiceAPI::Models::LookupRetrieveResponse::QueryMetadata

Metadata about the query that was performed

Returns:



43
44
45
 
# File 'lib/e_invoice_api/models/lookup_retrieve_response.rb', line 43

required :query_metadata,
-> { EInvoiceAPI::Models::LookupRetrieveResponse::QueryMetadata },
api_name: :queryMetadata

#service_metadata ⇒ EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata

Service metadata information for the Peppol participant

Returns:



51
52
53
 
# File 'lib/e_invoice_api/models/lookup_retrieve_response.rb', line 51

required :service_metadata,
-> { EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata },
api_name: :serviceMetadata

#status ⇒ String

Overall status of the lookup: ‘success’ or ‘error’

Returns:

  • (String) 


59
 
# File 'lib/e_invoice_api/models/lookup_retrieve_response.rb', line 59

required :status, String