payquicker-apimatic-sdk 1.0.0 → 1.0.1

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.
Files changed (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +42 -42
  3. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e613e7e8da161ea8407d39bc3838b51c5cd8dee1afbf0ca9f57b3d3c460fbee7
4
- data.tar.gz: fe76504cf41820c7d478a4e8dee1bffe6194c7eedeb1ee2b232421c565fd9f1b
3
+ metadata.gz: cfc4fa405010601e1db2f1990fa8309e439ea345984e9c41c3710c3cbb93bc58
4
+ data.tar.gz: 71369ae54107698df30bda465a779d2bc3895f3d0b224541f7e704cfb4f2ffcb
5
5
  SHA512:
6
- metadata.gz: 4b0e89952bc29f8fdfc170329d7498bed14dc4eb5f9fa72fcc3e934201dd7064acaa2d7718ee8198b1036fdb6865ed4c58fdeec56b9f1c8367197a350dc2f3b0
7
- data.tar.gz: 4a06478bfd3e0b4f0e9622e7c6122395ce12aaca74975436d7954fb274cbdab2d4b0db2429b359a9d380bcafb712f6351400adf92e678e0eb53d1e52c5b33a9c
6
+ metadata.gz: fba1de40e7895502e1100be2c6e5841c5d0f840b8b4527bddafc5bd812afb839b91f35718bfdd80f5c54af53b507e7065f89bbf7f1112368ebfa5a5c67ee0df7
7
+ data.tar.gz: d590f81cf4fed93a81ea24e3a2b7909364da3dbff2762328919f26f63df6d1ffe03630a922bcc0d4f63961bccef2d2d743b0b376d578a7f3f373f86cc69b2eaa
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 payquicker-apimatic-sdk -v 1.0.0
17
+ gem install payquicker-apimatic-sdk -v 1.0.1
18
18
  ```
19
19
 
20
20
  Or add the gem to your Gemfile and run `bundle`:
21
21
 
22
22
  ```ruby
23
- gem 'payquicker-apimatic-sdk', '1.0.0'
23
+ gem 'payquicker-apimatic-sdk', '1.0.1'
24
24
  ```
25
25
 
26
- For additional gem details, see the [RubyGems page for the payquicker-apimatic-sdk gem](https://rubygems.org/gems/payquicker-apimatic-sdk/versions/1.0.0).
26
+ For additional gem details, see the [RubyGems page for the payquicker-apimatic-sdk gem](https://rubygems.org/gems/payquicker-apimatic-sdk/versions/1.0.1).
27
27
 
28
28
  ## IRB Console Usage
29
29
 
@@ -70,7 +70,7 @@ rake
70
70
 
71
71
  ## Initialize the API Client
72
72
 
73
- **_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/client.md)
73
+ **_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/client.md)
74
74
 
75
75
  The following parameters are configurable for the API Client:
76
76
 
@@ -79,7 +79,7 @@ The following parameters are configurable for the API Client:
79
79
  | x_my_pay_quicker_version | `String` | Date-based API Version specified in the header *required* on all calls.<br>*Default*: `'2026.02.01'` |
80
80
  | sandbox_instance | `SandboxInstance` | Sandbox Environments<br>*Default*: `SandboxInstance::SANDBOX` |
81
81
  | uat_instance | `UatInstance` | UAT Environments<br>*Default*: `UatInstance::UAT1` |
82
- | environment | [`Environment`](https://www.github.com/sdks-io/payquicker/tree/1.0.0/README.md#environments) | The API environment. <br> **Default: `Environment.SANDBOX`** |
82
+ | environment | [`Environment`](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/README.md#environments) | The API environment. <br> **Default: `Environment.SANDBOX`** |
83
83
  | connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
84
84
  | adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
85
85
  | timeout | `Float` | The value to use for connection timeout. <br> **Default: 60** |
@@ -89,10 +89,10 @@ The following parameters are configurable for the API Client:
89
89
  | retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
90
90
  | retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
91
91
  | http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
92
- | proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
93
- | logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/logging-configuration.md) | The SDK logging configuration for API calls |
94
- | server_credentials | [`ServerCredentials`](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
95
- | clientside_credentials | [`ClientsideCredentials`](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
92
+ | proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
93
+ | logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
94
+ | server_credentials | [`ServerCredentials`](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
95
+ | clientside_credentials | [`ClientsideCredentials`](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
96
96
 
97
97
  The API client can be initialized as follows:
98
98
 
@@ -140,7 +140,7 @@ include PayQuickerSdk
140
140
  client = Client.from_env
141
141
  ```
142
142
 
143
- See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/environment-based-client-initialization.md) section for details.
143
+ See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/environment-based-client-initialization.md) section for details.
144
144
 
