TypeScript typings for Service Management API v1

Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers. For detailed description please check documentation.

Installing

Install typings for Service Management API:

npm install @types/gapi.client.servicemanagement-v1 --save-dev

TypeScript 6.0+

TypeScript 6.0 changed types to default to []. You must now explicitly list type packages in tsconfig.json:

{
  "compilerOptions": {
    "types": [
      "gapi",
      "gapi.auth2",
      "gapi.client",
      "gapi.client.servicemanagement-v1"
    ]
  }
}

Usage

You need to initialize Google API client in your code:

gapi.load('client', () => {
  // now we can use gapi.client
  // ...
});

Then load api client wrapper:

gapi.client.load(
  'https://servicemanagement.googleapis.com/$discovery/rest?version=v1',
  () => {
    // now we can use:
    // gapi.client.servicemanagement
  },
);

// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
gapi.client.load('servicemanagement', 'v1', () => {
  // now we can use:
  // gapi.client.servicemanagement
});

Don't forget to authenticate your client before sending any request to resources:

// declare client_id registered in Google Developers Console
var client_id = '',
  scope = [
    // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
    'https://www.googleapis.com/auth/cloud-platform',

    // View your data across Google Cloud services and see the email address of your Google Account
    'https://www.googleapis.com/auth/cloud-platform.read-only',

    // Manage your Google API service configuration
    'https://www.googleapis.com/auth/service.management',

    // View your Google API service configuration
    'https://www.googleapis.com/auth/service.management.readonly',
  ],
  immediate = true;
// ...

gapi.auth.authorize(
  {client_id: client_id, scope: scope, immediate: immediate},
  authResult => {
    if (authResult && !authResult.error) {
      /* handle successful authorization */
    } else {
      /* handle authorization error */
    }
  },
);

After that you can use Service Management API resources:

/*
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
*/
await gapi.client.servicemanagement.operations.get({name: 'name'});

/*
Lists service operations that match the specified filter in the request.
*/
await gapi.client.servicemanagement.operations.list({});

/*
Creates a new managed service. A managed service is immutable, and is subject to mandatory 30-day data retention. You cannot move a service or recreate it within 30 days after deletion. One producer project can own no more than 500 services. For security and reliability purposes, a production service should be hosted in a dedicated producer project. Operation
*/
await gapi.client.servicemanagement.services.create({});

/*
Deletes a managed service. This method will change the service to the `Soft-Delete` state for 30 days. Within this period, service producers may call UndeleteService to restore the service. After 30 days, the service will be permanently deleted. Operation
*/
await gapi.client.servicemanagement.services.delete({
  serviceName: 'serviceName',
});

/*
Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_value If GenerateConfigReportRequest.old_value is specified, GenerateConfigReportRequest will contain a single ChangeReport based on the comparison between GenerateConfigReportRequest.new_value and GenerateConfigReportRequest.old_value. If GenerateConfigReportRequest.old_value is not specified, this method will compare GenerateConfigReportRequest.new_value with the last pushed service configuration.
*/
await gapi.client.servicemanagement.services.generateConfigReport({});

/*
Gets a managed service. Authentication is required unless the service is public.
*/
await gapi.client.servicemanagement.services.get({serviceName: 'serviceName'});

/*
Gets a service configuration (version) for a managed service.
*/
await gapi.client.servicemanagement.services.getConfig({
  serviceName: 'serviceName',
});

/*
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
*/
await gapi.client.servicemanagement.services.getIamPolicy({
  resource: 'resource',
});

/*
Lists managed services. Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for.
*/
await gapi.client.servicemanagement.services.list({});

/*
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
*/
await gapi.client.servicemanagement.services.setIamPolicy({
  resource: 'resource',
});

/*
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
*/
await gapi.client.servicemanagement.services.testIamPermissions({
  resource: 'resource',
});

/*
Revives a previously deleted managed service. The method restores the service using the configuration at the time the service was deleted. The target service must exist and must have been deleted within the last 30 days. Operation
*/
await gapi.client.servicemanagement.services.undelete({
  serviceName: 'serviceName',
});

For provenance information see Provenance section on NPM