github.com/grokify/go-ringcentral-client@v0.3.31/office/v1/README.md (about)

     1  # Go API client for RingCentral
     2  
     3  [![Build Status][build-status-svg]][build-status-link]
     4  [![Go Report Card][goreport-svg]][goreport-link]
     5  [![Docs][docs-godoc-svg]][docs-godoc-link]
     6  [![License][license-svg]][license-link]
     7  [![Stack Overflow][stackoverflow-svg]][stackoverflow-link]
     8  [![Twitter][twitter-svg]][twitter-link]
     9  
    10   [build-status-svg]: https://api.travis-ci.org/grokify/go-ringcentral-client.svg?branch=master
    11   [build-status-link]: https://travis-ci.org/grokify/go-ringcentral-client
    12   [goreport-svg]: https://goreportcard.com/badge/github.com/grokify/go-ringcentral-client
    13   [goreport-link]: https://goreportcard.com/report/github.com/grokify/go-ringcentral-client
    14   [docs-godoc-svg]: https://img.shields.io/badge/docs-godoc-blue.svg
    15   [docs-godoc-link]: https://godoc.org/github.com/grokify/go-ringcentral-client
    16   [license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
    17   [license-link]: https://github.com/grokify/go-ringcentral-client/blob/master/LICENSE
    18   [stackoverflow-svg]: https://img.shields.io/badge/Stack%20Overflow-ringcentral-orange.svg
    19   [stackoverflow-link]: https://stackoverflow.com/questions/tagged/ringcentral
    20   [twitter-svg]: https://img.shields.io/twitter/follow/ringcentraldevs.svg?style=social&label=follow
    21   [twitter-link]: https://twitter.com/RingCentralDevs
    22  
    23  ## Overview
    24  
    25  This is a API client built using [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) using this RingCentral API spec [`swagger_spec.yaml`](codegen/swagger_spec.yaml).
    26  
    27  This API client does not include auth and relies on [`goauth/ringcentral`](https://github.com/grokify/goauth/tree/master/ringcentral) to create an `*http.Client` to use as a dependency injection.
    28  
    29  ## Installation
    30  
    31  `$ go get github.com/grokify/go-ringcentral-client/...`
    32  
    33  ## Usage
    34  
    35  See examples in the [`examples`](examples) directory. To get started, you can use [`examples/get_me/get_me.go`](examples/get_me/get_me.go).
    36  
    37  By default, these use a `.env` file which can be specified by the `ENV_PATH` environment variable or a local `./.env` file. Using one `.env` file specified by `ENV_PATH` is useful so you only need one file to run all the examples.
    38  
    39  ## Documentation
    40  
    41  The auto-generated Swagger files are in the [`client`](client) folder and you can find the Swagger docs there as [`client/README.md`](client/README.md)
    42  
    43  ## Related Packages
    44  
    45  In addition to [`goauth/ringcentral`](https://github.com/grokify/goauth/tree/master/ringcentral), the following project provides a website with OAuth 2.0 authorization code flow example:
    46  
    47  [`grokify/beegoutil`](https://github.com/grokify/beegoutil)