Class: EInvoiceAPI::Models::LookupRetrieveResponse::BusinessCard::Entity

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

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(entities: , query_time_ms: , status: , error: nil) ⇒ Object

Business card information for the Peppol participant

Parameters:

  • entities (Array<EInvoiceAPI::Models::LookupRetrieveResponse::BusinessCard::Entity>) (defaults to: ) —

    List of business entities associated with the Peppol ID

  • query_time_ms (Float) (defaults to: ) —

    Time taken to query the business card in milliseconds

  • status (String) (defaults to: ) —

    Status of the business card lookup: ‘success’, ‘error’, or ‘pending’

  • error (String, nil) (defaults to: nil) —

    Error message if business card lookup failed



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
 
# File 'lib/e_invoice_api/models/lookup_retrieve_response.rb', line 126

class Entity < EInvoiceAPI::Internal::Type::BaseModel
  # @!attribute additional_information
  #   Additional information about the business entity
  #
  #   @return [Array<String>, nil]
  optional :additional_information,
           EInvoiceAPI::Internal::Type::ArrayOf[String],
           api_name: :additionalInformation,
           nil?: true

  # @!attribute country_code
  #   ISO 3166-1 alpha-2 country code of the business entity
  #
  #   @return [String, nil]
  optional :country_code, String, api_name: :countryCode, nil?: true

  # @!attribute name
  #   Name of the business entity
  #
  #   @return [String, nil]
  optional :name, String, nil?: true

  # @!attribute registration_date
  #   ISO 8601 date of when the entity was registered in Peppol
  #
  #   @return [String, nil]
  optional :registration_date, String, api_name: :registrationDate, nil?: true

  # @!method initialize(additional_information: nil, country_code: nil, name: nil, registration_date: nil)
  #   Business entity information in the Peppol network.
  #
  #   @param additional_information [Array<String>, nil] Additional information about the business entity
  #
  #   @param country_code [String, nil] ISO 3166-1 alpha-2 country code of the business entity
  #
  #   @param name [String, nil] Name of the business entity
  #
  #   @param registration_date [String, nil] ISO 8601 date of when the entity was registered in Peppol
end

Instance Attribute Details

#additional_information ⇒ Array<String>?

Additional information about the business entity

Returns:

  • (Array<String>, nil) 


131
132
133
134
 
# File 'lib/e_invoice_api/models/lookup_retrieve_response.rb', line 131

optional :additional_information,
EInvoiceAPI::Internal::Type::ArrayOf[String],
api_name: :additionalInformation,
nil?: true

#country_code ⇒ String?

ISO 3166-1 alpha-2 country code of the business entity

Returns:

  • (String, nil) 


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

optional :country_code, String, api_name: :countryCode, nil?: true

#name ⇒ String?

Name of the business entity

Returns:

  • (String, nil) 


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

optional :name, String, nil?: true

#registration_date ⇒ String?

ISO 8601 date of when the entity was registered in Peppol

Returns:

  • (String, nil) 


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

optional :registration_date, String, api_name: :registrationDate, nil?: true