biz_api 3.9.1

data/docs/Details.md

@@ -0,0 +1,22 @@
+# BizReceipts::Details
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **blurred_number** | **String** |  | [optional] |
+| **holder** | **String** |  | [optional] |
+| **circuit** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'biz_api'
+
+instance = BizReceipts::Details.new(
+  blurred_number: null,
+  holder: null,
+  circuit: null
+)
+```
+

data/docs/HomeApi.md

@@ -0,0 +1,81 @@
+# BizReceipts::HomeApi
+
+All URIs are relative to *https://api.uat.platform.pagopa.it/bizevents/service/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**health_check**](HomeApi.md#health_check) | **GET** /info | health check |
+
+
+## health_check
+
+> <AppInfo> health_check(opts)
+
+health check
+
+Return OK if application is started
+
+### Examples
+
+```ruby
+require 'time'
+require 'biz_api'
+# setup authorization
+BizReceipts.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
+end
+
+api_instance = BizReceipts::HomeApi.new
+opts = {
+  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.
+}
+
+begin
+  # health check
+  result = api_instance.health_check(opts)
+  p result
+rescue BizReceipts::ApiError => e
+  puts "Error when calling HomeApi->health_check: #{e}"
+end
+```
+
+#### Using the health_check_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AppInfo>, Integer, Hash)> health_check_with_http_info(opts)
+
+```ruby
+begin
+  # health check
+  data, status_code, headers = api_instance.health_check_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AppInfo>
+rescue BizReceipts::ApiError => e
+  puts "Error when calling HomeApi->health_check_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_request_id** | **String** | This header identifies the call, if not passed it is self-generated. This ID is returned in the response. | [optional] |
+
+### Return type
+
+[**AppInfo**](AppInfo.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/IOTransactionsRESTAPIsApi.md

@@ -0,0 +1,328 @@
+# BizReceipts::IOTransactionsRESTAPIsApi
+
+All URIs are relative to *https://api.uat.platform.pagopa.it/bizevents/service/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**disable_transaction**](IOTransactionsRESTAPIsApi.md#disable_transaction) | **POST** /transactions/{transaction-id}/disable | Disable the transaction details given its id. |
+| [**get_pdf_receipt**](IOTransactionsRESTAPIsApi.md#get_pdf_receipt) | **GET** /transactions/{event-id}/pdf | Retrieve the PDF receipt given event id. |
+| [**get_transaction_details**](IOTransactionsRESTAPIsApi.md#get_transaction_details) | **GET** /transactions/{transaction-id} | Retrieve the transaction details given its id. |
+| [**get_transaction_list**](IOTransactionsRESTAPIsApi.md#get_transaction_list) | **GET** /transactions | Retrieve the paged transaction list from biz events. |
+
+
+## disable_transaction
+
+> disable_transaction(x_fiscal_code, transaction_id, opts)
+
+Disable the transaction details given its id.
+
+This operation is deprecated. Use Paid Notice APIs instead
+
+### Examples
+
+```ruby
+require 'time'
+require 'biz_api'
+# setup authorization
+BizReceipts.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
+end
+
+api_instance = BizReceipts::IOTransactionsRESTAPIsApi.new
+x_fiscal_code = 'x_fiscal_code_example' # String | 
+transaction_id = 'transaction_id_example' # String | The id of the transaction.
+opts = {
+  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.
+}
+
+begin
+  # Disable the transaction details given its id.
+  api_instance.disable_transaction(x_fiscal_code, transaction_id, opts)
+rescue BizReceipts::ApiError => e
+  puts "Error when calling IOTransactionsRESTAPIsApi->disable_transaction: #{e}"
+end
+```
+
+#### Using the disable_transaction_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> disable_transaction_with_http_info(x_fiscal_code, transaction_id, opts)
+
+```ruby
+begin
+  # Disable the transaction details given its id.
+  data, status_code, headers = api_instance.disable_transaction_with_http_info(x_fiscal_code, transaction_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue BizReceipts::ApiError => e
+  puts "Error when calling IOTransactionsRESTAPIsApi->disable_transaction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_fiscal_code** | **String** |  |  |
+| **transaction_id** | **String** | The id of the transaction. |  |
+| **x_request_id** | **String** | This header identifies the call, if not passed it is self-generated. This ID is returned in the response. | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_pdf_receipt
+
+> File get_pdf_receipt(x_fiscal_code, event_id, opts)
+
+Retrieve the PDF receipt given event id.
+
+This operation is deprecated. Use Paid Notice APIs instead
+
+### Examples
+
+```ruby
+require 'time'
+require 'biz_api'
+# setup authorization
+BizReceipts.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
+end
+
+api_instance = BizReceipts::IOTransactionsRESTAPIsApi.new
+x_fiscal_code = 'x_fiscal_code_example' # String | 
+event_id = 'event_id_example' # String | The id of the event.
+opts = {
+  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.
+}
+
+begin
+  # Retrieve the PDF receipt given event id.
+  result = api_instance.get_pdf_receipt(x_fiscal_code, event_id, opts)
+  p result
+rescue BizReceipts::ApiError => e
+  puts "Error when calling IOTransactionsRESTAPIsApi->get_pdf_receipt: #{e}"
+end
+```
+
+#### Using the get_pdf_receipt_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> get_pdf_receipt_with_http_info(x_fiscal_code, event_id, opts)
+
+```ruby
+begin
+  # Retrieve the PDF receipt given event id.
+  data, status_code, headers = api_instance.get_pdf_receipt_with_http_info(x_fiscal_code, event_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue BizReceipts::ApiError => e
+  puts "Error when calling IOTransactionsRESTAPIsApi->get_pdf_receipt_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_fiscal_code** | **String** |  |  |
+| **event_id** | **String** | The id of the event. |  |
+| **x_request_id** | **String** | This header identifies the call, if not passed it is self-generated. This ID is returned in the response. | [optional] |
+
+### Return type
+
+**File**
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/pdf, application/json
+
+
+## get_transaction_details
+
+> <TransactionDetailResponse> get_transaction_details(x_fiscal_code, transaction_id, opts)
+
+Retrieve the transaction details given its id.
+
+This operation is deprecated. Use Paid Notice APIs instead
+
+### Examples
+
+```ruby
+require 'time'
+require 'biz_api'
+# setup authorization
+BizReceipts.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
+end
+
+api_instance = BizReceipts::IOTransactionsRESTAPIsApi.new
+x_fiscal_code = 'x_fiscal_code_example' # String | 
+transaction_id = 'transaction_id_example' # String | The id of the transaction.
+opts = {
+  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.
+}
+
+begin
+  # Retrieve the transaction details given its id.
+  result = api_instance.get_transaction_details(x_fiscal_code, transaction_id, opts)
+  p result
+rescue BizReceipts::ApiError => e
+  puts "Error when calling IOTransactionsRESTAPIsApi->get_transaction_details: #{e}"
+end
+```
+
+#### Using the get_transaction_details_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionDetailResponse>, Integer, Hash)> get_transaction_details_with_http_info(x_fiscal_code, transaction_id, opts)
+
+```ruby
+begin
+  # Retrieve the transaction details given its id.
+  data, status_code, headers = api_instance.get_transaction_details_with_http_info(x_fiscal_code, transaction_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionDetailResponse>
+rescue BizReceipts::ApiError => e
+  puts "Error when calling IOTransactionsRESTAPIsApi->get_transaction_details_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_fiscal_code** | **String** |  |  |
+| **transaction_id** | **String** | The id of the transaction. |  |
+| **x_request_id** | **String** | This header identifies the call, if not passed it is self-generated. This ID is returned in the response. | [optional] |
+
+### Return type
+
+[**TransactionDetailResponse**](TransactionDetailResponse.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_transaction_list
+
+> <TransactionListWrapResponse> get_transaction_list(x_fiscal_code, opts)
+
+Retrieve the paged transaction list from biz events.
+
+This operation is deprecated. Use Paid Notice APIs instead
+
+### Examples
+
+```ruby
+require 'time'
+require 'biz_api'
+# setup authorization
+BizReceipts.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
+end
+
+api_instance = BizReceipts::IOTransactionsRESTAPIsApi.new
+x_fiscal_code = 'x_fiscal_code_example' # String | 
+opts = {
+  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.
+  is_payer: true, # Boolean | Filter by payer
+  is_debtor: true, # Boolean | Filter by debtor
+  x_continuation_token: 'x_continuation_token_example', # String | 
+  size: 56, # Integer | 
+  orderby: 'TRANSACTION_DATE', # String | Order by TRANSACTION_DATE
+  ordering: 'ASC' # String | Direction of ordering
+}
+
+begin
+  # Retrieve the paged transaction list from biz events.
+  result = api_instance.get_transaction_list(x_fiscal_code, opts)
+  p result
+rescue BizReceipts::ApiError => e
+  puts "Error when calling IOTransactionsRESTAPIsApi->get_transaction_list: #{e}"
+end
+```
+
+#### Using the get_transaction_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionListWrapResponse>, Integer, Hash)> get_transaction_list_with_http_info(x_fiscal_code, opts)
+
+```ruby
+begin
+  # Retrieve the paged transaction list from biz events.
+  data, status_code, headers = api_instance.get_transaction_list_with_http_info(x_fiscal_code, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionListWrapResponse>
+rescue BizReceipts::ApiError => e
+  puts "Error when calling IOTransactionsRESTAPIsApi->get_transaction_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_fiscal_code** | **String** |  |  |
+| **x_request_id** | **String** | This header identifies the call, if not passed it is self-generated. This ID is returned in the response. | [optional] |
+| **is_payer** | **Boolean** | Filter by payer | [optional] |
+| **is_debtor** | **Boolean** | Filter by debtor | [optional] |
+| **x_continuation_token** | **String** |  | [optional] |
+| **size** | **Integer** |  | [optional][default to 10] |
+| **orderby** | **String** | Order by TRANSACTION_DATE | [optional][default to &#39;TRANSACTION_DATE&#39;] |
+| **ordering** | **String** | Direction of ordering | [optional][default to &#39;DESC&#39;] |
+
+### Return type
+
+[**TransactionListWrapResponse**](TransactionListWrapResponse.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, */*
+

data/docs/Info.md

@@ -0,0 +1,34 @@
+# BizReceipts::Info
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **blurred_number** | **String** |  | [optional] |
+| **holder** | **String** |  | [optional] |
+| **expire_month** | **String** |  | [optional] |
+| **expire_year** | **String** |  | [optional] |
+| **brand** | **String** |  | [optional] |
+| **issuer_abi** | **String** |  | [optional] |
+| **issuer_name** | **String** |  | [optional] |
+| **label** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'biz_api'
+
+instance = BizReceipts::Info.new(
+  type: null,
+  blurred_number: null,
+  holder: null,
+  expire_month: null,
+  expire_year: null,
+  brand: null,
+  issuer_abi: null,
+  issuer_name: null,
+  label: null
+)
+```
+

data/docs/InfoNotice.md

@@ -0,0 +1,38 @@
+# BizReceipts::InfoNotice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** |  |  |
+| **auth_code** | **String** |  | [optional] |
+| **rrn** | **String** |  |  |
+| **notice_date** | **String** |  |  |
+| **psp_name** | **String** |  |  |
+| **wallet_info** | [**WalletInfo**](WalletInfo.md) |  | [optional] |
+| **payment_method** | **String** |  | [optional] |
+| **payer** | [**UserDetail**](UserDetail.md) |  | [optional] |
+| **amount** | **String** |  |  |
+| **fee** | **String** |  | [optional] |
+| **origin** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'biz_api'
+
+instance = BizReceipts::InfoNotice.new(
+  event_id: null,
+  auth_code: null,
+  rrn: null,
+  notice_date: null,
+  psp_name: null,
+  wallet_info: null,
+  payment_method: null,
+  payer: null,
+  amount: null,
+  fee: null,
+  origin: null
+)
+```
+

data/docs/InfoTransaction.md

@@ -0,0 +1,26 @@
+# BizReceipts::InfoTransaction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **brand** | **String** |  | [optional] |
+| **brand_logo** | **String** |  | [optional] |
+| **client_id** | **String** |  | [optional] |
+| **payment_method_name** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'biz_api'
+
+instance = BizReceipts::InfoTransaction.new(
+  brand: null,
+  brand_logo: null,
+  client_id: null,
+  payment_method_name: null,
+  type: null
+)
+```
+

data/docs/InfoTransactionView.md

@@ -0,0 +1,38 @@
+# BizReceipts::InfoTransactionView
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_id** | **String** |  | [optional] |
+| **auth_code** | **String** |  | [optional] |
+| **rrn** | **String** |  | [optional] |
+| **transaction_date** | **String** |  | [optional] |
+| **psp_name** | **String** |  | [optional] |
+| **wallet_info** | [**WalletInfo**](WalletInfo.md) |  | [optional] |
+| **payment_method** | **String** |  | [optional] |
+| **payer** | [**UserDetail**](UserDetail.md) |  | [optional] |
+| **amount** | **String** |  | [optional] |
+| **fee** | **String** |  | [optional] |
+| **origin** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'biz_api'
+
+instance = BizReceipts::InfoTransactionView.new(
+  transaction_id: null,
+  auth_code: null,
+  rrn: null,
+  transaction_date: null,
+  psp_name: null,
+  wallet_info: null,
+  payment_method: null,
+  payer: null,
+  amount: null,
+  fee: null,
+  origin: null
+)
+```
+

data/docs/MBD.md

@@ -0,0 +1,26 @@
+# BizReceipts::MBD
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **iubd** | **String** |  | [optional] |
+| **ora_acquisto** | **String** |  | [optional] |
+| **importo** | **String** |  | [optional] |
+| **tipo_bollo** | **String** |  | [optional] |
+| **mbd_attachment** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'biz_api'
+
+instance = BizReceipts::MBD.new(
+  iubd: null,
+  ora_acquisto: null,
+  importo: null,
+  tipo_bollo: null,
+  mbd_attachment: null
+)
+```
+

data/docs/MapEntry.md

@@ -0,0 +1,20 @@
+# BizReceipts::MapEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  | [optional] |
+| **value** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'biz_api'
+
+instance = BizReceipts::MapEntry.new(
+  key: null,
+  value: null
+)
+```
+

data/docs/NoticeDetailResponse.md

@@ -0,0 +1,20 @@
+# BizReceipts::NoticeDetailResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **info_notice** | [**InfoNotice**](InfoNotice.md) |  | [optional] |
+| **carts** | [**Array<CartItem>**](CartItem.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'biz_api'
+
+instance = BizReceipts::NoticeDetailResponse.new(
+  info_notice: null,
+  carts: null
+)
+```
+

data/docs/NoticeListItem.md

@@ -0,0 +1,32 @@
+# BizReceipts::NoticeListItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** |  |  |
+| **payee_name** | **String** |  | [optional] |
+| **payee_tax_code** | **String** |  |  |
+| **amount** | **String** |  |  |
+| **notice_date** | **String** |  |  |
+| **is_cart** | **Boolean** |  |  |
+| **is_payer** | **Boolean** |  |  |
+| **is_debtor** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'biz_api'
+
+instance = BizReceipts::NoticeListItem.new(
+  event_id: null,
+  payee_name: null,
+  payee_tax_code: null,
+  amount: null,
+  notice_date: null,
+  is_cart: null,
+  is_payer: null,
+  is_debtor: null
+)
+```
+

data/docs/NoticeListWrapResponse.md

@@ -0,0 +1,18 @@
+# BizReceipts::NoticeListWrapResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **notices** | [**Array<NoticeListItem>**](NoticeListItem.md) |  |  |
+
+## Example
+
+```ruby
+require 'biz_api'
+
+instance = BizReceipts::NoticeListWrapResponse.new(
+  notices: null
+)
+```
+