@taskcluster/client-web 88.0.1

package/src/clients/Notify.js

@@ -0,0 +1,144 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+
+import Client from '../Client';
+
+export default class Notify extends Client {
+  constructor(options = {}) {
+    super({
+      serviceName: 'notify',
+      serviceVersion: 'v1',
+      exchangePrefix: '',
+      ...options,
+    });
+    this.ping.entry = {"args":[],"category":"Monitoring","method":"get","name":"ping","query":[],"route":"/ping","stability":"stable","type":"function"}; // eslint-disable-line
+    this.lbheartbeat.entry = {"args":[],"category":"Monitoring","method":"get","name":"lbheartbeat","query":[],"route":"/__lbheartbeat__","stability":"stable","type":"function"}; // eslint-disable-line
+    this.version.entry = {"args":[],"category":"Monitoring","method":"get","name":"version","query":[],"route":"/__version__","stability":"stable","type":"function"}; // eslint-disable-line
+    this.email.entry = {"args":[],"category":"Notifications","input":true,"method":"post","name":"email","query":[],"route":"/email","scopes":"notify:email:<address>","stability":"experimental","type":"function"}; // eslint-disable-line
+    this.pulse.entry = {"args":[],"category":"Notifications","input":true,"method":"post","name":"pulse","query":[],"route":"/pulse","scopes":"notify:pulse:<routingKey>","stability":"experimental","type":"function"}; // eslint-disable-line
+    this.matrix.entry = {"args":[],"category":"Notifications","input":true,"method":"post","name":"matrix","query":[],"route":"/matrix","scopes":"notify:matrix-room:<roomId>","stability":"experimental","type":"function"}; // eslint-disable-line
+    this.slack.entry = {"args":[],"category":"Notifications","input":true,"method":"post","name":"slack","query":[],"route":"/slack","scopes":"notify:slack-channel:<channelId>","stability":"experimental","type":"function"}; // eslint-disable-line
+    this.addDenylistAddress.entry = {"args":[],"category":"Denylist","input":true,"method":"post","name":"addDenylistAddress","query":[],"route":"/denylist/add","scopes":"notify:manage-denylist","stability":"experimental","type":"function"}; // eslint-disable-line
+    this.deleteDenylistAddress.entry = {"args":[],"category":"Denylist","input":true,"method":"delete","name":"deleteDenylistAddress","query":[],"route":"/denylist/delete","scopes":"notify:manage-denylist","stability":"experimental","type":"function"}; // eslint-disable-line
+    this.listDenylist.entry = {"args":[],"category":"Denylist","method":"get","name":"listDenylist","output":true,"query":["continuationToken","limit"],"route":"/denylist/list","scopes":"notify:manage-denylist","stability":"experimental","type":"function"}; // eslint-disable-line
+    this.heartbeat.entry = {"args":[],"category":"Monitoring","method":"get","name":"heartbeat","query":[],"route":"/__heartbeat__","stability":"stable","type":"function"}; // eslint-disable-line
+  }
+  /* eslint-disable max-len */
+  // Respond without doing anything.
+  // This endpoint is used to check that the service is up.
+  /* eslint-enable max-len */
+  ping(...args) {
+    this.validate(this.ping.entry, args);
+
+    return this.request(this.ping.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Respond without doing anything.
+  // This endpoint is used to check that the service is up.
+  /* eslint-enable max-len */
+  lbheartbeat(...args) {
+    this.validate(this.lbheartbeat.entry, args);
+
+    return this.request(this.lbheartbeat.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Respond with the JSON version object.
+  // https://github.com/mozilla-services/Dockerflow/blob/main/docs/version_object.md
+  /* eslint-enable max-len */
+  version(...args) {
+    this.validate(this.version.entry, args);
+
+    return this.request(this.version.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Send an email to `address`. The content is markdown and will be rendered
+  // to HTML, but both the HTML and raw markdown text will be sent in the
+  // email. If a link is included, it will be rendered to a nice button in the
+  // HTML version of the email
+  // In case when duplicate message has been detected and no email was sent,
+  // this endpoint will return 204 status code.
+  /* eslint-enable max-len */
+  email(...args) {
+    this.validate(this.email.entry, args);
+
+    return this.request(this.email.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Publish a message on pulse with the given `routingKey`.
+  // Endpoint will return 204 when duplicate message has been detected
+  /* eslint-enable max-len */
+  pulse(...args) {
+    this.validate(this.pulse.entry, args);
+
+    return this.request(this.pulse.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Post a message to a room in Matrix. Optionally includes formatted message.
+  // The `roomId` in the scopes is a fully formed `roomId` with leading `!` such
+  // as `!foo:bar.com`.
+  // Note that the matrix client used by taskcluster must be invited to a room before
+  // it can post there!
+  // In case when duplicate message has been detected and no message was sent,
+  // this endpoint will return 204 status code.
+  /* eslint-enable max-len */
+  matrix(...args) {
+    this.validate(this.matrix.entry, args);
+
+    return this.request(this.matrix.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Post a message to a Slack channel.
+  // The `channelId` in the scopes is a Slack channel ID, starting with a capital C.
+  // The Slack app can post into public channels by default but will need to be added
+  // to private channels before it can post messages there.
+  // In case when duplicate message has been detected and no message was sent,
+  // this endpoint will return 204 status code.
+  /* eslint-enable max-len */
+  slack(...args) {
+    this.validate(this.slack.entry, args);
+
+    return this.request(this.slack.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Add the given address to the notification denylist. Addresses in the denylist will be ignored
+  // by the notification service.
+  /* eslint-enable max-len */
+  addDenylistAddress(...args) {
+    this.validate(this.addDenylistAddress.entry, args);
+
+    return this.request(this.addDenylistAddress.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Delete the specified address from the notification denylist.
+  /* eslint-enable max-len */
+  deleteDenylistAddress(...args) {
+    this.validate(this.deleteDenylistAddress.entry, args);
+
+    return this.request(this.deleteDenylistAddress.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Lists all the denylisted addresses.
+  // By default this end-point will try to return up to 1000 addresses in one
+  // request. But it **may return less**, even if more tasks are available.
+  // It may also return a `continuationToken` even though there are no more
+  // results. However, you can only be sure to have seen all results if you
+  // keep calling `list` with the last `continuationToken` until you
+  // get a result without a `continuationToken`.
+  // If you are not interested in listing all the members at once, you may
+  // use the query-string option `limit` to return fewer.
+  /* eslint-enable max-len */
+  listDenylist(...args) {
+    this.validate(this.listDenylist.entry, args);
+
+    return this.request(this.listDenylist.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Respond with a service heartbeat.
+  // This endpoint is used to check on backing services this service
+  // depends on.
+  /* eslint-enable max-len */
+  heartbeat(...args) {
+    this.validate(this.heartbeat.entry, args);
+
+    return this.request(this.heartbeat.entry, args);
+  }
+}

package/src/clients/NotifyEvents.js

@@ -0,0 +1,27 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+
+import Client from '../Client';
+
+export default class NotifyEvents extends Client {
+  constructor(options = {}) {
+    super({
+      serviceName: 'notify',
+      serviceVersion: 'v1',
+      exchangePrefix: 'exchange/taskcluster-notify/v1/',
+      ...options,
+    });
+  }
+  /* eslint-disable max-len */
+  // An arbitrary message that a taskcluster user
+  // can trigger if they like.
+  // The standard one that is published by us watching
+  // for the completion of tasks is just the task status
+  // data that we pull from the queue `status()` endpoint
+  // when we notice a task is complete.
+  /* eslint-enable max-len */
+  notify(pattern) {
+    const entry = {"exchange":"notification","name":"notify","routingKey":[{"constant":"primary","multipleWords":false,"name":"routingKeyKind","required":true},{"multipleWords":true,"name":"topic","required":true}],"schema":"v1/notification-message.json#","type":"topic-exchange"}; // eslint-disable-line
+
+    return this.normalizePattern(entry, pattern);
+  }
+}

package/src/clients/Object.js

@@ -0,0 +1,135 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+
+import Client from '../Client';
+
+export default class Object extends Client {
+  constructor(options = {}) {
+    super({
+      serviceName: 'object',
+      serviceVersion: 'v1',
+      exchangePrefix: '',
+      ...options,
+    });
+    this.ping.entry = {"args":[],"category":"Monitoring","method":"get","name":"ping","query":[],"route":"/ping","stability":"stable","type":"function"}; // eslint-disable-line
+    this.lbheartbeat.entry = {"args":[],"category":"Monitoring","method":"get","name":"lbheartbeat","query":[],"route":"/__lbheartbeat__","stability":"stable","type":"function"}; // eslint-disable-line
+    this.version.entry = {"args":[],"category":"Monitoring","method":"get","name":"version","query":[],"route":"/__version__","stability":"stable","type":"function"}; // eslint-disable-line
+    this.createUpload.entry = {"args":["name"],"category":"Upload","input":true,"method":"put","name":"createUpload","output":true,"query":[],"route":"/upload/<name>","scopes":"object:upload:<projectId>:<name>","stability":"stable","type":"function"}; // eslint-disable-line
+    this.finishUpload.entry = {"args":["name"],"category":"Upload","input":true,"method":"post","name":"finishUpload","query":[],"route":"/finish-upload/<name>","scopes":"object:upload:<projectId>:<name>","stability":"stable","type":"function"}; // eslint-disable-line
+    this.startDownload.entry = {"args":["name"],"category":"Download","input":true,"method":"put","name":"startDownload","output":true,"query":[],"route":"/start-download/<name>","scopes":"object:download:<name>","stability":"stable","type":"function"}; // eslint-disable-line
+    this.object.entry = {"args":["name"],"category":"Objects","method":"get","name":"object","output":true,"query":[],"route":"/metadata/<name>","scopes":"object:download:<name>","stability":"stable","type":"function"}; // eslint-disable-line
+    this.download.entry = {"args":["name"],"category":"Download","method":"get","name":"download","query":[],"route":"/download/<name>","scopes":"object:download:<name>","stability":"stable","type":"function"}; // eslint-disable-line
+    this.heartbeat.entry = {"args":[],"category":"Monitoring","method":"get","name":"heartbeat","query":[],"route":"/__heartbeat__","stability":"stable","type":"function"}; // eslint-disable-line
+  }
+  /* eslint-disable max-len */
+  // Respond without doing anything.
+  // This endpoint is used to check that the service is up.
+  /* eslint-enable max-len */
+  ping(...args) {
+    this.validate(this.ping.entry, args);
+
+    return this.request(this.ping.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Respond without doing anything.
+  // This endpoint is used to check that the service is up.
+  /* eslint-enable max-len */
+  lbheartbeat(...args) {
+    this.validate(this.lbheartbeat.entry, args);
+
+    return this.request(this.lbheartbeat.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Respond with the JSON version object.
+  // https://github.com/mozilla-services/Dockerflow/blob/main/docs/version_object.md
+  /* eslint-enable max-len */
+  version(...args) {
+    this.validate(this.version.entry, args);
+
+    return this.request(this.version.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Create a new object by initiating upload of its data.
+  // This endpoint implements negotiation of upload methods.  It can be called
+  // multiple times if necessary, either to propose new upload methods or to
+  // renew credentials for an already-agreed upload.
+  // The `name` parameter can contain any printable ASCII character (0x20 - 0x7e).
+  // The `uploadId` must be supplied by the caller, and any attempts to upload
+  // an object with the same name but a different `uploadId` will fail.
+  // Thus the first call to this method establishes the `uploadId` for the
+  // object, and as long as that value is kept secret, no other caller can
+  // upload an object of that name, regardless of scopes.  Object expiration
+  // cannot be changed after the initial call, either.  It is possible to call
+  // this method with no proposed upload methods, which has the effect of "locking
+  // in" the `expiration`, `projectId`, and `uploadId` properties and any
+  // supplied hashes.
+  // Unfinished uploads expire after 1 day.
+  /* eslint-enable max-len */
+  createUpload(...args) {
+    this.validate(this.createUpload.entry, args);
+
+    return this.request(this.createUpload.entry, args);
+  }
+  /* eslint-disable max-len */
+  // This endpoint marks an upload as complete.  This indicates that all data has been
+  // transmitted to the backend.  After this call, no further calls to `uploadObject` are
+  // allowed, and downloads of the object may begin.  This method is idempotent, but will
+  // fail if given an incorrect uploadId for an unfinished upload.
+  // It is possible to finish an upload with no hashes specified via either
+  // `startUpload` or `finishUpload`.  However, many clients will refuse to
+  // download an object with no hashes.  The utility methods included with the
+  // client libraries always include hashes as of version 44.0.0.
+  // Note that, once `finishUpload` is complete, the object is considered immutable.
+  /* eslint-enable max-len */
+  finishUpload(...args) {
+    this.validate(this.finishUpload.entry, args);
+
+    return this.request(this.finishUpload.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Start the process of downloading an object's data.  Call this endpoint with a list of acceptable
+  // download methods, and the server will select a method and return the corresponding payload.
+  // Returns a 406 error if none of the given download methods are available.
+  // See [Download Methods](https://docs.taskcluster.net/docs/reference/platform/object/download-methods) for more detail.
+  /* eslint-enable max-len */
+  startDownload(...args) {
+    this.validate(this.startDownload.entry, args);
+
+    return this.request(this.startDownload.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Get the metadata for the named object.  This metadata is not sufficient to
+  // get the object's content; for that use `startDownload`.
+  /* eslint-enable max-len */
+  object(...args) {
+    this.validate(this.object.entry, args);
+
+    return this.request(this.object.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Get the data in an object directly.  This method does not return a JSON body, but
+  // redirects to a location that will serve the object content directly.
+  // URLs for this endpoint, perhaps with attached authentication (`?bewit=..`),
+  // are typically used for downloads of objects by simple HTTP clients such as
+  // web browsers, curl, or wget.
+  // This method is limited by the common capabilities of HTTP, so it may not be
+  // the most efficient, resilient, or featureful way to retrieve an artifact.
+  // Situations where such functionality is required should ues the
+  // `startDownload` API endpoint.
+  // See [Simple Downloads](https://docs.taskcluster.net/docs/reference/platform/object/simple-downloads) for more detail.
+  /* eslint-enable max-len */
+  download(...args) {
+    this.validate(this.download.entry, args);
+
+    return this.request(this.download.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Respond with a service heartbeat.
+  // This endpoint is used to check on backing services this service
+  // depends on.
+  /* eslint-enable max-len */
+  heartbeat(...args) {
+    this.validate(this.heartbeat.entry, args);
+
+    return this.request(this.heartbeat.entry, args);
+  }
+}

package/src/clients/PurgeCache.js

@@ -0,0 +1,92 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+
+import Client from '../Client';
+
+export default class PurgeCache extends Client {
+  constructor(options = {}) {
+    super({
+      serviceName: 'purge-cache',
+      serviceVersion: 'v1',
+      exchangePrefix: '',
+      ...options,
+    });
+    this.ping.entry = {"args":[],"category":"Monitoring","method":"get","name":"ping","query":[],"route":"/ping","stability":"stable","type":"function"}; // eslint-disable-line
+    this.lbheartbeat.entry = {"args":[],"category":"Monitoring","method":"get","name":"lbheartbeat","query":[],"route":"/__lbheartbeat__","stability":"stable","type":"function"}; // eslint-disable-line
+    this.version.entry = {"args":[],"category":"Monitoring","method":"get","name":"version","query":[],"route":"/__version__","stability":"stable","type":"function"}; // eslint-disable-line
+    this.purgeCache.entry = {"args":["workerPoolId"],"category":"Purge-Cache Service","input":true,"method":"post","name":"purgeCache","query":[],"route":"/purge-cache/<workerPoolId>","scopes":"purge-cache:<workerPoolId>:<cacheName>","stability":"stable","type":"function"}; // eslint-disable-line
+    this.allPurgeRequests.entry = {"args":[],"category":"Purge-Cache Service","method":"get","name":"allPurgeRequests","output":true,"query":["continuationToken","limit"],"route":"/purge-cache/list","scopes":"purge-cache:all-purge-requests","stability":"stable","type":"function"}; // eslint-disable-line
+    this.purgeRequests.entry = {"args":["workerPoolId"],"category":"Purge-Cache Service","method":"get","name":"purgeRequests","output":true,"query":["since"],"route":"/purge-cache/<workerPoolId>","scopes":"purge-cache:purge-requests::<workerPoolId>","stability":"stable","type":"function"}; // eslint-disable-line
+    this.heartbeat.entry = {"args":[],"category":"Monitoring","method":"get","name":"heartbeat","query":[],"route":"/__heartbeat__","stability":"stable","type":"function"}; // eslint-disable-line
+  }
+  /* eslint-disable max-len */
+  // Respond without doing anything.
+  // This endpoint is used to check that the service is up.
+  /* eslint-enable max-len */
+  ping(...args) {
+    this.validate(this.ping.entry, args);
+
+    return this.request(this.ping.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Respond without doing anything.
+  // This endpoint is used to check that the service is up.
+  /* eslint-enable max-len */
+  lbheartbeat(...args) {
+    this.validate(this.lbheartbeat.entry, args);
+
+    return this.request(this.lbheartbeat.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Respond with the JSON version object.
+  // https://github.com/mozilla-services/Dockerflow/blob/main/docs/version_object.md
+  /* eslint-enable max-len */
+  version(...args) {
+    this.validate(this.version.entry, args);
+
+    return this.request(this.version.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Publish a request to purge caches named `cacheName` with
+  // on `workerPoolId` workers.
+  // If such a request already exists, its `before` timestamp is updated to
+  // the current time.
+  /* eslint-enable max-len */
+  purgeCache(...args) {
+    this.validate(this.purgeCache.entry, args);
+
+    return this.request(this.purgeCache.entry, args);
+  }
+  /* eslint-disable max-len */
+  // View all active purge requests.
+  // This is useful mostly for administors to view
+  // the set of open purge requests. It should not
+  // be used by workers. They should use the purgeRequests
+  // endpoint that is specific to their workerType and
+  // provisionerId.
+  /* eslint-enable max-len */
+  allPurgeRequests(...args) {
+    this.validate(this.allPurgeRequests.entry, args);
+
+    return this.request(this.allPurgeRequests.entry, args);
+  }
+  /* eslint-disable max-len */
+  // List the caches for this `workerPoolId` that should to be
+  // purged if they are from before the time given in the response.
+  // This is intended to be used by workers to determine which caches to purge.
+  /* eslint-enable max-len */
+  purgeRequests(...args) {
+    this.validate(this.purgeRequests.entry, args);
+
+    return this.request(this.purgeRequests.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Respond with a service heartbeat.
+  // This endpoint is used to check on backing services this service
+  // depends on.
+  /* eslint-enable max-len */
+  heartbeat(...args) {
+    this.validate(this.heartbeat.entry, args);
+
+    return this.request(this.heartbeat.entry, args);
+  }
+}