@cloudcommerce/api 1.0.0-alpha.7 → 2.0.0

package/types/categories.d.ts

@@ -0,0 +1,216 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * Category object model
+ */
+export interface Categories {
+  /**
+   * Category ID (ObjectID) [auto]
+   */
+  _id: string & { length: 24 };
+  /**
+   * When object was seted (POST/PUT), date and time in ISO 8601 standard representation [auto]
+   */
+  created_at: string;
+  /**
+   * When was it last changed, date and time in ISO 8601 standard representation [auto]
+   */
+  updated_at: string;
+  /**
+   * ID of store [auto]
+   */
+  store_id: number;
+  /**
+   * List of sales channels if category not available in all channels
+   *
+   * @maxItems 10
+   */
+  channel_ids?: string[];
+  /**
+   * Category full name
+   */
+  name: string;
+  /**
+   * Slug to complete page URL, starting with number or lowercase letter
+   */
+  slug?: string;
+  /**
+   * Short category description in plain text
+   */
+  short_description?: string;
+  /**
+   * Full category description, may use HTML tags
+   */
+  body_html?: string;
+  /**
+   * Full category description, plain text only
+   */
+  body_text?: string;
+  /**
+   * Title tag for page SEO
+   */
+  meta_title?: string;
+  /**
+   * Meta description tag for page SEO
+   */
+  meta_description?: string;
+  /**
+   * Text translations for internationalization
+   */
+  i18n?: {
+    /**
+     * Language specific text fields
+     *
+     * This interface was referenced by `undefined`'s JSON-Schema definition
+     * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
+     */
+    [k: string]: {
+      /**
+       * Category full name
+       */
+      name?: string;
+      /**
+       * Short category description in plain text
+       */
+      short_description?: string;
+      /**
+       * Full category description, may use HTML tags
+       */
+      body_html?: string;
+      /**
+       * Full category description, plain text only
+       */
+      body_text?: string;
+      /**
+       * Title tag for page SEO
+       */
+      meta_title?: string;
+      /**
+       * Meta description tag for page SEO
+       */
+      meta_description?: string;
+    };
+  };
+  /**
+   * Parent category (above) of current category
+   */
+  parent?: {
+    /**
+     * Parent category ID (ObjectID)
+     */
+    _id?: string & { length: 24 };
+    /**
+     * Parent category name
+     */
+    name: string;
+    /**
+     * Text translations for internationalization
+     */
+    i18n?: {
+      /**
+       * Language specific text fields
+       *
+       * This interface was referenced by `undefined`'s JSON-Schema definition
+       * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
+       */
+      [k: string]: {
+        /**
+         * Parent category name
+         */
+        name?: string;
+      };
+    };
+    /**
+     * Parent category page slug
+     */
+    slug?: string;
+  };
+  /**
+   * Category icon image
+   */
+  icon?: {
+    /**
+     * Image link
+     */
+    url: string;
+    /**
+     * Image size (width x height) in px, such as 100x50 (100px width, 50px height)
+     */
+    size?: string;
+    /**
+     * Alternative text, HTML alt tag (important for SEO)
+     */
+    alt?: string;
+  };
+  /**
+   * List of category images
+   *
+   * @maxItems 50
+   */
+  pictures?: {
+    /**
+     * Picture ID (ObjectID) [auto]
+     */
+    _id?: string & { length: 24 };
+    /**
+     * Tag to identify object, use only lowercase letters, digits and underscore
+     */
+    tag?: string;
+    /**
+     * Image link
+     */
+    url: string;
+    /**
+     * Image size (width x height) in px, such as 100x50 (100px width, 50px height)
+     */
+    size?: string;
+    /**
+     * Alternative text, HTML alt tag (important for SEO)
+     */
+    alt?: string;
+  }[];
+  /**
+   * Mercado Libre Taxonomy: https://api.mercadolibre.com/sites/MLB/categories
+   */
+  ml_category_id?: string;
+  /**
+   * Google Taxonomy: https://www.google.com/basepages/producttype/taxonomy-with-ids.pt-BR.txt
+   */
+  google_product_category_id?: number;
+  /**
+   * List of custom attributes
+   *
+   * @maxItems 100
+   */
+  metafields?: {
+    /**
+     * String to help distinguish who (or which app) created and can use the metafield
+     */
+    namespace?: string;
+    /**
+     * Field name
+     */
+    field?: string;
+    /**
+     * Custom property value
+     */
+    value: {
+      [k: string]: unknown;
+    };
+  }[];
+  /**
+   * Flags to associate additional info
+   *
+   * @maxItems 10
+   */
+  flags?: string[];
+  /**
+   * Optional notes with additional info about this category
+   */
+  notes?: string;
+}

