fortis-apimatic-sdk 1.0.0 → 1.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.
Files changed (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +55 -55
  3. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 201bd5899c0f56a214ac746247a323779583b65a642005ccc2ed49ba4d2876fa
4
- data.tar.gz: 419a05724dd957a86bf76bcc35b0a7029abe41ff84c31c7c3659364986a035d6
3
+ metadata.gz: 0d3b3ce7b5de74f27b4506dea12d4533f10255f5262c726efb0776ecba67e206
4
+ data.tar.gz: 437e8776f8a9b6d9bc9ce48f95475d7733e1059ea1ccc003e1c8ba77344944d7
5
5
  SHA512:
6
- metadata.gz: 00d2907dd0a17d9d47d8331233ecee8f0b299446be137dfc2170278be3a60b7aff36de0641977d28e309c02d1583ba0a559f76386fe3b3e204254af08772ae6e
7
- data.tar.gz: a9a3ff0a46ca745c03a8fb6d8061a41fef0ce72aa22c0da7e3bf27560138abdddedcabfa78c15451e339e9df6886bda6381149ac847fce5d6785636e1193882c
6
+ metadata.gz: d0b0994aaa3e5a9c8b0a394b02dc71095f81e84861c5fe34ba359cde156edb2fc6d184fcf8948be318c146e0c59a78264f61333cc54e98fb711872da7ba77789
7
+ data.tar.gz: fe2538fbb01b2788c2ba15317d4f9af3ffde969106eae3310a882909da9614fc32e64a2daf9e7f47ce7c4e986e5b34c299b60c5bc22e4539f450da6ad70b6ea2
data/README.md CHANGED
@@ -6,16 +6,16 @@
6
6
  Install the gem from the command line:
7
7
 
8
8
  ```bash
9
- gem install fortis-apimatic-sdk -v 1.0.0
9
+ gem install fortis-apimatic-sdk -v 1.0.2
10
10
  ```
11
11
 
12
12
  Or add the gem to your Gemfile and run `bundle`:
13
13
 
14
14
  ```ruby
15
- gem 'fortis-apimatic-sdk', '1.0.0'
15
+ gem 'fortis-apimatic-sdk', '1.0.2'
16
16
  ```
17
17
 
18
- For additional gem details, see the [RubyGems page for the fortis-apimatic-sdk gem](https://rubygems.org/gems/fortis-apimatic-sdk/versions/1.0.0).
18
+ For additional gem details, see the [RubyGems page for the fortis-apimatic-sdk gem](https://rubygems.org/gems/fortis-apimatic-sdk/versions/1.0.2).
19
19
 
20
20
  ## IRB Console Usage
21
21
 
@@ -62,13 +62,13 @@ rake
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/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/client.md)
65
+ **_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/client.md)
66
66
 
67
67
  The following parameters are configurable for the API Client:
68
68
 
69
69
  | Parameter | Type | Description |
70
70
  | --- | --- | --- |
71
- | environment | [`Environment`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/README.md#environments) | The API environment. <br> **Default: `Environment.SANDBOX`** |
71
+ | environment | [`Environment`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/README.md#environments) | The API environment. <br> **Default: `Environment.SANDBOX`** |
72
72
  | connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
73
73
  | adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
74
74
  | timeout | `Float` | The value to use for connection timeout. <br> **Default: 60** |
@@ -78,11 +78,11 @@ The following parameters are configurable for the API Client:
78
78
  | retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
79
79
  | retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
80
80
  | http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
81
- | proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
82
- | user_id_credentials | [`UserIdCredentials`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
83
- | user_api_key_credentials | [`UserApiKeyCredentials`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/auth/custom-header-signature-1.md) | The credential object for Custom Header Signature |
84
- | developer_id_credentials | [`DeveloperIdCredentials`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/auth/custom-header-signature-2.md) | The credential object for Custom Header Signature |
85
- | access_token_credentials | [`AccessTokenCredentials`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/auth/custom-header-signature-3.md) | The credential object for Custom Header Signature |
81
+ | proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
82
+ | user_id_credentials | [`UserIdCredentials`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
83
+ | user_api_key_credentials | [`UserApiKeyCredentials`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/auth/custom-header-signature-1.md) | The credential object for Custom Header Signature |
84
+ | developer_id_credentials | [`DeveloperIdCredentials`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/auth/custom-header-signature-2.md) | The credential object for Custom Header Signature |
85
+ | access_token_credentials | [`AccessTokenCredentials`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/auth/custom-header-signature-3.md) | The credential object for Custom Header Signature |
86
86
 
87
87
  The API client can be initialized as follows:
88
88
 
@@ -119,7 +119,7 @@ include FortisApi
119
119
  client = Client.from_env
120
120
  ```
121
121
 
122
- See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/environment-based-client-initialization.md) section for details.
122
+ See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/environment-based-client-initialization.md) section for details.
123
123
 
124
124
  ## Environments
125
125
 
@@ -136,62 +136,62 @@ The SDK can be configured to use a different environment for making API calls. A
136
136
 
137
137
  This API uses the following authentication schemes.
138
138
 
139
- * [`user-id (Custom Header Signature)`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/auth/custom-header-signature.md)
140
- * [`user-api-key (Custom Header Signature)`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/auth/custom-header-signature-1.md)
141
- * [`developer-id (Custom Header Signature)`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/auth/custom-header-signature-2.md)
142
- * [`access-token (Custom Header Signature)`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/auth/custom-header-signature-3.md)
139
+ * [`user-id (Custom Header Signature)`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/auth/custom-header-signature.md)
140
+ * [`user-api-key (Custom Header Signature)`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/auth/custom-header-signature-1.md)
141
+ * [`developer-id (Custom Header Signature)`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/auth/custom-header-signature-2.md)
142
+ * [`access-token (Custom Header Signature)`](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/auth/custom-header-signature-3.md)
143
143
 
144
144
  ## List of APIs
145
145
 
146
- * [Async Processing](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/async-processing.md)
147
- * [Declined Recurring Transactions](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/declined-recurring-transactions.md)
148
- * [Device Terms](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/device-terms.md)
149
- * [Full Boarding](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/full-boarding.md)
150
- * [3 DS Authentication](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/3-ds-authentication.md)
151
- * [3 DS Transactions](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/3-ds-transactions.md)
152
- * [Merchant Deposits](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/merchant-deposits.md)
153
- * [On Boarding](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/on-boarding.md)
154
- * [Payment Card Reader Token](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/payment-card-reader-token.md)
155
- * [Quick Invoices](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/quick-invoices.md)
156
- * [Transaction ACH Retries](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/transaction-ach-retries.md)
157
- * [Transactions-ACH](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/transactions-ach.md)
158
- * [Transactions-Cash](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/transactions-cash.md)
159
- * [Transactions-Credit Card](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/transactions-credit-card.md)
160
- * [Transactions-EBT Card](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/transactions-ebt-card.md)
161
- * [Transactions-Read](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/transactions-read.md)
162
- * [Level 3 Data](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/level-3-data.md)
163
- * [Transactions-Updates](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/transactions-updates.md)
164
- * [User Verifications](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/user-verifications.md)
165
- * [Apple Pay Validate Merchant](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/apple-pay-validate-merchant.md)
166
- * [Merchant Details](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/merchant-details.md)
167
- * [Batches](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/batches.md)
168
- * [Contacts](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/contacts.md)
169
- * [Elements](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/elements.md)
170
- * [Locations](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/locations.md)
171
- * [Paylinks](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/paylinks.md)
172
- * [Recurring](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/recurring.md)
173
- * [Signatures](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/signatures.md)
174
- * [Tags](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/tags.md)
175
- * [Terminals](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/terminals.md)
176
- * [Tickets](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/tickets.md)
177
- * [Tokens](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/tokens.md)
178
- * [Users](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/users.md)
179
- * [Webhooks](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/webhooks.md)
146
+ * [Async Processing](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/async-processing.md)
147
+ * [Declined Recurring Transactions](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/declined-recurring-transactions.md)
148
+ * [Device Terms](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/device-terms.md)
149
+ * [Full Boarding](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/full-boarding.md)
150
+ * [3 DS Authentication](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/3-ds-authentication.md)
151
+ * [3 DS Transactions](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/3-ds-transactions.md)
152
+ * [Merchant Deposits](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/merchant-deposits.md)
153
+ * [On Boarding](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/on-boarding.md)
154
+ * [Payment Card Reader Token](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/payment-card-reader-token.md)
155
+ * [Quick Invoices](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/quick-invoices.md)
156
+ * [Transaction ACH Retries](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/transaction-ach-retries.md)
157
+ * [Transactions-ACH](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/transactions-ach.md)
158
+ * [Transactions-Cash](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/transactions-cash.md)
159
+ * [Transactions-Credit Card](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/transactions-credit-card.md)
160
+ * [Transactions-EBT Card](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/transactions-ebt-card.md)
161
+ * [Transactions-Read](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/transactions-read.md)
162
+ * [Level 3 Data](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/level-3-data.md)
163
+ * [Transactions-Updates](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/transactions-updates.md)
164
+ * [User Verifications](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/user-verifications.md)
165
+ * [Apple Pay Validate Merchant](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/apple-pay-validate-merchant.md)
166
+ * [Merchant Details](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/merchant-details.md)
167
+ * [Batches](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/batches.md)
168
+ * [Contacts](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/contacts.md)
169
+ * [Elements](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/elements.md)
170
+ * [Locations](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/locations.md)
171
+ * [Paylinks](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/paylinks.md)
172
+ * [Recurring](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/recurring.md)
173
+ * [Signatures](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/signatures.md)
174
+ * [Tags](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/tags.md)
175
+ * [Terminals](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/terminals.md)
176
+ * [Tickets](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/tickets.md)
177
+ * [Tokens](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/tokens.md)
178
+ * [Users](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/users.md)
179
+ * [Webhooks](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/controllers/webhooks.md)
180
180
 
181
181
  ## SDK Infrastructure
182
182
 
183
183
  ### Configuration
184
184
 
185
- * [ProxySettings](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/proxy-settings.md)
186
- * [Environment-Based Client Initialization](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/environment-based-client-initialization.md)
185
+ * [ProxySettings](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/proxy-settings.md)
186
+ * [Environment-Based Client Initialization](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/environment-based-client-initialization.md)
187
187
 
188
188
  ### HTTP
189
189
 
190
- * [HttpResponse](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/http-response.md)
191
- * [HttpRequest](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/http-request.md)
190
+ * [HttpResponse](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/http-response.md)
191
+ * [HttpRequest](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/http-request.md)
192
192
 
193
193
  ### Utilities
194
194
 
195
- * [ApiHelper](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/api-helper.md)
196
- * [DateTimeHelper](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.0/doc/date-time-helper.md)
195
+ * [ApiHelper](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/api-helper.md)
196
+ * [DateTimeHelper](https://www.github.com/sdks-io/fortis-apimatic-ruby-sdk/tree/1.0.2/doc/date-time-helper.md)
197
197
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: fortis-apimatic-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Muhammad Rafay