Class: EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint

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

Defined Under Namespace

Classes: DocumentType, Process

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(scheme: , value: ) ⇒ Object

Document type supported by a Peppol participant.

Parameters:

  • scheme (String) (defaults to: ) —

    Scheme of the document type identifier

  • value (String) (defaults to: ) —

    Value of the document type identifier



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/e_invoice_api/models/lookup_retrieve_response.rb', line 304

class Endpoint < EInvoiceAPI::Internal::Type::BaseModel
  # @!attribute document_types
  #   List of document types supported by this endpoint
  #
  #   @return [Array<EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::DocumentType>]
  required :document_types,
           -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::DocumentType] },
           api_name: :documentTypes

  # @!attribute status
  #   Status of the endpoint lookup: 'success', 'error', or 'pending'
  #
  #   @return [String]
  required :status, String

  # @!attribute url
  #   URL of the endpoint
  #
  #   @return [String]
  required :url, String

  # @!attribute error
  #   Error message if endpoint lookup failed
  #
  #   @return [String, nil]
  optional :error, String, nil?: true

  # @!attribute processes
  #   List of processes supported by this endpoint
  #
  #   @return [Array<EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process>, nil]
  optional :processes,
           -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process] },
           nil?: true

  # @!method initialize(document_types:, status:, url:, error: nil, processes: nil)
  #   Information about a Peppol participant's endpoint.
  #
  #   @param document_types [Array<EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::DocumentType>] List of document types supported by this endpoint
  #
  #   @param status [String] Status of the endpoint lookup: 'success', 'error', or 'pending'
  #
  #   @param url [String] URL of the endpoint
  #
  #   @param error [String, nil] Error message if endpoint lookup failed
  #
  #   @param processes [Array<EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process>, nil] List of processes supported by this endpoint

  class DocumentType < EInvoiceAPI::Internal::Type::BaseModel
    # @!attribute scheme
    #   Scheme of the document type identifier
    #
    #   @return [String]
    required :scheme, String

    # @!attribute value
    #   Value of the document type identifier
    #
    #   @return [String]
    required :value, String

    # @!method initialize(scheme:, value:)
    #   Document type supported by a Peppol participant.
    #
    #   @param scheme [String] Scheme of the document type identifier
    #
    #   @param value [String] Value of the document type identifier
  end

  class Process < EInvoiceAPI::Internal::Type::BaseModel
    # @!attribute endpoints
    #   List of endpoints supporting this process
    #
    #   @return [Array<EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process::Endpoint>]
    required :endpoints,
             -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process::Endpoint] }

    # @!attribute process_id
    #   Identifier of the process
    #
    #   @return [EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process::ProcessID]
    required :process_id,
             -> { EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process::ProcessID },
             api_name: :processId

    # @!method initialize(endpoints:, process_id:)
    #   Process information in the Peppol network.
    #
    #   @param endpoints [Array<EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process::Endpoint>] List of endpoints supporting this process
    #
    #   @param process_id [EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process::ProcessID] Identifier of the process

    class Endpoint < EInvoiceAPI::Internal::Type::BaseModel
      # @!attribute address
      #   URL or address of the endpoint
      #
      #   @return [String]
      required :address, String

      # @!attribute transport_profile
      #   Transport profile used by this endpoint
      #
      #   @return [String]
      required :transport_profile, String, api_name: :transportProfile

      # @!attribute certificate
      #   Certificate information for a Peppol endpoint.
      #
      #   @return [EInvoiceAPI::Models::Certificate, nil]
      optional :certificate, -> { EInvoiceAPI::Certificate }, nil?: true

      # @!attribute service_activation_date
      #   ISO 8601 date when the service was activated
      #
      #   @return [String, nil]
      optional :service_activation_date, String, api_name: :serviceActivationDate, nil?: true

      # @!attribute service_description
      #   Human-readable description of the service
      #
      #   @return [String, nil]
      optional :service_description, String, api_name: :serviceDescription, nil?: true

      # @!attribute service_expiration_date
      #   ISO 8601 date when the service will expire
      #
      #   @return [String, nil]
      optional :service_expiration_date, String, api_name: :serviceExpirationDate, nil?: true

      # @!attribute technical_contact_url
      #   URL for technical contact information
      #
      #   @return [String, nil]
      optional :technical_contact_url, String, api_name: :technicalContactUrl, nil?: true

      # @!attribute technical_information_url
      #   URL for technical documentation
      #
      #   @return [String, nil]
      optional :technical_information_url, String, api_name: :technicalInformationUrl, nil?: true

      # @!method initialize(address:, transport_profile:, certificate: nil, service_activation_date: nil, service_description: nil, service_expiration_date: nil, technical_contact_url: nil, technical_information_url: nil)
      #   Endpoint information for a specific Peppol process.
      #
      #   @param address [String] URL or address of the endpoint
      #
      #   @param transport_profile [String] Transport profile used by this endpoint
      #
      #   @param certificate [EInvoiceAPI::Models::Certificate, nil] Certificate information for a Peppol endpoint.
      #
      #   @param service_activation_date [String, nil] ISO 8601 date when the service was activated
      #
      #   @param service_description [String, nil] Human-readable description of the service
      #
      #   @param service_expiration_date [String, nil] ISO 8601 date when the service will expire
      #
      #   @param technical_contact_url [String, nil] URL for technical contact information
      #
      #   @param technical_information_url [String, nil] URL for technical documentation
    end

    # @see EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process#process_id
    class ProcessID < EInvoiceAPI::Internal::Type::BaseModel
      # @!attribute scheme
      #   Scheme of the process identifier
      #
      #   @return [String]
      required :scheme, String

      # @!attribute value
      #   Value of the process identifier
      #
      #   @return [String]
      required :value, String

      # @!method initialize(scheme:, value:)
      #   Identifier of the process
      #
      #   @param scheme [String] Scheme of the process identifier
      #
      #   @param value [String] Value of the process identifier
    end
  end
end

Instance Attribute Details

#document_types ⇒ Array<EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::DocumentType>

List of document types supported by this endpoint

Returns:



309
310
311
 
# File 'lib/e_invoice_api/models/lookup_retrieve_response.rb', line 309

required :document_types,
-> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::DocumentType] },
api_name: :documentTypes

#error ⇒ String?

Error message if endpoint lookup failed

Returns:

  • (String, nil) 


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

optional :error, String, nil?: true

#processes ⇒ Array<EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process>?

List of processes supported by this endpoint

Returns:



335
336
337
 
# File 'lib/e_invoice_api/models/lookup_retrieve_response.rb', line 335

optional :processes,
-> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process] },
nil?: true

#status ⇒ String

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

Returns:

  • (String) 


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

required :status, String

#url ⇒ String

URL of the endpoint

Returns:

  • (String) 


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

required :url, String