@cloudcommerce/api 1.0.0-alpha.8 → 2.0.0

package/types/authentications.d.ts

@@ -0,0 +1,121 @@
+/* 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.
+ */
+
+/**
+ * Authenticated API user
+ */
+export interface Authentications {
+  /**
+   * Authentication 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;
+  /**
+   * List of store IDs granted for this authentication [auto]
+   *
+   * @maxItems 500
+   */
+  store_ids: number[];
+  /**
+   * Simple username for identification, only numbers and lowercase letters
+   */
+  username: string;
+  /**
+   * User language two letter code, sometimes with region, eg.: pt_br, fr, en_us
+   */
+  locale?: string;
+  /**
+   * User email address
+   */
+  email?: string;
+  /**
+   * User full name
+   */
+  name?: string;
+  /**
+   * User phone number
+   */
+  phone?: string;
+  /**
+   * MD5 hash generated with the user's password
+   */
+  pass_md5_hash?: string;
+  /**
+   * API key as a random 128 bytes hexadecimal number
+   */
+  api_key?: string;
+  /**
+   * Collection of resources allowed to user, each resource uri as object property
+   */
+  permissions?: {
+    /**
+     * Resource/Subresources/Third-level/ID
+     *
+     * This interface was referenced by `undefined`'s JSON-Schema definition
+     * via the `patternProperty` "^(([^/_][a-z0-9/_@:$+]{1,60}[^/])|[*])$".
+     */
+    [k: string]: ('all' | 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE')[];
+  };
+  /**
+   * List of dashboard cards chosen by user
+   *
+   * @maxItems 40
+   */
+  panel_cards?: {
+    /**
+     * Unique identifier, card name using only lowercase, numbers and underscore
+     */
+    card_id: string;
+    /**
+     * Card title
+     */
+    title?: string;
+    /**
+     * Card text, usually a brief description
+     */
+    paragraph?: string;
+    /**
+     * Custom card calling MongoDB aggregate
+     */
+    custom_aggregation?: {
+      /**
+       * API resource
+       */
+      resource: 'products' | 'categories' | 'brands' | 'collections' | 'grids' | 'customers' | 'carts' | 'orders';
+      /**
+       * Aggregation pipeline
+       *
+       * @minItems 1
+       * @maxItems 50
+       */
+      pipeline: {
+        [k: string]: unknown;
+      }[];
+    };
+  }[];
+  /**
+   * Whether the user is able to use builder and file manager to edit storefront
+   */
+  edit_storefront?: boolean;
+  /**
+   * Flags to associate additional info
+   *
+   * @maxItems 10
+   */
+  flags?: string[];
+  /**
+   * Optional notes with additional info about this user
+   */
+  notes?: string;
+}

package/types/brands.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.
+ */
+
+/**
+ * Brand object model
+ */
+export interface Brands {
+  /**
+   * Brand 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 brand not available in all channels
+   *
+   * @maxItems 10
+   */
+  channel_ids?: string[];
+  /**
+   * Brand full name
+   */
+  name: string;
+  /**
+   * Slug to complete page URL, starting with number or lowercase letter
+   */
+  slug?: string;
+  /**
+   * Short brand description in plain text
+   */
+  short_description?: string;
+  /**
+   * Full brand description, may use HTML tags
+   */
+  body_html?: string;
+  /**
+   * Full brand 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]: {
+      /**
+       * Brand full name
+       */
+      name?: string;
+      /**
+       * Short brand description in plain text
+       */
+      short_description?: string;
+      /**
+       * Full brand description, may use HTML tags
+       */
+      body_html?: string;
+      /**
+       * Full brand description, plain text only
+       */
+      body_text?: string;
+      /**
+       * Title tag for page SEO
+       */
+      meta_title?: string;
+      /**
+       * Meta description tag for page SEO
+       */
+      meta_description?: string;
+    };
+  };
+  /**
+   * Brand logo
+   */
+  logo?: {
+    /**
+     * 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 brand 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 brand
+   */
+  notes?: string;
+}

package/types/carts.d.ts

