@cloudcommerce/api 0.14.0 → 0.15.0

package/src/types/applications.d.ts

@@ -1,165 +0,0 @@
-/* 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.
- */
-
-export interface Applications {
-  _id: string & { length: 24 };
-  created_at: string;
-  updated_at: string;
-  store_id: number;
-  /**
-   * ID of application on marketplace
-   */
-  app_id: number;
-  /**
-   * The working state of this app in the shop
-   */
-  state?: 'inactive' | 'active' | 'test';
-  /**
-   * App title
-   */
-  title: string;
-  /**
-   * App unique slug on marketplace, only lowercase letters, numbers and hyphen
-   */
-  slug?: string;
-  /**
-   * Whether this app is paid
-   */
-  paid?: boolean;
-  /**
-   * Installed application version, semver e.g. 1.0.0
-   */
-  version: string;
-  /**
-   * When app installation was updated, date and time in ISO 8601 standard representation
-   */
-  version_date?: string;
-  /**
-   * Type of app
-   */
-  type: 'dashboard' | 'storefront' | 'external';
-  /**
-   * Modules handled by this app
-   */
-  modules?: {
-    calculate_shipping?: Module;
-    list_payments?: Module1;
-    apply_discount?: Module2;
-    create_transaction?: Module3;
-    checkout_done?: Module4;
-  };
-  /**
-   * Configuration options for staff on admin dashboard, saved on app data
-   */
-  admin_settings?: {
-    /**
-     * Configuration field object, property name same as saved on data object
-     *
-     * This interface was referenced by `undefined`'s JSON-Schema definition
-     * via the `patternProperty` "^[a-z0-9_]{2,30}$".
-     */
-    [k: string]: {
-      /**
-       * JSON Schema (https://json-schema.org/specification.html) for field model
-       */
-      schema: {
-        [k: string]: unknown;
-      };
-      /**
-       * Whether the field value is private, saved in `hidden_data`
-       */
-      hide?: boolean;
-    };
-  };
-  /**
-   * Application object data, schema free
-   */
-  data?: {
-    [k: string]: any;
-  };
-  /**
-   * Application private data, available only with authentication
-   */
-  hidden_data?: {
-    [k: string]: any;
-  };
-  /**
-   * Flags to associate additional info
-   *
-   * @maxItems 10
-   */
-  flags?: string[];
-  /**
-   * Optional notes with additional info about this user
-   */
-  notes?: string;
-}
-/**
- * Triggered to calculate shipping options, must return calculated values and times
- */
-export interface Module {
-  /**
-   * Whether current app is enabled to handle the module requests
-   */
-  enabled: boolean;
-  /**
-   * URL to receive POST request of respective module
-   */
-  endpoint: string;
-}
-/**
- * Triggered when listing payments, must return available methods
- */
-export interface Module1 {
-  /**
-   * Whether current app is enabled to handle the module requests
-   */
-  enabled: boolean;
-  /**
-   * URL to receive POST request of respective module
-   */
-  endpoint: string;
-}
-/**
- * Triggered to validate and apply discout value, must return discount and conditions
- */
-export interface Module2 {
-  /**
-   * Whether current app is enabled to handle the module requests
-   */
-  enabled: boolean;
-  /**
-   * URL to receive POST request of respective module
-   */
-  endpoint: string;
-}
-/**
- * Triggered when order is being closed, must create payment transaction and return info
- */
-export interface Module3 {
-  /**
-   * Whether current app is enabled to handle the module requests
-   */
-  enabled: boolean;
-  /**
-   * URL to receive POST request of respective module
-   */
-  endpoint: string;
-}
-/**
- * Triggered after each order created from storefront, could return custom fields
- */
-export interface Module4 {
-  /**
-   * Whether current app is enabled to handle the module requests
-   */
-  enabled: boolean;
-  /**
-   * URL to receive POST request of respective module
-   */
-  endpoint: string;
-}

package/src/types/authentications.d.ts

@@ -1,107 +0,0 @@
-/* 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.
- */
-
-export interface Authentications {
-  _id: string & { length: 24 };
-  created_at: string;
-  updated_at: string;
-  /**
-   * @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/src/types/categories.d.ts

@@ -1,199 +0,0 @@
-/* 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.
- */
-
-export interface Categories {
-  _id: string & { length: 24 };
-  created_at: string;
-  updated_at: string;
-  store_id: number;
-  /**
-   * @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;
-    /**
-     * 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;
-    /**
-     * 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/src/types/grids.d.ts

@@ -1,157 +0,0 @@
-/* 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.
- */
-
-export interface Grids {
-  _id: string & { length: 24 };
-  created_at: string;
-  updated_at: string;
-  store_id: number;
-  /**
-   * Grid title
-   */
-  title: 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]: {
-      /**
-       * Grid title
-       */
-      title?: string;
-    };
-  };
-  /**
-   * Identifier for integrations and syncronizations, generally the grid name normalized
-   */
-  grid_id?: string;
-  /**
-   * Pre-defined options for this grid, used in specifications, customization and variations
-   *
-   * @maxItems 3000
-   */
-  options?: {
-    /**
-     * Option ID (ObjectID) [auto]
-     */
-    _id?: string;
-    /**
-     * Option text value displayed for the client
-     */
-    text: 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]: {
-        /**
-         * Option text value displayed for the client
-         */
-        text?: string;
-      };
-    };
-    /**
-     * Default normalized value to use in integrations
-     */
-    value?: string;
-    /**
-     * Normalized values to use in specific integrations (ID in property)
-     */
-    external_values?: {
-      /**
-       * Attribute text value
-       *
-       * This interface was referenced by `undefined`'s JSON-Schema definition
-       * via the `patternProperty` "^[a-z0-9_]{2,30}$".
-       */
-      [k: string]: string;
-    };
-    /**
-     * Option color palette (if the grid involves colors), starting by main color
-     *
-     * @maxItems 6
-     */
-    colors?: string[];
-    /**
-     * Default price alteration for product with this option for customization or variations
-     */
-    add_to_price?: {
-      /**
-       * Type of price addition
-       */
-      type?: 'percentage' | 'fixed';
-      /**
-       * Additional value, could be negative
-       */
-      addition: number;
-    };
-  }[];
-  /**
-   * If this grid accept custom value defined by customer (product customization)
-   */
-  custom_value?: boolean;
-  /**
-   * If this grid accept customer file attachment
-   */
-  attachment?: boolean;
-  /**
-   * Default price alteration for product with this grid for customization or variations
-   */
-  add_to_price?: {
-    /**
-     * Type of price addition
-     */
-    type?: 'percentage' | 'fixed';
-    /**
-     * Additional value, could be negative
-     */
-    addition: 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 product
-   */
-  notes?: string;
-}