e-invoice-api 0.1.0.pre.alpha.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (233) hide show
  1. checksums.yaml +7 -0
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +57 -0
  4. data/README.md +285 -0
  5. data/SECURITY.md +27 -0
  6. data/lib/e_invoice_api/client.rb +94 -0
  7. data/lib/e_invoice_api/errors.rb +192 -0
  8. data/lib/e_invoice_api/file_part.rb +55 -0
  9. data/lib/e_invoice_api/internal/documents_number_page.rb +96 -0
  10. data/lib/e_invoice_api/internal/transport/base_client.rb +555 -0
  11. data/lib/e_invoice_api/internal/transport/pooled_net_requester.rb +209 -0
  12. data/lib/e_invoice_api/internal/type/array_of.rb +162 -0
  13. data/lib/e_invoice_api/internal/type/base_model.rb +482 -0
  14. data/lib/e_invoice_api/internal/type/base_page.rb +55 -0
  15. data/lib/e_invoice_api/internal/type/boolean.rb +71 -0
  16. data/lib/e_invoice_api/internal/type/converter.rb +292 -0
  17. data/lib/e_invoice_api/internal/type/enum.rb +148 -0
  18. data/lib/e_invoice_api/internal/type/file_input.rb +103 -0
  19. data/lib/e_invoice_api/internal/type/hash_of.rb +182 -0
  20. data/lib/e_invoice_api/internal/type/request_parameters.rb +42 -0
  21. data/lib/e_invoice_api/internal/type/union.rb +236 -0
  22. data/lib/e_invoice_api/internal/type/unknown.rb +75 -0
  23. data/lib/e_invoice_api/internal/util.rb +914 -0
  24. data/lib/e_invoice_api/internal.rb +20 -0
  25. data/lib/e_invoice_api/models/certificate.rb +34 -0
  26. data/lib/e_invoice_api/models/currency_code.rb +28 -0
  27. data/lib/e_invoice_api/models/document_attachment_create.rb +33 -0
  28. data/lib/e_invoice_api/models/document_create.rb +521 -0
  29. data/lib/e_invoice_api/models/document_create_params.rb +14 -0
  30. data/lib/e_invoice_api/models/document_delete_params.rb +14 -0
  31. data/lib/e_invoice_api/models/document_delete_response.rb +16 -0
  32. data/lib/e_invoice_api/models/document_direction.rb +15 -0
  33. data/lib/e_invoice_api/models/document_response.rb +418 -0
  34. data/lib/e_invoice_api/models/document_retrieve_params.rb +14 -0
  35. data/lib/e_invoice_api/models/document_send_params.rb +44 -0
  36. data/lib/e_invoice_api/models/document_state.rb +18 -0
  37. data/lib/e_invoice_api/models/document_type.rb +15 -0
  38. data/lib/e_invoice_api/models/documents/attachment_add_params.rb +22 -0
  39. data/lib/e_invoice_api/models/documents/attachment_delete_params.rb +22 -0
  40. data/lib/e_invoice_api/models/documents/attachment_delete_response.rb +18 -0
  41. data/lib/e_invoice_api/models/documents/attachment_list_params.rb +16 -0
  42. data/lib/e_invoice_api/models/documents/attachment_list_response.rb +11 -0
  43. data/lib/e_invoice_api/models/documents/attachment_retrieve_params.rb +22 -0
  44. data/lib/e_invoice_api/models/documents/document_attachment.rb +44 -0
  45. data/lib/e_invoice_api/models/documents/ubl_get_params.rb +16 -0
  46. data/lib/e_invoice_api/models/documents/ubl_get_response.rb +72 -0
  47. data/lib/e_invoice_api/models/inbox_list_credit_notes_params.rb +30 -0
  48. data/lib/e_invoice_api/models/inbox_list_invoices_params.rb +30 -0
  49. data/lib/e_invoice_api/models/inbox_list_params.rb +78 -0
  50. data/lib/e_invoice_api/models/lookup_retrieve_params.rb +26 -0
  51. data/lib/e_invoice_api/models/lookup_retrieve_response.rb +491 -0
  52. data/lib/e_invoice_api/models/outbox_list_draft_documents_params.rb +30 -0
  53. data/lib/e_invoice_api/models/outbox_list_received_documents_params.rb +78 -0
  54. data/lib/e_invoice_api/models/paginated_document_response.rb +39 -0
  55. data/lib/e_invoice_api/models/payment_detail_create.rb +33 -0
  56. data/lib/e_invoice_api/models/ubl_document_validation.rb +97 -0
  57. data/lib/e_invoice_api/models/unit_of_measure_code.rb +104 -0
  58. data/lib/e_invoice_api/models/validate_validate_json_params.rb +14 -0
  59. data/lib/e_invoice_api/models/validate_validate_peppol_id_params.rb +26 -0
  60. data/lib/e_invoice_api/models/validate_validate_peppol_id_response.rb +80 -0
  61. data/lib/e_invoice_api/models/validate_validate_ubl_params.rb +20 -0
  62. data/lib/e_invoice_api/models/webhook_create_params.rb +32 -0
  63. data/lib/e_invoice_api/models/webhook_delete_params.rb +14 -0
  64. data/lib/e_invoice_api/models/webhook_delete_response.rb +18 -0
  65. data/lib/e_invoice_api/models/webhook_list_params.rb +14 -0
  66. data/lib/e_invoice_api/models/webhook_list_response.rb +8 -0
  67. data/lib/e_invoice_api/models/webhook_response.rb +42 -0
  68. data/lib/e_invoice_api/models/webhook_retrieve_params.rb +14 -0
  69. data/lib/e_invoice_api/models/webhook_update_params.rb +32 -0
  70. data/lib/e_invoice_api/models.rb +105 -0
  71. data/lib/e_invoice_api/request_options.rb +77 -0
  72. data/lib/e_invoice_api/resources/documents/attachments.rb +109 -0
  73. data/lib/e_invoice_api/resources/documents/ubl.rb +35 -0
  74. data/lib/e_invoice_api/resources/documents.rb +188 -0
  75. data/lib/e_invoice_api/resources/inbox.rb +101 -0
  76. data/lib/e_invoice_api/resources/lookup.rb +43 -0
  77. data/lib/e_invoice_api/resources/outbox.rb +76 -0
  78. data/lib/e_invoice_api/resources/validate.rb +168 -0
  79. data/lib/e_invoice_api/resources/webhooks.rb +117 -0
  80. data/lib/e_invoice_api/version.rb +5 -0
  81. data/lib/e_invoice_api.rb +107 -0
  82. data/manifest.yaml +15 -0
  83. data/rbi/e_invoice_api/client.rbi +64 -0
  84. data/rbi/e_invoice_api/errors.rbi +162 -0
  85. data/rbi/e_invoice_api/file_part.rbi +37 -0
  86. data/rbi/e_invoice_api/internal/documents_number_page.rbi +28 -0
  87. data/rbi/e_invoice_api/internal/transport/base_client.rbi +298 -0
  88. data/rbi/e_invoice_api/internal/transport/pooled_net_requester.rbi +80 -0
  89. data/rbi/e_invoice_api/internal/type/array_of.rbi +104 -0
  90. data/rbi/e_invoice_api/internal/type/base_model.rbi +304 -0
  91. data/rbi/e_invoice_api/internal/type/base_page.rbi +43 -0
  92. data/rbi/e_invoice_api/internal/type/boolean.rbi +56 -0
  93. data/rbi/e_invoice_api/internal/type/converter.rbi +162 -0
  94. data/rbi/e_invoice_api/internal/type/enum.rbi +82 -0
  95. data/rbi/e_invoice_api/internal/type/file_input.rbi +59 -0
  96. data/rbi/e_invoice_api/internal/type/hash_of.rbi +104 -0
  97. data/rbi/e_invoice_api/internal/type/request_parameters.rbi +31 -0
  98. data/rbi/e_invoice_api/internal/type/union.rbi +116 -0
  99. data/rbi/e_invoice_api/internal/type/unknown.rbi +56 -0
  100. data/rbi/e_invoice_api/internal/util.rbi +487 -0
  101. data/rbi/e_invoice_api/internal.rbi +18 -0
  102. data/rbi/e_invoice_api/models/certificate.rbi +54 -0
  103. data/rbi/e_invoice_api/models/currency_code.rbi +34 -0
  104. data/rbi/e_invoice_api/models/document_attachment_create.rbi +57 -0
  105. data/rbi/e_invoice_api/models/document_create.rbi +638 -0
  106. data/rbi/e_invoice_api/models/document_create_params.rbi +30 -0
  107. data/rbi/e_invoice_api/models/document_delete_params.rbi +30 -0
  108. data/rbi/e_invoice_api/models/document_delete_response.rbi +26 -0
  109. data/rbi/e_invoice_api/models/document_direction.rbi +22 -0
  110. data/rbi/e_invoice_api/models/document_response.rbi +504 -0
  111. data/rbi/e_invoice_api/models/document_retrieve_params.rbi +30 -0
  112. data/rbi/e_invoice_api/models/document_send_params.rbi +65 -0
  113. data/rbi/e_invoice_api/models/document_state.rbi +24 -0
  114. data/rbi/e_invoice_api/models/document_type.rbi +21 -0
  115. data/rbi/e_invoice_api/models/documents/attachment_add_params.rbi +43 -0
  116. data/rbi/e_invoice_api/models/documents/attachment_delete_params.rbi +43 -0
  117. data/rbi/e_invoice_api/models/documents/attachment_delete_response.rbi +28 -0
  118. data/rbi/e_invoice_api/models/documents/attachment_list_params.rbi +34 -0
  119. data/rbi/e_invoice_api/models/documents/attachment_list_response.rbi +15 -0
  120. data/rbi/e_invoice_api/models/documents/attachment_retrieve_params.rbi +43 -0
  121. data/rbi/e_invoice_api/models/documents/document_attachment.rbi +72 -0
  122. data/rbi/e_invoice_api/models/documents/ubl_get_params.rbi +34 -0
  123. data/rbi/e_invoice_api/models/documents/ubl_get_response.rbi +97 -0
  124. data/rbi/e_invoice_api/models/inbox_list_credit_notes_params.rbi +60 -0
  125. data/rbi/e_invoice_api/models/inbox_list_invoices_params.rbi +60 -0
  126. data/rbi/e_invoice_api/models/inbox_list_params.rbi +105 -0
  127. data/rbi/e_invoice_api/models/lookup_retrieve_params.rbi +45 -0
  128. data/rbi/e_invoice_api/models/lookup_retrieve_response.rbi +852 -0
  129. data/rbi/e_invoice_api/models/outbox_list_draft_documents_params.rbi +60 -0
  130. data/rbi/e_invoice_api/models/outbox_list_received_documents_params.rbi +108 -0
  131. data/rbi/e_invoice_api/models/paginated_document_response.rbi +56 -0
  132. data/rbi/e_invoice_api/models/payment_detail_create.rbi +56 -0
  133. data/rbi/e_invoice_api/models/ubl_document_validation.rbi +159 -0
  134. data/rbi/e_invoice_api/models/unit_of_measure_code.rbi +149 -0
  135. data/rbi/e_invoice_api/models/validate_validate_json_params.rbi +30 -0
  136. data/rbi/e_invoice_api/models/validate_validate_peppol_id_params.rbi +45 -0
  137. data/rbi/e_invoice_api/models/validate_validate_peppol_id_response.rbi +141 -0
  138. data/rbi/e_invoice_api/models/validate_validate_ubl_params.rbi +41 -0
  139. data/rbi/e_invoice_api/models/webhook_create_params.rbi +54 -0
  140. data/rbi/e_invoice_api/models/webhook_delete_params.rbi +30 -0
  141. data/rbi/e_invoice_api/models/webhook_delete_response.rbi +27 -0
  142. data/rbi/e_invoice_api/models/webhook_list_params.rbi +27 -0
  143. data/rbi/e_invoice_api/models/webhook_list_response.rbi +11 -0
  144. data/rbi/e_invoice_api/models/webhook_response.rbi +57 -0
  145. data/rbi/e_invoice_api/models/webhook_retrieve_params.rbi +30 -0
  146. data/rbi/e_invoice_api/models/webhook_update_params.rbi +51 -0
  147. data/rbi/e_invoice_api/models.rbi +70 -0
  148. data/rbi/e_invoice_api/request_options.rbi +59 -0
  149. data/rbi/e_invoice_api/resources/documents/attachments.rbi +58 -0
  150. data/rbi/e_invoice_api/resources/documents/ubl.rbi +24 -0
  151. data/rbi/e_invoice_api/resources/documents.rbi +164 -0
  152. data/rbi/e_invoice_api/resources/inbox.rbi +93 -0
  153. data/rbi/e_invoice_api/resources/lookup.rbi +31 -0
  154. data/rbi/e_invoice_api/resources/outbox.rbi +72 -0
  155. data/rbi/e_invoice_api/resources/validate.rbi +145 -0
  156. data/rbi/e_invoice_api/resources/webhooks.rbi +72 -0
  157. data/rbi/e_invoice_api/version.rbi +5 -0
  158. data/sig/e_invoice_api/client.rbs +36 -0
  159. data/sig/e_invoice_api/errors.rbs +101 -0
  160. data/sig/e_invoice_api/file_part.rbs +21 -0
  161. data/sig/e_invoice_api/internal/documents_number_page.rbs +17 -0
  162. data/sig/e_invoice_api/internal/transport/base_client.rbs +131 -0
  163. data/sig/e_invoice_api/internal/transport/pooled_net_requester.rbs +45 -0
  164. data/sig/e_invoice_api/internal/type/array_of.rbs +48 -0
  165. data/sig/e_invoice_api/internal/type/base_model.rbs +102 -0
  166. data/sig/e_invoice_api/internal/type/base_page.rbs +24 -0
  167. data/sig/e_invoice_api/internal/type/boolean.rbs +26 -0
  168. data/sig/e_invoice_api/internal/type/converter.rbs +56 -0
  169. data/sig/e_invoice_api/internal/type/enum.rbs +32 -0
  170. data/sig/e_invoice_api/internal/type/file_input.rbs +25 -0
  171. data/sig/e_invoice_api/internal/type/hash_of.rbs +48 -0
  172. data/sig/e_invoice_api/internal/type/request_parameters.rbs +19 -0
  173. data/sig/e_invoice_api/internal/type/union.rbs +52 -0
  174. data/sig/e_invoice_api/internal/type/unknown.rbs +26 -0
  175. data/sig/e_invoice_api/internal/util.rbs +185 -0
  176. data/sig/e_invoice_api/internal.rbs +9 -0
  177. data/sig/e_invoice_api/models/certificate.rbs +26 -0
  178. data/sig/e_invoice_api/models/currency_code.rbs +42 -0
  179. data/sig/e_invoice_api/models/document_attachment_create.rbs +39 -0
  180. data/sig/e_invoice_api/models/document_create.rbs +403 -0
  181. data/sig/e_invoice_api/models/document_create_params.rbs +15 -0
  182. data/sig/e_invoice_api/models/document_delete_params.rbs +15 -0
  183. data/sig/e_invoice_api/models/document_delete_response.rbs +13 -0
  184. data/sig/e_invoice_api/models/document_direction.rbs +14 -0
  185. data/sig/e_invoice_api/models/document_response.rbs +358 -0
  186. data/sig/e_invoice_api/models/document_retrieve_params.rbs +15 -0
  187. data/sig/e_invoice_api/models/document_send_params.rbs +46 -0
  188. data/sig/e_invoice_api/models/document_state.rbs +17 -0
  189. data/sig/e_invoice_api/models/document_type.rbs +14 -0
  190. data/sig/e_invoice_api/models/documents/attachment_add_params.rbs +26 -0
  191. data/sig/e_invoice_api/models/documents/attachment_delete_params.rbs +26 -0
  192. data/sig/e_invoice_api/models/documents/attachment_delete_response.rbs +15 -0
  193. data/sig/e_invoice_api/models/documents/attachment_list_params.rbs +17 -0
  194. data/sig/e_invoice_api/models/documents/attachment_list_response.rbs +10 -0
  195. data/sig/e_invoice_api/models/documents/attachment_retrieve_params.rbs +26 -0
  196. data/sig/e_invoice_api/models/documents/document_attachment.rbs +48 -0
  197. data/sig/e_invoice_api/models/documents/ubl_get_params.rbs +17 -0
  198. data/sig/e_invoice_api/models/documents/ubl_get_response.rbs +69 -0
  199. data/sig/e_invoice_api/models/inbox_list_credit_notes_params.rbs +32 -0
  200. data/sig/e_invoice_api/models/inbox_list_invoices_params.rbs +32 -0
  201. data/sig/e_invoice_api/models/inbox_list_params.rbs +65 -0
  202. data/sig/e_invoice_api/models/lookup_retrieve_params.rbs +23 -0
  203. data/sig/e_invoice_api/models/lookup_retrieve_response.rbs +365 -0
  204. data/sig/e_invoice_api/models/outbox_list_draft_documents_params.rbs +32 -0
  205. data/sig/e_invoice_api/models/outbox_list_received_documents_params.rbs +65 -0
  206. data/sig/e_invoice_api/models/paginated_document_response.rbs +40 -0
  207. data/sig/e_invoice_api/models/payment_detail_create.rbs +35 -0
  208. data/sig/e_invoice_api/models/ubl_document_validation.rbs +98 -0
  209. data/sig/e_invoice_api/models/unit_of_measure_code.rbs +192 -0
  210. data/sig/e_invoice_api/models/validate_validate_json_params.rbs +15 -0
  211. data/sig/e_invoice_api/models/validate_validate_peppol_id_params.rbs +23 -0
  212. data/sig/e_invoice_api/models/validate_validate_peppol_id_response.rbs +65 -0
  213. data/sig/e_invoice_api/models/validate_validate_ubl_params.rbs +24 -0
  214. data/sig/e_invoice_api/models/webhook_create_params.rbs +34 -0
  215. data/sig/e_invoice_api/models/webhook_delete_params.rbs +15 -0
  216. data/sig/e_invoice_api/models/webhook_delete_response.rbs +13 -0
  217. data/sig/e_invoice_api/models/webhook_list_params.rbs +15 -0
  218. data/sig/e_invoice_api/models/webhook_list_response.rbs +7 -0
  219. data/sig/e_invoice_api/models/webhook_response.rbs +42 -0
  220. data/sig/e_invoice_api/models/webhook_retrieve_params.rbs +15 -0
  221. data/sig/e_invoice_api/models/webhook_update_params.rbs +32 -0
  222. data/sig/e_invoice_api/models.rbs +65 -0
  223. data/sig/e_invoice_api/request_options.rbs +36 -0
  224. data/sig/e_invoice_api/resources/documents/attachments.rbs +32 -0
  225. data/sig/e_invoice_api/resources/documents/ubl.rbs +14 -0
  226. data/sig/e_invoice_api/resources/documents.rbs +76 -0
  227. data/sig/e_invoice_api/resources/inbox.rbs +31 -0
  228. data/sig/e_invoice_api/resources/lookup.rbs +12 -0
  229. data/sig/e_invoice_api/resources/outbox.rbs +25 -0
  230. data/sig/e_invoice_api/resources/validate.rbs +62 -0
  231. data/sig/e_invoice_api/resources/webhooks.rbs +36 -0
  232. data/sig/e_invoice_api/version.rbs +3 -0
  233. metadata +290 -0
