apigee-edge-js/lib/company.js

nodejs library for the administration API for Apigee (Edge and X and hybrid).

// company.js
// ------------------------------------------------------------------
// Copyright 2018-2023 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
/* global process */

const utility = require("./utility.js"),
  common = require("./common.js"),
  promiseWrap = require("./promiseWrap.js"),
  request = require("postman-request"),
  urljoin = require("url-join"),
  sprintf = require("sprintf-js").sprintf;

function Company(conn) {
  this.conn = conn;
}

Company.prototype.create = promiseWrap(function (options, cb) {
  // POST :mgmtserver/v1/o/:orgname/companies
  // Authorization: :apigee-auth
  // Content-type: application/json
  //
  // {
  //   "attributes": [ {
  //     "name" : "tag1",
  //     "value" : "whatever you like" }],
  //   "name": "myAwesomeCompany",
  //   "displayName": "my Awesome Company"
  // }
  const conn = this.conn;
  if (!options.name) {
    return cb(new Error("missing a required input: name"));
  }
  const displayName = options.displayName || options.name;
  if (conn.verbosity > 0) {
    utility.logWrite(sprintf("Create Company %s", options.name));
  }
  common.insureFreshToken(conn, function (requestOptions) {
    requestOptions.headers["content-type"] = "application/json";
    requestOptions.url = urljoin(conn.urlBase, "companies");
    const body = { name: options.name, displayName };
    if (options.attributes) {
      body.attributes = common.hashToArrayOfKeyValuePairs(options.attributes);
    }
    requestOptions.body = JSON.stringify(body);
    if (conn.verbosity > 0) {
      utility.logWrite(sprintf("POST %s", requestOptions.url));
    }
    //request.debug = true;
    request.post(requestOptions, common.callback(conn, [201], cb));
  });
});

Company.prototype.get = promiseWrap(function (options, cb) {
  const conn = this.conn;
  if (!cb) {
    cb = options;
    options = {};
  }
  common.insureFreshToken(conn, function (requestOptions) {
    requestOptions.url = options.name
      ? urljoin(conn.urlBase, "companies", options.name)
      : urljoin(conn.urlBase, "companies");
    if (conn.verbosity > 0) {
      utility.logWrite(sprintf("GET %s", requestOptions.url));
    }
    request.get(requestOptions, common.callback(conn, [200], cb));
  });
});

module.exports = Company;