fdr_organization 3.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 973e7175afa97ffbd7b7843729f089fe8637990073fa51cc8d23dbad05acc87b
+  data.tar.gz: f21b7a787959ec55621df909d268de69fc4f54fc5de7f55456817257a0149b1d
+SHA512:
+  metadata.gz: 5bb419618db63f037f5fae559c4e58df6e5a6f6e86407acbabc99ebb1e6decc7895eb7f8494b9391e4a3683320e3e1c4f76eb385db9a616cc3179838591297dc
+  data.tar.gz: 1c52655c230fcfd5a8ff61f9328c17db582bd572bbf4cd9bb90c6e4d6f36893ab26b5bd9b6a6d7dbe044cb79e1be8d33846c82b522aa08f7220834b82bd20e2f

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,144 @@
+# fdr_organization
+
+FdrOrgs - the Ruby gem for the FDR - Flussi di rendicontazione (ORGS)
+
+FDR - Flussi di rendicontazione (ORGS)
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: v1
+- Package version: 3.9.1
+- Generator version: 7.11.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build fdr_organization.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./fdr_organization-3.9.1.gem
+```
+
+(for development, run `gem install --dev ./fdr_organization-3.9.1.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'fdr_organization', '~> 3.9.1'
+
+### Install from Git
+
+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:
+
+    gem 'fdr_organization', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'fdr_organization'
+
+# Setup authorization
+FdrOrgs.configure do |config|
+  # Configure API key authorization: apiKeyQuery
+  config.api_key['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['subscription-key'] = 'Bearer'
+
+  # Configure API key authorization: apiKeyHeader
+  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 = FdrOrgs::InfoApi.new
+
+begin
+  #Get info of FDR
+  result = api_instance.get_info
+  p result
+rescue FdrOrgs::ApiError => e
+  puts "Exception when calling InfoApi->get_info: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.uat.platform.pagopa.it/fdr-org/service/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*FdrOrgs::InfoApi* | [**get_info**](docs/InfoApi.md#get_info) | **GET** /info | Get info of FDR
+*FdrOrgs::OrganizationsApi* | [**get**](docs/OrganizationsApi.md#get) | **GET** /organizations/{organizationId}/fdrs/{fdr}/revisions/{revision}/psps/{pspId} | Get fdr
+*FdrOrgs::OrganizationsApi* | [**get_all_published**](docs/OrganizationsApi.md#get_all_published) | **GET** /organizations/{organizationId}/fdrs | Get all fdr published
+*FdrOrgs::OrganizationsApi* | [**get_payment**](docs/OrganizationsApi.md#get_payment) | **GET** /organizations/{organizationId}/fdrs/{fdr}/revisions/{revision}/psps/{pspId}/payments | Get payments of fdr
+
+
+## Documentation for Models
+
+ - [FdrOrgs::AddPaymentRequest](docs/AddPaymentRequest.md)
+ - [FdrOrgs::CreateRequest](docs/CreateRequest.md)
+ - [FdrOrgs::DeletePaymentRequest](docs/DeletePaymentRequest.md)
+ - [FdrOrgs::ErrorCode](docs/ErrorCode.md)
+ - [FdrOrgs::ErrorMessage](docs/ErrorMessage.md)
+ - [FdrOrgs::ErrorResponse](docs/ErrorResponse.md)
+ - [FdrOrgs::Fdr](docs/Fdr.md)
+ - [FdrOrgs::FdrByPspIdIuvIurBase](docs/FdrByPspIdIuvIurBase.md)
+ - [FdrOrgs::FdrByPspIdIuvIurResponse](docs/FdrByPspIdIuvIurResponse.md)
+ - [FdrOrgs::FdrInserted](docs/FdrInserted.md)
+ - [FdrOrgs::FdrPublished](docs/FdrPublished.md)
+ - [FdrOrgs::GenericResponse](docs/GenericResponse.md)
+ - [FdrOrgs::GetAllCreatedResponse](docs/GetAllCreatedResponse.md)
+ - [FdrOrgs::GetAllPublishedResponse](docs/GetAllPublishedResponse.md)
+ - [FdrOrgs::GetAllResponse](docs/GetAllResponse.md)
+ - [FdrOrgs::GetCreatedResponse](docs/GetCreatedResponse.md)
+ - [FdrOrgs::GetPaymentResponse](docs/GetPaymentResponse.md)
+ - [FdrOrgs::GetResponse](docs/GetResponse.md)
+ - [FdrOrgs::InfoResponse](docs/InfoResponse.md)
+ - [FdrOrgs::Metadata](docs/Metadata.md)
+ - [FdrOrgs::Payment](docs/Payment.md)
+ - [FdrOrgs::PaymentStatusEnum](docs/PaymentStatusEnum.md)
+ - [FdrOrgs::Receiver](docs/Receiver.md)
+ - [FdrOrgs::ReportingFlowStatusEnum](docs/ReportingFlowStatusEnum.md)
+ - [FdrOrgs::Sender](docs/Sender.md)
+ - [FdrOrgs::SenderTypeEnum](docs/SenderTypeEnum.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### apiKeyHeader
+
+
+- **Type**: API key
+- **API key parameter name**: Ocp-Apim-Subscription-Key
+- **Location**: HTTP header
+
+### apiKeyQuery
+
+
+- **Type**: API key
+- **API key parameter name**: subscription-key
+- **Location**: URL query string
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AddPaymentRequest.md

@@ -0,0 +1,18 @@
+# FdrOrgs::AddPaymentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payments** | [**Array<Payment>**](Payment.md) |  |  |
+
+## Example
+
+```ruby
+require 'fdr_organization'
+
+instance = FdrOrgs::AddPaymentRequest.new(
+  payments: null
+)
+```
+

data/docs/CreateRequest.md

@@ -0,0 +1,34 @@
+# FdrOrgs::CreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fdr** | **String** | [XML NodoInviaFlussoRendicontazione]=[identificativoFlusso] |  |
+| **fdr_date** | **Time** | [XML NodoInviaFlussoRendicontazione]=[dataOraFlusso] |  |
+| **sender** | [**Sender**](Sender.md) |  |  |
+| **receiver** | [**Receiver**](Receiver.md) |  |  |
+| **regulation** | **String** | [XML FlussoRiversamento]=[identificativoUnivocoRegolamento] |  |
+| **regulation_date** | **Time** | [XML FlussoRiversamento]=[dataRegolamento] |  |
+| **bic_code_pouring_bank** | **String** | [XML FlussoRiversamento]=[codiceBicBancaDiRiversamento] | [optional] |
+| **tot_payments** | **Integer** | [XML FlussoRiversamento]=[numeroTotalePagamenti] |  |
+| **sum_payments** | **Float** | [XML FlussoRiversamento]=[importoTotalePagamenti] |  |
+
+## Example
+
+```ruby
+require 'fdr_organization'
+
+instance = FdrOrgs::CreateRequest.new(
+  fdr: 2016-08-16pspTest-1178,
+  fdr_date: 2022-03-10T04:15:50Z,
+  sender: null,
+  receiver: null,
+  regulation: SEPA - Bonifico xzy,
+  regulation_date: 2022-03-10T04:15:50Z,
+  bic_code_pouring_bank: UNCRITMMXXX,
+  tot_payments: 1,
+  sum_payments: 0.01
+)
+```
+

data/docs/DeletePaymentRequest.md

@@ -0,0 +1,18 @@
+# FdrOrgs::DeletePaymentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index_list** | **Array<Integer>** |  |  |
+
+## Example
+
+```ruby
+require 'fdr_organization'
+
+instance = FdrOrgs::DeletePaymentRequest.new(
+  index_list: null
+)
+```
+

data/docs/ErrorCode.md

@@ -0,0 +1,22 @@
+# FdrOrgs::ErrorCode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **status_code** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fdr_organization'
+
+instance = FdrOrgs::ErrorCode.new(
+  code: FDR-0500,
+  description: An unexpected error has occurred. Please contact support.,
+  status_code: 500
+)
+```
+

data/docs/ErrorMessage.md

@@ -0,0 +1,20 @@
+# FdrOrgs::ErrorMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **path** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fdr_organization'
+
+instance = FdrOrgs::ErrorMessage.new(
+  path: demo.test,
+  message: An unexpected error has occurred. Please contact support.
+)
+```
+

data/docs/ErrorResponse.md

@@ -0,0 +1,26 @@
+# FdrOrgs::ErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_id** | **String** |  | [optional] |
+| **http_status_code** | **Integer** |  | [optional] |
+| **http_status_description** | **String** |  | [optional] |
+| **app_error_code** | **String** |  | [optional] |
+| **errors** | [**Array<ErrorMessage>**](ErrorMessage.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'fdr_organization'
+
+instance = FdrOrgs::ErrorResponse.new(
+  error_id: 50905466-1881-457b-b42f-fb7b2bfb1610,
+  http_status_code: 500,
+  http_status_description: Internal Server Error,
+  app_error_code: FDR-500,
+  errors: null
+)
+```
+

data/docs/Fdr.md

@@ -0,0 +1,24 @@
+# FdrOrgs::Fdr
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fdr** | **String** |  | [optional] |
+| **psp_id** | **String** |  | [optional] |
+| **revision** | **Integer** |  | [optional] |
+| **published** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fdr_organization'
+
+instance = FdrOrgs::Fdr.new(
+  fdr: AAABBB,
+  psp_id: 1,
+  revision: 1,
+  published: 2022-03-10T04:15:50Z
+)
+```
+

data/docs/FdrByPspIdIuvIurBase.md

@@ -0,0 +1,26 @@
+# FdrOrgs::FdrByPspIdIuvIurBase
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **psp_id** | **String** |  | [optional] |
+| **organization_id** | **String** |  | [optional] |
+| **fdr** | **String** |  | [optional] |
+| **revision** | **Integer** |  | [optional] |
+| **created** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fdr_organization'
+
+instance = FdrOrgs::FdrByPspIdIuvIurBase.new(
+  psp_id: null,
+  organization_id: null,
+  fdr: null,
+  revision: null,
+  created: 2022-03-10T04:15:50Z
+)
+```
+

data/docs/FdrByPspIdIuvIurResponse.md

@@ -0,0 +1,22 @@
+# FdrOrgs::FdrByPspIdIuvIurResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**Metadata**](Metadata.md) |  | [optional] |
+| **count** | **Integer** |  | [optional] |
+| **data** | [**Array<FdrByPspIdIuvIurBase>**](FdrByPspIdIuvIurBase.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'fdr_organization'
+
+instance = FdrOrgs::FdrByPspIdIuvIurResponse.new(
+  metadata: null,
+  count: 100,
+  data: null
+)
+```
+

data/docs/FdrInserted.md

@@ -0,0 +1,24 @@
+# FdrOrgs::FdrInserted
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fdr** | **String** |  | [optional] |
+| **organization_id** | **String** |  | [optional] |
+| **revision** | **Integer** |  | [optional] |
+| **created** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fdr_organization'
+
+instance = FdrOrgs::FdrInserted.new(
+  fdr: AAABBB,
+  organization_id: 1,
+  revision: 1,
+  created: 2022-03-10T04:15:50Z
+)
+```
+

data/docs/FdrPublished.md

@@ -0,0 +1,24 @@
+# FdrOrgs::FdrPublished
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fdr** | **String** |  | [optional] |
+| **organization_id** | **String** |  | [optional] |
+| **revision** | **Integer** |  | [optional] |
+| **published** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fdr_organization'
+
+instance = FdrOrgs::FdrPublished.new(
+  fdr: AAABBB,
+  organization_id: 1,
+  revision: 1,
+  published: 2022-03-10T04:15:50Z
+)
+```
+

data/docs/GenericResponse.md

@@ -0,0 +1,18 @@
+# FdrOrgs::GenericResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fdr_organization'
+
+instance = FdrOrgs::GenericResponse.new(
+  message: Success
+)
+```
+

data/docs/GetAllCreatedResponse.md

@@ -0,0 +1,22 @@
+# FdrOrgs::GetAllCreatedResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**Metadata**](Metadata.md) |  | [optional] |
+| **count** | **Integer** |  | [optional] |
+| **data** | [**Array<FdrInserted>**](FdrInserted.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'fdr_organization'
+
+instance = FdrOrgs::GetAllCreatedResponse.new(
+  metadata: null,
+  count: 100,
+  data: null
+)
+```
+

data/docs/GetAllPublishedResponse.md

@@ -0,0 +1,22 @@
+# FdrOrgs::GetAllPublishedResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**Metadata**](Metadata.md) |  | [optional] |
+| **count** | **Integer** |  | [optional] |
+| **data** | [**Array<FdrPublished>**](FdrPublished.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'fdr_organization'
+
+instance = FdrOrgs::GetAllPublishedResponse.new(
+  metadata: null,
+  count: 100,
+  data: null
+)
+```
+

data/docs/GetAllResponse.md

@@ -0,0 +1,22 @@
+# FdrOrgs::GetAllResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**Metadata**](Metadata.md) |  | [optional] |
+| **count** | **Integer** |  | [optional] |
+| **data** | [**Array<Fdr>**](Fdr.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'fdr_organization'
+
+instance = FdrOrgs::GetAllResponse.new(
+  metadata: null,
+  count: 100,
+  data: null
+)
+```
+

data/docs/GetCreatedResponse.md

@@ -0,0 +1,46 @@
+# FdrOrgs::GetCreatedResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**ReportingFlowStatusEnum**](ReportingFlowStatusEnum.md) |  | [optional] |
+| **revision** | **Integer** |  | [optional] |
+| **created** | **Time** |  | [optional] |
+| **updated** | **Time** |  | [optional] |
+| **fdr** | **String** |  | [optional] |
+| **fdr_date** | **Time** |  | [optional] |
+| **regulation** | **String** |  | [optional] |
+| **regulation_date** | **Time** |  | [optional] |
+| **bic_code_pouring_bank** | **String** |  | [optional] |
+| **sender** | [**Sender**](Sender.md) |  | [optional] |
+| **receiver** | [**Receiver**](Receiver.md) |  | [optional] |
+| **computed_tot_payments** | **Integer** |  | [optional] |
+| **computed_sum_payments** | **Float** |  | [optional] |
+| **tot_payments** | **Integer** |  | [optional] |
+| **sum_payments** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fdr_organization'
+
+instance = FdrOrgs::GetCreatedResponse.new(
+  status: null,
+  revision: 4,
+  created: 2022-03-10T04:15:50Z,
+  updated: 2022-03-10T04:15:50Z,
+  fdr: 2016-08-16pspTest-1178,
+  fdr_date: 2022-03-10T04:15:50Z,
+  regulation: SEPA - Bonifico xzy,
+  regulation_date: 2022-03-10T04:15:50Z,
+  bic_code_pouring_bank: UNCRITMMXXX,
+  sender: null,
+  receiver: null,
+  computed_tot_payments: 100,
+  computed_sum_payments: 100.9,
+  tot_payments: 100,
+  sum_payments: 100.9
+)
+```
+

data/docs/GetPaymentResponse.md

@@ -0,0 +1,22 @@
+# FdrOrgs::GetPaymentResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**Metadata**](Metadata.md) |  | [optional] |
+| **count** | **Integer** |  | [optional] |
+| **data** | [**Array<Payment>**](Payment.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'fdr_organization'
+
+instance = FdrOrgs::GetPaymentResponse.new(
+  metadata: null,
+  count: 100,
+  data: null
+)
+```
+

data/docs/GetResponse.md

@@ -0,0 +1,48 @@
+# FdrOrgs::GetResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**ReportingFlowStatusEnum**](ReportingFlowStatusEnum.md) |  | [optional] |
+| **revision** | **Integer** |  | [optional] |
+| **created** | **Time** |  | [optional] |
+| **updated** | **Time** |  | [optional] |
+| **fdr** | **String** |  | [optional] |
+| **fdr_date** | **Time** |  | [optional] |
+| **regulation** | **String** |  | [optional] |
+| **regulation_date** | **Time** |  | [optional] |
+| **bic_code_pouring_bank** | **String** |  | [optional] |
+| **sender** | [**Sender**](Sender.md) |  | [optional] |
+| **receiver** | [**Receiver**](Receiver.md) |  | [optional] |
+| **published** | **Time** |  | [optional] |
+| **computed_tot_payments** | **Integer** |  | [optional] |
+| **computed_sum_payments** | **Float** |  | [optional] |
+| **tot_payments** | **Integer** |  | [optional] |
+| **sum_payments** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fdr_organization'
+
+instance = FdrOrgs::GetResponse.new(
+  status: null,
+  revision: 4,
+  created: 2022-03-10T04:15:50Z,
+  updated: 2022-03-10T04:15:50Z,
+  fdr: 2016-08-16pspTest-1178,
+  fdr_date: 2022-03-10T04:15:50Z,
+  regulation: SEPA - Bonifico xzy,
+  regulation_date: 2022-03-10T04:15:50Z,
+  bic_code_pouring_bank: UNCRITMMXXX,
+  sender: null,
+  receiver: null,
+  published: 2022-03-10T04:15:50Z,
+  computed_tot_payments: 100,
+  computed_sum_payments: 100.9,
+  tot_payments: 100,
+  sum_payments: 100.9
+)
+```
+