@@ -0,0 +1,380 @@
+/* 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.
+ */
+
+/**
+ * Shopping cart object model
+ */
+export interface Carts {
+  /**
+   * Cart 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;
+  /**
+   * Whether cart was created by staff and is trusted
+   */
+  staff_signature?: boolean;
+  /**
+   * Whether cart still available to complete checkout
+   */
+  available?: boolean;
+  /**
+   * If the cart has been completed, generating an order
+   */
+  completed?: boolean;
+  /**
+   * URL to this cart's page
+   */
+  permalink?: string;
+  /**
+   * Status defined by seller
+   */
+  status?: string;
+  /**
+   * UTM campaign HTTP parameters
+   */
+  utm?: {
+    /**
+     * Parameter 'utm_source', the referrer: (e.g. 'google', 'newsletter')
+     */
+    source?: string;
+    /**
+     * Parameter 'utm_medium', the marketing medium: (e.g. 'cpc', 'banner', 'email')
+     */
+    medium?: string;
+    /**
+     * Parameter 'utm_campaign', the product, promo code, or slogan (e.g. 'spring_sale')
+     */
+    campaign?: string;
+    /**
+     * Parameter 'utm_term', identifies the paid keywords
+     */
+    term?: string;
+    /**
+     * Parameter 'utm_content', used to differentiate ads
+     */
+    content?: string;
+  };
+  /**
+   * The website that the customer clicked on to come to the shop
+   */
+  referring_site?: string;
+  /**
+   * Code to identify the affiliate that referred the customer
+   */
+  affiliate_code?: string;
+  /**
+   * List of customers associated with this cart
+   *
+   * @maxItems 3000
+   */
+  customers?: Array<string & { length: 24 }>;
+  /**
+   * Whether cart is available for other customers too (anyone)
+   */
+  other_customers?: boolean;
+  /**
+   * Products composing the cart
+   *
+   * @maxItems 3000
+   */
+  items: {
+    /**
+     * Cart item ID (ObjectID) [auto]
+     */
+    _id?: string & { length: 24 };
+    /**
+     * Product ID
+     */
+    product_id: string & { length: 24 };
+    /**
+     * ID to specify the variation added to cart, if product has variations
+     */
+    variation_id?: string & { length: 24 };
+    /**
+     * Product or variation SKU (reference code)
+     */
+    sku?: string;
+    /**
+     * Product or variation full name, or other label for this cart item
+     */
+    name?: string;
+    /**
+     * Product slug to complete page URL
+     */
+    slug?: string;
+    /**
+     * Product or variation picture for this cart item
+     */
+    picture?: {
+      normal?: PictureSize;
+      big?: PictureSize1;
+      zoom?: PictureSize2;
+      small?: PictureSize3;
+    };
+    /**
+     * Item customization fields
+     *
+     * @maxItems 100
+     */
+    customizations?: {
+      /**
+       * Title for this customization field, can be the grid title
+       */
+      label?: string;
+      /**
+       * Option chosen or created by customer
+       */
+      option: {
+        /**
+         * Option ID (ObjectID) if it was predefined (not custom value created by customer)
+         */
+        _id?: string & { length: 24 };
+        /**
+         * Option text value displayed for the client
+         */
+        text: string;
+      };
+      /**
+       * URL of file attached by customer to this field
+       */
+      attachment?: string;
+      /**
+       * Price alteration due to this customization
+       */
+      add_to_price?: {
+        /**
+         * Type of price addition
+         */
+        type?: 'percentage' | 'fixed';
+        /**
+         * Additional value, could be negative
+         */
+        addition: number;
+      };
+    }[];
+    /**
+     * Parent kit product for this item
+     */
+    kit_product?: {
+      /**
+       * Kit product ID (ObjectID)
+       */
+      _id: string & { length: 24 };
+      /**
+       * Kit product full name
+       */
+      name?: string;
+      /**
+       * Total quantity of items to close a kit unit
+       */
+      pack_quantity?: number;
+      /**
+       * Kit total pack price
+       */
+      price?: number;
+      /**
+       * Current kit composition
+       *
+       * @maxItems 100
+       */
+      composition?: {
+        /**
+         * Product ID (ObjectID)
+         */
+        _id: string & { length: 24 };
+        /**
+         * Selected variation ID (ObjectID) if any
+         */
+        variation_id?: string & { length: 24 };
+        /**
+         * Kit item quantity
+         */
+        quantity?: number;
+      }[];
+    };
+    /**
+     * Item quantity in cart
+     */
+    quantity: number;
+    /**
+     * Minimum item quantity for this cart
+     */
+    min_quantity?: number;
+    /**
+     * Maximum item quantity for this cart
+     */
+    max_quantity?: number;
+    /**
+     * Deadline for production or handling of pre-ordered item
+     */
+    production_time?: {
+      /**
+       * Number of days to post the product after purchase, deadline for production or handling
+       */
+      days: number;
+      /**
+       * If the deadline is calculated in working days
+       */
+      working_days?: boolean;
+      /**
+       * If the production time is cumulative per item unit
+       */
+      cumulative?: boolean;
+      /**
+       * When cumulative, increase the term proportionally up to this maximum (in days)
+       */
+      max_time?: number;
+    };
+    /**
+     * Designator of currency according to ISO 4217 (3 uppercase letters)
+     */
+    currency_id?: string;
+    /**
+     * Graphic symbol used as a shorthand for currency's name
+     */
+    currency_symbol?: string;
+    /**
+     * Product sale price specifically for this cart
+     */
+    price: number;
+    /**
+     * Final item price including additions due to customizations (auto-calculated)
+     */
+    final_price?: number;
+    /**
+     * Item's original price for comparison, without discounts
+     */
+    base_price?: number;
+    /**
+     * Flags to associate additional info
+     *
+     * @maxItems 10
+     */
+    flags?: string[];
+  }[];
+  /**
+   * The sum of all items prices (auto-calculated)
+   */
+  subtotal?: number;
+  /**
+   * List of orders completed with this cart
+   *
+   * @maxItems 3000
+   */
+  orders?: 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 brand
+   */
+  notes?: string;
+}
+/**
+ * Default image size variant
+ */
+export interface PictureSize {
+  /**
+   * 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;
+}
+/**
+ * Image big size variant
+ */
+export interface PictureSize1 {
+  /**
+   * 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;
+}
+/**
+ * Image zoom size variant
+ */
+export interface PictureSize2 {
+  /**
+   * 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;
+}
+/**
+ * Image small size variant
+ */
+export interface PictureSize3 {
+  /**
+   * 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;
+}