Google Cloud Support API: Node.js Client

Google Cloud Support 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
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project .
Enable billing for your project .
Enable the Google Cloud Support API API .
Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

 npm install @google-cloud/support

Using the client library

 /**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The fully qualified name of parent resource to list cases under.
 */
// const parent = 'abc123'
/**
 *  An expression written in filter language. If non-empty, the query returns
 *  the cases that match the filter. Else, the query doesn't filter the cases.
 *  Filter expressions use the following fields with the operators equals (`=`)
 *  and `AND`:
 *  - `state`: The accepted values are `OPEN` or `CLOSED`.
 *  - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You
 *  can specify multiple values for priority using the `OR` operator. For
 *  example, `priority=P1 OR priority=P2`.
 *  - `creator.email`: The email address of the case creator.
 *  Examples:
 *  - `state=CLOSED`
 *  - `state=OPEN AND creator.email="tester@example.com"`
 *  - `state=OPEN AND (priority=P0 OR priority=P1)`
 */
// const filter = 'abc123'
/**
 *  The maximum number of cases fetched with each request. Defaults to 10.
 */
// const pageSize = 1234
/**
 *  A token identifying the page of results to return. If unspecified, the
 *  first page is retrieved.
 */
// const pageToken = 'abc123'

// Imports the Support library
const {CaseServiceClient} = require(' @google-cloud/support 
').v2;

// Instantiates a client
const supportClient = new CaseServiceClient 
();

async function callListCases() {
  // Construct request
  const request = {
    parent,
  };

  // Run request
  const iterable = await supportClient. listCasesAsync 
(request);
  for await (const response of iterable) {
    console.log(response);
  }
}

callListCases();

Samples

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

Sample	Source Code	Try it
Case_attachment_service.list_attachments	source code
Case_service.close_case	source code
Case_service.create_case	source code
Case_service.escalate_case	source code
Case_service.get_case	source code
Case_service.list_cases	source code
Case_service.search_case_classifications	source code
Case_service.search_cases	source code
Case_service.update_case	source code
Comment_service.create_comment	source code
Comment_service.list_comments	source code
Quickstart	source code

The Google Cloud Support API Node.js Client API Reference documentation also contains samples.

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/support@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning .

This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide .

Please note that this README.md , the samples/README.md , and a variety of configuration files in this repository (including .nycrc and tsconfig.json ) are generated from a central template. To edit one of these files, make an edit to its templates in directory .

License

Apache Version 2.0

See LICENSE