README.md in ka-ching-client-0.1.0 vs README.md in ka-ching-client-0.2.0
- old
+ new
@@ -18,32 +18,30 @@
- [Lockings](#lockings)
- [lock!](#lock)
- [unlock!](#unlock)
- [all paginated](#all-paginated)
- [of\_year](#of_year)
- - [of\_year\_month](#of_year_month)
- - [of\_year\_month\_day](#of_year_month_day)
+ - [active](#active)
+ - [inactive](#inactive)
- [AuditLogs](#auditlogs)
- [of\_year](#of_year-1)
- - [of\_year\_month](#of_year_month-1)
- - [of\_year\_month\_day](#of_year_month_day-1)
+ - [of\_year\_month](#of_year_month)
+ - [of\_year\_month\_day](#of_year_month_day)
- [Tenants](#tenants)
- [all](#all)
- - [active](#active)
- - [inactive](#inactive)
+ - [active](#active-1)
+ - [inactive](#inactive-1)
- [Admin](#admin)
- [details](#details)
- [create!](#create)
- [drop!](#drop-1)
- [Development](#development)
- [Contributing](#contributing)
- [License](#license)
## Installation
-TODO: Replace `ka-ching-client` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
Install the gem and add to the application's Gemfile by executing:
$ bundle add ka-ching-client
If bundler is not being used to manage dependencies, install the gem by executing:
@@ -187,11 +185,11 @@
```ruby
res = client.v1.lockings.all(
tenant_account_id: 'testuser_1',
page: 1,
- per_page: 10
+ per_page: 10,
)
```
#### of_year
@@ -199,31 +197,28 @@
```ruby
res = client.v1.lockings.of_year(tenant_account_id: 'testuser_1', year: 2019)
```
-#### of_year_month
+#### active
-Get lockings for a tenant by year and month.
+Get active lockings for a tenant for a year.
```ruby
-res = client.v1.lockings.of_year(
+res = client.v1.lockings.active(
tenant_account_id: 'testuser_1',
year: 2019,
- month: 11
)
```
-#### of_year_month_day
+#### inactive
-Get lockings for a tenant by year, month and day.
+Get inactive lockings for a tenant for a year.
```ruby
-res = client.v1.lockings.of_year(
+res = client.v1.lockings.inactive(
tenant_account_id: 'testuser_1',
year: 2019,
- month: 11,
- day: 21
)
```
### AuditLogs