Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chaplean/zoho-books-client-bundle

Last synced: 20 days ago
JSON representation

Host: GitHub
URL: https://github.com/chaplean/zoho-books-client-bundle
Owner: chaplean
License: mit
Created: 2019-07-05T15:07:35.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2019-07-05T15:17:17.000Z (over 5 years ago)
Last Synced: 2024-11-29T21:47:04.349Z (about 1 month ago)
Language: PHP
Size: 44.9 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # Chaplean Zoho Books Client Bundle

[![build status](https://git.chaplean.coop/open-source/bundle/zoho-books-client-bundle/badges/master/build.svg)](https://git.chaplean.coop/open-source/bundle/zoho-books-client-bundle/commits/master)

[![build status](https://git.chaplean.coop/open-source/bundle/zoho-books-client-bundle/badges/master/coverage.svg)](https://git.chaplean.coop/open-source/bundle/zoho-books-client-bundle/commits/master)

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/chaplean/zoho-books-client-bundle/issues)

This bundle allows you to use the [zoho books api](https://www.zoho.com/books/api/v3/) easily from your php code.

## Table of content

* [Installation](#Installation)

* [Configuration](#Configuration)

* [Usage](#Usage)

* [Versioning](#Versioning)

* [Contributing](#Contributing)

* [Hacking](#Hacking)

* [License](#License)

## Installation

This bundle requires at least Symfony 3.0.

You can use [composer](https://getcomposer.org) to install zoho-books-client-bundle:

```bash

composer require chaplean/zoho-books-client-bundle

```

Then add to your AppKernel.php:

```php

new Chaplean\Bundle\ZohoBooksClientBundle\ChapleanZohoBooksClientBundle(),

```

## Configuration

First you will need to import bundle configuration.

config.yml:

```yaml

imports:

    - { resource: '@ChapleanZohoBooksClientBundle/Resources/config/config.yml' }

```

You must also create some parameters.

parameters.yml:

```yaml

parameters:

    chaplean_zoho_books.organization_id: f545ff15s4g

    chaplean_zoho_books.access_token: g45df45g41g5fd

```

## Usage

Here is an example of how to use the getEstimate route.

```php

$response = $zohoBooksApi->getEstimate()

    ->bindUrlParameters(['id' => 'df154f1fds4f54dsf15'])

    ->exec();

    

if ($response->succeeded()) {

    $content = $response->getContent();

    // your code

}

```

### Available functions:

* Contacts

    * getContacts()

    * getContactPersons()

    

* Items

    * getItems()

    * getItem()

    * postItem()

    * putItem()

    * deleteItem()

    * postItemActive()

    * postItemInactive()

* Estimate

    * getEstimate()

    * getEstimates()

    * postEstimate()

    * putEstimate()

    * deleteEstimate()

    * postEstimateAsDeclined()

    * postEstimateAsAccepted()

* Invoice

    * getInvoice()

    * getInvoices()

    * postInvoice()

    * putInvoice()

    * deleteInvoice()

## Versioning

zoho-books-client-bundle follows [semantic versioning](https://semver.org/). In short the scheme is MAJOR.MINOR.PATCH where

1. MAJOR is bumped when there is a breaking change,

2. MINOR is bumped when a new feature is added in a backward-compatible way,

3. PATCH is bumped when a bug is fixed in a backward-compatible way.

Versions bellow 1.0.0 are considered experimental and breaking changes may occur at any time.

## Contributing

Contributions are welcomed! There are many ways to contribute, and we appreciate all of them. Here are some of the major ones:

* [Bug Reports](https://github.com/chaplean/zoho-books-client-bundle/issues): While we strive for quality software, bugs can happen and we can't fix issues we're not aware of. So please report even if you're not sure about it or just want to ask a question. If anything the issue might indicate that the documentation can still be improved!

* [Feature Request](https://github.com/chaplean/zoho-books-client-bundle/issues): You have a use case not covered by the current api? Want to suggest a change or add something? We'd be glad to read about it and start a discussion to try to find the best possible solution.

* [Pull Request](https://github.com/chaplean/zoho-books-client-bundle/pulls): Want to contribute code or documentation? We'd love that! If you need help to get started, GitHub as [documentation](https://help.github.com/articles/about-pull-requests/) on pull requests. We use the ["fork and pull model"](https://help.github.com/articles/about-collaborative-development-models/) were contributors push changes to their personnal fork and then create pull requests to the main repository. Please make your pull requests against the `master` branch.

As a reminder, all contributors are expected to follow our [Code of Conduct](CODE_OF_CONDUCT.md).

## Hacking

You might find the following commands usefull when hacking on this project:

```bash

# Install dependencies

composer install

# Run tests

bin/phpunit

```

## License

zoho-books-client-bundle is distributed under the terms of the MIT license.

See [LICENSE](LICENSE.md) for details.