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

     1  # Go API client for RingCentral
     2  
     3  [![Build Status][build-status-svg]][build-status-url]
     4  [![Go Report Card][goreport-svg]][goreport-url]
     5  [![Docs][docs-godoc-svg]][docs-godoc-url]
     6  [![License][license-svg]][license-url]
     7  [![Stack Overflow][stackoverflow-svg]][stackoverflow-url]
     8  [![Twitter][twitter-svg]][twitter-url]
     9  
    10   [build-status-svg]: https://github.com/grokify/go-ringcentral-client/actions/workflows/ci.yaml/badge.svg?branch=master
    11   [build-status-url]: https://github.com/grokify/go-ringcentral-client/actions/workflows/ci.yaml
    12   [goreport-svg]: https://goreportcard.com/badge/github.com/grokify/go-ringcentral-client
    13   [goreport-url]: https://goreportcard.com/report/github.com/grokify/go-ringcentral-client
    14   [docs-godoc-svg]: https://pkg.go.dev/badge/github.com/grokify/go-ringcentral-client
    15   [docs-godoc-url]: https://pkg.go.dev/github.com/grokify/go-ringcentral-client
    16   [license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
    17   [license-url]: 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-url]: https://stackoverflow.com/questions/tagged/ringcentral
    20   [twitter-svg]: https://img.shields.io/twitter/follow/ringcentraldevs.svg?style=social&label=follow
    21   [twitter-url]: https://twitter.com/RingCentralDevs
    22  
    23  ## Overview
    24  
    25  <div align="center">
    26  
    27  :bangbang: This module has been renamed to `go-ringcentral-client` from `go-ringcentral` to better work with Go modules and its new versioning requirements. Old versions are still available via `proxy.golang.org` :bangbang:
    28  
    29  </div>
    30  
    31  This module provides RingCentral API clients for RingCentral Office, Engage Digital and Engage Voice.
    32  
    33  The clients are built using [OpenAPI Generator 4.x](https://github.com/OpenAPITools/openapi-generator) using this RingCentral API spec [`swagger_spec.yaml`](codegen/swagger_spec.yaml).
    34  
    35  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.
    36  
    37  ## Installation
    38  
    39  `$ go get github.com/grokify/go-ringcentral-client/...`
    40  
    41  ## Usage
    42  
    43  See Office examples in the [`office/v1/examples`](office/v1/examples) directory. To get started, you can use [`office/v1/examples/get_me/get_me.go`](office/v1/examples/get_me/get_me.go).
    44  
    45  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.
    46  
    47  ## Documentation
    48  
    49  The auto-generated Swagger files are in the `client` folder and you can find the Swagger docs there as `client/README.md`:
    50  
    51  * Office: [`office/v1/client`](office/v1/client), [`office/v1/client/README.md`](office/v1/client/README.md)
    52  * Engage Digital: [`engagedigital/v1/client`](engagedigital/v1/client), [`engagedigital/v1/client/README.md`](engagedigital/v1/client/README.md)
    53  * Engage Voice: [`engagevoice/v1/client`](engagevoice/v1/client), [`engagevoice/v1/client/README.md`](engagevoice/v1/client/README.md)
    54  
    55  ## Related Packages
    56  
    57  ### GoAuth RingCentral
    58  
    59  For RingCentral auth haandling see [`goauth/ringcentral`](https://github.com/grokify/goauth/tree/master/ringcentral). This is specifically a package to retrieve a `*http.Client` or `*oauth2.Token` without needing the auto-generated models.
    60  
    61  ### Beego Example
    62  
    63  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:
    64  
    65  [`grokify/beegoutil`](https://github.com/grokify/beegoutil)