package/types/collections.d.ts

@@ -0,0 +1,174 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * Collection object model
+ */
+export interface Collections {
+  /**
+   * Collection ID (ObjectID) [auto]
+   */
+  _id: string & { length: 24 };
+  /**
+   * When object was seted (POST/PUT), date and time in ISO 8601 standard representation [auto]
+   */
+  created_at: string;
+  /**
+   * When was it last changed, date and time in ISO 8601 standard representation [auto]
+   */
+  updated_at: string;
+  /**
+   * ID of store [auto]
+   */
+  store_id: number;
+  /**
+   * Collection full name
+   */
+  name: string;
+  /**
+   * Slug to complete page URL, starting with number or lowercase letter
+   */
+  slug?: string;
+  /**
+   * Short collection description in plain text
+   */
+  short_description?: string;
+  /**
+   * Full collection description, may use HTML tags
+   */
+  body_html?: string;
+  /**
+   * Full collection description, plain text only
+   */
+  body_text?: string;
+  /**
+   * Title tag for page SEO
+   */
+  meta_title?: string;
+  /**
+   * Meta description tag for page SEO
+   */
+  meta_description?: string;
+  /**
+   * Text translations for internationalization
+   */
+  i18n?: {
+    /**
+     * Language specific text fields
+     *
+     * This interface was referenced by `undefined`'s JSON-Schema definition
+     * via the `patternProperty` "^[a-z]{2}(_[a-z]{2})?$".
+     */
+    [k: string]: {
+      /**
+       * Category full name
+       */
+      name?: string;
+      /**
+       * Short collection description in plain text
+       */
+      short_description?: string;
+      /**
+       * Full collection description, may use HTML tags
+       */
+      body_html?: string;
+      /**
+       * Full collection description, plain text only
+       */
+      body_text?: string;
+      /**
+       * Title tag for page SEO
+       */
+      meta_title?: string;
+      /**
+       * Meta description tag for page SEO
+       */
+      meta_description?: string;
+    };
+  };
+  /**
+   * List of collection products
+   *
+   * @maxItems 3000
+   */
+  products?: Array<string & { length: 24 }>;
+  /**
+   * Collection icon image
+   */
+  icon?: {
+    /**
+     * Image link
+     */
+    url: string;
+    /**
+     * Image size (width x height) in px, such as 100x50 (100px width, 50px height)
+     */
+    size?: string;
+    /**
+     * Alternative text, HTML alt tag (important for SEO)
+     */
+    alt?: string;
+  };
+  /**
+   * List of collection images
+   *
+   * @maxItems 50
+   */
+  pictures?: {
+    /**
+     * Picture ID (ObjectID) [auto]
+     */
+    _id?: string & { length: 24 };
+    /**
+     * Tag to identify object, use only lowercase letters, digits and underscore
+     */
+    tag?: string;
+    /**
+     * Image link
+     */
+    url: string;
+    /**
+     * Image size (width x height) in px, such as 100x50 (100px width, 50px height)
+     */
+    size?: string;
+    /**
+     * Alternative text, HTML alt tag (important for SEO)
+     */
+    alt?: string;
+  }[];
+  /**
+   * List of custom attributes
+   *
+   * @maxItems 100
+   */
+  metafields?: {
+    /**
+     * String to help distinguish who (or which app) created and can use the metafield
+     */
+    namespace?: string;
+    /**
+     * Field name
+     */
+    field?: string;
+    /**
+     * Custom property value
+     */
+    value: {
+      [k: string]: unknown;
+    };
+  }[];
+  /**
+   * Flags to associate additional info
+   *
+   * @maxItems 10
+   */
+  flags?: string[];
+  /**
+   * Optional notes with additional info about this category
+   */
+  notes?: string;
+}