# NdsApi

NDS API is a Rubygem for easy interface with the NDS API. NDS is the National Data System for Child Care. NDS is a variety of applications and services that facilitate the work of Child Care R&Rs. This Ruby code is an interface to the new NDS API. This code is built and maintained by Exygy, in San Francisco. NDS is built by Child Care Aware of America. For any questions about using this code, please contact hello@exygy.com. For more information about NDS please see https://usa.childcareaware.org/members-providers/data-services/

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'nds_api'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install nds_api

## Usage

```ruby
nds = NdsApi::Client.new(
    user: 'username', #required
    password: '############', #required
    agency_key: 123 # optionals
)
```

##### AGENCY

Get Agency Option By Id

```ruby
nds.get_agency_option(option_id)
```


Required: agency_key param, see usage section.

Will raise 'NDS API GEM: Agency Key required' if Agency Key not specified

Contact NDS to get your agency key.

##### CLIENT


Create client

```ruby
nds.create_client(data)
```

Visit https://developer.uatup.naccrraware.net/#42d4c898-5868-19a8-0704-18235fa44a5e for fields

```ruby
nds.update_client(data)
```

```ruby
nds.clients
nds.client_by_email(email)      
nds.client_by_phone(phone)      
nds.client_by_first_name_and_last_name(first_name, last_name)      
nds.client_by_id(id)      
```

##### CHILDREN

```ruby

nds.create_child(data)
nds.update_child(data)

nds.children      
nds.child_by_uid(uid)      
nds.children_by_client_id(client_id)      
```

##### COMMUNITIES

```ruby
nds.communities()
```

##### PERSON

```ruby

nds.create_person(data)
nds.update_person(data)

nds.persons()
nds.person_by_id(id)      
```

#### POSITIONS

```ruby
nds.positions_by_work_email(email)      
```

##### PROVIDERS

```ruby
nds.search_providers(search_params)
nds.update_provider(data)

nds.providers()
nds.provider_by_uid(uid)      
nds.provider_by_id(id)      
nds.providers_by_center_name(center_name)      
nds.providers_by_email(email)      
nds.provider_schedule(uid)      
nds.provider_rates(uid)      
nds.provider_enrollments(uid)      
```

##### REFERRALS

```ruby
nds.create_referral(data)

nds.referrals()      
nds.referral_by_id(id)      
nds.referral_by_client_id(id)      
nds.referrals_before_date(date)      
nds.referrals_after_date(date)      
nds.referrals_in_date_range(start_date, end_date)      
```


## Development

After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

Test GEM

`bin/console`

```ruby
NdsApi::Client.new(agency_key: 00000, user: 'user', password: 'password', dev: true).provider_by_id(1234)
```

## Publication

`bundle exec rake release`

`gem push pkg/nds_api-0.X.X.gem`


## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/exygy/nds_api.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).