gpd_debtposition_api 3.8.0

data/docs/DebtPositionsAPIApi.md

@@ -0,0 +1,424 @@
+# GPDDebtPositions::DebtPositionsAPIApi
+
+All URIs are relative to *https://api.uat.platform.pagopa.it/gpd/debt-positions-service/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_position**](DebtPositionsAPIApi.md#create_position) | **POST** /organizations/{organizationfiscalcode}/debtpositions | The Organization creates a debt Position. |
+| [**delete_position**](DebtPositionsAPIApi.md#delete_position) | **DELETE** /organizations/{organizationfiscalcode}/debtpositions/{iupd} | The Organization deletes a debt position |
+| [**get_organization_debt_position_by_iupd**](DebtPositionsAPIApi.md#get_organization_debt_position_by_iupd) | **GET** /organizations/{organizationfiscalcode}/debtpositions/{iupd} | Return the details of a specific debt position. |
+| [**get_organization_debt_positions**](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. |
+| [**update_position**](DebtPositionsAPIApi.md#update_position) | **PUT** /organizations/{organizationfiscalcode}/debtpositions/{iupd} | The Organization updates a debt position  |
+
+
+## create_position
+
+> <PaymentPositionModel> create_position(organizationfiscalcode, payment_position_model, opts)
+
+The Organization creates 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::DebtPositionsAPIApi.new
+organizationfiscalcode = 'organizationfiscalcode_example' # String | Organization fiscal code, the fiscal code of the Organization.
+payment_position_model = GPDDebtPositions::PaymentPositionModel.new({iupd: 'iupd_example', type: 'F', fiscal_code: 'fiscal_code_example', full_name: 'full_name_example', switch_to_expired: false, company_name: 'company_name_example'}) # PaymentPositionModel | 
+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.
+  to_publish: true # Boolean | 
+}
+
+begin
+  # The Organization creates a debt Position.
+  result = api_instance.create_position(organizationfiscalcode, payment_position_model, opts)
+  p result
+rescue GPDDebtPositions::ApiError => e
+  puts "Error when calling DebtPositionsAPIApi->create_position: #{e}"
+end
+```
+
+#### Using the create_position_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaymentPositionModel>, Integer, Hash)> create_position_with_http_info(organizationfiscalcode, payment_position_model, opts)
+
+```ruby
+begin
+  # The Organization creates a debt Position.
+  data, status_code, headers = api_instance.create_position_with_http_info(organizationfiscalcode, payment_position_model, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentPositionModel>
+rescue GPDDebtPositions::ApiError => e
+  puts "Error when calling DebtPositionsAPIApi->create_position_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organizationfiscalcode** | **String** | Organization fiscal code, the fiscal code of the Organization. |  |
+| **payment_position_model** | [**PaymentPositionModel**](PaymentPositionModel.md) |  |  |
+| **x_request_id** | **String** | This header identifies the call, if not passed it is self-generated. This ID is returned in the response. | [optional] |
+| **to_publish** | **Boolean** |  | [optional][default to false] |
+
+### Return type
+
+[**PaymentPositionModel**](PaymentPositionModel.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_position
+
+> String delete_position(organizationfiscalcode, iupd, opts)
+
+The Organization deletes 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::DebtPositionsAPIApi.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 deletes a debt position
+  result = api_instance.delete_position(organizationfiscalcode, iupd, opts)
+  p result
+rescue GPDDebtPositions::ApiError => e
+  puts "Error when calling DebtPositionsAPIApi->delete_position: #{e}"
+end
+```
+
+#### Using the delete_position_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> delete_position_with_http_info(organizationfiscalcode, iupd, opts)
+
+```ruby
+begin
+  # The Organization deletes a debt position
+  data, status_code, headers = api_instance.delete_position_with_http_info(organizationfiscalcode, iupd, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue GPDDebtPositions::ApiError => e
+  puts "Error when calling DebtPositionsAPIApi->delete_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
+
+**String**
+
+### Authorization
+
+[Authorization](../README.md#Authorization), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_organization_debt_position_by_iupd
+
+> <PaymentPositionModelBaseResponse> get_organization_debt_position_by_iupd(organizationfiscalcode, iupd, opts)
+
+Return the details of a specific 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::DebtPositionsAPIApi.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
+  # Return the details of a specific debt position.
+  result = api_instance.get_organization_debt_position_by_iupd(organizationfiscalcode, iupd, opts)
+  p result
+rescue GPDDebtPositions::ApiError => e
+  puts "Error when calling DebtPositionsAPIApi->get_organization_debt_position_by_iupd: #{e}"
+end
+```
+
+#### Using the get_organization_debt_position_by_iupd_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaymentPositionModelBaseResponse>, Integer, Hash)> get_organization_debt_position_by_iupd_with_http_info(organizationfiscalcode, iupd, opts)
+
+```ruby
+begin
+  # Return the details of a specific debt position.
+  data, status_code, headers = api_instance.get_organization_debt_position_by_iupd_with_http_info(organizationfiscalcode, iupd, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentPositionModelBaseResponse>
+rescue GPDDebtPositions::ApiError => e
+  puts "Error when calling DebtPositionsAPIApi->get_organization_debt_position_by_iupd_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
+
+[**PaymentPositionModelBaseResponse**](PaymentPositionModelBaseResponse.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_organization_debt_positions
+
+> <PaymentPositionsInfo> get_organization_debt_positions(organizationfiscalcode, page, opts)
+
+Return the list of the organization debt positions. The due dates interval is mutually exclusive with the payment dates interval.
+
+### 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::DebtPositionsAPIApi.new
+organizationfiscalcode = 'organizationfiscalcode_example' # String | Organization fiscal code, the fiscal code of the Organization.
+page = 56 # Integer | Page number. Page value starts from 0
+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.
+  limit: 56, # Integer | Number of elements on one page. Default = 50
+  due_date_from: Date.parse('2013-10-20'), # Date | Filter from due_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days before the due_date_to.
+  due_date_to: Date.parse('2013-10-20'), # Date | Filter to due_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days after the due_date_from.
+  payment_date_from: Date.parse('2013-10-20'), # Date | Filter from payment_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days before the payment_date_to.
+  payment_date_to: Date.parse('2013-10-20'), # Date | Filter to payment_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days after the payment_date_from
+  status: 'DRAFT', # String | Filter by debt position status
+  orderby: 'INSERTED_DATE', # String | Order by INSERTED_DATE, COMPANY_NAME, IUPD or STATUS
+  ordering: 'ASC' # String | Direction of ordering
+}
+
+begin
+  # Return the list of the organization debt positions. The due dates interval is mutually exclusive with the payment dates interval.
+  result = api_instance.get_organization_debt_positions(organizationfiscalcode, page, opts)
+  p result
+rescue GPDDebtPositions::ApiError => e
+  puts "Error when calling DebtPositionsAPIApi->get_organization_debt_positions: #{e}"
+end
+```
+
+#### Using the get_organization_debt_positions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaymentPositionsInfo>, Integer, Hash)> get_organization_debt_positions_with_http_info(organizationfiscalcode, page, opts)
+
+```ruby
+begin
+  # Return the list of the organization debt positions. The due dates interval is mutually exclusive with the payment dates interval.
+  data, status_code, headers = api_instance.get_organization_debt_positions_with_http_info(organizationfiscalcode, page, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentPositionsInfo>
+rescue GPDDebtPositions::ApiError => e
+  puts "Error when calling DebtPositionsAPIApi->get_organization_debt_positions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organizationfiscalcode** | **String** | Organization fiscal code, the fiscal code of the Organization. |  |
+| **page** | **Integer** | Page number. Page value starts from 0 |  |
+| **x_request_id** | **String** | This header identifies the call, if not passed it is self-generated. This ID is returned in the response. | [optional] |
+| **limit** | **Integer** | Number of elements on one page. Default &#x3D; 50 | [optional][default to 50] |
+| **due_date_from** | **Date** | Filter from due_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days before the due_date_to. | [optional] |
+| **due_date_to** | **Date** | Filter to due_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days after the due_date_from. | [optional] |
+| **payment_date_from** | **Date** | Filter from payment_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days before the payment_date_to. | [optional] |
+| **payment_date_to** | **Date** | Filter to payment_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days after the payment_date_from | [optional] |
+| **status** | **String** | Filter by debt position status | [optional] |
+| **orderby** | **String** | Order by INSERTED_DATE, COMPANY_NAME, IUPD or STATUS | [optional][default to &#39;INSERTED_DATE&#39;] |
+| **ordering** | **String** | Direction of ordering | [optional][default to &#39;DESC&#39;] |
+
+### Return type
+
+[**PaymentPositionsInfo**](PaymentPositionsInfo.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_position
+
+> <PaymentPositionModel> update_position(organizationfiscalcode, iupd, payment_position_model, opts)
+
+The Organization updates 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::DebtPositionsAPIApi.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.
+payment_position_model = GPDDebtPositions::PaymentPositionModel.new({iupd: 'iupd_example', type: 'F', fiscal_code: 'fiscal_code_example', full_name: 'full_name_example', switch_to_expired: false, company_name: 'company_name_example'}) # PaymentPositionModel | 
+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.
+  to_publish: true # Boolean | 
+}
+
+begin
+  # The Organization updates a debt position 
+  result = api_instance.update_position(organizationfiscalcode, iupd, payment_position_model, opts)
+  p result
+rescue GPDDebtPositions::ApiError => e
+  puts "Error when calling DebtPositionsAPIApi->update_position: #{e}"
+end
+```
+
+#### Using the update_position_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaymentPositionModel>, Integer, Hash)> update_position_with_http_info(organizationfiscalcode, iupd, payment_position_model, opts)
+
+```ruby
+begin
+  # The Organization updates a debt position 
+  data, status_code, headers = api_instance.update_position_with_http_info(organizationfiscalcode, iupd, payment_position_model, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentPositionModel>
+rescue GPDDebtPositions::ApiError => e
+  puts "Error when calling DebtPositionsAPIApi->update_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. |  |
+| **payment_position_model** | [**PaymentPositionModel**](PaymentPositionModel.md) |  |  |
+| **x_request_id** | **String** | This header identifies the call, if not passed it is self-generated. This ID is returned in the response. | [optional] |
+| **to_publish** | **Boolean** |  | [optional][default to false] |
+
+### Return type
+
+[**PaymentPositionModel**](PaymentPositionModel.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/HomeApi.md

@@ -0,0 +1,82 @@
+# GPDDebtPositions::HomeApi
+
+All URIs are relative to *https://api.uat.platform.pagopa.it/gpd/debt-positions-service/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**health_check**](HomeApi.md#health_check) | **GET** /info | Return OK if application is started |
+
+
+## health_check
+
+> <AppInfo> health_check(opts)
+
+Return OK if application is started
+
+### 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::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
+  # Return OK if application is started
+  result = api_instance.health_check(opts)
+  p result
+rescue GPDDebtPositions::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
+  # Return OK if application is started
+  data, status_code, headers = api_instance.health_check_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AppInfo>
+rescue GPDDebtPositions::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
+
+[Authorization](../README.md#Authorization), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/MultipleIUPDModel.md

@@ -0,0 +1,18 @@
+# GPDDebtPositions::MultipleIUPDModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_position_iupds** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'gpd_debtposition_api'
+
+instance = GPDDebtPositions::MultipleIUPDModel.new(
+  payment_position_iupds: null
+)
+```
+

data/docs/MultiplePaymentPositionModel.md

@@ -0,0 +1,18 @@
+# GPDDebtPositions::MultiplePaymentPositionModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_positions** | [**Array<PaymentPositionModel>**](PaymentPositionModel.md) |  |  |
+
+## Example
+
+```ruby
+require 'gpd_debtposition_api'
+
+instance = GPDDebtPositions::MultiplePaymentPositionModel.new(
+  payment_positions: null
+)
+```
+

data/docs/PageInfo.md

@@ -0,0 +1,24 @@
+# GPDDebtPositions::PageInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page number |  |
+| **limit** | **Integer** | Required number of items per page |  |
+| **items_found** | **Integer** | Number of items found. (The last page may have fewer elements than required) |  |
+| **total_pages** | **Integer** | Total number of pages |  |
+
+## Example
+
+```ruby
+require 'gpd_debtposition_api'
+
+instance = GPDDebtPositions::PageInfo.new(
+  page: null,
+  limit: null,
+  items_found: null,
+  total_pages: null
+)
+```
+

data/docs/PaymentOptionMetadataModel.md

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

data/docs/PaymentOptionMetadataModelResponse.md

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

data/docs/PaymentOptionModel.md

@@ -0,0 +1,38 @@
+# GPDDebtPositions::PaymentOptionModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **nav** | **String** |  | [optional] |
+| **iuv** | **String** |  |  |
+| **amount** | **Integer** |  |  |
+| **description** | **String** |  |  |
+| **is_partial_payment** | **Boolean** |  |  |
+| **due_date** | **Time** |  |  |
+| **retention_date** | **Time** |  | [optional] |
+| **fee** | **Integer** |  | [optional] |
+| **notification_fee** | **Integer** |  | [optional][readonly] |
+| **transfer** | [**Array<TransferModel>**](TransferModel.md) |  | [optional] |
+| **payment_option_metadata** | [**Array<PaymentOptionMetadataModel>**](PaymentOptionMetadataModel.md) | it can added a maximum of 10 key-value pairs for metadata | [optional] |
+
+## Example
+
+```ruby
+require 'gpd_debtposition_api'
+
+instance = GPDDebtPositions::PaymentOptionModel.new(
+  nav: null,
+  iuv: null,
+  amount: null,
+  description: null,
+  is_partial_payment: null,
+  due_date: null,
+  retention_date: null,
+  fee: null,
+  notification_fee: null,
+  transfer: null,
+  payment_option_metadata: null
+)
+```
+