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
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: '0509ecf27511852c9ac4f2f1439870a08ae0408875cbdc7474f8b9d8307d13af'
|
|
4
|
+
data.tar.gz: a7e19747d93bcf855eae3828e07d120d96ef6c0b7b217a09532c6c7a68d7bddc
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 207fff2e38cd9f413264d92df3e75ce6a3eaad9b4f36a9780c3db65fc3d7c78b2a90bfaf2fbbb8ad7622bc344d881fad98bd4edd07355a8b17809bab7ad30886
|
|
7
|
+
data.tar.gz: c70fe7639f8af9c8305cad9b7aebf1104763227ac16066a62ceb14855c09c17f9897bb5aed3c5a9365c2aee8b8f8023555654f6cfe28a194d05274275fda4042
|
data/Gemfile
ADDED
data/README.md
ADDED
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
# biz_api
|
|
2
|
+
|
|
3
|
+
BizReceipts - the Ruby gem for the Biz-Events Service
|
|
4
|
+
|
|
5
|
+
Microservice for exposing REST APIs about payment receipts.
|
|
6
|
+
|
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
|
+
|
|
9
|
+
- API version: 0.1.72
|
|
10
|
+
- Package version: 3.9.1
|
|
11
|
+
- Generator version: 7.11.0
|
|
12
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
13
|
+
|
|
14
|
+
## Installation
|
|
15
|
+
|
|
16
|
+
### Build a gem
|
|
17
|
+
|
|
18
|
+
To build the Ruby code into a gem:
|
|
19
|
+
|
|
20
|
+
```shell
|
|
21
|
+
gem build biz_api.gemspec
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Then either install the gem locally:
|
|
25
|
+
|
|
26
|
+
```shell
|
|
27
|
+
gem install ./biz_api-3.9.1.gem
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
(for development, run `gem install --dev ./biz_api-3.9.1.gem` to install the development dependencies)
|
|
31
|
+
|
|
32
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
33
|
+
|
|
34
|
+
Finally add this to the Gemfile:
|
|
35
|
+
|
|
36
|
+
gem 'biz_api', '~> 3.9.1'
|
|
37
|
+
|
|
38
|
+
### Install from Git
|
|
39
|
+
|
|
40
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
|
41
|
+
|
|
42
|
+
gem 'biz_api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
|
43
|
+
|
|
44
|
+
### Include the Ruby code directly
|
|
45
|
+
|
|
46
|
+
Include the Ruby code directly using `-I` as follows:
|
|
47
|
+
|
|
48
|
+
```shell
|
|
49
|
+
ruby -Ilib script.rb
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Getting Started
|
|
53
|
+
|
|
54
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
|
55
|
+
|
|
56
|
+
```ruby
|
|
57
|
+
# Load the gem
|
|
58
|
+
require 'biz_api'
|
|
59
|
+
|
|
60
|
+
# Setup authorization
|
|
61
|
+
BizReceipts.configure do |config|
|
|
62
|
+
# Configure API key authorization: ApiKey
|
|
63
|
+
config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
|
|
64
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
65
|
+
# config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
api_instance = BizReceipts::BizEventsHelpdeskApi.new
|
|
69
|
+
biz_event_id = 'biz_event_id_example' # String | The id of the biz-event.
|
|
70
|
+
opts = {
|
|
71
|
+
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.
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
begin
|
|
75
|
+
#Retrieve the biz-event given its id.
|
|
76
|
+
result = api_instance.get_biz_event(biz_event_id, opts)
|
|
77
|
+
p result
|
|
78
|
+
rescue BizReceipts::ApiError => e
|
|
79
|
+
puts "Exception when calling BizEventsHelpdeskApi->get_biz_event: #{e}"
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Documentation for API Endpoints
|
|
85
|
+
|
|
86
|
+
All URIs are relative to *https://api.uat.platform.pagopa.it/bizevents/service/v1*
|
|
87
|
+
|
|
88
|
+
Class | Method | HTTP request | Description
|
|
89
|
+
------------ | ------------- | ------------- | -------------
|
|
90
|
+
*BizReceipts::BizEventsHelpdeskApi* | [**get_biz_event**](docs/BizEventsHelpdeskApi.md#get_biz_event) | **GET** /events/{biz-event-id} | Retrieve the biz-event given its id.
|
|
91
|
+
*BizReceipts::BizEventsHelpdeskApi* | [**get_biz_event_by_organization_fiscal_code_and_iuv**](docs/BizEventsHelpdeskApi.md#get_biz_event_by_organization_fiscal_code_and_iuv) | **GET** /events/organizations/{organization-fiscal-code}/iuvs/{iuv} | Retrieve the biz-event given the organization fiscal code and IUV.
|
|
92
|
+
*BizReceipts::HomeApi* | [**health_check**](docs/HomeApi.md#health_check) | **GET** /info | health check
|
|
93
|
+
*BizReceipts::IOTransactionsRESTAPIsApi* | [**disable_transaction**](docs/IOTransactionsRESTAPIsApi.md#disable_transaction) | **POST** /transactions/{transaction-id}/disable | Disable the transaction details given its id.
|
|
94
|
+
*BizReceipts::IOTransactionsRESTAPIsApi* | [**get_pdf_receipt**](docs/IOTransactionsRESTAPIsApi.md#get_pdf_receipt) | **GET** /transactions/{event-id}/pdf | Retrieve the PDF receipt given event id.
|
|
95
|
+
*BizReceipts::IOTransactionsRESTAPIsApi* | [**get_transaction_details**](docs/IOTransactionsRESTAPIsApi.md#get_transaction_details) | **GET** /transactions/{transaction-id} | Retrieve the transaction details given its id.
|
|
96
|
+
*BizReceipts::IOTransactionsRESTAPIsApi* | [**get_transaction_list**](docs/IOTransactionsRESTAPIsApi.md#get_transaction_list) | **GET** /transactions | Retrieve the paged transaction list from biz events.
|
|
97
|
+
*BizReceipts::PaidNoticeRESTAPIsApi* | [**disable_paid_notice**](docs/PaidNoticeRESTAPIsApi.md#disable_paid_notice) | **POST** /paids/{event-id}/disable | Disable the paid notice details given its id.
|
|
98
|
+
*BizReceipts::PaidNoticeRESTAPIsApi* | [**generate_pdf**](docs/PaidNoticeRESTAPIsApi.md#generate_pdf) | **GET** /paids/{event-id}/pdf | Retrieve the PDF receipt given event id.
|
|
99
|
+
*BizReceipts::PaidNoticeRESTAPIsApi* | [**get_paid_notice_detail**](docs/PaidNoticeRESTAPIsApi.md#get_paid_notice_detail) | **GET** /paids/{event-id} | Retrieve the paid notice details given its id.
|
|
100
|
+
*BizReceipts::PaidNoticeRESTAPIsApi* | [**get_paid_notices**](docs/PaidNoticeRESTAPIsApi.md#get_paid_notices) | **GET** /paids | Retrieve the paged transaction list from biz events.
|
|
101
|
+
*BizReceipts::PaymentReceiptsRESTAPIsApi* | [**get_organization_receipt_iur**](docs/PaymentReceiptsRESTAPIsApi.md#get_organization_receipt_iur) | **GET** /organizations/{organizationfiscalcode}/receipts/{iur} | The organization get the receipt for the creditor institution using IUR.
|
|
102
|
+
*BizReceipts::PaymentReceiptsRESTAPIsApi* | [**get_organization_receipt_iuv_iur**](docs/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.
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
## Documentation for Models
|
|
106
|
+
|
|
107
|
+
- [BizReceipts::AppInfo](docs/AppInfo.md)
|
|
108
|
+
- [BizReceipts::AuthRequest](docs/AuthRequest.md)
|
|
109
|
+
- [BizReceipts::BizEvent](docs/BizEvent.md)
|
|
110
|
+
- [BizReceipts::CartItem](docs/CartItem.md)
|
|
111
|
+
- [BizReceipts::Creditor](docs/Creditor.md)
|
|
112
|
+
- [BizReceipts::CtReceiptModelResponse](docs/CtReceiptModelResponse.md)
|
|
113
|
+
- [BizReceipts::Debtor](docs/Debtor.md)
|
|
114
|
+
- [BizReceipts::DebtorPosition](docs/DebtorPosition.md)
|
|
115
|
+
- [BizReceipts::Details](docs/Details.md)
|
|
116
|
+
- [BizReceipts::Info](docs/Info.md)
|
|
117
|
+
- [BizReceipts::InfoNotice](docs/InfoNotice.md)
|
|
118
|
+
- [BizReceipts::InfoTransaction](docs/InfoTransaction.md)
|
|
119
|
+
- [BizReceipts::InfoTransactionView](docs/InfoTransactionView.md)
|
|
120
|
+
- [BizReceipts::MBD](docs/MBD.md)
|
|
121
|
+
- [BizReceipts::MapEntry](docs/MapEntry.md)
|
|
122
|
+
- [BizReceipts::NoticeDetailResponse](docs/NoticeDetailResponse.md)
|
|
123
|
+
- [BizReceipts::NoticeListItem](docs/NoticeListItem.md)
|
|
124
|
+
- [BizReceipts::NoticeListWrapResponse](docs/NoticeListWrapResponse.md)
|
|
125
|
+
- [BizReceipts::PageInfo](docs/PageInfo.md)
|
|
126
|
+
- [BizReceipts::Payer](docs/Payer.md)
|
|
127
|
+
- [BizReceipts::PaymentAuthorizationRequest](docs/PaymentAuthorizationRequest.md)
|
|
128
|
+
- [BizReceipts::PaymentInfo](docs/PaymentInfo.md)
|
|
129
|
+
- [BizReceipts::ProblemJson](docs/ProblemJson.md)
|
|
130
|
+
- [BizReceipts::Psp](docs/Psp.md)
|
|
131
|
+
- [BizReceipts::Transaction](docs/Transaction.md)
|
|
132
|
+
- [BizReceipts::TransactionDetailResponse](docs/TransactionDetailResponse.md)
|
|
133
|
+
- [BizReceipts::TransactionDetails](docs/TransactionDetails.md)
|
|
134
|
+
- [BizReceipts::TransactionListItem](docs/TransactionListItem.md)
|
|
135
|
+
- [BizReceipts::TransactionListWrapResponse](docs/TransactionListWrapResponse.md)
|
|
136
|
+
- [BizReceipts::TransactionPsp](docs/TransactionPsp.md)
|
|
137
|
+
- [BizReceipts::Transfer](docs/Transfer.md)
|
|
138
|
+
- [BizReceipts::TransferPA](docs/TransferPA.md)
|
|
139
|
+
- [BizReceipts::User](docs/User.md)
|
|
140
|
+
- [BizReceipts::UserDetail](docs/UserDetail.md)
|
|
141
|
+
- [BizReceipts::WalletInfo](docs/WalletInfo.md)
|
|
142
|
+
- [BizReceipts::WalletItem](docs/WalletItem.md)
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
## Documentation for Authorization
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
Authentication schemes defined for the API:
|
|
149
|
+
### ApiKey
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
- **Type**: API key
|
|
153
|
+
- **API key parameter name**: Ocp-Apim-Subscription-Key
|
|
154
|
+
- **Location**: HTTP header
|
|
155
|
+
|
data/Rakefile
ADDED
data/biz_api.gemspec
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
|
2
|
+
|
|
3
|
+
=begin
|
|
4
|
+
#Biz-Events Service
|
|
5
|
+
|
|
6
|
+
#Microservice for exposing REST APIs about payment receipts.
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 0.1.72
|
|
9
|
+
|
|
10
|
+
Generated by: https://openapi-generator.tech
|
|
11
|
+
Generator version: 7.11.0
|
|
12
|
+
|
|
13
|
+
=end
|
|
14
|
+
|
|
15
|
+
$:.push File.expand_path("../lib", __FILE__)
|
|
16
|
+
require "biz_api/version"
|
|
17
|
+
|
|
18
|
+
Gem::Specification.new do |s|
|
|
19
|
+
s.name = "biz_api"
|
|
20
|
+
s.version = BizReceipts::VERSION
|
|
21
|
+
s.platform = Gem::Platform::RUBY
|
|
22
|
+
s.authors = ["Loris Pizzolitto"]
|
|
23
|
+
s.email = ["loris.pizzolitto@dedagorup.it"]
|
|
24
|
+
s.homepage = "https://openapi-generator.tech"
|
|
25
|
+
s.summary = "Biz Receipts API Ruby Gem"
|
|
26
|
+
s.description = "PagoPA Microservice for exposing REST APIs about payment receipts."
|
|
27
|
+
s.license = "MIT"
|
|
28
|
+
s.required_ruby_version = ">= 2.4"
|
|
29
|
+
s.metadata = {}
|
|
30
|
+
|
|
31
|
+
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
|
32
|
+
|
|
33
|
+
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
|
34
|
+
|
|
35
|
+
s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
|
|
36
|
+
s.test_files = `find spec/*`.split("\n")
|
|
37
|
+
s.executables = []
|
|
38
|
+
s.require_paths = ["lib"]
|
|
39
|
+
end
|
data/docs/AppInfo.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# BizReceipts::AppInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | | [optional] |
|
|
8
|
+
| **version** | **String** | | [optional] |
|
|
9
|
+
| **environment** | **String** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'biz_api'
|
|
15
|
+
|
|
16
|
+
instance = BizReceipts::AppInfo.new(
|
|
17
|
+
name: null,
|
|
18
|
+
version: null,
|
|
19
|
+
environment: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/AuthRequest.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# BizReceipts::AuthRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **auth_outcome** | **String** | | [optional] |
|
|
8
|
+
| **guid** | **String** | | [optional] |
|
|
9
|
+
| **correlation_id** | **String** | | [optional] |
|
|
10
|
+
| **error** | **String** | | [optional] |
|
|
11
|
+
| **auth_code** | **String** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'biz_api'
|
|
17
|
+
|
|
18
|
+
instance = BizReceipts::AuthRequest.new(
|
|
19
|
+
auth_outcome: null,
|
|
20
|
+
guid: null,
|
|
21
|
+
correlation_id: null,
|
|
22
|
+
error: null,
|
|
23
|
+
auth_code: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
data/docs/BizEvent.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# BizReceipts::BizEvent
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional] |
|
|
8
|
+
| **version** | **String** | | [optional] |
|
|
9
|
+
| **id_payment_manager** | **String** | | [optional] |
|
|
10
|
+
| **complete** | **String** | | [optional] |
|
|
11
|
+
| **receipt_id** | **String** | | [optional] |
|
|
12
|
+
| **missing_info** | **Array<String>** | | [optional] |
|
|
13
|
+
| **debtor_position** | [**DebtorPosition**](DebtorPosition.md) | | [optional] |
|
|
14
|
+
| **creditor** | [**Creditor**](Creditor.md) | | [optional] |
|
|
15
|
+
| **psp** | [**Psp**](Psp.md) | | [optional] |
|
|
16
|
+
| **debtor** | [**Debtor**](Debtor.md) | | [optional] |
|
|
17
|
+
| **payer** | [**Payer**](Payer.md) | | [optional] |
|
|
18
|
+
| **payment_info** | [**PaymentInfo**](PaymentInfo.md) | | [optional] |
|
|
19
|
+
| **transfer_list** | [**Array<Transfer>**](Transfer.md) | | [optional] |
|
|
20
|
+
| **transaction_details** | [**TransactionDetails**](TransactionDetails.md) | | [optional] |
|
|
21
|
+
| **event_status** | **String** | | [optional] |
|
|
22
|
+
| **event_retry_enrichment_count** | **Integer** | | [optional] |
|
|
23
|
+
| **_ts** | **Time** | | [optional] |
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```ruby
|
|
28
|
+
require 'biz_api'
|
|
29
|
+
|
|
30
|
+
instance = BizReceipts::BizEvent.new(
|
|
31
|
+
id: null,
|
|
32
|
+
version: null,
|
|
33
|
+
id_payment_manager: null,
|
|
34
|
+
complete: null,
|
|
35
|
+
receipt_id: null,
|
|
36
|
+
missing_info: null,
|
|
37
|
+
debtor_position: null,
|
|
38
|
+
creditor: null,
|
|
39
|
+
psp: null,
|
|
40
|
+
debtor: null,
|
|
41
|
+
payer: null,
|
|
42
|
+
payment_info: null,
|
|
43
|
+
transfer_list: null,
|
|
44
|
+
transaction_details: null,
|
|
45
|
+
event_status: null,
|
|
46
|
+
event_retry_enrichment_count: null,
|
|
47
|
+
_ts: null
|
|
48
|
+
)
|
|
49
|
+
```
|
|
50
|
+
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
# BizReceipts::BizEventsHelpdeskApi
|
|
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_biz_event**](BizEventsHelpdeskApi.md#get_biz_event) | **GET** /events/{biz-event-id} | Retrieve the biz-event given its id. |
|
|
8
|
+
| [**get_biz_event_by_organization_fiscal_code_and_iuv**](BizEventsHelpdeskApi.md#get_biz_event_by_organization_fiscal_code_and_iuv) | **GET** /events/organizations/{organization-fiscal-code}/iuvs/{iuv} | Retrieve the biz-event given the organization fiscal code and IUV. |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## get_biz_event
|
|
12
|
+
|
|
13
|
+
> <BizEvent> get_biz_event(biz_event_id, opts)
|
|
14
|
+
|
|
15
|
+
Retrieve the biz-event given its id.
|
|
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::BizEventsHelpdeskApi.new
|
|
31
|
+
biz_event_id = 'biz_event_id_example' # String | The id of the biz-event.
|
|
32
|
+
opts = {
|
|
33
|
+
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.
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
begin
|
|
37
|
+
# Retrieve the biz-event given its id.
|
|
38
|
+
result = api_instance.get_biz_event(biz_event_id, opts)
|
|
39
|
+
p result
|
|
40
|
+
rescue BizReceipts::ApiError => e
|
|
41
|
+
puts "Error when calling BizEventsHelpdeskApi->get_biz_event: #{e}"
|
|
42
|
+
end
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
#### Using the get_biz_event_with_http_info variant
|
|
46
|
+
|
|
47
|
+
This returns an Array which contains the response data, status code and headers.
|
|
48
|
+
|
|
49
|
+
> <Array(<BizEvent>, Integer, Hash)> get_biz_event_with_http_info(biz_event_id, opts)
|
|
50
|
+
|
|
51
|
+
```ruby
|
|
52
|
+
begin
|
|
53
|
+
# Retrieve the biz-event given its id.
|
|
54
|
+
data, status_code, headers = api_instance.get_biz_event_with_http_info(biz_event_id, opts)
|
|
55
|
+
p status_code # => 2xx
|
|
56
|
+
p headers # => { ... }
|
|
57
|
+
p data # => <BizEvent>
|
|
58
|
+
rescue BizReceipts::ApiError => e
|
|
59
|
+
puts "Error when calling BizEventsHelpdeskApi->get_biz_event_with_http_info: #{e}"
|
|
60
|
+
end
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Parameters
|
|
64
|
+
|
|
65
|
+
| Name | Type | Description | Notes |
|
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
|
67
|
+
| **biz_event_id** | **String** | The id of the biz-event. | |
|
|
68
|
+
| **x_request_id** | **String** | This header identifies the call, if not passed it is self-generated. This ID is returned in the response. | [optional] |
|
|
69
|
+
|
|
70
|
+
### Return type
|
|
71
|
+
|
|
72
|
+
[**BizEvent**](BizEvent.md)
|
|
73
|
+
|
|
74
|
+
### Authorization
|
|
75
|
+
|
|
76
|
+
[ApiKey](../README.md#ApiKey)
|
|
77
|
+
|
|
78
|
+
### HTTP request headers
|
|
79
|
+
|
|
80
|
+
- **Content-Type**: Not defined
|
|
81
|
+
- **Accept**: application/json
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
## get_biz_event_by_organization_fiscal_code_and_iuv
|
|
85
|
+
|
|
86
|
+
> <BizEvent> get_biz_event_by_organization_fiscal_code_and_iuv(organization_fiscal_code, iuv, opts)
|
|
87
|
+
|
|
88
|
+
Retrieve the biz-event given the organization fiscal code and IUV.
|
|
89
|
+
|
|
90
|
+
### Examples
|
|
91
|
+
|
|
92
|
+
```ruby
|
|
93
|
+
require 'time'
|
|
94
|
+
require 'biz_api'
|
|
95
|
+
# setup authorization
|
|
96
|
+
BizReceipts.configure do |config|
|
|
97
|
+
# Configure API key authorization: ApiKey
|
|
98
|
+
config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
|
|
99
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
100
|
+
# config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
api_instance = BizReceipts::BizEventsHelpdeskApi.new
|
|
104
|
+
organization_fiscal_code = 'organization_fiscal_code_example' # String | The fiscal code of the Organization.
|
|
105
|
+
iuv = 'iuv_example' # String | The unique payment identification. Alphanumeric code that uniquely associates and identifies three key elements of a payment: reason, payer, amount
|
|
106
|
+
opts = {
|
|
107
|
+
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.
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
begin
|
|
111
|
+
# Retrieve the biz-event given the organization fiscal code and IUV.
|
|
112
|
+
result = api_instance.get_biz_event_by_organization_fiscal_code_and_iuv(organization_fiscal_code, iuv, opts)
|
|
113
|
+
p result
|
|
114
|
+
rescue BizReceipts::ApiError => e
|
|
115
|
+
puts "Error when calling BizEventsHelpdeskApi->get_biz_event_by_organization_fiscal_code_and_iuv: #{e}"
|
|
116
|
+
end
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
#### Using the get_biz_event_by_organization_fiscal_code_and_iuv_with_http_info variant
|
|
120
|
+
|
|
121
|
+
This returns an Array which contains the response data, status code and headers.
|
|
122
|
+
|
|
123
|
+
> <Array(<BizEvent>, Integer, Hash)> get_biz_event_by_organization_fiscal_code_and_iuv_with_http_info(organization_fiscal_code, iuv, opts)
|
|
124
|
+
|
|
125
|
+
```ruby
|
|
126
|
+
begin
|
|
127
|
+
# Retrieve the biz-event given the organization fiscal code and IUV.
|
|
128
|
+
data, status_code, headers = api_instance.get_biz_event_by_organization_fiscal_code_and_iuv_with_http_info(organization_fiscal_code, iuv, opts)
|
|
129
|
+
p status_code # => 2xx
|
|
130
|
+
p headers # => { ... }
|
|
131
|
+
p data # => <BizEvent>
|
|
132
|
+
rescue BizReceipts::ApiError => e
|
|
133
|
+
puts "Error when calling BizEventsHelpdeskApi->get_biz_event_by_organization_fiscal_code_and_iuv_with_http_info: #{e}"
|
|
134
|
+
end
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### Parameters
|
|
138
|
+
|
|
139
|
+
| Name | Type | Description | Notes |
|
|
140
|
+
| ---- | ---- | ----------- | ----- |
|
|
141
|
+
| **organization_fiscal_code** | **String** | The fiscal code of the Organization. | |
|
|
142
|
+
| **iuv** | **String** | The unique payment identification. Alphanumeric code that uniquely associates and identifies three key elements of a payment: reason, payer, amount | |
|
|
143
|
+
| **x_request_id** | **String** | This header identifies the call, if not passed it is self-generated. This ID is returned in the response. | [optional] |
|
|
144
|
+
|
|
145
|
+
### Return type
|
|
146
|
+
|
|
147
|
+
[**BizEvent**](BizEvent.md)
|
|
148
|
+
|
|
149
|
+
### Authorization
|
|
150
|
+
|
|
151
|
+
[ApiKey](../README.md#ApiKey)
|
|
152
|
+
|
|
153
|
+
### HTTP request headers
|
|
154
|
+
|
|
155
|
+
- **Content-Type**: Not defined
|
|
156
|
+
- **Accept**: application/json
|
|
157
|
+
|
data/docs/CartItem.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# BizReceipts::CartItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **subject** | **String** | | |
|
|
8
|
+
| **amount** | **String** | | |
|
|
9
|
+
| **payee** | [**UserDetail**](UserDetail.md) | | [optional] |
|
|
10
|
+
| **debtor** | [**UserDetail**](UserDetail.md) | | [optional] |
|
|
11
|
+
| **ref_number_value** | **String** | | |
|
|
12
|
+
| **ref_number_type** | **String** | | |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'biz_api'
|
|
18
|
+
|
|
19
|
+
instance = BizReceipts::CartItem.new(
|
|
20
|
+
subject: null,
|
|
21
|
+
amount: null,
|
|
22
|
+
payee: null,
|
|
23
|
+
debtor: null,
|
|
24
|
+
ref_number_value: null,
|
|
25
|
+
ref_number_type: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
data/docs/Creditor.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# BizReceipts::Creditor
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id_pa** | **String** | | [optional] |
|
|
8
|
+
| **id_broker_pa** | **String** | | [optional] |
|
|
9
|
+
| **id_station** | **String** | | [optional] |
|
|
10
|
+
| **company_name** | **String** | | [optional] |
|
|
11
|
+
| **office_name** | **String** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'biz_api'
|
|
17
|
+
|
|
18
|
+
instance = BizReceipts::Creditor.new(
|
|
19
|
+
id_pa: null,
|
|
20
|
+
id_broker_pa: null,
|
|
21
|
+
id_station: null,
|
|
22
|
+
company_name: null,
|
|
23
|
+
office_name: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# BizReceipts::CtReceiptModelResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **receipt_id** | **String** | | |
|
|
8
|
+
| **notice_number** | **String** | | |
|
|
9
|
+
| **fiscal_code** | **String** | | |
|
|
10
|
+
| **outcome** | **String** | | |
|
|
11
|
+
| **creditor_reference_id** | **String** | | |
|
|
12
|
+
| **payment_amount** | **Float** | | |
|
|
13
|
+
| **description** | **String** | | |
|
|
14
|
+
| **company_name** | **String** | | |
|
|
15
|
+
| **office_name** | **String** | | [optional] |
|
|
16
|
+
| **debtor** | [**Debtor**](Debtor.md) | | |
|
|
17
|
+
| **transfer_list** | [**Array<TransferPA>**](TransferPA.md) | | |
|
|
18
|
+
| **id_psp** | **String** | | |
|
|
19
|
+
| **psp_fiscal_code** | **String** | | [optional] |
|
|
20
|
+
| **psp_partita_iva** | **String** | | [optional] |
|
|
21
|
+
| **psp_company_name** | **String** | | |
|
|
22
|
+
| **id_channel** | **String** | | |
|
|
23
|
+
| **channel_description** | **String** | | [optional] |
|
|
24
|
+
| **payer** | [**Payer**](Payer.md) | | [optional] |
|
|
25
|
+
| **payment_method** | **String** | | [optional] |
|
|
26
|
+
| **fee** | **Float** | | [optional] |
|
|
27
|
+
| **primary_ci_incurred_fee** | **Float** | | [optional] |
|
|
28
|
+
| **id_bundle** | **String** | | [optional] |
|
|
29
|
+
| **id_ci_bundle** | **String** | | [optional] |
|
|
30
|
+
| **payment_date_time** | **Date** | | [optional] |
|
|
31
|
+
| **payment_date_time_formatted** | **Time** | | [optional] |
|
|
32
|
+
| **application_date** | **Date** | | [optional] |
|
|
33
|
+
| **transfer_date** | **Date** | | [optional] |
|
|
34
|
+
| **metadata** | [**Array<MapEntry>**](MapEntry.md) | | [optional] |
|
|
35
|
+
|
|
36
|
+
## Example
|
|
37
|
+
|
|
38
|
+
```ruby
|
|
39
|
+
require 'biz_api'
|
|
40
|
+
|
|
41
|
+
instance = BizReceipts::CtReceiptModelResponse.new(
|
|
42
|
+
receipt_id: null,
|
|
43
|
+
notice_number: null,
|
|
44
|
+
fiscal_code: null,
|
|
45
|
+
outcome: null,
|
|
46
|
+
creditor_reference_id: null,
|
|
47
|
+
payment_amount: null,
|
|
48
|
+
description: null,
|
|
49
|
+
company_name: null,
|
|
50
|
+
office_name: null,
|
|
51
|
+
debtor: null,
|
|
52
|
+
transfer_list: null,
|
|
53
|
+
id_psp: null,
|
|
54
|
+
psp_fiscal_code: null,
|
|
55
|
+
psp_partita_iva: null,
|
|
56
|
+
psp_company_name: null,
|
|
57
|
+
id_channel: null,
|
|
58
|
+
channel_description: null,
|
|
59
|
+
payer: null,
|
|
60
|
+
payment_method: null,
|
|
61
|
+
fee: null,
|
|
62
|
+
primary_ci_incurred_fee: null,
|
|
63
|
+
id_bundle: null,
|
|
64
|
+
id_ci_bundle: null,
|
|
65
|
+
payment_date_time: null,
|
|
66
|
+
payment_date_time_formatted: null,
|
|
67
|
+
application_date: null,
|
|
68
|
+
transfer_date: null,
|
|
69
|
+
metadata: null
|
|
70
|
+
)
|
|
71
|
+
```
|
|
72
|
+
|
data/docs/Debtor.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# BizReceipts::Debtor
|
|
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::Debtor.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,24 @@
|
|
|
1
|
+
# BizReceipts::DebtorPosition
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **model_type** | **String** | | [optional] |
|
|
8
|
+
| **notice_number** | **String** | | [optional] |
|
|
9
|
+
| **iuv** | **String** | | [optional] |
|
|
10
|
+
| **iur** | **String** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'biz_api'
|
|
16
|
+
|
|
17
|
+
instance = BizReceipts::DebtorPosition.new(
|
|
18
|
+
model_type: null,
|
|
19
|
+
notice_number: null,
|
|
20
|
+
iuv: null,
|
|
21
|
+
iur: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|