145
145
  ## Environments
146
146
 
@@ -159,50 +159,50 @@ The SDK can be configured to use a different environment for making API calls. A
159
159
 
160
160
  This API uses the following authentication schemes.
161
161
 
162
- * [`server (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md)
163
- * [`clientside (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/auth/oauth-2-bearer-token.md)
162
+ * [`server (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/auth/oauth-2-client-credentials-grant.md)
163
+ * [`clientside (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/auth/oauth-2-bearer-token.md)
164
164
 
165
165
  ## List of APIs
166
166
 
167
- * [Agreements](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/agreements.md)
168
- * [Balances](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/balances.md)
169
- * [Bank Accounts](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/bank-accounts.md)
170
- * [Client Side](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/client-side.md)
171
- * [Compliance](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/compliance.md)
172
- * [Documents](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/documents.md)
173
- * [Electronic Wallets](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/electronic-wallets.md)
174
- * [Events](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/events.md)
175
- * [Invitations](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/invitations.md)
176
- * [Jobs](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/jobs.md)
177
- * [Payments](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/payments.md)
178
- * [Prepaid Cards](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/prepaid-cards.md)
179
- * [Program](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/program.md)
180
- * [Receipts](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/receipts.md)
181
- * [Spendback](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/spendback.md)
182
- * [Spendback Refunds](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/spendback-refunds.md)
183
- * [Statements](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/statements.md)
184
- * [Transfers](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/transfers.md)
185
- * [Users](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/users.md)
186
- * [Webhooks](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/controllers/webhooks.md)
167
+ * [Agreements](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/agreements.md)
168
+ * [Balances](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/balances.md)
169
+ * [Bank Accounts](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/bank-accounts.md)
170
+ * [Client Side](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/client-side.md)
171
+ * [Compliance](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/compliance.md)
172
+ * [Documents](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/documents.md)
173
+ * [Electronic Wallets](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/electronic-wallets.md)
174
+ * [Events](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/events.md)
175
+ * [Invitations](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/invitations.md)
176
+ * [Jobs](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/jobs.md)
177
+ * [Payments](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/payments.md)
178
+ * [Prepaid Cards](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/prepaid-cards.md)
179
+ * [Program](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/program.md)
180
+ * [Receipts](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/receipts.md)
181
+ * [Spendback](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/spendback.md)
182
+ * [Spendback Refunds](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/spendback-refunds.md)
183
+ * [Statements](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/statements.md)
184
+ * [Transfers](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/transfers.md)
185
+ * [Users](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/users.md)
186
+ * [Webhooks](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/controllers/webhooks.md)
187
187
 
188
188
  ## SDK Infrastructure
189
189
 
190
190
  ### Configuration
191
191
 
192
- * [ProxySettings](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/proxy-settings.md)
193
- * [Environment-Based Client Initialization](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/environment-based-client-initialization.md)
194
- * [AbstractLogger](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/abstract-logger.md)
195
- * [LoggingConfiguration](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/logging-configuration.md)
196
- * [RequestLoggingConfiguration](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/request-logging-configuration.md)
197
- * [ResponseLoggingConfiguration](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/response-logging-configuration.md)
192
+ * [ProxySettings](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/proxy-settings.md)
193
+ * [Environment-Based Client Initialization](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/environment-based-client-initialization.md)
194
+ * [AbstractLogger](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/abstract-logger.md)
195
+ * [LoggingConfiguration](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/logging-configuration.md)
196
+ * [RequestLoggingConfiguration](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/request-logging-configuration.md)
197
+ * [ResponseLoggingConfiguration](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/response-logging-configuration.md)
198
198
 
199
199
  ### HTTP
200
200
 
201
- * [HttpResponse](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/http-response.md)
202
- * [HttpRequest](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/http-request.md)
201
+ * [HttpResponse](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/http-response.md)
202
+ * [HttpRequest](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/http-request.md)
203
203
 
204
204
  ### Utilities
205
205
 
206
- * [ApiHelper](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/api-helper.md)
207
- * [DateTimeHelper](https://www.github.com/sdks-io/payquicker/tree/1.0.0/doc/date-time-helper.md)
206
+ * [ApiHelper](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/api-helper.md)
207
+ * [DateTimeHelper](https://www.github.com/sdks-io/payquicker-ruby-sdk/tree/1.0.1/doc/date-time-helper.md)
208
208
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: payquicker-apimatic-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Muhammad Awais Rafique