gpd_debtposition_api 3.8.0

data/docs/PaymentOptionModelResponse.md

@@ -0,0 +1,58 @@
+# GPDDebtPositions::PaymentOptionModelResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **nav** | **String** |  | [optional] |
+| **iuv** | **String** |  | [optional] |
+| **organization_fiscal_code** | **String** |  | [optional] |
+| **amount** | **Integer** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **is_partial_payment** | **Boolean** |  | [optional] |
+| **due_date** | **Time** |  | [optional] |
+| **retention_date** | **Time** |  | [optional] |
+| **payment_date** | **Time** |  | [optional] |
+| **reporting_date** | **Time** |  | [optional] |
+| **inserted_date** | **Time** |  | [optional] |
+| **payment_method** | **String** |  | [optional] |
+| **fee** | **Integer** |  | [optional] |
+| **notification_fee** | **Integer** |  | [optional] |
+| **psp_company** | **String** |  | [optional] |
+| **id_receipt** | **String** |  | [optional] |
+| **id_flow_reporting** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **last_updated_date** | **Time** |  | [optional] |
+| **payment_option_metadata** | [**Array<PaymentOptionMetadataModelResponse>**](PaymentOptionMetadataModelResponse.md) |  | [optional] |
+| **transfer** | [**Array<TransferModelResponse>**](TransferModelResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'gpd_debtposition_api'
+
+instance = GPDDebtPositions::PaymentOptionModelResponse.new(
+  nav: null,
+  iuv: null,
+  organization_fiscal_code: null,
+  amount: null,
+  description: null,
+  is_partial_payment: null,
+  due_date: null,
+  retention_date: null,
+  payment_date: null,
+  reporting_date: null,
+  inserted_date: null,
+  payment_method: null,
+  fee: null,
+  notification_fee: null,
+  psp_company: null,
+  id_receipt: null,
+  id_flow_reporting: null,
+  status: null,
+  last_updated_date: null,
+  payment_option_metadata: null,
+  transfer: null
+)
+```
+

data/docs/PaymentPositionModel.md

@@ -0,0 +1,60 @@
+# GPDDebtPositions::PaymentPositionModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **iupd** | **String** |  |  |
+| **aca** | **Boolean** |  | [optional][default to false] |
+| **type** | **String** |  |  |
+| **pay_stand_in** | **Boolean** | feature flag to enable a debt position in stand-in mode | [optional][default to true] |
+| **fiscal_code** | **String** |  |  |
+| **full_name** | **String** |  |  |
+| **street_name** | **String** |  | [optional] |
+| **civic_number** | **String** |  | [optional] |
+| **postal_code** | **String** |  | [optional] |
+| **city** | **String** |  | [optional] |
+| **province** | **String** |  | [optional] |
+| **region** | **String** |  | [optional] |
+| **country** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **phone** | **String** |  | [optional] |
+| **switch_to_expired** | **Boolean** | feature flag to enable the debt position to expire after the due date | [default to false] |
+| **company_name** | **String** |  |  |
+| **office_name** | **String** |  | [optional] |
+| **validity_date** | **Time** |  | [optional] |
+| **payment_date** | **Time** |  | [optional][readonly] |
+| **status** | **String** |  | [optional][readonly] |
+| **payment_option** | [**Array<PaymentOptionModel>**](PaymentOptionModel.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'gpd_debtposition_api'
+
+instance = GPDDebtPositions::PaymentPositionModel.new(
+  iupd: null,
+  aca: null,
+  type: null,
+  pay_stand_in: true,
+  fiscal_code: null,
+  full_name: null,
+  street_name: null,
+  civic_number: null,
+  postal_code: null,
+  city: null,
+  province: null,
+  region: null,
+  country: null,
+  email: null,
+  phone: null,
+  switch_to_expired: false,
+  company_name: null,
+  office_name: null,
+  validity_date: null,
+  payment_date: null,
+  status: null,
+  payment_option: null
+)
+```
+

data/docs/PaymentPositionModelBaseResponse.md

@@ -0,0 +1,44 @@
+# GPDDebtPositions::PaymentPositionModelBaseResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **iupd** | **String** |  | [optional] |
+| **aca** | **Boolean** |  | [optional][default to false] |
+| **pay_stand_in** | **Boolean** |  | [optional][default to true] |
+| **organization_fiscal_code** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **company_name** | **String** |  | [optional] |
+| **office_name** | **String** |  | [optional] |
+| **inserted_date** | **Time** |  | [optional] |
+| **publish_date** | **Time** |  | [optional] |
+| **validity_date** | **Time** |  | [optional] |
+| **payment_date** | **Time** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **last_updated_date** | **Time** |  | [optional] |
+| **payment_option** | [**Array<PaymentOptionModelResponse>**](PaymentOptionModelResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'gpd_debtposition_api'
+
+instance = GPDDebtPositions::PaymentPositionModelBaseResponse.new(
+  iupd: null,
+  aca: null,
+  pay_stand_in: null,
+  organization_fiscal_code: null,
+  type: null,
+  company_name: null,
+  office_name: null,
+  inserted_date: null,
+  publish_date: null,
+  validity_date: null,
+  payment_date: null,
+  status: null,
+  last_updated_date: null,
+  payment_option: null
+)
+```
+

data/docs/PaymentPositionsInfo.md

@@ -0,0 +1,20 @@
+# GPDDebtPositions::PaymentPositionsInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_position_list** | [**Array<PaymentPositionModelBaseResponse>**](PaymentPositionModelBaseResponse.md) |  |  |
+| **page_info** | [**PageInfo**](PageInfo.md) |  |  |
+
+## Example
+
+```ruby
+require 'gpd_debtposition_api'
+
+instance = GPDDebtPositions::PaymentPositionsInfo.new(
+  payment_position_list: null,
+  page_info: null
+)
+```
+

data/docs/ProblemJson.md

@@ -0,0 +1,22 @@
+# GPDDebtPositions::ProblemJson
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** | A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable | [optional] |
+| **status** | **Integer** | The HTTP status code generated by the origin server for this occurrence of the problem. | [optional] |
+| **detail** | **String** | A human readable explanation specific to this occurrence of the problem. | [optional] |
+
+## Example
+
+```ruby
+require 'gpd_debtposition_api'
+
+instance = GPDDebtPositions::ProblemJson.new(
+  title: null,
+  status: 200,
+  detail: There was an error processing the request
+)
+```
+

data/docs/Stamp.md

@@ -0,0 +1,22 @@
+# GPDDebtPositions::Stamp
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hash_document** | **String** | Document hash |  |
+| **stamp_type** | **String** | The type of the stamp |  |
+| **provincial_residence** | **String** | The provincial of the residence |  |
+
+## Example
+
+```ruby
+require 'gpd_debtposition_api'
+
+instance = GPDDebtPositions::Stamp.new(
+  hash_document: null,
+  stamp_type: null,
+  provincial_residence: RM
+)
+```
+

data/docs/TransferMetadataModel.md

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

data/docs/TransferMetadataModelResponse.md

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

data/docs/TransferModel.md

@@ -0,0 +1,34 @@
+# GPDDebtPositions::TransferModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id_transfer** | **String** |  |  |
+| **amount** | **Integer** |  |  |
+| **organization_fiscal_code** | **String** | Fiscal code related to the organization targeted by this transfer. | [optional] |
+| **remittance_information** | **String** |  |  |
+| **category** | **String** |  |  |
+| **iban** | **String** | mutual exclusive with stamp | [optional] |
+| **postal_iban** | **String** | optional - can be combined with iban but not with stamp | [optional] |
+| **stamp** | [**Stamp**](Stamp.md) |  | [optional] |
+| **transfer_metadata** | [**Array<TransferMetadataModel>**](TransferMetadataModel.md) | it can added a maximum of 10 key-value pairs for metadata | [optional] |
+
+## Example
+
+```ruby
+require 'gpd_debtposition_api'
+
+instance = GPDDebtPositions::TransferModel.new(
+  id_transfer: null,
+  amount: null,
+  organization_fiscal_code: 00000000000,
+  remittance_information: null,
+  category: null,
+  iban: IT0000000000000000000000000,
+  postal_iban: IT0000000000000000000000000,
+  stamp: null,
+  transfer_metadata: null
+)
+```
+

data/docs/TransferModelResponse.md

@@ -0,0 +1,40 @@
+# GPDDebtPositions::TransferModelResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_fiscal_code** | **String** |  | [optional] |
+| **id_transfer** | **String** |  | [optional] |
+| **amount** | **Integer** |  | [optional] |
+| **remittance_information** | **String** |  | [optional] |
+| **category** | **String** |  | [optional] |
+| **iban** | **String** |  | [optional] |
+| **postal_iban** | **String** |  | [optional] |
+| **stamp** | [**Stamp**](Stamp.md) |  | [optional] |
+| **inserted_date** | **Time** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **last_updated_date** | **Time** |  | [optional] |
+| **transfer_metadata** | [**Array<TransferMetadataModelResponse>**](TransferMetadataModelResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'gpd_debtposition_api'
+
+instance = GPDDebtPositions::TransferModelResponse.new(
+  organization_fiscal_code: null,
+  id_transfer: null,
+  amount: null,
+  remittance_information: null,
+  category: null,
+  iban: null,
+  postal_iban: null,
+  stamp: null,
+  inserted_date: null,
+  status: null,
+  last_updated_date: null,
+  transfer_metadata: null
+)
+```
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

data/gpd_debtposition_api.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#PagoPA API Debt Position
+
+#Progetto Gestione Posizioni Debitorie
+
+The version of the OpenAPI document: 0.11.18
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.11.0
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "gpd_debtposition_api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "gpd_debtposition_api"
+  s.version     = GPDDebtPositions::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Loris Pizzolitto"]
+  s.email       = ["loris.pizzolitto@dedagorup.it"]
+  s.homepage    = "https://openapi-generator.tech"
+  s.summary     = "Debt Positions API Ruby Gem"
+  s.description = "PagoPA GPDDebtPositions"
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 2.4"
+  s.metadata    = {}
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/lib/gpd_debtposition_api/api/debt_position_actions_api_api.rb

@@ -0,0 +1,162 @@
+=begin
+#PagoPA API Debt Position
+
+#Progetto Gestione Posizioni Debitorie
+
+The version of the OpenAPI document: 0.11.18
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.11.0
+
+=end
+
+require 'cgi'
+
+module GPDDebtPositions
+  class DebtPositionActionsAPIApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # The Organization invalidate a debt Position.
+    # @param organizationfiscalcode [String] Organization fiscal code, the fiscal code of the Organization.
+    # @param iupd [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.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_request_id This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
+    # @return [PaymentPositionModel]
+    def invalidate_position(organizationfiscalcode, iupd, opts = {})
+      data, _status_code, _headers = invalidate_position_with_http_info(organizationfiscalcode, iupd, opts)
+      data
+    end
+
+    # The Organization invalidate a debt Position.
+    # @param organizationfiscalcode [String] Organization fiscal code, the fiscal code of the Organization.
+    # @param iupd [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.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_request_id This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
+    # @return [Array<(PaymentPositionModel, Integer, Hash)>] PaymentPositionModel data, response status code and response headers
+    def invalidate_position_with_http_info(organizationfiscalcode, iupd, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DebtPositionActionsAPIApi.invalidate_position ...'
+      end
+      # verify the required parameter 'organizationfiscalcode' is set
+      if @api_client.config.client_side_validation && organizationfiscalcode.nil?
+        fail ArgumentError, "Missing the required parameter 'organizationfiscalcode' when calling DebtPositionActionsAPIApi.invalidate_position"
+      end
+      # verify the required parameter 'iupd' is set
+      if @api_client.config.client_side_validation && iupd.nil?
+        fail ArgumentError, "Missing the required parameter 'iupd' when calling DebtPositionActionsAPIApi.invalidate_position"
+      end
+      # resource path
+      local_var_path = '/organizations/{organizationfiscalcode}/debtpositions/{iupd}/invalidate'.sub('{' + 'organizationfiscalcode' + '}', CGI.escape(organizationfiscalcode.to_s)).sub('{' + 'iupd' + '}', CGI.escape(iupd.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PaymentPositionModel'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Authorization', 'ApiKey']
+
+      new_options = opts.merge(
+        :operation => :"DebtPositionActionsAPIApi.invalidate_position",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DebtPositionActionsAPIApi#invalidate_position\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # The Organization publish a debt Position.
+    # @param organizationfiscalcode [String] Organization fiscal code, the fiscal code of the Organization.
+    # @param 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.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_request_id This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
+    # @return [PaymentPositionModel]
+    def publish_position(organizationfiscalcode, iupd, opts = {})
+      data, _status_code, _headers = publish_position_with_http_info(organizationfiscalcode, iupd, opts)
+      data
+    end
+
+    # The Organization publish a debt Position.
+    # @param organizationfiscalcode [String] Organization fiscal code, the fiscal code of the Organization.
+    # @param 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.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_request_id This header identifies the call, if not passed it is self-generated. This ID is returned in the response.
+    # @return [Array<(PaymentPositionModel, Integer, Hash)>] PaymentPositionModel data, response status code and response headers
+    def publish_position_with_http_info(organizationfiscalcode, iupd, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DebtPositionActionsAPIApi.publish_position ...'
+      end
+      # verify the required parameter 'organizationfiscalcode' is set
+      if @api_client.config.client_side_validation && organizationfiscalcode.nil?
+        fail ArgumentError, "Missing the required parameter 'organizationfiscalcode' when calling DebtPositionActionsAPIApi.publish_position"
+      end
+      # verify the required parameter 'iupd' is set
+      if @api_client.config.client_side_validation && iupd.nil?
+        fail ArgumentError, "Missing the required parameter 'iupd' when calling DebtPositionActionsAPIApi.publish_position"
+      end
+      # resource path
+      local_var_path = '/organizations/{organizationfiscalcode}/debtpositions/{iupd}/publish'.sub('{' + 'organizationfiscalcode' + '}', CGI.escape(organizationfiscalcode.to_s)).sub('{' + 'iupd' + '}', CGI.escape(iupd.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PaymentPositionModel'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Authorization', 'ApiKey']
+
+      new_options = opts.merge(
+        :operation => :"DebtPositionActionsAPIApi.publish_position",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DebtPositionActionsAPIApi#publish_position\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end