ps-apimatic-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 26744ea6b5230d320dea715ef4704accc4830176c3d240b97306a4eef81340dc
+  data.tar.gz: d8033c5a8caabe0e851cc8530937fc54126d1634696b9ac5e7f688f72985abf9
+SHA512:
+  metadata.gz: b3e86af2104cdee29134a670f1f999ec24c25f42f1d462f7e8257f579ab3705ec869178ed207f2cbe8deecc32bb7a4723f2c9ca946fb5e92ccc9904794466c24
+  data.tar.gz: 36f374977ba1f82272bfb72a411b3642e6472754e16aede06c87021ec29dbca10642a3b78259882dd51f74243b4d8eef243d0daee7ae82b12922a693e873f23c

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2026 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,231 @@
+
+# Getting Started with Paysecure API Documentation - Live
+
+## Introduction
+
+### Overview
+
+---
+
+
+Paysecure is a payment gateway optimization and intelligence service that merchants can use to provide a remote and frictionless payment experience.
+
+This documentation will help you get started with integrating Paysecure but if you have any questions, please do not hesitate to reach out to us via email at [info@paysecure.net](https://)
+
+Please be advised that our support team is only available during standard business hours.
+
+### Environments
+
+---
+
+
+These are the BaseUrls for the APIs on different environments:
+
+| **Environment** | **Base URL** |
+| --- | --- |
+| Production | [https://api.paysecure.net/api/v1](https://) |
+| Sandbox | [https://api.paysecure.net/api/v1](https://)  <br>`Note: set the Sandbox flag true (checked) in your merchant account. As shown in the image below` |
+
+### Authentication
+
+---
+
+
+To access the API, you must acquire your unique API key from the merchant dashboard -> API Keys section in your account. Make sure to use this key as a **bearer token** in the Authorization header for every request you send.
+
+`AUTHORIZATION: Bearer Token`
+
+`Token: {{APIKey}} .`
+
+Access your sandbox API key credentials by navigating to your merchant login and checking the 'is sandbox' option, located in the top right corner under merchant profile.
+
+<img src="https://content.pstmn.io/dfe64a66-8699-45c8-9f10-b00f7df380b7/U2NyZWVuc2hvdCAyMDIzLTA5LTE1IGF0IDE2LjU2LjQyLnBuZw==">
+
+
+To get to the live API key, uncheck the **'Is Sandbox'** option in the top right corner of your merchant dashboard. After unchecking, the page will refresh, and you can generate an API key for live transactions in this environment."
+
+<img src="https://content.pstmn.io/afa2574d-8438-4a63-9b29-81feb0f755e5/U2NyZWVuc2hvdCAyMDIzLTA5LTE1IGF0IDE3LjE0LjI4LnBuZw==">
+
+
+Reiterating, the API keys in Sandbox mode are for testing (when 'is sandbox' is CHECKED in the top right corner under merchant profile). The live API key credentials are for processing actual card transactions in Live mode (when 'is sandbox' is UNCHECKED in the same location)
+
+### Request Headers
+
+---
+
+
+Use these headers on every API call unless noted.
+
+| Header | Value | Required | Notes |
+| --- | --- | --- | --- |
+| `Content-Type` | `application/json` | Yes | All endpoints. Send JSON payloads. |
+| `Authorization` | `Bearer {MERCHANT_API_KEY}` | Yes | All endpoints.  <br>Replace with your merchant API key. |
+| `BrandId` | `{YOUR_BRAND_ID}` | Conditional | **Session** and **Customer**APIs.  <br>optional in customer APIs but Mandatory in Session APIs |
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install ps-apimatic-sdk -v 0.0.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'ps-apimatic-sdk', '0.0.1'
+```
+
+For additional gem details, see the [RubyGems page for the ps-apimatic-sdk gem](https://rubygems.org/gems/ps-apimatic-sdk/versions/0.0.1).
+
+## IRB Console Usage
+
+You can explore the SDK interactively using IRB in two ways
+
+### 1. Use IRB with Installed Gem
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
+
+```bash
+irb
+```
+
+Now you can load the SDK in the IRB
+
+```ruby
+require 'paysecure_api_documentation_live'
+include PaysecureApiDocumentationLive
+```
+
+### 2. Use IRB within SDK
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
+
+```
+cd path/to/paysecure_api_documentation_live
+```
+
+Now you can start the preconfigured irb console by running the following command
+
+```bash
+ruby bin/console
+```
+
+**_Note:_** This automatically loads the SDK from lib/
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| environment | [`Environment`](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION`** |
+| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| timeout | `Float` | The value to use for connection timeout. <br> **Default: 30** |
+| max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| bearer_auth_credentials | [`BearerAuthCredentials`](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'paysecure_api_documentation_live'
+include PaysecureApiDocumentationLive
+
+client = Client.new(
+  bearer_auth_credentials: BearerAuthCredentials.new(
+    access_token: 'AccessToken'
+  ),
+  environment: Environment::PRODUCTION,
+  logging_configuration: LoggingConfiguration.new(
+    log_level: Logger::INFO,
+    request_logging_config: RequestLoggingConfiguration.new(
+      log_body: true
+    ),
+    response_logging_config: ResponseLoggingConfiguration.new(
+      log_headers: true
+    )
+  )
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'paysecure_api_documentation_live'
+include PaysecureApiDocumentationLive
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md) section for details.
+
+## Environments
+
+The SDK can be configured to use a different environment for making API calls. Available environments are:
+
+### Fields
+
+| Name | Description |
+|  --- | --- |
+| PRODUCTION | **Default** |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`bearer (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md)
+
+## List of APIs
+
+* [Pay in API](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/pay-in-api.md)
+* [Pay Out API](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/pay-out-api.md)
+* [Get Balance API](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/get-balance-api.md)
+* [Refund API](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/refund-api.md)
+* [🌎 Paypal Wallet](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/paypal-wallet.md)
+* [💳 Virtual Cards Payout](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/virtual-cards-payout.md)
+* [Trust Score](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/trust-score.md)
+* [Cashier AP Is](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/cashier-ap-is.md)
+* [Transaction Reporting](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/transaction-reporting.md)
+* [Get Balance API V2-Orchestration](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/get-balance-api-v2-orchestration.md)
+* [Global Collection](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/global-collection.md)
+* [Payout Manual Review](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/payout-manual-review.md)
+* [AP Is](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/ap-is.md)
+* [Payout](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/payout.md)
+* [Payin](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/payin.md)
+* [API](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/api.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/ps-apimatic-ruby-sdk/tree/0.0.1/doc/date-time-helper.md)
+

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# Load the lib folder into Ruby's load path
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+# Require the gem
+require 'paysecure_api_documentation_live'
+
+puts 'PaysecureApiDocumentationLive SDK loaded!'
+puts 'You can now create a client with: client = PaysecureApiDocumentationLive::Client.new'
+puts 'Or use from_env: client = PaysecureApiDocumentationLive::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/paysecure_api_documentation_live/api_helper.rb

@@ -0,0 +1,10 @@
+# paysecure_api_documentation_live
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PaysecureApiDocumentationLive
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end