pcp-server-ruby-sdk 0.1.0 → 1.1.0

data/docs/ReturnInformation.md

@@ -1,20 +0,0 @@
-# PCPServerSDK::ReturnInformation
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **return_reason** | **String** | Reason of the Refund (e.g. communicated by or to the consumer). | [optional] |
-| **items** | [**Array<CartItemInput>**](CartItemInput.md) | Items returned. | [optional] |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::ReturnInformation.new(
-  return_reason: Customer complained,
-  items: null
-)
-```
-

data/docs/ReturnItem.md

@@ -1,20 +0,0 @@
-# PCPServerSDK::ReturnItem
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | Id of the item to return. |  |
-| **quantity** | **Integer** | Quantity of the units being returned, should be greater than zero Note: Must not be all spaces or all zeros |  |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::ReturnItem.new(
-  id: 4f0c512e-f12c-11ec-8ea0-0242ac120002,
-  quantity: 1
-)
-```
-

data/docs/ReturnRequest.md

@@ -1,22 +0,0 @@
-# PCPServerSDK::ReturnRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **return_type** | [**ReturnType**](ReturnType.md) |  | [optional] |
-| **return_reason** | **String** | Reason of the Refund (e.g. communicated by or to the consumer). | [optional] |
-| **return_items** | [**Array<ReturnItem>**](ReturnItem.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::ReturnRequest.new(
-  return_type: null,
-  return_reason: Customer complained,
-  return_items: null
-)
-```
-

data/docs/ReturnResponse.md

@@ -1,20 +0,0 @@
-# PCPServerSDK::ReturnResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **return_payment_response** | [**RefundPaymentResponse**](RefundPaymentResponse.md) |  | [optional] |
-| **shopping_cart** | [**ShoppingCartResult**](ShoppingCartResult.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::ReturnResponse.new(
-  return_payment_response: null,
-  shopping_cart: null
-)
-```
-

data/docs/ReturnType.md

@@ -1,15 +0,0 @@
-# PCPServerSDK::ReturnType
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::ReturnType.new()
-```
-

data/docs/SepaDirectDebitPaymentMethodSpecificInput.md

@@ -1,20 +0,0 @@
-# PCPServerSDK::SepaDirectDebitPaymentMethodSpecificInput
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **payment_product771_specific_input** | [**SepaDirectDebitPaymentProduct771SpecificInput**](SepaDirectDebitPaymentProduct771SpecificInput.md) |  | [optional] |
-| **payment_product_id** | **Integer** | Payment product identifier - please check product documentation for a full overview of possible values. | [optional] |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::SepaDirectDebitPaymentMethodSpecificInput.new(
-  payment_product771_specific_input: null,
-  payment_product_id: 840
-)
-```
-

data/docs/SepaDirectDebitPaymentMethodSpecificOutput.md

@@ -1,20 +0,0 @@
-# PCPServerSDK::SepaDirectDebitPaymentMethodSpecificOutput
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **payment_product_id** | **Integer** | Payment product identifier - please check product documentation for a full overview of possible values. | [optional] |
-| **payment_product771_specific_output** | [**PaymentProduct771SpecificOutput**](PaymentProduct771SpecificOutput.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::SepaDirectDebitPaymentMethodSpecificOutput.new(
-  payment_product_id: 840,
-  payment_product771_specific_output: null
-)
-```
-

data/docs/SepaDirectDebitPaymentProduct771SpecificInput.md

@@ -1,20 +0,0 @@
-# PCPServerSDK::SepaDirectDebitPaymentProduct771SpecificInput
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **existing_unique_mandate_reference** | **String** | The unique reference of the existing mandate to use in this payment. | [optional] |
-| **mandate** | [**ProcessingMandateInformation**](ProcessingMandateInformation.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::SepaDirectDebitPaymentProduct771SpecificInput.new(
-  existing_unique_mandate_reference: exampleMandateReference,
-  mandate: null
-)
-```
-

data/docs/Shipping.md

@@ -1,18 +0,0 @@
-# PCPServerSDK::Shipping
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **address** | [**AddressPersonal**](AddressPersonal.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::Shipping.new(
-  address: null
-)
-```
-

data/docs/ShoppingCartInput.md

@@ -1,18 +0,0 @@
-# PCPServerSDK::ShoppingCartInput
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **items** | [**Array<CartItemInput>**](CartItemInput.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::ShoppingCartInput.new(
-  items: null
-)
-```
-

data/docs/ShoppingCartPatch.md

@@ -1,18 +0,0 @@
-# PCPServerSDK::ShoppingCartPatch
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **items** | [**Array<CartItemPatch>**](CartItemPatch.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::ShoppingCartPatch.new(
-  items: null
-)
-```
-

data/docs/ShoppingCartResult.md

@@ -1,18 +0,0 @@
-# PCPServerSDK::ShoppingCartResult
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **items** | [**Array<CartItemResult>**](CartItemResult.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::ShoppingCartResult.new(
-  items: null
-)
-```
-

data/docs/StatusCategoryValue.md

@@ -1,15 +0,0 @@
-# PCPServerSDK::StatusCategoryValue
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::StatusCategoryValue.new()
-```
-

data/docs/StatusCheckout.md

@@ -1,15 +0,0 @@
-# PCPServerSDK::StatusCheckout
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::StatusCheckout.new()
-```
-

data/docs/StatusOutput.md

@@ -1,30 +0,0 @@
-# PCPServerSDK::StatusOutput
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **payment_status** | **String** | * WAITING_FOR_PAYMENT - There does not yet exist a PaymentExecution nor a PaymentInformation for this Checkout. * PAYMENT_NOT_COMPLETED - There exists a PaymentExecution or a PaymentInformation for this Checkout, but all or some part of the total amount is still unpaid. * PAYMENT_COMPLETED - There exists a PaymentExecution or a PaymentInformation for this Checkout and the total amount is fully paid. * NO_PAYMENT - Checkout was created and deleted. No Payment Execution and no other actions can be triggered on the Checkout. | [optional] |
-| **is_modifiable** | **Boolean** | Indicates whether the Checkout can still be modified. False if any payment is already in progress, true otherwise. | [optional] |
-| **open_amount** | **Integer** | Amount in cents always having 2 decimals. The amount yet to be paid. | [optional] |
-| **collected_amount** | **Integer** | Amount in cents always having 2 decimals. The amount that has already been collected. | [optional] |
-| **cancelled_amount** | **Integer** | Amount in cents always having 2 decimals. The amount that has already been cancelled. | [optional] |
-| **refunded_amount** | **Integer** | Amount in cents always having 2 decimals. Amount that has been collected but was refunded to the customer. | [optional] |
-| **chargeback_amount** | **Integer** | Amount in cents always having 2 decimals. Amount that has been collected but was charged back by the customer. | [optional] |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::StatusOutput.new(
-  payment_status: WAITING_FOR_PAYMENT,
-  is_modifiable: null,
-  open_amount: null,
-  collected_amount: null,
-  cancelled_amount: null,
-  refunded_amount: null,
-  chargeback_amount: null
-)
-```
-

data/docs/StatusValue.md

@@ -1,15 +0,0 @@
-# PCPServerSDK::StatusValue
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::StatusValue.new()
-```
-

data/docs/ThreeDSecureResults.md

@@ -1,22 +0,0 @@
-# PCPServerSDK::ThreeDSecureResults
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **version** | **String** | 3D Secure Protocol version used during this transaction. | [optional] |
-| **scheme_eci** | **String** | 3D Secure ECI (Electronic Commerce Indicator) depending on the Scheme. Returned by DS. | [optional] |
-| **applied_exemption** | **String** | Exemption requested and applied in the authorization.  | [optional] |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::ThreeDSecureResults.new(
-  version: 2.2.0,
-  scheme_eci: 5,
-  applied_exemption: null
-)
-```
-

data/docs/TransactionChannel.md

@@ -1,15 +0,0 @@
-# PCPServerSDK::TransactionChannel
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::TransactionChannel.new()
-```
-

data/docs/UnscheduledCardOnFileRequestor.md

@@ -1,15 +0,0 @@
-# PCPServerSDK::UnscheduledCardOnFileRequestor
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::UnscheduledCardOnFileRequestor.new()
-```
-

data/docs/UnscheduledCardOnFileSequenceIndicator.md

@@ -1,15 +0,0 @@
-# PCPServerSDK::UnscheduledCardOnFileSequenceIndicator
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'PCP-server-Ruby-SDK'
-
-instance = PCPServerSDK::UnscheduledCardOnFileSequenceIndicator.new()
-```
-

data/lib/PCP-server-Ruby-SDK/api/base_api_client.rb

@@ -1,105 +0,0 @@
-require 'net/http'
-require 'json'
-require 'uri'
-
-require_relative '../communicator_configuration'
-require_relative '../request_header_generator'
-require_relative '../errors/api_error_response_exception'
-require_relative '../errors/api_response_retrieval_exception'
-
-MERCHANT_ID_REQUIRED_ERROR = 'Merchant ID is required'
-COMMERCE_CASE_ID_REQUIRED_ERROR = 'Commerce Case ID is required'
-CHECKOUT_ID_REQUIRED_ERROR = 'Checkout ID is required'
-
-class BaseApiClient
-  def initialize(config)
-    @config = config
-    @request_header_generator = RequestHeaderGenerator.new(config)
-  end
-
-protected
-
-  def get_request_header_generator
-    @request_header_generator
-  end
-
-  def get_config
-    @config
-  end
-
-  def make_api_call(url, request_init, &parse_body)
-    parse_body ||= BaseApiClient.method(:parse_json)
-
-    uri = URI.parse(url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    http.use_ssl = uri.scheme == 'https'
-    
-    headers = @request_header_generator.generate_additional_request_headers(url, request_init || {})
-    
-    request = build_http_request(uri, request_init, headers)
-    response = http.request(request)
-    
-    body = response.body
-
-    begin
-      parsed = JSON.parse(body)
-    rescue StandardError => e
-      raise ApiResponseRetrievalException.new(response.code.to_i, parsed, e)
-    end
-    
-    unless response.is_a?(Net::HTTPSuccess)
-      if is_error_response(body)
-        raise ApiErrorResponseException.new(response.code.to_i, body, parsed['errors'] || [])
-      else
-        raise ApiResponseRetrievalException.new(response.code.to_i, body)
-      end
-    end
-    
-    parsed
-  end
-
-  def self.parse_void
-    nil
-  end
-
-  def self.parse_json(body)
-    parsed = JSON.parse(body)
-    raise TypeError, 'Parsed JSON is not an object' unless parsed.is_a?(Hash)
-    
-    parsed
-  end
-
-private
-
-  def build_http_request(uri, request_init, headers)
-    method = request_init[:method].to_s.upcase
-
-    case method
-    when 'GET'
-      req = Net::HTTP::Get.new(uri)
-    when 'POST'
-      req = Net::HTTP::Post.new(uri)
-      req.body = request_init[:body] if request_init[:body]
-    else
-      raise ArgumentError, "Unsupported HTTP method: #{method}"
-    end
-
-    headers[:headers].each do |key, value|
-      req[key] = value
-    end
-
-    req
-  end
-
-  def is_error_response(parsed)
-    return false unless parsed.is_a?(Hash)
-    
-    if parsed.key?('errorId') && !parsed['errorId'].is_a?(String)
-      return false
-    end
-    if parsed.key?('errors') && !parsed['errors'].is_a?(Array)
-      return false
-    end
-    true
-  end
-end

data/lib/PCP-server-Ruby-SDK/api/checkout_api_client.rb

@@ -1,94 +0,0 @@
-require 'net/http'
-require 'json'
-require 'uri'
-require_relative 'base_api_client'
-require_relative '../queries/get_checkouts_query'
-require_relative '../models/checkout_response'
-require_relative '../models/checkouts_response'
-require_relative '../models/create_checkout_request'
-require_relative '../models/create_checkout_response'
-require_relative '../models/patch_checkout_request'
-
-class CheckoutApiClient < BaseApiClient
-  def initialize(config)
-    super(config)
-  end
-
-  def create_checkout_request(merchant_id, commerce_case_id, payload)
-    raise TypeError, MERCHANT_ID_REQUIRED_ERROR if merchant_id.nil? || merchant_id.empty?
-    raise TypeError, COMMERCE_CASE_ID_REQUIRED_ERROR if commerce_case_id.nil? || commerce_case_id.empty?
-
-    url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts")
-    
-    request_init = {
-      method: 'POST',
-      headers: { 'Content-Type' => 'application/json' },
-      body: JSON.generate(payload)
-    }
-
-    make_api_call(url.to_s, request_init)
-  end
-
-  def get_checkout_request(merchant_id, commerce_case_id, checkout_id)
-    raise TypeError, MERCHANT_ID_REQUIRED_ERROR if merchant_id.nil? || merchant_id.empty?
-    raise TypeError, COMMERCE_CASE_ID_REQUIRED_ERROR if commerce_case_id.nil? || commerce_case_id.empty?
-    raise TypeError, CHECKOUT_ID_REQUIRED_ERROR if checkout_id.nil? || checkout_id.empty?
-
-    url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts/#{checkout_id}")
-    
-    request_init = {
-      method: 'GET',
-      headers: {}
-    }
-
-    make_api_call(url.to_s, request_init)
-  end
-
-  def get_checkouts_request(merchant_id, query_params = nil)
-    raise TypeError, MERCHANT_ID_REQUIRED_ERROR if merchant_id.nil? || merchant_id.empty?
-
-    url = URI.join(get_config.host, "/v1/#{merchant_id}/checkouts")
-    
-    if query_params
-      url.query = URI.encode_www_form(query_params.to_query_map)
-    end
-
-    request_init = {
-      method: 'GET',
-      headers: {}
-    }
-
-    make_api_call(url.to_s, request_init)
-  end
-
-  def update_checkout_request(merchant_id, commerce_case_id, checkout_id, payload)
-    raise TypeError, MERCHANT_ID_REQUIRED_ERROR if merchant_id.nil? || merchant_id.empty?
-    raise TypeError, COMMERCE_CASE_ID_REQUIRED_ERROR if commerce_case_id.nil? || commerce_case_id.empty?
-    raise TypeError, CHECKOUT_ID_REQUIRED_ERROR if checkout_id.nil? || checkout_id.empty?
-
-    url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts/#{checkout_id}")
-    
-    request_init = {
-      method: 'PATCH',
-      headers: { 'Content-Type' => 'application/json' },
-      body: JSON.generate(payload)
-    }
-
-    make_api_call(url.to_s, request_init) { nil }
-  end
-
-  def remove_checkout_request(merchant_id, commerce_case_id, checkout_id)
-    raise TypeError, MERCHANT_ID_REQUIRED_ERROR if merchant_id.nil? || merchant_id.empty?
-    raise TypeError, COMMERCE_CASE_ID_REQUIRED_ERROR if commerce_case_id.nil? || commerce_case_id.empty?
-    raise TypeError, CHECKOUT_ID_REQUIRED_ERROR if checkout_id.nil? || checkout_id.empty?
-
-    url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts/#{checkout_id}")
-    
-    request_init = {
-      method: 'DELETE',
-      headers: {}
-    }
-
-    make_api_call(url.to_s, request_init) { nil }
-  end
-end

data/lib/PCP-server-Ruby-SDK/api/commerce_case_api_client.rb

@@ -1,75 +0,0 @@
-require 'net/http'
-require 'json'
-require 'uri'
-require_relative 'base_api_client'
-require_relative '../models/commerce_case_response'
-require_relative '../models/create_commerce_case_request'
-require_relative '../models/create_commerce_case_response'
-require_relative '../models/customer'
-require_relative '../queries/get_commerce_cases_query'
-
-class CommerceCaseApiClient < BaseApiClient
-  def initialize(config)
-    super(config)
-  end
-
-  def create_commerce_case_request(merchant_id, payload)
-    raise TypeError, MERCHANT_ID_REQUIRED_ERROR if merchant_id.nil? || merchant_id.empty?
-
-    url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases")
-    
-    request_init = {
-      method: 'POST',
-      headers: { 'Content-Type' => 'application/json; charset=utf-8' },
-      body: JSON.generate(payload)
-    }
-
-    make_api_call(url.to_s, request_init)
-  end
-
-  def get_commerce_case_request(merchant_id, commerce_case_id)
-    raise TypeError, MERCHANT_ID_REQUIRED_ERROR if merchant_id.nil? || merchant_id.empty?
-    raise TypeError, COMMERCE_CASE_ID_REQUIRED_ERROR if commerce_case_id.nil? || commerce_case_id.empty?
-
-    url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}")
-    
-    request_init = {
-      method: 'GET',
-      headers: {}
-    }
-
-    make_api_call(url.to_s, request_init)
-  end
-
-  def get_commerce_cases_request(merchant_id, query_params = nil)
-    raise TypeError, MERCHANT_ID_REQUIRED_ERROR if merchant_id.nil? || merchant_id.empty?
-
-    url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases")
-    
-    if query_params
-      url.query = URI.encode_www_form(query_params.to_query_map)
-    end
-
-    request_init = {
-      method: 'GET',
-      headers: {}
-    }
-
-    make_api_call(url.to_s, request_init)
-  end
-
-  def update_commerce_case_request(merchant_id, commerce_case_id, customer)
-    raise TypeError, MERCHANT_ID_REQUIRED_ERROR if merchant_id.nil? || merchant_id.empty?
-    raise TypeError, COMMERCE_CASE_ID_REQUIRED_ERROR if commerce_case_id.nil? || commerce_case_id.empty?
-
-    url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}")
-    
-    request_init = {
-      method: 'PATCH',
-      headers: { 'Content-Type' => 'application/json' },
-      body: JSON.generate({ customer: customer })
-    }
-
-    make_api_call(url.to_s, request_init) { nil }
-  end
-end