biz_api 3.9.1
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.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +155 -0
- data/Rakefile +10 -0
- data/biz_api.gemspec +39 -0
- data/docs/AppInfo.md +22 -0
- data/docs/AuthRequest.md +26 -0
- data/docs/BizEvent.md +50 -0
- data/docs/BizEventsHelpdeskApi.md +157 -0
- data/docs/CartItem.md +28 -0
- data/docs/Creditor.md +26 -0
- data/docs/CtReceiptModelResponse.md +72 -0
- data/docs/Debtor.md +36 -0
- data/docs/DebtorPosition.md +24 -0
- data/docs/Details.md +22 -0
- data/docs/HomeApi.md +81 -0
- data/docs/IOTransactionsRESTAPIsApi.md +328 -0
- data/docs/Info.md +34 -0
- data/docs/InfoNotice.md +38 -0
- data/docs/InfoTransaction.md +26 -0
- data/docs/InfoTransactionView.md +38 -0
- data/docs/MBD.md +26 -0
- data/docs/MapEntry.md +20 -0
- data/docs/NoticeDetailResponse.md +20 -0
- data/docs/NoticeListItem.md +32 -0
- data/docs/NoticeListWrapResponse.md +18 -0
- data/docs/PageInfo.md +24 -0
- data/docs/PaidNoticeRESTAPIsApi.md +322 -0
- data/docs/Payer.md +36 -0
- data/docs/PaymentAuthorizationRequest.md +28 -0
- data/docs/PaymentInfo.md +50 -0
- data/docs/PaymentReceiptsRESTAPIsApi.md +161 -0
- data/docs/ProblemJson.md +22 -0
- data/docs/Psp.md +30 -0
- data/docs/Transaction.md +44 -0
- data/docs/TransactionDetailResponse.md +20 -0
- data/docs/TransactionDetails.md +28 -0
- data/docs/TransactionListItem.md +32 -0
- data/docs/TransactionListWrapResponse.md +20 -0
- data/docs/TransactionPsp.md +22 -0
- data/docs/Transfer.md +34 -0
- data/docs/TransferPA.md +32 -0
- data/docs/User.md +30 -0
- data/docs/UserDetail.md +20 -0
- data/docs/WalletInfo.md +24 -0
- data/docs/WalletItem.md +34 -0
- data/git_push.sh +57 -0
- data/lib/biz_api/api/biz_events_helpdesk_api.rb +156 -0
- data/lib/biz_api/api/home_api.rb +82 -0
- data/lib/biz_api/api/io_transactions_restapis_api.rb +334 -0
- data/lib/biz_api/api/paid_notice_restapis_api.rb +328 -0
- data/lib/biz_api/api/payment_receipts_restapis_api.rb +168 -0
- data/lib/biz_api/api_client.rb +394 -0
- data/lib/biz_api/api_error.rb +58 -0
- data/lib/biz_api/configuration.rb +333 -0
- data/lib/biz_api/models/app_info.rb +232 -0
- data/lib/biz_api/models/auth_request.rb +250 -0
- data/lib/biz_api/models/biz_event.rb +396 -0
- data/lib/biz_api/models/cart_item.rb +287 -0
- data/lib/biz_api/models/creditor.rb +250 -0
- data/lib/biz_api/models/ct_receipt_model_response.rb +552 -0
- data/lib/biz_api/models/debtor.rb +295 -0
- data/lib/biz_api/models/debtor_position.rb +241 -0
- data/lib/biz_api/models/details.rb +232 -0
- data/lib/biz_api/models/info.rb +286 -0
- data/lib/biz_api/models/info_notice.rb +392 -0
- data/lib/biz_api/models/info_transaction.rb +250 -0
- data/lib/biz_api/models/info_transaction_view.rb +350 -0
- data/lib/biz_api/models/map_entry.rb +223 -0
- data/lib/biz_api/models/mbd.rb +250 -0
- data/lib/biz_api/models/notice_detail_response.rb +225 -0
- data/lib/biz_api/models/notice_list_item.rb +326 -0
- data/lib/biz_api/models/notice_list_wrap_response.rb +223 -0
- data/lib/biz_api/models/page_info.rb +273 -0
- data/lib/biz_api/models/payer.rb +295 -0
- data/lib/biz_api/models/payment_authorization_request.rb +259 -0
- data/lib/biz_api/models/payment_info.rb +360 -0
- data/lib/biz_api/models/problem_json.rb +259 -0
- data/lib/biz_api/models/psp.rb +268 -0
- data/lib/biz_api/models/transaction.rb +331 -0
- data/lib/biz_api/models/transaction_detail_response.rb +225 -0
- data/lib/biz_api/models/transaction_details.rb +259 -0
- data/lib/biz_api/models/transaction_list_item.rb +277 -0
- data/lib/biz_api/models/transaction_list_wrap_response.rb +225 -0
- data/lib/biz_api/models/transaction_psp.rb +232 -0
- data/lib/biz_api/models/transfer.rb +288 -0
- data/lib/biz_api/models/transfer_pa.rb +345 -0
- data/lib/biz_api/models/user.rb +302 -0
- data/lib/biz_api/models/user_detail.rb +230 -0
- data/lib/biz_api/models/wallet_info.rb +241 -0
- data/lib/biz_api/models/wallet_item.rb +322 -0
- data/lib/biz_api/version.rb +15 -0
- data/lib/biz_api.rb +80 -0
- data/spec/api/biz_events_helpdesk_api_spec.rb +60 -0
- data/spec/api/home_api_spec.rb +47 -0
- data/spec/api/io_transactions_restapis_api_spec.rb +96 -0
- data/spec/api/paid_notice_restapis_api_spec.rb +93 -0
- data/spec/api/payment_receipts_restapis_api_spec.rb +62 -0
- data/spec/models/app_info_spec.rb +48 -0
- data/spec/models/auth_request_spec.rb +60 -0
- data/spec/models/biz_event_spec.rb +136 -0
- data/spec/models/cart_item_spec.rb +66 -0
- data/spec/models/creditor_spec.rb +60 -0
- data/spec/models/ct_receipt_model_response_spec.rb +198 -0
- data/spec/models/debtor_position_spec.rb +54 -0
- data/spec/models/debtor_spec.rb +90 -0
- data/spec/models/details_spec.rb +48 -0
- data/spec/models/info_notice_spec.rb +104 -0
- data/spec/models/info_spec.rb +84 -0
- data/spec/models/info_transaction_spec.rb +60 -0
- data/spec/models/info_transaction_view_spec.rb +104 -0
- data/spec/models/map_entry_spec.rb +42 -0
- data/spec/models/mbd_spec.rb +60 -0
- data/spec/models/notice_detail_response_spec.rb +42 -0
- data/spec/models/notice_list_item_spec.rb +78 -0
- data/spec/models/notice_list_wrap_response_spec.rb +36 -0
- data/spec/models/page_info_spec.rb +54 -0
- data/spec/models/payer_spec.rb +90 -0
- data/spec/models/payment_authorization_request_spec.rb +66 -0
- data/spec/models/payment_info_spec.rb +132 -0
- data/spec/models/problem_json_spec.rb +48 -0
- data/spec/models/psp_spec.rb +72 -0
- data/spec/models/transaction_detail_response_spec.rb +42 -0
- data/spec/models/transaction_details_spec.rb +66 -0
- data/spec/models/transaction_list_item_spec.rb +78 -0
- data/spec/models/transaction_list_wrap_response_spec.rb +42 -0
- data/spec/models/transaction_psp_spec.rb +48 -0
- data/spec/models/transaction_spec.rb +114 -0
- data/spec/models/transfer_pa_spec.rb +78 -0
- data/spec/models/transfer_spec.rb +84 -0
- data/spec/models/user_detail_spec.rb +42 -0
- data/spec/models/user_spec.rb +76 -0
- data/spec/models/wallet_info_spec.rb +54 -0
- data/spec/models/wallet_item_spec.rb +88 -0
- data/spec/spec_helper.rb +111 -0
- metadata +259 -0
data/docs/PageInfo.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# BizReceipts::PageInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **page** | **Integer** | Page number | |
|
|
8
|
+
| **limit** | **Integer** | Required number of items per page | |
|
|
9
|
+
| **items_found** | **Integer** | Number of items found. (The last page may have fewer elements than required) | |
|
|
10
|
+
| **total_pages** | **Integer** | Total number of pages | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'biz_api'
|
|
16
|
+
|
|
17
|
+
instance = BizReceipts::PageInfo.new(
|
|
18
|
+
page: null,
|
|
19
|
+
limit: null,
|
|
20
|
+
items_found: null,
|
|
21
|
+
total_pages: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,322 @@
|
|
|
1
|
+
# BizReceipts::PaidNoticeRESTAPIsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.uat.platform.pagopa.it/bizevents/service/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**disable_paid_notice**](PaidNoticeRESTAPIsApi.md#disable_paid_notice) | **POST** /paids/{event-id}/disable | Disable the paid notice details given its id. |
|
|
8
|
+
| [**generate_pdf**](PaidNoticeRESTAPIsApi.md#generate_pdf) | **GET** /paids/{event-id}/pdf | Retrieve the PDF receipt given event id. |
|
|
9
|
+
| [**get_paid_notice_detail**](PaidNoticeRESTAPIsApi.md#get_paid_notice_detail) | **GET** /paids/{event-id} | Retrieve the paid notice details given its id. |
|
|
10
|
+
| [**get_paid_notices**](PaidNoticeRESTAPIsApi.md#get_paid_notices) | **GET** /paids | Retrieve the paged transaction list from biz events. |
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## disable_paid_notice
|
|
14
|
+
|
|
15
|
+
> disable_paid_notice(x_fiscal_code, event_id, opts)
|
|
16
|
+
|
|
17
|
+
Disable the paid notice details given its id.
|
|
18
|
+
|
|
19
|
+
### Examples
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'time'
|
|
23
|
+
require 'biz_api'
|
|
24
|
+
# setup authorization
|
|
25
|
+
BizReceipts.configure do |config|
|
|
26
|
+
# Configure API key authorization: ApiKey
|
|
27
|
+
config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
|
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
29
|
+
# config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
api_instance = BizReceipts::PaidNoticeRESTAPIsApi.new
|
|
33
|
+
x_fiscal_code = 'x_fiscal_code_example' # String |
|
|
34
|
+
event_id = 'event_id_example' # String | The id of the paid event.
|
|
35
|
+
opts = {
|
|
36
|
+
x_request_id: 'x_request_id_example' # String | This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
begin
|
|
40
|
+
# Disable the paid notice details given its id.
|
|
41
|
+
api_instance.disable_paid_notice(x_fiscal_code, event_id, opts)
|
|
42
|
+
rescue BizReceipts::ApiError => e
|
|
43
|
+
puts "Error when calling PaidNoticeRESTAPIsApi->disable_paid_notice: #{e}"
|
|
44
|
+
end
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
#### Using the disable_paid_notice_with_http_info variant
|
|
48
|
+
|
|
49
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
50
|
+
|
|
51
|
+
> <Array(nil, Integer, Hash)> disable_paid_notice_with_http_info(x_fiscal_code, event_id, opts)
|
|
52
|
+
|
|
53
|
+
```ruby
|
|
54
|
+
begin
|
|
55
|
+
# Disable the paid notice details given its id.
|
|
56
|
+
data, status_code, headers = api_instance.disable_paid_notice_with_http_info(x_fiscal_code, event_id, opts)
|
|
57
|
+
p status_code # => 2xx
|
|
58
|
+
p headers # => { ... }
|
|
59
|
+
p data # => nil
|
|
60
|
+
rescue BizReceipts::ApiError => e
|
|
61
|
+
puts "Error when calling PaidNoticeRESTAPIsApi->disable_paid_notice_with_http_info: #{e}"
|
|
62
|
+
end
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### Parameters
|
|
66
|
+
|
|
67
|
+
| Name | Type | Description | Notes |
|
|
68
|
+
| ---- | ---- | ----------- | ----- |
|
|
69
|
+
| **x_fiscal_code** | **String** | | |
|
|
70
|
+
| **event_id** | **String** | The id of the paid event. | |
|
|
71
|
+
| **x_request_id** | **String** | This header identifies the call, if not passed it is self-generated. This ID is returned in the response. | [optional] |
|
|
72
|
+
|
|
73
|
+
### Return type
|
|
74
|
+
|
|
75
|
+
nil (empty response body)
|
|
76
|
+
|
|
77
|
+
### Authorization
|
|
78
|
+
|
|
79
|
+
[ApiKey](../README.md#ApiKey)
|
|
80
|
+
|
|
81
|
+
### HTTP request headers
|
|
82
|
+
|
|
83
|
+
- **Content-Type**: Not defined
|
|
84
|
+
- **Accept**: application/json
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
## generate_pdf
|
|
88
|
+
|
|
89
|
+
> File generate_pdf(x_fiscal_code, event_id, opts)
|
|
90
|
+
|
|
91
|
+
Retrieve the PDF receipt given event id.
|
|
92
|
+
|
|
93
|
+
### Examples
|
|
94
|
+
|
|
95
|
+
```ruby
|
|
96
|
+
require 'time'
|
|
97
|
+
require 'biz_api'
|
|
98
|
+
# setup authorization
|
|
99
|
+
BizReceipts.configure do |config|
|
|
100
|
+
# Configure API key authorization: ApiKey
|
|
101
|
+
config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
|
|
102
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
103
|
+
# config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
api_instance = BizReceipts::PaidNoticeRESTAPIsApi.new
|
|
107
|
+
x_fiscal_code = 'x_fiscal_code_example' # String |
|
|
108
|
+
event_id = 'event_id_example' # String | The id of the paid event.
|
|
109
|
+
opts = {
|
|
110
|
+
x_request_id: 'x_request_id_example' # String | This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
begin
|
|
114
|
+
# Retrieve the PDF receipt given event id.
|
|
115
|
+
result = api_instance.generate_pdf(x_fiscal_code, event_id, opts)
|
|
116
|
+
p result
|
|
117
|
+
rescue BizReceipts::ApiError => e
|
|
118
|
+
puts "Error when calling PaidNoticeRESTAPIsApi->generate_pdf: #{e}"
|
|
119
|
+
end
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
#### Using the generate_pdf_with_http_info variant
|
|
123
|
+
|
|
124
|
+
This returns an Array which contains the response data, status code and headers.
|
|
125
|
+
|
|
126
|
+
> <Array(File, Integer, Hash)> generate_pdf_with_http_info(x_fiscal_code, event_id, opts)
|
|
127
|
+
|
|
128
|
+
```ruby
|
|
129
|
+
begin
|
|
130
|
+
# Retrieve the PDF receipt given event id.
|
|
131
|
+
data, status_code, headers = api_instance.generate_pdf_with_http_info(x_fiscal_code, event_id, opts)
|
|
132
|
+
p status_code # => 2xx
|
|
133
|
+
p headers # => { ... }
|
|
134
|
+
p data # => File
|
|
135
|
+
rescue BizReceipts::ApiError => e
|
|
136
|
+
puts "Error when calling PaidNoticeRESTAPIsApi->generate_pdf_with_http_info: #{e}"
|
|
137
|
+
end
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### Parameters
|
|
141
|
+
|
|
142
|
+
| Name | Type | Description | Notes |
|
|
143
|
+
| ---- | ---- | ----------- | ----- |
|
|
144
|
+
| **x_fiscal_code** | **String** | | |
|
|
145
|
+
| **event_id** | **String** | The id of the paid event. | |
|
|
146
|
+
| **x_request_id** | **String** | This header identifies the call, if not passed it is self-generated. This ID is returned in the response. | [optional] |
|
|
147
|
+
|
|
148
|
+
### Return type
|
|
149
|
+
|
|
150
|
+
**File**
|
|
151
|
+
|
|
152
|
+
### Authorization
|
|
153
|
+
|
|
154
|
+
[ApiKey](../README.md#ApiKey)
|
|
155
|
+
|
|
156
|
+
### HTTP request headers
|
|
157
|
+
|
|
158
|
+
- **Content-Type**: Not defined
|
|
159
|
+
- **Accept**: application/pdf, application/json
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
## get_paid_notice_detail
|
|
163
|
+
|
|
164
|
+
> <NoticeDetailResponse> get_paid_notice_detail(x_fiscal_code, event_id, opts)
|
|
165
|
+
|
|
166
|
+
Retrieve the paid notice details given its id.
|
|
167
|
+
|
|
168
|
+
### Examples
|
|
169
|
+
|
|
170
|
+
```ruby
|
|
171
|
+
require 'time'
|
|
172
|
+
require 'biz_api'
|
|
173
|
+
# setup authorization
|
|
174
|
+
BizReceipts.configure do |config|
|
|
175
|
+
# Configure API key authorization: ApiKey
|
|
176
|
+
config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
|
|
177
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
178
|
+
# config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
|
|
179
|
+
end
|
|
180
|
+
|
|
181
|
+
api_instance = BizReceipts::PaidNoticeRESTAPIsApi.new
|
|
182
|
+
x_fiscal_code = 'x_fiscal_code_example' # String |
|
|
183
|
+
event_id = 'event_id_example' # String | The id of the paid event.
|
|
184
|
+
opts = {
|
|
185
|
+
x_request_id: 'x_request_id_example' # String | This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
begin
|
|
189
|
+
# Retrieve the paid notice details given its id.
|
|
190
|
+
result = api_instance.get_paid_notice_detail(x_fiscal_code, event_id, opts)
|
|
191
|
+
p result
|
|
192
|
+
rescue BizReceipts::ApiError => e
|
|
193
|
+
puts "Error when calling PaidNoticeRESTAPIsApi->get_paid_notice_detail: #{e}"
|
|
194
|
+
end
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
#### Using the get_paid_notice_detail_with_http_info variant
|
|
198
|
+
|
|
199
|
+
This returns an Array which contains the response data, status code and headers.
|
|
200
|
+
|
|
201
|
+
> <Array(<NoticeDetailResponse>, Integer, Hash)> get_paid_notice_detail_with_http_info(x_fiscal_code, event_id, opts)
|
|
202
|
+
|
|
203
|
+
```ruby
|
|
204
|
+
begin
|
|
205
|
+
# Retrieve the paid notice details given its id.
|
|
206
|
+
data, status_code, headers = api_instance.get_paid_notice_detail_with_http_info(x_fiscal_code, event_id, opts)
|
|
207
|
+
p status_code # => 2xx
|
|
208
|
+
p headers # => { ... }
|
|
209
|
+
p data # => <NoticeDetailResponse>
|
|
210
|
+
rescue BizReceipts::ApiError => e
|
|
211
|
+
puts "Error when calling PaidNoticeRESTAPIsApi->get_paid_notice_detail_with_http_info: #{e}"
|
|
212
|
+
end
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
### Parameters
|
|
216
|
+
|
|
217
|
+
| Name | Type | Description | Notes |
|
|
218
|
+
| ---- | ---- | ----------- | ----- |
|
|
219
|
+
| **x_fiscal_code** | **String** | | |
|
|
220
|
+
| **event_id** | **String** | The id of the paid event. | |
|
|
221
|
+
| **x_request_id** | **String** | This header identifies the call, if not passed it is self-generated. This ID is returned in the response. | [optional] |
|
|
222
|
+
|
|
223
|
+
### Return type
|
|
224
|
+
|
|
225
|
+
[**NoticeDetailResponse**](NoticeDetailResponse.md)
|
|
226
|
+
|
|
227
|
+
### Authorization
|
|
228
|
+
|
|
229
|
+
[ApiKey](../README.md#ApiKey)
|
|
230
|
+
|
|
231
|
+
### HTTP request headers
|
|
232
|
+
|
|
233
|
+
- **Content-Type**: Not defined
|
|
234
|
+
- **Accept**: application/json
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
## get_paid_notices
|
|
238
|
+
|
|
239
|
+
> <NoticeListWrapResponse> get_paid_notices(x_fiscal_code, opts)
|
|
240
|
+
|
|
241
|
+
Retrieve the paged transaction list from biz events.
|
|
242
|
+
|
|
243
|
+
This operation is deprecated. Use Paid Notice APIs instead
|
|
244
|
+
|
|
245
|
+
### Examples
|
|
246
|
+
|
|
247
|
+
```ruby
|
|
248
|
+
require 'time'
|
|
249
|
+
require 'biz_api'
|
|
250
|
+
# setup authorization
|
|
251
|
+
BizReceipts.configure do |config|
|
|
252
|
+
# Configure API key authorization: ApiKey
|
|
253
|
+
config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
|
|
254
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
255
|
+
# config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
|
|
256
|
+
end
|
|
257
|
+
|
|
258
|
+
api_instance = BizReceipts::PaidNoticeRESTAPIsApi.new
|
|
259
|
+
x_fiscal_code = 'x_fiscal_code_example' # String |
|
|
260
|
+
opts = {
|
|
261
|
+
x_request_id: 'x_request_id_example', # String | This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
|
|
262
|
+
x_continuation_token: 'x_continuation_token_example', # String |
|
|
263
|
+
size: 56, # Integer |
|
|
264
|
+
is_payer: true, # Boolean | Filter by payer
|
|
265
|
+
is_debtor: true, # Boolean | Filter by debtor
|
|
266
|
+
orderby: 'TRANSACTION_DATE', # String | Order by TRANSACTION_DATE
|
|
267
|
+
ordering: 'ASC' # String | Direction of ordering
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
begin
|
|
271
|
+
# Retrieve the paged transaction list from biz events.
|
|
272
|
+
result = api_instance.get_paid_notices(x_fiscal_code, opts)
|
|
273
|
+
p result
|
|
274
|
+
rescue BizReceipts::ApiError => e
|
|
275
|
+
puts "Error when calling PaidNoticeRESTAPIsApi->get_paid_notices: #{e}"
|
|
276
|
+
end
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
#### Using the get_paid_notices_with_http_info variant
|
|
280
|
+
|
|
281
|
+
This returns an Array which contains the response data, status code and headers.
|
|
282
|
+
|
|
283
|
+
> <Array(<NoticeListWrapResponse>, Integer, Hash)> get_paid_notices_with_http_info(x_fiscal_code, opts)
|
|
284
|
+
|
|
285
|
+
```ruby
|
|
286
|
+
begin
|
|
287
|
+
# Retrieve the paged transaction list from biz events.
|
|
288
|
+
data, status_code, headers = api_instance.get_paid_notices_with_http_info(x_fiscal_code, opts)
|
|
289
|
+
p status_code # => 2xx
|
|
290
|
+
p headers # => { ... }
|
|
291
|
+
p data # => <NoticeListWrapResponse>
|
|
292
|
+
rescue BizReceipts::ApiError => e
|
|
293
|
+
puts "Error when calling PaidNoticeRESTAPIsApi->get_paid_notices_with_http_info: #{e}"
|
|
294
|
+
end
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
### Parameters
|
|
298
|
+
|
|
299
|
+
| Name | Type | Description | Notes |
|
|
300
|
+
| ---- | ---- | ----------- | ----- |
|
|
301
|
+
| **x_fiscal_code** | **String** | | |
|
|
302
|
+
| **x_request_id** | **String** | This header identifies the call, if not passed it is self-generated. This ID is returned in the response. | [optional] |
|
|
303
|
+
| **x_continuation_token** | **String** | | [optional] |
|
|
304
|
+
| **size** | **Integer** | | [optional][default to 10] |
|
|
305
|
+
| **is_payer** | **Boolean** | Filter by payer | [optional] |
|
|
306
|
+
| **is_debtor** | **Boolean** | Filter by debtor | [optional] |
|
|
307
|
+
| **orderby** | **String** | Order by TRANSACTION_DATE | [optional][default to 'TRANSACTION_DATE'] |
|
|
308
|
+
| **ordering** | **String** | Direction of ordering | [optional][default to 'DESC'] |
|
|
309
|
+
|
|
310
|
+
### Return type
|
|
311
|
+
|
|
312
|
+
[**NoticeListWrapResponse**](NoticeListWrapResponse.md)
|
|
313
|
+
|
|
314
|
+
### Authorization
|
|
315
|
+
|
|
316
|
+
[ApiKey](../README.md#ApiKey)
|
|
317
|
+
|
|
318
|
+
### HTTP request headers
|
|
319
|
+
|
|
320
|
+
- **Content-Type**: Not defined
|
|
321
|
+
- **Accept**: application/json, */*
|
|
322
|
+
|
data/docs/Payer.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# BizReceipts::Payer
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **full_name** | **String** | | [optional] |
|
|
8
|
+
| **entity_unique_identifier_type** | **String** | | [optional] |
|
|
9
|
+
| **entity_unique_identifier_value** | **String** | | [optional] |
|
|
10
|
+
| **street_name** | **String** | | [optional] |
|
|
11
|
+
| **civic_number** | **String** | | [optional] |
|
|
12
|
+
| **postal_code** | **String** | | [optional] |
|
|
13
|
+
| **city** | **String** | | [optional] |
|
|
14
|
+
| **state_province_region** | **String** | | [optional] |
|
|
15
|
+
| **country** | **String** | | [optional] |
|
|
16
|
+
| **email** | **String** | | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'biz_api'
|
|
22
|
+
|
|
23
|
+
instance = BizReceipts::Payer.new(
|
|
24
|
+
full_name: null,
|
|
25
|
+
entity_unique_identifier_type: null,
|
|
26
|
+
entity_unique_identifier_value: null,
|
|
27
|
+
street_name: null,
|
|
28
|
+
civic_number: null,
|
|
29
|
+
postal_code: null,
|
|
30
|
+
city: null,
|
|
31
|
+
state_province_region: null,
|
|
32
|
+
country: null,
|
|
33
|
+
email: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# BizReceipts::PaymentAuthorizationRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **auth_outcome** | **String** | | [optional] |
|
|
8
|
+
| **request_id** | **String** | | [optional] |
|
|
9
|
+
| **correlation_id** | **String** | | [optional] |
|
|
10
|
+
| **auth_code** | **String** | | [optional] |
|
|
11
|
+
| **payment_method_type** | **String** | | [optional] |
|
|
12
|
+
| **details** | [**Details**](Details.md) | | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'biz_api'
|
|
18
|
+
|
|
19
|
+
instance = BizReceipts::PaymentAuthorizationRequest.new(
|
|
20
|
+
auth_outcome: null,
|
|
21
|
+
request_id: null,
|
|
22
|
+
correlation_id: null,
|
|
23
|
+
auth_code: null,
|
|
24
|
+
payment_method_type: null,
|
|
25
|
+
details: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
data/docs/PaymentInfo.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# BizReceipts::PaymentInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **payment_date_time** | **String** | | [optional] |
|
|
8
|
+
| **application_date** | **String** | | [optional] |
|
|
9
|
+
| **transfer_date** | **String** | | [optional] |
|
|
10
|
+
| **due_date** | **String** | | [optional] |
|
|
11
|
+
| **payment_token** | **String** | | [optional] |
|
|
12
|
+
| **amount** | **String** | | [optional] |
|
|
13
|
+
| **fee** | **String** | | [optional] |
|
|
14
|
+
| **primary_ci_incurred_fee** | **String** | | [optional] |
|
|
15
|
+
| **id_bundle** | **String** | | [optional] |
|
|
16
|
+
| **id_ci_bundle** | **String** | | [optional] |
|
|
17
|
+
| **total_notice** | **String** | | [optional] |
|
|
18
|
+
| **payment_method** | **String** | | [optional] |
|
|
19
|
+
| **touchpoint** | **String** | | [optional] |
|
|
20
|
+
| **remittance_information** | **String** | | [optional] |
|
|
21
|
+
| **description** | **String** | | [optional] |
|
|
22
|
+
| **metadata** | [**Array<MapEntry>**](MapEntry.md) | | [optional] |
|
|
23
|
+
| **iur** | **String** | | [optional] |
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```ruby
|
|
28
|
+
require 'biz_api'
|
|
29
|
+
|
|
30
|
+
instance = BizReceipts::PaymentInfo.new(
|
|
31
|
+
payment_date_time: null,
|
|
32
|
+
application_date: null,
|
|
33
|
+
transfer_date: null,
|
|
34
|
+
due_date: null,
|
|
35
|
+
payment_token: null,
|
|
36
|
+
amount: null,
|
|
37
|
+
fee: null,
|
|
38
|
+
primary_ci_incurred_fee: null,
|
|
39
|
+
id_bundle: null,
|
|
40
|
+
id_ci_bundle: null,
|
|
41
|
+
total_notice: null,
|
|
42
|
+
payment_method: null,
|
|
43
|
+
touchpoint: null,
|
|
44
|
+
remittance_information: null,
|
|
45
|
+
description: null,
|
|
46
|
+
metadata: null,
|
|
47
|
+
iur: null
|
|
48
|
+
)
|
|
49
|
+
```
|
|
50
|
+
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
# BizReceipts::PaymentReceiptsRESTAPIsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.uat.platform.pagopa.it/bizevents/service/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**get_organization_receipt_iur**](PaymentReceiptsRESTAPIsApi.md#get_organization_receipt_iur) | **GET** /organizations/{organizationfiscalcode}/receipts/{iur} | The organization get the receipt for the creditor institution using IUR. |
|
|
8
|
+
| [**get_organization_receipt_iuv_iur**](PaymentReceiptsRESTAPIsApi.md#get_organization_receipt_iuv_iur) | **GET** /organizations/{organizationfiscalcode}/receipts/{iur}/paymentoptions/{iuv} | The organization get the receipt for the creditor institution using IUV and IUR. |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## get_organization_receipt_iur
|
|
12
|
+
|
|
13
|
+
> <CtReceiptModelResponse> get_organization_receipt_iur(organizationfiscalcode, iur, opts)
|
|
14
|
+
|
|
15
|
+
The organization get the receipt for the creditor institution using IUR.
|
|
16
|
+
|
|
17
|
+
### Examples
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'time'
|
|
21
|
+
require 'biz_api'
|
|
22
|
+
# setup authorization
|
|
23
|
+
BizReceipts.configure do |config|
|
|
24
|
+
# Configure API key authorization: ApiKey
|
|
25
|
+
config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
|
|
26
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
27
|
+
# config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
api_instance = BizReceipts::PaymentReceiptsRESTAPIsApi.new
|
|
31
|
+
organizationfiscalcode = 'organizationfiscalcode_example' # String | The fiscal code of the Organization.
|
|
32
|
+
iur = 'iur_example' # String | The unique reference of the operation assigned to the payment (Payment Token).
|
|
33
|
+
opts = {
|
|
34
|
+
x_request_id: 'x_request_id_example' # String | This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
begin
|
|
38
|
+
# The organization get the receipt for the creditor institution using IUR.
|
|
39
|
+
result = api_instance.get_organization_receipt_iur(organizationfiscalcode, iur, opts)
|
|
40
|
+
p result
|
|
41
|
+
rescue BizReceipts::ApiError => e
|
|
42
|
+
puts "Error when calling PaymentReceiptsRESTAPIsApi->get_organization_receipt_iur: #{e}"
|
|
43
|
+
end
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
#### Using the get_organization_receipt_iur_with_http_info variant
|
|
47
|
+
|
|
48
|
+
This returns an Array which contains the response data, status code and headers.
|
|
49
|
+
|
|
50
|
+
> <Array(<CtReceiptModelResponse>, Integer, Hash)> get_organization_receipt_iur_with_http_info(organizationfiscalcode, iur, opts)
|
|
51
|
+
|
|
52
|
+
```ruby
|
|
53
|
+
begin
|
|
54
|
+
# The organization get the receipt for the creditor institution using IUR.
|
|
55
|
+
data, status_code, headers = api_instance.get_organization_receipt_iur_with_http_info(organizationfiscalcode, iur, opts)
|
|
56
|
+
p status_code # => 2xx
|
|
57
|
+
p headers # => { ... }
|
|
58
|
+
p data # => <CtReceiptModelResponse>
|
|
59
|
+
rescue BizReceipts::ApiError => e
|
|
60
|
+
puts "Error when calling PaymentReceiptsRESTAPIsApi->get_organization_receipt_iur_with_http_info: #{e}"
|
|
61
|
+
end
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Parameters
|
|
65
|
+
|
|
66
|
+
| Name | Type | Description | Notes |
|
|
67
|
+
| ---- | ---- | ----------- | ----- |
|
|
68
|
+
| **organizationfiscalcode** | **String** | The fiscal code of the Organization. | |
|
|
69
|
+
| **iur** | **String** | The unique reference of the operation assigned to the payment (Payment Token). | |
|
|
70
|
+
| **x_request_id** | **String** | This header identifies the call, if not passed it is self-generated. This ID is returned in the response. | [optional] |
|
|
71
|
+
|
|
72
|
+
### Return type
|
|
73
|
+
|
|
74
|
+
[**CtReceiptModelResponse**](CtReceiptModelResponse.md)
|
|
75
|
+
|
|
76
|
+
### Authorization
|
|
77
|
+
|
|
78
|
+
[ApiKey](../README.md#ApiKey)
|
|
79
|
+
|
|
80
|
+
### HTTP request headers
|
|
81
|
+
|
|
82
|
+
- **Content-Type**: Not defined
|
|
83
|
+
- **Accept**: application/json
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
## get_organization_receipt_iuv_iur
|
|
87
|
+
|
|
88
|
+
> <CtReceiptModelResponse> get_organization_receipt_iuv_iur(organizationfiscalcode, iur, iuv, opts)
|
|
89
|
+
|
|
90
|
+
The organization get the receipt for the creditor institution using IUV and IUR.
|
|
91
|
+
|
|
92
|
+
### Examples
|
|
93
|
+
|
|
94
|
+
```ruby
|
|
95
|
+
require 'time'
|
|
96
|
+
require 'biz_api'
|
|
97
|
+
# setup authorization
|
|
98
|
+
BizReceipts.configure do |config|
|
|
99
|
+
# Configure API key authorization: ApiKey
|
|
100
|
+
config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
|
|
101
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
102
|
+
# config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
api_instance = BizReceipts::PaymentReceiptsRESTAPIsApi.new
|
|
106
|
+
organizationfiscalcode = 'organizationfiscalcode_example' # String | The fiscal code of the Organization.
|
|
107
|
+
iur = 'iur_example' # String | The unique reference of the operation assigned to the payment (Payment Token).
|
|
108
|
+
iuv = 'iuv_example' # String | The unique payment identification. Alphanumeric code that uniquely associates and identifies three key elements of a payment: reason, payer, amount
|
|
109
|
+
opts = {
|
|
110
|
+
x_request_id: 'x_request_id_example' # String | This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
begin
|
|
114
|
+
# The organization get the receipt for the creditor institution using IUV and IUR.
|
|
115
|
+
result = api_instance.get_organization_receipt_iuv_iur(organizationfiscalcode, iur, iuv, opts)
|
|
116
|
+
p result
|
|
117
|
+
rescue BizReceipts::ApiError => e
|
|
118
|
+
puts "Error when calling PaymentReceiptsRESTAPIsApi->get_organization_receipt_iuv_iur: #{e}"
|
|
119
|
+
end
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
#### Using the get_organization_receipt_iuv_iur_with_http_info variant
|
|
123
|
+
|
|
124
|
+
This returns an Array which contains the response data, status code and headers.
|
|
125
|
+
|
|
126
|
+
> <Array(<CtReceiptModelResponse>, Integer, Hash)> get_organization_receipt_iuv_iur_with_http_info(organizationfiscalcode, iur, iuv, opts)
|
|
127
|
+
|
|
128
|
+
```ruby
|
|
129
|
+
begin
|
|
130
|
+
# The organization get the receipt for the creditor institution using IUV and IUR.
|
|
131
|
+
data, status_code, headers = api_instance.get_organization_receipt_iuv_iur_with_http_info(organizationfiscalcode, iur, iuv, opts)
|
|
132
|
+
p status_code # => 2xx
|
|
133
|
+
p headers # => { ... }
|
|
134
|
+
p data # => <CtReceiptModelResponse>
|
|
135
|
+
rescue BizReceipts::ApiError => e
|
|
136
|
+
puts "Error when calling PaymentReceiptsRESTAPIsApi->get_organization_receipt_iuv_iur_with_http_info: #{e}"
|
|
137
|
+
end
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### Parameters
|
|
141
|
+
|
|
142
|
+
| Name | Type | Description | Notes |
|
|
143
|
+
| ---- | ---- | ----------- | ----- |
|
|
144
|
+
| **organizationfiscalcode** | **String** | The fiscal code of the Organization. | |
|
|
145
|
+
| **iur** | **String** | The unique reference of the operation assigned to the payment (Payment Token). | |
|
|
146
|
+
| **iuv** | **String** | The unique payment identification. Alphanumeric code that uniquely associates and identifies three key elements of a payment: reason, payer, amount | |
|
|
147
|
+
| **x_request_id** | **String** | This header identifies the call, if not passed it is self-generated. This ID is returned in the response. | [optional] |
|
|
148
|
+
|
|
149
|
+
### Return type
|
|
150
|
+
|
|
151
|
+
[**CtReceiptModelResponse**](CtReceiptModelResponse.md)
|
|
152
|
+
|
|
153
|
+
### Authorization
|
|
154
|
+
|
|
155
|
+
[ApiKey](../README.md#ApiKey)
|
|
156
|
+
|
|
157
|
+
### HTTP request headers
|
|
158
|
+
|
|
159
|
+
- **Content-Type**: Not defined
|
|
160
|
+
- **Accept**: application/json
|
|
161
|
+
|
data/docs/ProblemJson.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# BizReceipts::ProblemJson
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable | [optional] |
|
|
8
|
+
| **status** | **Integer** | The HTTP status code generated by the origin server for this occurrence of the problem. | [optional] |
|
|
9
|
+
| **detail** | **String** | A human readable explanation specific to this occurrence of the problem. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'biz_api'
|
|
15
|
+
|
|
16
|
+
instance = BizReceipts::ProblemJson.new(
|
|
17
|
+
title: null,
|
|
18
|
+
status: 200,
|
|
19
|
+
detail: There was an error processing the request
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/Psp.md
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# BizReceipts::Psp
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id_psp** | **String** | | [optional] |
|
|
8
|
+
| **id_broker_psp** | **String** | | [optional] |
|
|
9
|
+
| **id_channel** | **String** | | [optional] |
|
|
10
|
+
| **psp** | **String** | | [optional] |
|
|
11
|
+
| **psp_partita_iva** | **String** | | [optional] |
|
|
12
|
+
| **psp_fiscal_code** | **String** | | [optional] |
|
|
13
|
+
| **channel_description** | **String** | | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'biz_api'
|
|
19
|
+
|
|
20
|
+
instance = BizReceipts::Psp.new(
|
|
21
|
+
id_psp: null,
|
|
22
|
+
id_broker_psp: null,
|
|
23
|
+
id_channel: null,
|
|
24
|
+
psp: null,
|
|
25
|
+
psp_partita_iva: null,
|
|
26
|
+
psp_fiscal_code: null,
|
|
27
|
+
channel_description: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|