Class: EInvoiceAPI::Models::LookupRetrieveParticipantsResponse::Participant

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

Defined Under Namespace

Classes: DocumentType, Entity

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

Represents a supported document type

Parameters:

  • scheme (String) (defaults to: ) —

    Document type scheme

  • value (String) (defaults to: ) —

    Document type value



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/e_invoice_api/models/lookup_retrieve_participants_response.rb', line 51

class Participant < EInvoiceAPI::Internal::Type::BaseModel
  # @!attribute peppol_id
  #   Peppol ID of the participant
  #
  #   @return [String]
  required :peppol_id, String

  # @!attribute peppol_scheme
  #   Peppol scheme of the participant
  #
  #   @return [String]
  required :peppol_scheme, String

  # @!attribute document_types
  #   List of supported document types
  #
  #   @return [Array<EInvoiceAPI::Models::LookupRetrieveParticipantsResponse::Participant::DocumentType>, nil]
  optional :document_types,
           -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::LookupRetrieveParticipantsResponse::Participant::DocumentType] }

  # @!attribute entities
  #   List of business entities
  #
  #   @return [Array<EInvoiceAPI::Models::LookupRetrieveParticipantsResponse::Participant::Entity>, nil]
  optional :entities,
           -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::LookupRetrieveParticipantsResponse::Participant::Entity] }

  # @!method initialize(peppol_id:, peppol_scheme:, document_types: nil, entities: nil)
  #   Represents a Peppol participant with their details
  #
  #   @param peppol_id [String] Peppol ID of the participant
  #
  #   @param peppol_scheme [String] Peppol scheme of the participant
  #
  #   @param document_types [Array<EInvoiceAPI::Models::LookupRetrieveParticipantsResponse::Participant::DocumentType>] List of supported document types
  #
  #   @param entities [Array<EInvoiceAPI::Models::LookupRetrieveParticipantsResponse::Participant::Entity>] List of business entities

  class DocumentType < EInvoiceAPI::Internal::Type::BaseModel
    # @!attribute scheme
    #   Document type scheme
    #
    #   @return [String]
    required :scheme, String

    # @!attribute value
    #   Document type value
    #
    #   @return [String]
    required :value, String

    # @!method initialize(scheme:, value:)
    #   Represents a supported document type
    #
    #   @param scheme [String] Document type scheme
    #
    #   @param value [String] Document type value
  end

  class Entity < EInvoiceAPI::Internal::Type::BaseModel
    # @!attribute additional_info
    #   Additional information
    #
    #   @return [String, nil]
    optional :additional_info, String, nil?: true

    # @!attribute country_code
    #   Country code
    #
    #   @return [String, nil]
    optional :country_code, String, nil?: true

    # @!attribute geo_info
    #   Geographic information
    #
    #   @return [String, nil]
    optional :geo_info, String, nil?: true

    # @!attribute identifiers
    #   List of business identifiers
    #
    #   @return [Array<EInvoiceAPI::Models::LookupRetrieveParticipantsResponse::Participant::Entity::Identifier>, nil]
    optional :identifiers,
             -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::LookupRetrieveParticipantsResponse::Participant::Entity::Identifier] }

    # @!attribute name
    #   Business entity name
    #
    #   @return [String, nil]
    optional :name, String, nil?: true

    # @!attribute registration_date
    #   Registration date
    #
    #   @return [String, nil]
    optional :registration_date, String, nil?: true

    # @!attribute website
    #   Website URL
    #
    #   @return [String, nil]
    optional :website, String, nil?: true

    # @!method initialize(additional_info: nil, country_code: nil, geo_info: nil, identifiers: nil, name: nil, registration_date: nil, website: nil)
    #   Represents a business entity
    #
    #   @param additional_info [String, nil] Additional information
    #
    #   @param country_code [String, nil] Country code
    #
    #   @param geo_info [String, nil] Geographic information
    #
    #   @param identifiers [Array<EInvoiceAPI::Models::LookupRetrieveParticipantsResponse::Participant::Entity::Identifier>] List of business identifiers
    #
    #   @param name [String, nil] Business entity name
    #
    #   @param registration_date [String, nil] Registration date
    #
    #   @param website [String, nil] Website URL

    class Identifier < EInvoiceAPI::Internal::Type::BaseModel
      # @!attribute scheme
      #   Identifier scheme
      #
      #   @return [String]
      required :scheme, String

      # @!attribute value
      #   Identifier value
      #
      #   @return [String]
      required :value, String

      # @!method initialize(scheme:, value:)
      #   Represents a business identifier
      #
      #   @param scheme [String] Identifier scheme
      #
      #   @param value [String] Identifier value
    end
  end
end

Instance Attribute Details

#document_types ⇒ Array<EInvoiceAPI::Models::LookupRetrieveParticipantsResponse::Participant::DocumentType>?

List of supported document types

Returns:



68
69
 
# File 'lib/e_invoice_api/models/lookup_retrieve_participants_response.rb', line 68

optional :document_types,
-> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::LookupRetrieveParticipantsResponse::Participant::DocumentType] }

#entities ⇒ Array<EInvoiceAPI::Models::LookupRetrieveParticipantsResponse::Participant::Entity>?

List of business entities

Returns:



75
76
 
# File 'lib/e_invoice_api/models/lookup_retrieve_participants_response.rb', line 75

optional :entities,
-> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::LookupRetrieveParticipantsResponse::Participant::Entity] }

#peppol_id ⇒ String

Peppol ID of the participant

Returns:

  • (String) 


56
 
# File 'lib/e_invoice_api/models/lookup_retrieve_participants_response.rb', line 56

required :peppol_id, String

#peppol_scheme ⇒ String

Peppol scheme of the participant

Returns:

  • (String) 


62
 
# File 'lib/e_invoice_api/models/lookup_retrieve_participants_response.rb', line 62

required :peppol_scheme, String