apimatic-stax-sdk 0.0.1 → 0.0.2
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 +49 -49
- data/lib/stax_fatt_merchant_api/apis/base_api.rb +1 -1
- 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: b48fed4da155b3c0ce599763911cc1439b9fe0c351bf4cc97d43992b1ea75037
|
|
4
|
+
data.tar.gz: 737a6c4aa0bc107ed926cf764ecb77d4fcab43dddca88944539ca39fc2643c30
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e2113c3856f52eb25764bcded68d4afcae04c6ebcefe8c0a803a6a731b33d7176d98b3a6508405f41a01c960c055799cb25f4aa891cc4707a5092ef5b8cdb277
|
|
7
|
+
data.tar.gz: 9b9c2ed5dcce572d9a5e5484b760b74ccb36bd2cf2b4cfa89dbe33be7c8b3bedc7c5c4127b78ac8e56d085efccc7dd0cfe2f4abc95c25e898873913616be800f
|
data/README.md
CHANGED
|
@@ -12,16 +12,16 @@ All routes require JWT authentication unless otherwise noted.
|
|
|
12
12
|
Install the gem from the command line:
|
|
13
13
|
|
|
14
14
|
```bash
|
|
15
|
-
gem install apimatic-stax-sdk -v 0.0.
|
|
15
|
+
gem install apimatic-stax-sdk -v 0.0.2
|
|
16
16
|
```
|
|
17
17
|
|
|
18
18
|
Or add the gem to your Gemfile and run `bundle`:
|
|
19
19
|
|
|
20
20
|
```ruby
|
|
21
|
-
gem 'apimatic-stax-sdk', '0.0.
|
|
21
|
+
gem 'apimatic-stax-sdk', '0.0.2'
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
For additional gem details, see the [RubyGems page for the apimatic-stax-sdk gem](https://rubygems.org/gems/apimatic-stax-sdk/versions/0.0.
|
|
24
|
+
For additional gem details, see the [RubyGems page for the apimatic-stax-sdk gem](https://rubygems.org/gems/apimatic-stax-sdk/versions/0.0.2).
|
|
25
25
|
|
|
26
26
|
## IRB Console Usage
|
|
27
27
|
|
|
@@ -60,13 +60,13 @@ ruby bin/console
|
|
|
60
60
|
|
|
61
61
|
## Initialize the API Client
|
|
62
62
|
|
|
63
|
-
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
63
|
+
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/client.md)
|
|
64
64
|
|
|
65
65
|
The following parameters are configurable for the API Client:
|
|
66
66
|
|
|
67
67
|
| Parameter | Type | Description |
|
|
68
68
|
| --- | --- | --- |
|
|
69
|
-
| environment | [`Environment`](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
69
|
+
| environment | [`Environment`](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION`** |
|
|
70
70
|
| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
|
|
71
71
|
| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
|
|
72
72
|
| timeout | `Float` | The value to use for connection timeout. <br> **Default: 30** |
|
|
@@ -76,9 +76,9 @@ The following parameters are configurable for the API Client:
|
|
|
76
76
|
| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
|
|
77
77
|
| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
|
|
78
78
|
| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
|
|
79
|
-
| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
80
|
-
| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
81
|
-
| bearer_auth_credentials | [`BearerAuthCredentials`](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
79
|
+
| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
|
|
80
|
+
| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/logging-configuration.md) | The SDK logging configuration for API calls |
|
|
81
|
+
| bearer_auth_credentials | [`BearerAuthCredentials`](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
|
|
82
82
|
|
|
83
83
|
The API client can be initialized as follows:
|
|
84
84
|
|
|
@@ -115,7 +115,7 @@ include StaxFattMerchantApi
|
|
|
115
115
|
client = Client.from_env
|
|
116
116
|
```
|
|
117
117
|
|
|
118
|
-
See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
118
|
+
See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/environment-based-client-initialization.md) section for details.
|
|
119
119
|
|
|
120
120
|
## Environments
|
|
121
121
|
|
|
@@ -132,58 +132,58 @@ The SDK can be configured to use a different environment for making API calls. A
|
|
|
132
132
|
|
|
133
133
|
This API uses the following authentication schemes.
|
|
134
134
|
|
|
135
|
-
* [`bearerAuth (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
135
|
+
* [`bearerAuth (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/auth/oauth-2-bearer-token.md)
|
|
136
136
|
|
|
137
137
|
## List of APIs
|
|
138
138
|
|
|
139
|
-
* [Team Users](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
140
|
-
* [Team API Keys](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
141
|
-
* [Team Options](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
142
|
-
* [Team Registration](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
143
|
-
* [Team Funding Accounts](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
144
|
-
* [Invoice Schedule](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
145
|
-
* [Dispute File](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
146
|
-
* [Payment Method](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
147
|
-
* [Merchant Admin](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
148
|
-
* [User Admin](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
149
|
-
* [Web Payment](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
150
|
-
* [Self](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
151
|
-
* [Team](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
152
|
-
* [Webhook](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
153
|
-
* [Transaction](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
154
|
-
* [Invoice](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
155
|
-
* [Customer](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
156
|
-
* [Item](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
157
|
-
* [File](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
158
|
-
* [Integration](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
159
|
-
* [Hello Sign](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
160
|
-
* [Reporting](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
161
|
-
* [Charge](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
162
|
-
* [Credit](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
163
|
-
* [Verify](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
164
|
-
* [Terminal](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
165
|
-
* [Sandbox](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
166
|
-
* [Cache](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
139
|
+
* [Team Users](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/team-users.md)
|
|
140
|
+
* [Team API Keys](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/team-api-keys.md)
|
|
141
|
+
* [Team Options](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/team-options.md)
|
|
142
|
+
* [Team Registration](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/team-registration.md)
|
|
143
|
+
* [Team Funding Accounts](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/team-funding-accounts.md)
|
|
144
|
+
* [Invoice Schedule](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/invoice-schedule.md)
|
|
145
|
+
* [Dispute File](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/dispute-file.md)
|
|
146
|
+
* [Payment Method](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/payment-method.md)
|
|
147
|
+
* [Merchant Admin](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/merchant-admin.md)
|
|
148
|
+
* [User Admin](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/user-admin.md)
|
|
149
|
+
* [Web Payment](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/web-payment.md)
|
|
150
|
+
* [Self](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/self.md)
|
|
151
|
+
* [Team](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/team.md)
|
|
152
|
+
* [Webhook](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/webhook.md)
|
|
153
|
+
* [Transaction](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/transaction.md)
|
|
154
|
+
* [Invoice](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/invoice.md)
|
|
155
|
+
* [Customer](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/customer.md)
|
|
156
|
+
* [Item](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/item.md)
|
|
157
|
+
* [File](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/file.md)
|
|
158
|
+
* [Integration](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/integration.md)
|
|
159
|
+
* [Hello Sign](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/hello-sign.md)
|
|
160
|
+
* [Reporting](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/reporting.md)
|
|
161
|
+
* [Charge](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/charge.md)
|
|
162
|
+
* [Credit](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/credit.md)
|
|
163
|
+
* [Verify](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/verify.md)
|
|
164
|
+
* [Terminal](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/terminal.md)
|
|
165
|
+
* [Sandbox](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/sandbox.md)
|
|
166
|
+
* [Cache](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/controllers/cache.md)
|
|
167
167
|
|
|
168
168
|
## SDK Infrastructure
|
|
169
169
|
|
|
170
170
|
### Configuration
|
|
171
171
|
|
|
172
|
-
* [ProxySettings](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
173
|
-
* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
174
|
-
* [AbstractLogger](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
175
|
-
* [LoggingConfiguration](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
176
|
-
* [RequestLoggingConfiguration](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
177
|
-
* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
172
|
+
* [ProxySettings](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/proxy-settings.md)
|
|
173
|
+
* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/environment-based-client-initialization.md)
|
|
174
|
+
* [AbstractLogger](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/abstract-logger.md)
|
|
175
|
+
* [LoggingConfiguration](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/logging-configuration.md)
|
|
176
|
+
* [RequestLoggingConfiguration](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/request-logging-configuration.md)
|
|
177
|
+
* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/response-logging-configuration.md)
|
|
178
178
|
|
|
179
179
|
### HTTP
|
|
180
180
|
|
|
181
|
-
* [HttpResponse](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
182
|
-
* [HttpRequest](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
181
|
+
* [HttpResponse](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/http-response.md)
|
|
182
|
+
* [HttpRequest](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/http-request.md)
|
|
183
183
|
|
|
184
184
|
### Utilities
|
|
185
185
|
|
|
186
|
-
* [ApiResponse](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
187
|
-
* [ApiHelper](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
188
|
-
* [DateTimeHelper](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.
|
|
186
|
+
* [ApiResponse](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/api-response.md)
|
|
187
|
+
* [ApiHelper](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/api-helper.md)
|
|
188
|
+
* [DateTimeHelper](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.2/doc/date-time-helper.md)
|
|
189
189
|
|
|
@@ -10,7 +10,7 @@ module StaxFattMerchantApi
|
|
|
10
10
|
attr_accessor :config, :http_call_back
|
|
11
11
|
|
|
12
12
|
def self.user_agent
|
|
13
|
-
'Ruby-SDK/0.0.
|
|
13
|
+
'Ruby-SDK/0.0.2 (OS: {os-info}, Engine: {engine}/{engine-version})'
|
|
14
14
|
end
|
|
15
15
|
|
|
16
16
|
def self.user_agent_parameters
|