pq-api-matic-sdk 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +42 -42
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4fc4611dde039454847203f6650df101d58c35edb719337961c6dc2cc38130c1
|
|
4
|
+
data.tar.gz: bd22c02567eeb785b088ee9d4b64eddd43a11b3363a3698da98d3e4acd233d9a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 4fe0a7c75abd016160be2226961dd56a48e12ac3d2c111ecabcf893d7201ed3df91dc4b0ac215daf533eacacb513a9ce849e2e91d05775f35c10eda736f4d757
|
|
7
|
+
data.tar.gz: 1d22547f7cd82d68a258a71328277d3d3a2b4d76cf11ae2d5f12f8a864ebbc623836fd4bde2a5386a062bfdd8576b12ae88092b54ec298ef9ead440447a9c528
|
data/README.md
CHANGED
|
@@ -14,16 +14,16 @@ PayQuicker provides a RESTful API that allows authorized clients to send and rec
|
|
|
14
14
|
Install the gem from the command line:
|
|
15
15
|
|
|
16
16
|
```bash
|
|
17
|
-
gem install pq-api-matic-sdk -v 1.0.
|
|
17
|
+
gem install pq-api-matic-sdk -v 1.0.3
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
Or add the gem to your Gemfile and run `bundle`:
|
|
21
21
|
|
|
22
22
|
```ruby
|
|
23
|
-
gem 'pq-api-matic-sdk', '1.0.
|
|
23
|
+
gem 'pq-api-matic-sdk', '1.0.3'
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
For additional gem details, see the [RubyGems page for the pq-api-matic-sdk gem](https://rubygems.org/gems/pq-api-matic-sdk/versions/1.0.
|
|
26
|
+
For additional gem details, see the [RubyGems page for the pq-api-matic-sdk gem](https://rubygems.org/gems/pq-api-matic-sdk/versions/1.0.3).
|
|
27
27
|
|
|
28
28
|
## IRB Console Usage
|
|
29
29
|
|
|
@@ -62,7 +62,7 @@ ruby bin/console
|
|
|
62
62
|
|
|
63
63
|
## Initialize the API Client
|
|
64
64
|
|
|
65
|
-
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
65
|
+
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/client.md)
|
|
66
66
|
|
|
67
67
|
The following parameters are configurable for the API Client:
|
|
68
68
|
|
|
@@ -71,7 +71,7 @@ The following parameters are configurable for the API Client:
|
|
|
71
71
|
| x_my_pay_quicker_version | `String` | Date-based API Version specified in the header *required* on all calls.<br>*Default*: `'2026.02.01'` |
|
|
72
72
|
| sandbox_instance | `SandboxInstance` | Sandbox Environments<br>*Default*: `SandboxInstance::SANDBOX` |
|
|
73
73
|
| uat_instance | `UatInstance` | UAT Environments<br>*Default*: `UatInstance::UAT1` |
|
|
74
|
-
| environment | [`Environment`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
74
|
+
| environment | [`Environment`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/README.md#environments) | The API environment. <br> **Default: `Environment.SANDBOX`** |
|
|
75
75
|
| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
|
|
76
76
|
| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
|
|
77
77
|
| timeout | `Float` | The value to use for connection timeout. <br> **Default: 60** |
|
|
@@ -81,10 +81,10 @@ The following parameters are configurable for the API Client:
|
|
|
81
81
|
| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
|
|
82
82
|
| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
|
|
83
83
|
| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
|
|
84
|
-
| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
85
|
-
| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
86
|
-
| server_credentials | [`ServerCredentials`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
87
|
-
| clientside_credentials | [`ClientsideCredentials`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
84
|
+
| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
|
|
85
|
+
| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/logging-configuration.md) | The SDK logging configuration for API calls |
|
|
86
|
+
| server_credentials | [`ServerCredentials`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
|
|
87
|
+
| clientside_credentials | [`ClientsideCredentials`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
|
|
88
88
|
|
|
89
89
|
The API client can be initialized as follows:
|
|
90
90
|
|
|
@@ -132,7 +132,7 @@ include PayQuickerSdk
|
|
|
132
132
|
client = Client.from_env
|
|
133
133
|
```
|
|
134
134
|
|
|
135
|
-
See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
135
|
+
See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/environment-based-client-initialization.md) section for details.
|
|
136
136
|
|
|
137
137
|
## Environments
|
|
138
138
|
|
|
@@ -151,50 +151,50 @@ The SDK can be configured to use a different environment for making API calls. A
|
|
|
151
151
|
|
|
152
152
|
This API uses the following authentication schemes.
|
|
153
153
|
|
|
154
|
-
* [`server (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
155
|
-
* [`clientside (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
154
|
+
* [`server (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/auth/oauth-2-client-credentials-grant.md)
|
|
155
|
+
* [`clientside (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/auth/oauth-2-bearer-token.md)
|
|
156
156
|
|
|
157
157
|
## List of APIs
|
|
158
158
|
|
|
159
|
-
* [Agreements](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
160
|
-
* [Balances](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
161
|
-
* [Bank Accounts](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
162
|
-
* [Client Side](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
163
|
-
* [Compliance](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
164
|
-
* [Documents](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
165
|
-
* [Electronic Wallets](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
166
|
-
* [Events](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
167
|
-
* [Invitations](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
168
|
-
* [Jobs](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
169
|
-
* [Payments](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
170
|
-
* [Prepaid Cards](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
171
|
-
* [Program](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
172
|
-
* [Receipts](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
173
|
-
* [Spendback](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
174
|
-
* [Spendback Refunds](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
175
|
-
* [Statements](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
176
|
-
* [Transfers](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
177
|
-
* [Users](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
178
|
-
* [Webhooks](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
159
|
+
* [Agreements](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/agreements.md)
|
|
160
|
+
* [Balances](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/balances.md)
|
|
161
|
+
* [Bank Accounts](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/bank-accounts.md)
|
|
162
|
+
* [Client Side](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/client-side.md)
|
|
163
|
+
* [Compliance](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/compliance.md)
|
|
164
|
+
* [Documents](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/documents.md)
|
|
165
|
+
* [Electronic Wallets](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/electronic-wallets.md)
|
|
166
|
+
* [Events](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/events.md)
|
|
167
|
+
* [Invitations](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/invitations.md)
|
|
168
|
+
* [Jobs](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/jobs.md)
|
|
169
|
+
* [Payments](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/payments.md)
|
|
170
|
+
* [Prepaid Cards](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/prepaid-cards.md)
|
|
171
|
+
* [Program](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/program.md)
|
|
172
|
+
* [Receipts](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/receipts.md)
|
|
173
|
+
* [Spendback](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/spendback.md)
|
|
174
|
+
* [Spendback Refunds](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/spendback-refunds.md)
|
|
175
|
+
* [Statements](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/statements.md)
|
|
176
|
+
* [Transfers](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/transfers.md)
|
|
177
|
+
* [Users](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/users.md)
|
|
178
|
+
* [Webhooks](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/controllers/webhooks.md)
|
|
179
179
|
|
|
180
180
|
## SDK Infrastructure
|
|
181
181
|
|
|
182
182
|
### Configuration
|
|
183
183
|
|
|
184
|
-
* [ProxySettings](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
185
|
-
* [Environment-Based Client Initialization](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
186
|
-
* [AbstractLogger](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
187
|
-
* [LoggingConfiguration](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
188
|
-
* [RequestLoggingConfiguration](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
189
|
-
* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
184
|
+
* [ProxySettings](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/proxy-settings.md)
|
|
185
|
+
* [Environment-Based Client Initialization](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/environment-based-client-initialization.md)
|
|
186
|
+
* [AbstractLogger](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/abstract-logger.md)
|
|
187
|
+
* [LoggingConfiguration](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/logging-configuration.md)
|
|
188
|
+
* [RequestLoggingConfiguration](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/request-logging-configuration.md)
|
|
189
|
+
* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/response-logging-configuration.md)
|
|
190
190
|
|
|
191
191
|
### HTTP
|
|
192
192
|
|
|
193
|
-
* [HttpResponse](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
194
|
-
* [HttpRequest](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
193
|
+
* [HttpResponse](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/http-response.md)
|
|
194
|
+
* [HttpRequest](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/http-request.md)
|
|
195
195
|
|
|
196
196
|
### Utilities
|
|
197
197
|
|
|
198
|
-
* [ApiHelper](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
199
|
-
* [DateTimeHelper](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.
|
|
198
|
+
* [ApiHelper](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/api-helper.md)
|
|
199
|
+
* [DateTimeHelper](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.3/doc/date-time-helper.md)
|
|
200
200
|
|