Cloud Commerce Consumer Procurement API: Node.js Client

release level npm version

Cloud Commerce Consumer Procurement 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 Commerce Consumer Procurement API API.
  4. Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/procurement

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 parent resource to query for orders.
 *  This field has the form `billingAccounts/{billing-account-id}`.
 */
// const parent = 'abc123'
/**
 *  The maximum number of entries requested.
 *  The default page size is 25 and the maximum page size is 200.
 */
// const pageSize = 1234
/**
 *  The token for fetching the next page.
 */
// const pageToken = 'abc123'
/**
 *  Filter that you can use to limit the list request.
 *  A query string that can match a selected set of attributes
 *  with string values. For example, `display_name=abc`.
 *  Supported query attributes are
 *  * `display_name`
 *  If the query contains special characters other than letters,
 *  underscore, or digits, the phrase must be quoted with double quotes. For
 *  example, `display_name="foo:bar"`, where the display name needs to be
 *  quoted because it contains special character colon.
 *  Queries can be combined with `OR`, and `NOT` to form more complex queries.
 *  You can also group them to force a desired evaluation order.
 *  For example, `display_name=abc OR display_name=def`.
 */
// const filter = 'abc123'

// Imports the Procurement library
const {ConsumerProcurementServiceClient} =
  require('@google-cloud/procurement').v1alpha1;

// Instantiates a client
const procurementClient = new ConsumerProcurementServiceClient();

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

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

callListOrders();

Samples

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

Sample Source Code Try it
Consumer_procurement_service.cancel_order source code Open in Cloud Shell
Consumer_procurement_service.get_order source code Open in Cloud Shell
Consumer_procurement_service.list_orders source code Open in Cloud Shell
Consumer_procurement_service.modify_order source code Open in Cloud Shell
Consumer_procurement_service.place_order source code Open in Cloud Shell
License_management_service.assign source code Open in Cloud Shell
License_management_service.enumerate_licensed_users source code Open in Cloud Shell
License_management_service.get_license_pool source code Open in Cloud Shell
License_management_service.unassign source code Open in Cloud Shell
License_management_service.update_license_pool source code Open in Cloud Shell
Consumer_procurement_service.get_order source code Open in Cloud Shell
Consumer_procurement_service.list_orders source code Open in Cloud Shell
Consumer_procurement_service.place_order source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell

The Cloud Commerce Consumer Procurement 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/procurement@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

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.

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