gpd_debtposition_api 3.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 055e50ff2b68b65d249a1c7d89f2a9900becdde18667025b28a68334bf6b0407
+  data.tar.gz: fa4bfd77a905850390ede94cf6902aeb750dd80a0c63d0ac8b02b29600543d76
+SHA512:
+  metadata.gz: 8a788bc2b99fd930c249b4d0ea659bb7a1e033b547b7c4b406786d74e1142118b1c96eef19d2899f8069de2a6d06b7dcbc90f442f2541cb4f1695b9a1677ad06
+  data.tar.gz: 57648a02812ec97a3fb686e21a597c85953ebffb905d251dbeecc55cac378e1a7feb674ee616ae775c7821ac3e5fbcbd9d75b73655d04dfab27b5ee3d3eee382

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,141 @@
+# gpd_debtposition_api
+
+GPDDebtPositions - the Ruby gem for the PagoPA API Debt Position
+
+Progetto Gestione Posizioni Debitorie
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 0.11.18
+- Package version: 3.8.0
+- 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 gpd_debtposition_api.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./gpd_debtposition_api-3.8.0.gem
+```
+
+(for development, run `gem install --dev ./gpd_debtposition_api-3.8.0.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 'gpd_debtposition_api', '~> 3.8.0'
+
+### 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 'gpd_debtposition_api', :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 'gpd_debtposition_api'
+
+# Setup authorization
+GPDDebtPositions.configure do |config|
+  # Configure Bearer authorization (JWT): Authorization
+  config.access_token = 'YOUR_BEARER_TOKEN'
+  # Configure a proc to get access tokens in lieu of the static access_token configuration
+  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
+
+  # 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 = GPDDebtPositions::DebtPositionActionsAPIApi.new
+organizationfiscalcode = 'organizationfiscalcode_example' # String | Organization fiscal code, the fiscal code of the Organization.
+iupd = 'iupd_example' # String | IUPD (Unique identifier of the debt position). Format could be `<Organization fiscal code + UUID>` this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is `true` and if not, notify the EC.
+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
+  #The Organization invalidate a debt Position.
+  result = api_instance.invalidate_position(organizationfiscalcode, iupd, opts)
+  p result
+rescue GPDDebtPositions::ApiError => e
+  puts "Exception when calling DebtPositionActionsAPIApi->invalidate_position: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.uat.platform.pagopa.it/gpd/debt-positions-service/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*GPDDebtPositions::DebtPositionActionsAPIApi* | [**invalidate_position**](docs/DebtPositionActionsAPIApi.md#invalidate_position) | **POST** /organizations/{organizationfiscalcode}/debtpositions/{iupd}/invalidate | The Organization invalidate a debt Position.
+*GPDDebtPositions::DebtPositionActionsAPIApi* | [**publish_position**](docs/DebtPositionActionsAPIApi.md#publish_position) | **POST** /organizations/{organizationfiscalcode}/debtpositions/{iupd}/publish | The Organization publish a debt Position.
+*GPDDebtPositions::DebtPositionsAPIApi* | [**create_position**](docs/DebtPositionsAPIApi.md#create_position) | **POST** /organizations/{organizationfiscalcode}/debtpositions | The Organization creates a debt Position.
+*GPDDebtPositions::DebtPositionsAPIApi* | [**delete_position**](docs/DebtPositionsAPIApi.md#delete_position) | **DELETE** /organizations/{organizationfiscalcode}/debtpositions/{iupd} | The Organization deletes a debt position
+*GPDDebtPositions::DebtPositionsAPIApi* | [**get_organization_debt_position_by_iupd**](docs/DebtPositionsAPIApi.md#get_organization_debt_position_by_iupd) | **GET** /organizations/{organizationfiscalcode}/debtpositions/{iupd} | Return the details of a specific debt position.
+*GPDDebtPositions::DebtPositionsAPIApi* | [**get_organization_debt_positions**](docs/DebtPositionsAPIApi.md#get_organization_debt_positions) | **GET** /organizations/{organizationfiscalcode}/debtpositions | Return the list of the organization debt positions. The due dates interval is mutually exclusive with the payment dates interval.
+*GPDDebtPositions::DebtPositionsAPIApi* | [**update_position**](docs/DebtPositionsAPIApi.md#update_position) | **PUT** /organizations/{organizationfiscalcode}/debtpositions/{iupd} | The Organization updates a debt position 
+*GPDDebtPositions::HomeApi* | [**health_check**](docs/HomeApi.md#health_check) | **GET** /info | Return OK if application is started
+
+
+## Documentation for Models
+
+ - [GPDDebtPositions::AppInfo](docs/AppInfo.md)
+ - [GPDDebtPositions::MultipleIUPDModel](docs/MultipleIUPDModel.md)
+ - [GPDDebtPositions::MultiplePaymentPositionModel](docs/MultiplePaymentPositionModel.md)
+ - [GPDDebtPositions::PageInfo](docs/PageInfo.md)
+ - [GPDDebtPositions::PaymentOptionMetadataModel](docs/PaymentOptionMetadataModel.md)
+ - [GPDDebtPositions::PaymentOptionMetadataModelResponse](docs/PaymentOptionMetadataModelResponse.md)
+ - [GPDDebtPositions::PaymentOptionModel](docs/PaymentOptionModel.md)
+ - [GPDDebtPositions::PaymentOptionModelResponse](docs/PaymentOptionModelResponse.md)
+ - [GPDDebtPositions::PaymentPositionModel](docs/PaymentPositionModel.md)
+ - [GPDDebtPositions::PaymentPositionModelBaseResponse](docs/PaymentPositionModelBaseResponse.md)
+ - [GPDDebtPositions::PaymentPositionsInfo](docs/PaymentPositionsInfo.md)
+ - [GPDDebtPositions::ProblemJson](docs/ProblemJson.md)
+ - [GPDDebtPositions::Stamp](docs/Stamp.md)
+ - [GPDDebtPositions::TransferMetadataModel](docs/TransferMetadataModel.md)
+ - [GPDDebtPositions::TransferMetadataModelResponse](docs/TransferMetadataModelResponse.md)
+ - [GPDDebtPositions::TransferModel](docs/TransferModel.md)
+ - [GPDDebtPositions::TransferModelResponse](docs/TransferModelResponse.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### ApiKey
+
+
+- **Type**: API key
+- **API key parameter name**: Ocp-Apim-Subscription-Key
+- **Location**: HTTP header
+
+### Authorization
+
+- **Type**: Bearer authentication (JWT)
+

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/AppInfo.md

@@ -0,0 +1,22 @@
+# GPDDebtPositions::AppInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **version** | **String** |  | [optional] |
+| **environment** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'gpd_debtposition_api'
+
+instance = GPDDebtPositions::AppInfo.new(
+  name: null,
+  version: null,
+  environment: null
+)
+```
+

data/docs/DebtPositionActionsAPIApi.md

@@ -0,0 +1,165 @@
+# GPDDebtPositions::DebtPositionActionsAPIApi
+
+All URIs are relative to *https://api.uat.platform.pagopa.it/gpd/debt-positions-service/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**invalidate_position**](DebtPositionActionsAPIApi.md#invalidate_position) | **POST** /organizations/{organizationfiscalcode}/debtpositions/{iupd}/invalidate | The Organization invalidate a debt Position. |
+| [**publish_position**](DebtPositionActionsAPIApi.md#publish_position) | **POST** /organizations/{organizationfiscalcode}/debtpositions/{iupd}/publish | The Organization publish a debt Position. |
+
+
+## invalidate_position
+
+> <PaymentPositionModel> invalidate_position(organizationfiscalcode, iupd, opts)
+
+The Organization invalidate a debt Position.
+
+### Examples
+
+```ruby
+require 'time'
+require 'gpd_debtposition_api'
+# setup authorization
+GPDDebtPositions.configure do |config|
+  # Configure Bearer authorization (JWT): Authorization
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # 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 = GPDDebtPositions::DebtPositionActionsAPIApi.new
+organizationfiscalcode = 'organizationfiscalcode_example' # String | Organization fiscal code, the fiscal code of the Organization.
+iupd = 'iupd_example' # String | IUPD (Unique identifier of the debt position). Format could be `<Organization fiscal code + UUID>` this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is `true` and if not, notify the EC.
+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
+  # The Organization invalidate a debt Position.
+  result = api_instance.invalidate_position(organizationfiscalcode, iupd, opts)
+  p result
+rescue GPDDebtPositions::ApiError => e
+  puts "Error when calling DebtPositionActionsAPIApi->invalidate_position: #{e}"
+end
+```
+
+#### Using the invalidate_position_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaymentPositionModel>, Integer, Hash)> invalidate_position_with_http_info(organizationfiscalcode, iupd, opts)
+
+```ruby
+begin
+  # The Organization invalidate a debt Position.
+  data, status_code, headers = api_instance.invalidate_position_with_http_info(organizationfiscalcode, iupd, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentPositionModel>
+rescue GPDDebtPositions::ApiError => e
+  puts "Error when calling DebtPositionActionsAPIApi->invalidate_position_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organizationfiscalcode** | **String** | Organization fiscal code, the fiscal code of the Organization. |  |
+| **iupd** | **String** | IUPD (Unique identifier of the debt position). Format could be &#x60;&lt;Organization fiscal code + UUID&gt;&#x60; this would make it unique within the new PD management system. It&#39;s the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is &#x60;true&#x60; and if not, notify the EC. |  |
+| **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
+
+[**PaymentPositionModel**](PaymentPositionModel.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## publish_position
+
+> <PaymentPositionModel> publish_position(organizationfiscalcode, iupd, opts)
+
+The Organization publish a debt Position.
+
+### Examples
+
+```ruby
+require 'time'
+require 'gpd_debtposition_api'
+# setup authorization
+GPDDebtPositions.configure do |config|
+  # Configure Bearer authorization (JWT): Authorization
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # 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 = GPDDebtPositions::DebtPositionActionsAPIApi.new
+organizationfiscalcode = 'organizationfiscalcode_example' # String | Organization fiscal code, the fiscal code of the Organization.
+iupd = 'iupd_example' # String | IUPD (Unique identifier of the debt position). Format could be `<Organization fiscal code + UUID>` this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is `true` and if not, notify the EC.
+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
+  # The Organization publish a debt Position.
+  result = api_instance.publish_position(organizationfiscalcode, iupd, opts)
+  p result
+rescue GPDDebtPositions::ApiError => e
+  puts "Error when calling DebtPositionActionsAPIApi->publish_position: #{e}"
+end
+```
+
+#### Using the publish_position_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaymentPositionModel>, Integer, Hash)> publish_position_with_http_info(organizationfiscalcode, iupd, opts)
+
+```ruby
+begin
+  # The Organization publish a debt Position.
+  data, status_code, headers = api_instance.publish_position_with_http_info(organizationfiscalcode, iupd, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentPositionModel>
+rescue GPDDebtPositions::ApiError => e
+  puts "Error when calling DebtPositionActionsAPIApi->publish_position_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organizationfiscalcode** | **String** | Organization fiscal code, the fiscal code of the Organization. |  |
+| **iupd** | **String** | IUPD (Unique identifier of the debt position). Format could be &#x60;&lt;Organization fiscal code + UUID&gt;&#x60; this would make it unique within the new PD management system. It&#39;s the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is &#x60;true&#x60; and if not, notify the EC. |  |
+| **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
+
+[**PaymentPositionModel**](PaymentPositionModel.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+