Back to Google Cloud Node

[Cloud Channel API: Nodejs Client][homepage]

packages/google-cloud-channel/README.md

0.57.015.0 KB
Original Source

Cloud Channel API: Nodejs Client

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority

Cloud Channel API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Cloud Channel API API.
  4. Set up authentication so you can access the API from your local workstation.

Installing the client library

bash
npm install @google-cloud/channel

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

SampleSource Code
fetch report resultssource code
list reportssource code
run report jobsource code
activate entitlementsource code
cancel entitlementsource code
change offersource code
change parameterssource code
change renewal settingssource code
check cloud identity accounts existsource code
create channel partner linksource code
create channel partner repricing configsource code
create customersource code
create customer repricing configsource code
create entitlementsource code
delete channel partner repricing configsource code
delete customersource code
delete customer repricing configsource code
get channel partner linksource code
get channel partner repricing configsource code
get customersource code
get customer repricing configsource code
get entitlementsource code
import customersource code
list channel partner linkssource code
list channel partner repricing configssource code
list customer repricing configssource code
list customerssource code
list entitlement changessource code
list entitlementssource code
list offerssource code
list productssource code
list purchasable offerssource code
list purchasable skussource code
list sku group billable skussource code
list sku groupssource code
list skussource code
list subscriberssource code
list transferable offerssource code
list transferable skussource code
lookup offersource code
provision cloud identitysource code
query eligible billing accountssource code
register subscribersource code
start paid servicesource code
suspend entitlementsource code
transfer entitlementssource code
transfer entitlements to googlesource code
unregister subscribersource code
update channel partner linksource code
update channel partner repricing configsource code
update customersource code
update customer repricing configsource code
cloudsource code

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/channel@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template.

License

Apache Version 2.0

See LICENSE