@revenexx/node 0.0.1 → 0.1.0

package/dist/services/channels.mjs

@@ -0,0 +1,610 @@
+import { RevenexxException } from '../client.mjs';
+
+// src/services/channels.ts
+var Channels = class {
+  constructor(client) {
+    this.client = client;
+  }
+  channelsList(paramsOrFirst, ...rest) {
+    let params;
+    if (!paramsOrFirst || paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        id: paramsOrFirst,
+        code: rest[0],
+        name: rest[1],
+        labels: rest[2],
+        type: rest[3],
+        status: rest[4],
+        unassignedVisibility: rest[5],
+        isDefault: rest[6],
+        position: rest[7],
+        createdAt: rest[8],
+        updatedAt: rest[9],
+        limit: rest[10],
+        offset: rest[11],
+        order: rest[12]
+      };
+    }
+    const id = params.id;
+    const code = params.code;
+    const name = params.name;
+    const labels = params.labels;
+    const type = params.type;
+    const status = params.status;
+    const unassignedVisibility = params.unassignedVisibility;
+    const isDefault = params.isDefault;
+    const position = params.position;
+    const createdAt = params.createdAt;
+    const updatedAt = params.updatedAt;
+    const limit = params.limit;
+    const offset = params.offset;
+    const order = params.order;
+    const apiPath = "/v1/channels";
+    const apiPayload = {};
+    if (typeof id !== "undefined") {
+      apiPayload["id"] = id;
+    }
+    if (typeof code !== "undefined") {
+      apiPayload["code"] = code;
+    }
+    if (typeof name !== "undefined") {
+      apiPayload["name"] = name;
+    }
+    if (typeof labels !== "undefined") {
+      apiPayload["labels"] = labels;
+    }
+    if (typeof type !== "undefined") {
+      apiPayload["type"] = type;
+    }
+    if (typeof status !== "undefined") {
+      apiPayload["status"] = status;
+    }
+    if (typeof unassignedVisibility !== "undefined") {
+      apiPayload["unassigned_visibility"] = unassignedVisibility;
+    }
+    if (typeof isDefault !== "undefined") {
+      apiPayload["is_default"] = isDefault;
+    }
+    if (typeof position !== "undefined") {
+      apiPayload["position"] = position;
+    }
+    if (typeof createdAt !== "undefined") {
+      apiPayload["created_at"] = createdAt;
+    }
+    if (typeof updatedAt !== "undefined") {
+      apiPayload["updated_at"] = updatedAt;
+    }
+    if (typeof limit !== "undefined") {
+      apiPayload["limit"] = limit;
+    }
+    if (typeof offset !== "undefined") {
+      apiPayload["offset"] = offset;
+    }
+    if (typeof order !== "undefined") {
+      apiPayload["order"] = order;
+    }
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {};
+    return this.client.call(
+      "get",
+      uri,
+      apiHeaders,
+      apiPayload
+    );
+  }
+  channelsCreate(paramsOrFirst, ...rest) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        code: paramsOrFirst,
+        name: rest[0],
+        isDefault: rest[1],
+        labels: rest[2],
+        position: rest[3],
+        status: rest[4],
+        type: rest[5],
+        unassignedVisibility: rest[6]
+      };
+    }
+    const code = params.code;
+    const name = params.name;
+    const isDefault = params.isDefault;
+    const labels = params.labels;
+    const position = params.position;
+    const status = params.status;
+    const type = params.type;
+    const unassignedVisibility = params.unassignedVisibility;
+    if (typeof code === "undefined") {
+      throw new RevenexxException('Missing required parameter: "code"');
+    }
+    if (typeof name === "undefined") {
+      throw new RevenexxException('Missing required parameter: "name"');
+    }
+    const apiPath = "/v1/channels";
+    const apiPayload = {};
+    if (typeof code !== "undefined") {
+      apiPayload["code"] = code;
+    }
+    if (typeof isDefault !== "undefined") {
+      apiPayload["is_default"] = isDefault;
+    }
+    if (typeof labels !== "undefined") {
+      apiPayload["labels"] = labels;
+    }
+    if (typeof name !== "undefined") {
+      apiPayload["name"] = name;
+    }
+    if (typeof position !== "undefined") {
+      apiPayload["position"] = position;
+    }
+    if (typeof status !== "undefined") {
+      apiPayload["status"] = status;
+    }
+    if (typeof type !== "undefined") {
+      apiPayload["type"] = type;
+    }
+    if (typeof unassignedVisibility !== "undefined") {
+      apiPayload["unassigned_visibility"] = unassignedVisibility;
+    }
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {
+      "content-type": "application/json"
+    };
+    return this.client.call(
+      "post",
+      uri,
+      apiHeaders,
+      apiPayload
+    );
+  }
+  channelsContext(paramsOrFirst) {
+    let params;
+    if (!paramsOrFirst || paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        channel: paramsOrFirst
+      };
+    }
+    const channel = params.channel;
+    const apiPath = "/v1/channels/context";
+    const apiPayload = {};
+    if (typeof channel !== "undefined") {
+      apiPayload["channel"] = channel;
+    }
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {};
+    return this.client.call(
+      "get",
+      uri,
+      apiHeaders,
+      apiPayload
+    );
+  }
+  /**
+   * The repair call. A tenant installed before `channel_types` existed, or one that deleted its way into a state where nothing works, gets the shipped starting point back — the 5 seeded types first, because the seeded channel carries one of them, then the `shop` channel. Most tenants never call it: the platform invokes the same routine itself on `app.installed`, so a fresh install already has its 5 types and its shop channel before anyone asks, and this route exists for the tenant whose install predates them or who has since removed them. Calling it on a settled tenant is safe and cheap for the same reason it is safe to fire on every install: it is idempotent, keyed on the code, so a second call writes nothing. Everything a merchant added themselves is left alone, and a row that already exists is reported under `existing` rather than rewritten — the values you edited on a seeded type survive this call. It RESTORES THE WHOLE SEED SET, including a seeded type the merchant deliberately deleted. Idempotency here is keyed on the code and nothing else, and there is nowhere to remember a retirement: retirement is not a state this app can represent. Retiring a type IS deleting the row; `channel_types` has no retired flag and these tables carry no foreign keys, so nothing anywhere distinguishes a code a merchant removed on purpose from one they never had. Honouring the retirement would mean inventing a tombstone rather than reading one. Given that, restoring all 5 is the better half of the trade: this is the call a tenant makes when something is missing, and a repair that silently skips part of what it repairs, with no way to ask for the rest, is worse than one that says plainly what it puts back. It is also never a surprise. The only automatic seeding elsewhere in the app fires when the type table is completely EMPTY, which cannot happen once installed because the last remaining type cannot be deleted — so a retired type comes back exactly when somebody calls this route or the app is installed again, and never as a side effect of an unrelated read. Deleting it a second time costs one DELETE, and is refused only if a channel has since started carrying it. What it does not do: it creates no assignments, it does not repair a channel whose own code you deleted (only `shop` comes back), and it does not restore the seeded VALUES of a type that still exists — a renamed `storefront` stays renamed.
+   *
+   * @throws {RevenexxException}
+   * @returns {Promise<Models.Error>}
+   */
+  channelsDefaults() {
+    const apiPath = "/v1/channels/defaults";
+    const apiPayload = {};
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {};
+    return this.client.call(
+      "post",
+      uri,
+      apiHeaders,
+      apiPayload
+    );
+  }
+  channelsTypesList(paramsOrFirst, ...rest) {
+    let params;
+    if (!paramsOrFirst || paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        limit: paramsOrFirst,
+        offset: rest[0]
+      };
+    }
+    const limit = params.limit;
+    const offset = params.offset;
+    const apiPath = "/v1/channels/types";
+    const apiPayload = {};
+    if (typeof limit !== "undefined") {
+      apiPayload["limit"] = limit;
+    }
+    if (typeof offset !== "undefined") {
+      apiPayload["offset"] = offset;
+    }
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {};
+    return this.client.call(
+      "get",
+      uri,
+      apiHeaders,
+      apiPayload
+    );
+  }
+  channelsTypesCreate(paramsOrFirst, ...rest) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        code: paramsOrFirst,
+        title: rest[0],
+        description: rest[1],
+        descriptions: rest[2],
+        isDefault: rest[3],
+        labels: rest[4],
+        position: rest[5],
+        tone: rest[6]
+      };
+    }
+    const code = params.code;
+    const title = params.title;
+    const description = params.description;
+    const descriptions = params.descriptions;
+    const isDefault = params.isDefault;
+    const labels = params.labels;
+    const position = params.position;
+    const tone = params.tone;
+    if (typeof code === "undefined") {
+      throw new RevenexxException('Missing required parameter: "code"');
+    }
+    if (typeof title === "undefined") {
+      throw new RevenexxException('Missing required parameter: "title"');
+    }
+    const apiPath = "/v1/channels/types";
+    const apiPayload = {};
+    if (typeof code !== "undefined") {
+      apiPayload["code"] = code;
+    }
+    if (typeof description !== "undefined") {
+      apiPayload["description"] = description;
+    }
+    if (typeof descriptions !== "undefined") {
+      apiPayload["descriptions"] = descriptions;
+    }
+    if (typeof isDefault !== "undefined") {
+      apiPayload["is_default"] = isDefault;
+    }
+    if (typeof labels !== "undefined") {
+      apiPayload["labels"] = labels;
+    }
+    if (typeof position !== "undefined") {
+      apiPayload["position"] = position;
+    }
+    if (typeof title !== "undefined") {
+      apiPayload["title"] = title;
+    }
+    if (typeof tone !== "undefined") {
+      apiPayload["tone"] = tone;
+    }
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {
+      "content-type": "application/json"
+    };
+    return this.client.call(
+      "post",
+      uri,
+      apiHeaders,
+      apiPayload
+    );
+  }
+  channelsTypesDelete(paramsOrFirst) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        id: paramsOrFirst
+      };
+    }
+    const id = params.id;
+    if (typeof id === "undefined") {
+      throw new RevenexxException('Missing required parameter: "id"');
+    }
+    const apiPath = "/v1/channels/types/{id}".replace("{id}", id);
+    const apiPayload = {};
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {};
+    return this.client.call(
+      "delete",
+      uri,
+      apiHeaders,
+      apiPayload
+    );
+  }
+  channelsTypesGet(paramsOrFirst) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        id: paramsOrFirst
+      };
+    }
+    const id = params.id;
+    if (typeof id === "undefined") {
+      throw new RevenexxException('Missing required parameter: "id"');
+    }
+    const apiPath = "/v1/channels/types/{id}".replace("{id}", id);
+    const apiPayload = {};
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {};
+    return this.client.call(
+      "get",
+      uri,
+      apiHeaders,
+      apiPayload
+    );
+  }
+  channelsTypesUpdate(paramsOrFirst, ...rest) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        id: paramsOrFirst,
+        description: rest[0],
+        descriptions: rest[1],
+        isDefault: rest[2],
+        labels: rest[3],
+        position: rest[4],
+        title: rest[5],
+        tone: rest[6]
+      };
+    }
+    const id = params.id;
+    const description = params.description;
+    const descriptions = params.descriptions;
+    const isDefault = params.isDefault;
+    const labels = params.labels;
+    const position = params.position;
+    const title = params.title;
+    const tone = params.tone;
+    if (typeof id === "undefined") {
+      throw new RevenexxException('Missing required parameter: "id"');
+    }
+    const apiPath = "/v1/channels/types/{id}".replace("{id}", id);
+    const apiPayload = {};
+    if (typeof description !== "undefined") {
+      apiPayload["description"] = description;
+    }
+    if (typeof descriptions !== "undefined") {
+      apiPayload["descriptions"] = descriptions;
+    }
+    if (typeof isDefault !== "undefined") {
+      apiPayload["is_default"] = isDefault;
+    }
+    if (typeof labels !== "undefined") {
+      apiPayload["labels"] = labels;
+    }
+    if (typeof position !== "undefined") {
+      apiPayload["position"] = position;
+    }
+    if (typeof title !== "undefined") {
+      apiPayload["title"] = title;
+    }
+    if (typeof tone !== "undefined") {
+      apiPayload["tone"] = tone;
+    }
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {
+      "content-type": "application/json"
+    };
+    return this.client.call(
+      "put",
+      uri,
+      apiHeaders,
+      apiPayload
+    );
+  }
+  channelsVisibility(paramsOrFirst, ...rest) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst) && ("items" in paramsOrFirst || "channel" in paramsOrFirst || "channelBody" in paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        items: paramsOrFirst,
+        channel: rest[0],
+        channelBody: rest[1]
+      };
+    }
+    const items = params.items;
+    const channel = params.channel;
+    const channelBody = params.channelBody;
+    if (typeof items === "undefined") {
+      throw new RevenexxException('Missing required parameter: "items"');
+    }
+    const apiPath = "/v1/channels/visibility";
+    const apiPayload = {};
+    if (typeof channel !== "undefined") {
+      apiPayload["channel"] = channel;
+    }
+    if (typeof channelBody !== "undefined") {
+      apiPayload["channel"] = channelBody;
+    }
+    if (typeof items !== "undefined") {
+      apiPayload["items"] = items;
+    }
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {
+      "content-type": "application/json"
+    };
+    return this.client.call(
+      "post",
+      uri,
+      apiHeaders,
+      apiPayload
+    );
+  }
+  /**
+   * Discovery for the vocabulary routes: which enums this app publishes, not what is in them. An entry carries the name and the localised title and description a UI would put above a select, and stops there — the permitted values, their labels and their badge tones are the other route's answer. The split is deliberate. This index is a fixed, tiny answer a client can hold onto, while a vocabulary's contents are not fixed at all: `types` is backed by the tenant's own rows, so its values change whenever a merchant adds or retires one, and folding them in here would make every consumer re-fetch the whole set to learn a title. Names: statuses, types, unassigned-visibility. Fetch one with GET /channels/vocabularies/{name}; a client holding the qualified pair 'channels.<name>' builds that URL from the pair alone.
+   *
+   * @throws {RevenexxException}
+   * @returns {Promise<Models.ChannelVocabularyIndex>}
+   */
+  channelsVocabulariesList() {
+    const apiPath = "/v1/channels/vocabularies";
+    const apiPayload = {};
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {};
+    return this.client.call(
+      "get",
+      uri,
+      apiHeaders,
+      apiPayload
+    );
+  }
+  channelsVocabulariesGet(paramsOrFirst) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst) && "name" in paramsOrFirst) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        name: paramsOrFirst
+      };
+    }
+    const name = params.name;
+    if (typeof name === "undefined") {
+      throw new RevenexxException('Missing required parameter: "name"');
+    }
+    const apiPath = "/v1/channels/vocabularies/{name}".replace("{name}", name);
+    const apiPayload = {};
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {};
+    return this.client.call(
+      "get",
+      uri,
+      apiHeaders,
+      apiPayload
+    );
+  }
+  channelsDelete(paramsOrFirst) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        id: paramsOrFirst
+      };
+    }
+    const id = params.id;
+    if (typeof id === "undefined") {
+      throw new RevenexxException('Missing required parameter: "id"');
+    }
+    const apiPath = "/v1/channels/{id}".replace("{id}", id);
+    const apiPayload = {};
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {};
+    return this.client.call(
+      "delete",
+      uri,
+      apiHeaders,
+      apiPayload
+    );
+  }
+  channelsGet(paramsOrFirst) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        id: paramsOrFirst
+      };
+    }
+    const id = params.id;
+    if (typeof id === "undefined") {
+      throw new RevenexxException('Missing required parameter: "id"');
+    }
+    const apiPath = "/v1/channels/{id}".replace("{id}", id);
+    const apiPayload = {};
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {};
+    return this.client.call(
+      "get",
+      uri,
+      apiHeaders,
+      apiPayload
+    );
+  }
+  channelsUpdate(paramsOrFirst, ...rest) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        id: paramsOrFirst,
+        code: rest[0],
+        isDefault: rest[1],
+        labels: rest[2],
+        name: rest[3],
+        position: rest[4],
+        status: rest[5],
+        type: rest[6],
+        unassignedVisibility: rest[7]
+      };
+    }
+    const id = params.id;
+    const code = params.code;
+    const isDefault = params.isDefault;
+    const labels = params.labels;
+    const name = params.name;
+    const position = params.position;
+    const status = params.status;
+    const type = params.type;
+    const unassignedVisibility = params.unassignedVisibility;
+    if (typeof id === "undefined") {
+      throw new RevenexxException('Missing required parameter: "id"');
+    }
+    const apiPath = "/v1/channels/{id}".replace("{id}", id);
+    const apiPayload = {};
+    if (typeof code !== "undefined") {
+      apiPayload["code"] = code;
+    }
+    if (typeof isDefault !== "undefined") {
+      apiPayload["is_default"] = isDefault;
+    }
+    if (typeof labels !== "undefined") {
+      apiPayload["labels"] = labels;
+    }
+    if (typeof name !== "undefined") {
+      apiPayload["name"] = name;
+    }
+    if (typeof position !== "undefined") {
+      apiPayload["position"] = position;
+    }
+    if (typeof status !== "undefined") {
+      apiPayload["status"] = status;
+    }
+    if (typeof type !== "undefined") {
+      apiPayload["type"] = type;
+    }
+    if (typeof unassignedVisibility !== "undefined") {
+      apiPayload["unassigned_visibility"] = unassignedVisibility;
+    }
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {
+      "content-type": "application/json"
+    };
+    return this.client.call(
+      "put",
+      uri,
+      apiHeaders,
+      apiPayload
+    );
+  }
+};
+
+export { Channels };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=channels.mjs.map