@@ -0,0 +1,491 @@
1
+ # frozen_string_literal: true
2
+
3
+ module EInvoiceAPI
4
+ module Models
5
+ # @see EInvoiceAPI::Resources::Lookup#retrieve
6
+ class LookupRetrieveResponse < EInvoiceAPI::Internal::Type::BaseModel
7
+ # @!attribute business_card
8
+ # Business card information for the Peppol participant
9
+ #
10
+ # @return [EInvoiceAPI::Models::LookupRetrieveResponse::BusinessCard]
11
+ required :business_card,
12
+ -> { EInvoiceAPI::Models::LookupRetrieveResponse::BusinessCard },
13
+ api_name: :businessCard
14
+
15
+ # @!attribute certificates
16
+ # List of certificates found for the Peppol participant
17
+ #
18
+ # @return [Array<EInvoiceAPI::Models::Certificate>]
19
+ required :certificates, -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Certificate] }
20
+
21
+ # @!attribute dns_info
22
+ # Information about the DNS lookup performed
23
+ #
24
+ # @return [EInvoiceAPI::Models::LookupRetrieveResponse::DNSInfo]
25
+ required :dns_info, -> { EInvoiceAPI::Models::LookupRetrieveResponse::DNSInfo }, api_name: :dnsInfo
26
+
27
+ # @!attribute errors
28
+ # List of error messages if any errors occurred during the lookup
29
+ #
30
+ # @return [Array<String>]
31
+ required :errors, EInvoiceAPI::Internal::Type::ArrayOf[String]
32
+
33
+ # @!attribute execution_time_ms
34
+ # Total execution time of the lookup operation in milliseconds
35
+ #
36
+ # @return [Float]
37
+ required :execution_time_ms, Float, api_name: :executionTimeMs
38
+
39
+ # @!attribute query_metadata
40
+ # Metadata about the query that was performed
41
+ #
42
+ # @return [EInvoiceAPI::Models::LookupRetrieveResponse::QueryMetadata]
43
+ required :query_metadata,
44
+ -> { EInvoiceAPI::Models::LookupRetrieveResponse::QueryMetadata },
45
+ api_name: :queryMetadata
46
+
47
+ # @!attribute service_metadata
48
+ # Service metadata information for the Peppol participant
49
+ #
50
+ # @return [EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata]
51
+ required :service_metadata,
52
+ -> { EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata },
53
+ api_name: :serviceMetadata
54
+
55
+ # @!attribute status
56
+ # Overall status of the lookup: 'success' or 'error'
57
+ #
58
+ # @return [String]
59
+ required :status, String
60
+
61
+ # @!method initialize(business_card:, certificates:, dns_info:, errors:, execution_time_ms:, query_metadata:, service_metadata:, status:)
62
+ # Response from a Peppol ID lookup operation.
63
+ #
64
+ # This model represents the complete result of validating and looking up a Peppol
65
+ # ID in the Peppol network, including DNS information, service metadata, business
66
+ # card details, and certificate information.
67
+ #
68
+ # Example: A successful lookup for a Peppol ID "0192:991825827" would return DNS
69
+ # information, service metadata with supported document types and processes,
70
+ # business card information with organization details, and certificate data.
71
+ #
72
+ # @param business_card [EInvoiceAPI::Models::LookupRetrieveResponse::BusinessCard] Business card information for the Peppol participant
73
+ #
74
+ # @param certificates [Array<EInvoiceAPI::Models::Certificate>] List of certificates found for the Peppol participant
75
+ #
76
+ # @param dns_info [EInvoiceAPI::Models::LookupRetrieveResponse::DNSInfo] Information about the DNS lookup performed
77
+ #
78
+ # @param errors [Array<String>] List of error messages if any errors occurred during the lookup
79
+ #
80
+ # @param execution_time_ms [Float] Total execution time of the lookup operation in milliseconds
81
+ #
82
+ # @param query_metadata [EInvoiceAPI::Models::LookupRetrieveResponse::QueryMetadata] Metadata about the query that was performed
83
+ #
84
+ # @param service_metadata [EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata] Service metadata information for the Peppol participant
85
+ #
86
+ # @param status [String] Overall status of the lookup: 'success' or 'error'
87
+
88
+ # @see EInvoiceAPI::Models::LookupRetrieveResponse#business_card
89
+ class BusinessCard < EInvoiceAPI::Internal::Type::BaseModel
90
+ # @!attribute entities
91
+ # List of business entities associated with the Peppol ID
92
+ #
93
+ # @return [Array<EInvoiceAPI::Models::LookupRetrieveResponse::BusinessCard::Entity>]
94
+ required :entities,
95
+ -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::LookupRetrieveResponse::BusinessCard::Entity] }
96
+
97
+ # @!attribute query_time_ms
98
+ # Time taken to query the business card in milliseconds
99
+ #
100
+ # @return [Float]
101
+ required :query_time_ms, Float, api_name: :queryTimeMs
102
+
103
+ # @!attribute status
104
+ # Status of the business card lookup: 'success', 'error', or 'pending'
105
+ #
106
+ # @return [String]
107
+ required :status, String
108
+
109
+ # @!attribute error
110
+ # Error message if business card lookup failed
111
+ #
112
+ # @return [String, nil]
113
+ optional :error, String, nil?: true
114
+
115
+ # @!method initialize(entities:, query_time_ms:, status:, error: nil)
116
+ # Business card information for the Peppol participant
117
+ #
118
+ # @param entities [Array<EInvoiceAPI::Models::LookupRetrieveResponse::BusinessCard::Entity>] List of business entities associated with the Peppol ID
119
+ #
120
+ # @param query_time_ms [Float] Time taken to query the business card in milliseconds
121
+ #
122
+ # @param status [String] Status of the business card lookup: 'success', 'error', or 'pending'
123
+ #
124
+ # @param error [String, nil] Error message if business card lookup failed
125
+
126
+ class Entity < EInvoiceAPI::Internal::Type::BaseModel
127
+ # @!attribute additional_information
128
+ # Additional information about the business entity
129
+ #
130
+ # @return [Array<String>, nil]
131
+ optional :additional_information,
132
+ EInvoiceAPI::Internal::Type::ArrayOf[String],
133
+ api_name: :additionalInformation,
134
+ nil?: true
135
+
136
+ # @!attribute country_code
137
+ # ISO 3166-1 alpha-2 country code of the business entity
138
+ #
139
+ # @return [String, nil]
140
+ optional :country_code, String, api_name: :countryCode, nil?: true
141
+
142
+ # @!attribute name
143
+ # Name of the business entity
144
+ #
145
+ # @return [String, nil]
146
+ optional :name, String, nil?: true
147
+
148
+ # @!attribute registration_date
149
+ # ISO 8601 date of when the entity was registered in Peppol
150
+ #
151
+ # @return [String, nil]
152
+ optional :registration_date, String, api_name: :registrationDate, nil?: true
153
+
154
+ # @!method initialize(additional_information: nil, country_code: nil, name: nil, registration_date: nil)
155
+ # Business entity information in the Peppol network.
156
+ #
157
+ # @param additional_information [Array<String>, nil] Additional information about the business entity
158
+ #
159
+ # @param country_code [String, nil] ISO 3166-1 alpha-2 country code of the business entity
160
+ #
161
+ # @param name [String, nil] Name of the business entity
162
+ #
163
+ # @param registration_date [String, nil] ISO 8601 date of when the entity was registered in Peppol
164
+ end
165
+ end
166
+
167
+ # @see EInvoiceAPI::Models::LookupRetrieveResponse#dns_info
168
+ class DNSInfo < EInvoiceAPI::Internal::Type::BaseModel
169
+ # @!attribute dns_records
170
+ # List of DNS records found for the Peppol participant
171
+ #
172
+ # @return [Array<EInvoiceAPI::Models::LookupRetrieveResponse::DNSInfo::DNSRecord>]
173
+ required :dns_records,
174
+ -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::LookupRetrieveResponse::DNSInfo::DNSRecord] },
175
+ api_name: :dnsRecords
176
+
177
+ # @!attribute sml_hostname
178
+ # Hostname of the SML used for the query
179
+ #
180
+ # @return [String]
181
+ required :sml_hostname, String, api_name: :smlHostname
182
+
183
+ # @!attribute status
184
+ # Status of the DNS lookup: 'success', 'error', or 'pending'
185
+ #
186
+ # @return [String]
187
+ required :status, String
188
+
189
+ # @!attribute error
190
+ # Error message if the DNS lookup failed
191
+ #
192
+ # @return [String, nil]
193
+ optional :error, String, nil?: true
194
+
195
+ # @!method initialize(dns_records:, sml_hostname:, status:, error: nil)
196
+ # Information about the DNS lookup performed
197
+ #
198
+ # @param dns_records [Array<EInvoiceAPI::Models::LookupRetrieveResponse::DNSInfo::DNSRecord>] List of DNS records found for the Peppol participant
199
+ #
200
+ # @param sml_hostname [String] Hostname of the SML used for the query
201
+ #
202
+ # @param status [String] Status of the DNS lookup: 'success', 'error', or 'pending'
203
+ #
204
+ # @param error [String, nil] Error message if the DNS lookup failed
205
+
206
+ class DNSRecord < EInvoiceAPI::Internal::Type::BaseModel
207
+ # @!attribute ip
208
+ # IP address found in the DNS record
209
+ #
210
+ # @return [String]
211
+ required :ip, String
212
+
213
+ # @!method initialize(ip:)
214
+ # DNS record information for a Peppol participant.
215
+ #
216
+ # @param ip [String] IP address found in the DNS record
217
+ end
218
+ end
219
+
220
+ # @see EInvoiceAPI::Models::LookupRetrieveResponse#query_metadata
221
+ class QueryMetadata < EInvoiceAPI::Internal::Type::BaseModel
222
+ # @!attribute identifier_scheme
223
+ # Scheme of the identifier, typically 'iso6523-actorid-upis'
224
+ #
225
+ # @return [String]
226
+ required :identifier_scheme, String, api_name: :identifierScheme
227
+
228
+ # @!attribute identifier_value
229
+ # The actual Peppol ID value being queried
230
+ #
231
+ # @return [String]
232
+ required :identifier_value, String, api_name: :identifierValue
233
+
234
+ # @!attribute sml_domain
235
+ # Domain of the SML (Service Metadata Locator) used for the lookup
236
+ #
237
+ # @return [String]
238
+ required :sml_domain, String, api_name: :smlDomain
239
+
240
+ # @!attribute timestamp
241
+ # ISO 8601 timestamp of when the query was executed
242
+ #
243
+ # @return [String]
244
+ required :timestamp, String
245
+
246
+ # @!attribute version
247
+ # Version of the API used for the lookup
248
+ #
249
+ # @return [String]
250
+ required :version, String
251
+
252
+ # @!method initialize(identifier_scheme:, identifier_value:, sml_domain:, timestamp:, version:)
253
+ # Metadata about the query that was performed
254
+ #
255
+ # @param identifier_scheme [String] Scheme of the identifier, typically 'iso6523-actorid-upis'
256
+ #
257
+ # @param identifier_value [String] The actual Peppol ID value being queried
258
+ #
259
+ # @param sml_domain [String] Domain of the SML (Service Metadata Locator) used for the lookup
260
+ #
261
+ # @param timestamp [String] ISO 8601 timestamp of when the query was executed
262
+ #
263
+ # @param version [String] Version of the API used for the lookup
264
+ end
265
+
266
+ # @see EInvoiceAPI::Models::LookupRetrieveResponse#service_metadata
267
+ class ServiceMetadata < EInvoiceAPI::Internal::Type::BaseModel
268
+ # @!attribute endpoints
269
+ # List of endpoints found for the Peppol participant
270
+ #
271
+ # @return [Array<EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint>]
272
+ required :endpoints,
273
+ -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint] }
274
+
275
+ # @!attribute query_time_ms
276
+ # Time taken to query the service metadata in milliseconds
277
+ #
278
+ # @return [Float]
279
+ required :query_time_ms, Float, api_name: :queryTimeMs
280
+
281
+ # @!attribute status
282
+ # Status of the service metadata lookup: 'success', 'error', or 'pending'
283
+ #
284
+ # @return [String]
285
+ required :status, String
286
+
287
+ # @!attribute error
288
+ # Error message if service metadata lookup failed
289
+ #
290
+ # @return [String, nil]
291
+ optional :error, String, nil?: true
292
+
293
+ # @!method initialize(endpoints:, query_time_ms:, status:, error: nil)
294
+ # Service metadata information for the Peppol participant
295
+ #
296
+ # @param endpoints [Array<EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint>] List of endpoints found for the Peppol participant
297
+ #
298
+ # @param query_time_ms [Float] Time taken to query the service metadata in milliseconds
299
+ #
300
+ # @param status [String] Status of the service metadata lookup: 'success', 'error', or 'pending'
301
+ #
302
+ # @param error [String, nil] Error message if service metadata lookup failed
303
+
304
+ class Endpoint < EInvoiceAPI::Internal::Type::BaseModel
305
+ # @!attribute document_types
306
+ # List of document types supported by this endpoint
307
+ #
308
+ # @return [Array<EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::DocumentType>]
309
+ required :document_types,
310
+ -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::DocumentType] },
311
+ api_name: :documentTypes
312
+
313
+ # @!attribute status
314
+ # Status of the endpoint lookup: 'success', 'error', or 'pending'
315
+ #
316
+ # @return [String]
317
+ required :status, String
318
+
319
+ # @!attribute url
320
+ # URL of the endpoint
321
+ #
322
+ # @return [String]
323
+ required :url, String
324
+
325
+ # @!attribute error
326
+ # Error message if endpoint lookup failed
327
+ #
328
+ # @return [String, nil]
329
+ optional :error, String, nil?: true
330
+
331
+ # @!attribute processes
332
+ # List of processes supported by this endpoint
333
+ #
334
+ # @return [Array<EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process>, nil]
335
+ optional :processes,
336
+ -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process] },
337
+ nil?: true
338
+
339
+ # @!method initialize(document_types:, status:, url:, error: nil, processes: nil)
340
+ # Information about a Peppol participant's endpoint.
341
+ #
342
+ # @param document_types [Array<EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::DocumentType>] List of document types supported by this endpoint
343
+ #
344
+ # @param status [String] Status of the endpoint lookup: 'success', 'error', or 'pending'
345
+ #
346
+ # @param url [String] URL of the endpoint
347
+ #
348
+ # @param error [String, nil] Error message if endpoint lookup failed
349
+ #
350
+ # @param processes [Array<EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process>, nil] List of processes supported by this endpoint
351
+
352
+ class DocumentType < EInvoiceAPI::Internal::Type::BaseModel
353
+ # @!attribute scheme
354
+ # Scheme of the document type identifier
355
+ #
356
+ # @return [String]
357
+ required :scheme, String
358
+
359
+ # @!attribute value
360
+ # Value of the document type identifier
361
+ #
362
+ # @return [String]
363
+ required :value, String
364
+
365
+ # @!method initialize(scheme:, value:)
366
+ # Document type supported by a Peppol participant.
367
+ #
368
+ # @param scheme [String] Scheme of the document type identifier
369
+ #
370
+ # @param value [String] Value of the document type identifier
371
+ end
372
+
373
+ class Process < EInvoiceAPI::Internal::Type::BaseModel
374
+ # @!attribute endpoints
375
+ # List of endpoints supporting this process
376
+ #
377
+ # @return [Array<EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process::Endpoint>]
378
+ required :endpoints,
379
+ -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process::Endpoint] }
380
+
381
+ # @!attribute process_id
382
+ # Identifier of the process
383
+ #
384
+ # @return [EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process::ProcessID]
385
+ required :process_id,
386
+ -> { EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process::ProcessID },
387
+ api_name: :processId
388
+
389
+ # @!method initialize(endpoints:, process_id:)
390
+ # Process information in the Peppol network.
391
+ #
392
+ # @param endpoints [Array<EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process::Endpoint>] List of endpoints supporting this process
393
+ #
394
+ # @param process_id [EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process::ProcessID] Identifier of the process
395
+
396
+ class Endpoint < EInvoiceAPI::Internal::Type::BaseModel
397
+ # @!attribute address
398
+ # URL or address of the endpoint
399
+ #
400
+ # @return [String]
401
+ required :address, String
402
+
403
+ # @!attribute transport_profile
404
+ # Transport profile used by this endpoint
405
+ #
406
+ # @return [String]
407
+ required :transport_profile, String, api_name: :transportProfile
408
+
409
+ # @!attribute certificate
410
+ # Certificate information for a Peppol endpoint.
411
+ #
412
+ # @return [EInvoiceAPI::Models::Certificate, nil]
413
+ optional :certificate, -> { EInvoiceAPI::Certificate }, nil?: true
414
+
415
+ # @!attribute service_activation_date
416
+ # ISO 8601 date when the service was activated
417
+ #
418
+ # @return [String, nil]
419
+ optional :service_activation_date, String, api_name: :serviceActivationDate, nil?: true
420
+
421
+ # @!attribute service_description
422
+ # Human-readable description of the service
423
+ #
424
+ # @return [String, nil]
425
+ optional :service_description, String, api_name: :serviceDescription, nil?: true
426
+
427
+ # @!attribute service_expiration_date
428
+ # ISO 8601 date when the service will expire
429
+ #
430
+ # @return [String, nil]
431
+ optional :service_expiration_date, String, api_name: :serviceExpirationDate, nil?: true
432
+
433
+ # @!attribute technical_contact_url
434
+ # URL for technical contact information
435
+ #
436
+ # @return [String, nil]
437
+ optional :technical_contact_url, String, api_name: :technicalContactUrl, nil?: true
438
+
439
+ # @!attribute technical_information_url
440
+ # URL for technical documentation
441
+ #
442
+ # @return [String, nil]
443
+ optional :technical_information_url, String, api_name: :technicalInformationUrl, nil?: true
444
+
445
+ # @!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)
446
+ # Endpoint information for a specific Peppol process.
447
+ #
448
+ # @param address [String] URL or address of the endpoint
449
+ #
450
+ # @param transport_profile [String] Transport profile used by this endpoint
451
+ #
452
+ # @param certificate [EInvoiceAPI::Models::Certificate, nil] Certificate information for a Peppol endpoint.
453
+ #
454
+ # @param service_activation_date [String, nil] ISO 8601 date when the service was activated
455
+ #
456
+ # @param service_description [String, nil] Human-readable description of the service
457
+ #
458
+ # @param service_expiration_date [String, nil] ISO 8601 date when the service will expire
459
+ #
460
+ # @param technical_contact_url [String, nil] URL for technical contact information
461
+ #
462
+ # @param technical_information_url [String, nil] URL for technical documentation
463
+ end
464
+
465
+ # @see EInvoiceAPI::Models::LookupRetrieveResponse::ServiceMetadata::Endpoint::Process#process_id
466
+ class ProcessID < EInvoiceAPI::Internal::Type::BaseModel
467
+ # @!attribute scheme
468
+ # Scheme of the process identifier
469
+ #
470
+ # @return [String]
471
+ required :scheme, String
472
+
473
+ # @!attribute value
474
+ # Value of the process identifier
475
+ #
476
+ # @return [String]
477
+ required :value, String
478
+
479
+ # @!method initialize(scheme:, value:)
480
+ # Identifier of the process
481
+ #
482
+ # @param scheme [String] Scheme of the process identifier
483
+ #
484
+ # @param value [String] Value of the process identifier
485
+ end
486
+ end
487
+ end
488
+ end
489
+ end
490
+ end
491
+ end
@@ -0,0 +1,30 @@
1
+ # frozen_string_literal: true
2
+
3
+ module EInvoiceAPI
4
+ module Models
5
+ # @see EInvoiceAPI::Resources::Outbox#list_draft_documents
6
+ class OutboxListDraftDocumentsParams < EInvoiceAPI::Internal::Type::BaseModel
7
+ extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
8
+ include EInvoiceAPI::Internal::Type::RequestParameters
9
+
10
+ # @!attribute page
11
+ # Page number
12
+ #
13
+ # @return [Integer, nil]
14
+ optional :page, Integer
15
+
16
+ # @!attribute page_size
17
+ # Number of items per page
18
+ #
19
+ # @return [Integer, nil]
20
+ optional :page_size, Integer
21
+
22
+ # @!method initialize(page: nil, page_size: nil, request_options: {})
23
+ # @param page [Integer] Page number
24
+ #
25
+ # @param page_size [Integer] Number of items per page
26
+ #
27
+ # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,78 @@
1
+ # frozen_string_literal: true
2
+
3
+ module EInvoiceAPI
4
+ module Models
5
+ # @see EInvoiceAPI::Resources::Outbox#list_received_documents
6
+ class OutboxListReceivedDocumentsParams < EInvoiceAPI::Internal::Type::BaseModel
7
+ extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
8
+ include EInvoiceAPI::Internal::Type::RequestParameters
9
+
10
+ # @!attribute date_from
11
+ # Filter by issue date (from)
12
+ #
13
+ # @return [Time, nil]
14
+ optional :date_from, Time, nil?: true
15
+
16
+ # @!attribute date_to
17
+ # Filter by issue date (to)
18
+ #
19
+ # @return [Time, nil]
20
+ optional :date_to, Time, nil?: true
21
+
22
+ # @!attribute page
23
+ # Page number
24
+ #
25
+ # @return [Integer, nil]
26
+ optional :page, Integer
27
+
28
+ # @!attribute page_size
29
+ # Number of items per page
30
+ #
31
+ # @return [Integer, nil]
32
+ optional :page_size, Integer
33
+
34
+ # @!attribute search
35
+ # Search in invoice number, seller/buyer names
36
+ #
37
+ # @return [String, nil]
38
+ optional :search, String, nil?: true
39
+
40
+ # @!attribute sender
41
+ # Filter by sender ID
42
+ #
43
+ # @return [String, nil]
44
+ optional :sender, String, nil?: true
45
+
46
+ # @!attribute state
47
+ # Filter by document state
48
+ #
49
+ # @return [Symbol, EInvoiceAPI::Models::DocumentState, nil]
50
+ optional :state, enum: -> { EInvoiceAPI::DocumentState }, nil?: true
51
+
52
+ # @!attribute type
53
+ # Filter by document type
54
+ #
55
+ # @return [Symbol, EInvoiceAPI::Models::DocumentType, nil]
56
+ optional :type, enum: -> { EInvoiceAPI::DocumentType }, nil?: true
57
+
58
+ # @!method initialize(date_from: nil, date_to: nil, page: nil, page_size: nil, search: nil, sender: nil, state: nil, type: nil, request_options: {})
59
+ # @param date_from [Time, nil] Filter by issue date (from)
60
+ #
61
+ # @param date_to [Time, nil] Filter by issue date (to)
62
+ #
63
+ # @param page [Integer] Page number
64
+ #
65
+ # @param page_size [Integer] Number of items per page
66
+ #
67
+ # @param search [String, nil] Search in invoice number, seller/buyer names
68
+ #
69
+ # @param sender [String, nil] Filter by sender ID
70
+ #
71
+ # @param state [Symbol, EInvoiceAPI::Models::DocumentState, nil] Filter by document state
72
+ #
73
+ # @param type [Symbol, EInvoiceAPI::Models::DocumentType, nil] Filter by document type
74
+ #
75
+ # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
76
+ end
77
+ end
78
+ end
@@ -0,0 +1,39 @@
1
+ # frozen_string_literal: true
2
+
3
+ module EInvoiceAPI
4
+ module Models
5
+ class PaginatedDocumentResponse < EInvoiceAPI::Internal::Type::BaseModel
6
+ # @!attribute items
7
+ #
8
+ # @return [Array<EInvoiceAPI::Models::DocumentResponse>]
9
+ required :items, -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::DocumentResponse] }
10
+
11
+ # @!attribute page
12
+ #
13
+ # @return [Integer]
14
+ required :page, Integer
15
+
16
+ # @!attribute page_size
17
+ #
18
+ # @return [Integer]
19
+ required :page_size, Integer
20
+
21
+ # @!attribute pages
22
+ #
23
+ # @return [Integer]
24
+ required :pages, Integer
25
+
26
+ # @!attribute total
27
+ #
28
+ # @return [Integer]
29
+ required :total, Integer
30
+
31
+ # @!method initialize(items:, page:, page_size:, pages:, total:)
32
+ # @param items [Array<EInvoiceAPI::Models::DocumentResponse>]
33
+ # @param page [Integer]
34
+ # @param page_size [Integer]
35
+ # @param pages [Integer]
36
+ # @param total [Integer]
37
+ end
38
+ end
39
+ end
@@ -0,0 +1,33 @@
1
+ # frozen_string_literal: true
2
+
3
+ module EInvoiceAPI
4
+ module Models
5
+ class PaymentDetailCreate < EInvoiceAPI::Internal::Type::BaseModel
6
+ # @!attribute bank_account_number
7
+ #
8
+ # @return [String, nil]
9
+ optional :bank_account_number, String, nil?: true
10
+
11
+ # @!attribute iban
12
+ #
13
+ # @return [String, nil]
14
+ optional :iban, String, nil?: true
15
+
16
+ # @!attribute payment_reference
17
+ #
18
+ # @return [String, nil]
19
+ optional :payment_reference, String, nil?: true
20
+
21
+ # @!attribute swift
22
+ #
23
+ # @return [String, nil]
24
+ optional :swift, String, nil?: true
25
+
26
+ # @!method initialize(bank_account_number: nil, iban: nil, payment_reference: nil, swift: nil)
27
+ # @param bank_account_number [String, nil]
28
+ # @param iban [String, nil]
29
+ # @param payment_reference [String, nil]
30
+ # @param swift [String, nil]
31
+ end
32
+ end
33
+ end