@cloudcommerce/api 0.14.0 → 0.15.0

package/lib/types/customers.d.ts

@@ -1,523 +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.
- */
-
-/**
- * Customer object model
- */
-export interface Customers {
-  _id: string & { length: 24 };
-  created_at: string;
-  updated_at: string;
-  store_id: number;
-  /**
-   * Whether customer was registered by staff and is trusted
-   */
-  staff_signature?: boolean;
-  /**
-   * The state of registration, if completed, invited and waiting, or declined by customer
-   */
-  state?: 'invited' | 'registered' | 'declined';
-  /**
-   * Whether customer account is enabled to make orders
-   */
-  enabled?: boolean;
-  /**
-   * Whether the customer can sign in to the store with this account
-   */
-  login?: boolean;
-  /**
-   * Status defined by seller, such as active or blocked
-   */
-  status?: string;
-  /**
-   * Code to identify the affiliate that referred the customer
-   */
-  affiliate_code?: string;
-  /**
-   * UTM campaign HTTP parameters associated with this customer's first access
-   */
-  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;
-  };
-  /**
-   * Providers for OAuth authentication
-   *
-   * @maxItems 20
-   */
-  oauth_providers?: {
-    /**
-     * The provider with which the user authenticated, e.g.: 'facebook'
-     */
-    provider: string;
-    /**
-     * Unique ID for the user generated by the service provider
-     */
-    user_id: string;
-  }[];
-  /**
-   * Customer language two letters code, sometimes with region, e.g.: 'pt_br', 'fr', 'en_us'
-   */
-  locale?: string;
-  /**
-   * Customer main email address
-   */
-  main_email: string;
-  /**
-   * Customer email addresses list
-   *
-   * @maxItems 20
-   */
-  emails?: {
-    /**
-     * The actual email address
-     */
-    address: string;
-    /**
-     * The type of email
-     */
-    type?: 'home' | 'personal' | 'work' | 'other';
-    /**
-     * States whether or not the email address has been verified
-     */
-    verified?: boolean;
-  }[];
-  /**
-   * Indicates whether customer would like to receive email updates from the shop
-   */
-  accepts_marketing?: boolean;
-  /**
-   * The name of this Customer, suitable for display
-   */
-  display_name: string;
-  /**
-   * Customer name object
-   */
-  name?: {
-    /**
-     * The family name of this user, or "last name"
-     */
-    family_name?: string;
-    /**
-     * The "first name" of this user
-     */
-    given_name?: string;
-    /**
-     * The middle name(s) of this user
-     */
-    middle_name?: string;
-  };
-  /**
-   * Date of customer birth
-   */
-  birth_date?: {
-    /**
-     * Day of birth
-     */
-    day?: number;
-    /**
-     * Number of month of birth
-     */
-    month?: number;
-    /**
-     * Year of birth
-     */
-    year?: number;
-  };
-  /**
-   * Customer preferred pronoun
-   */
-  pronoun?: 'he' | 'she';
-  /**
-   * User profile pictures
-   *
-   * @maxItems 20
-   */
-  photos?: string[];
-  /**
-   * List of customer phone numbers
-   *
-   * @maxItems 20
-   */
-  phones?: {
-    /**
-     * Country calling code (without +), defined by standards E.123 and E.164
-     */
-    country_code?: number;
-    /**
-     * The actual phone number, digits only
-     */
-    number: string;
-    /**
-     * The type of phone
-     */
-    type?: 'home' | 'personal' | 'work' | 'other';
-  }[];
-  /**
-   * Physical or juridical (company) person
-   */
-  registry_type?: 'p' | 'j';
-  /**
-   * Country of document origin, an ISO 3166-2 code
-   */
-  doc_country?: string;
-  /**
-   * Responsible person or organization document number (only numbers)
-   */
-  doc_number?: string;
-  /**
-   * Municipal or state registration if exists
-   */
-  inscription_type?: 'State' | 'Municipal';
-  /**
-   * Municipal or state registration number (with characters) if exists
-   */
-  inscription_number?: string;
-  /**
-   * Registered company name or responsible fullname
-   */
-  corporate_name?: string;
-  /**
-   * List of customer shipping addresses
-   *
-   * @maxItems 40
-   */
-  addresses?: {
-    /**
-     * ZIP (CEP, postal...) code
-     */
-    zip: string;
-    /**
-     * Street or public place name
-     */
-    street?: string;
-    /**
-     * House or building street number
-     */
-    number?: number;
-    /**
-     * Address complement or second line, such as apartment number
-     */
-    complement?: string;
-    /**
-     * Borough name
-     */
-    borough?: string;
-    /**
-     * Some optional other reference for this address
-     */
-    near_to?: string;
-    /**
-     * Full in line mailing address, should include street, number and borough
-     */
-    line_address?: string;
-    /**
-     * City name
-     */
-    city?: string;
-    /**
-     * Country name
-     */
-    country?: string;
-    /**
-     * An ISO 3166-2 country code
-     */
-    country_code?: string;
-    /**
-     * Province or state name
-     */
-    province?: string;
-    /**
-     * The two-letter code for the province or state
-     */
-    province_code?: string;
-    /**
-     * The name of recipient, generally is the customer's name
-     */
-    name?: string;
-    /**
-     * The recipient's last name
-     */
-    last_name?: string;
-    /**
-     * Customer phone number for this mailing address
-     */
-    phone?: {
-      /**
-       * Country calling code (without +), defined by standards E.123 and E.164
-       */
-      country_code?: number;
-      /**
-       * The actual phone number, digits only
-       */
-      number: string;
-    };
-    /**
-     * Indicates whether this address is the default address for the customer
-     */
-    default?: boolean;
-  }[];
-  /**
-   * Products marked as favorites
-   *
-   * @maxItems 3000
-   */
-  favorites?: string[];
-  /**
-   * Last products visited by the customer
-   *
-   * @maxItems 100
-   */
-  last_visited_products?: string[];
-  /**
-   * Last terms searched on shop by the customer
-   *
-   * @maxItems 100
-   */
-  last_searched_terms?: string[];
-  /**
-   * Default currency for the user, designator according to ISO 4217 (3 uppercase letters)
-   */
-  currency_id?: string;
-  /**
-   * Graphic symbol used as a shorthand for currency's name
-   */
-  currency_symbol?: string;
-  /**
-   * Total number of orders completed by this customer
-   */
-  orders_count?: number;
-  /**
-   * The total amount in orders completed by this customer
-   */
-  orders_total_value?: number;
-  /**
-   * List of customer accumulated loyalty points by program and expiration
-   *
-   * @maxItems 1000
-   */
-  loyalty_points_entries?: {
-    /**
-     * The name of the loyalty points program
-     */
-    name?: string;
-    /**
-     * Unique identifier, program name using only lowercase, numbers and underscore
-     */
-    program_id: string;
-    /**
-     * Number of loyalty points earned
-     */
-    earned_points?: number;
-    /**
-     * Number of active (not yet used) loyalty points
-     */
-    active_points: number;
-    /**
-     * The ratio of a point when converted to currency
-     */
-    ratio?: number;
-    /**
-     * Validity of the points entry, until this date the active points can be converted
-     */
-    valid_thru?: string;
-    /**
-     * Points origin order ID (ObjectID)
-     */
-    order_id?: string;
-  }[];
-  /**
-   * The total amount of money that this customer has spent at the store
-   */
-  total_spent?: number;
-  /**
-   * The total amount in cancelled orders
-   */
-  total_cancelled?: number;
-  /**
-   * List of customer orders
-   *
-   * @maxItems 1000
-   */
-  orders?: {
-    /**
-     * Order ID (ObjectID)
-     */
-    _id: string & { length: 24 };
-    /**
-     * When order was saved, date and time in ISO 8601 standard representation
-     */
-    created_at?: string;
-    /**
-     * Auto incremented order number
-     */
-    number?: 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;
-    /**
-     * Object with sums of values
-     */
-    amount?: {
-      /**
-       * Order total amount
-       */
-      total: number;
-      /**
-       * The sum of all items prices
-       */
-      subtotal?: number;
-      /**
-       * Order freight cost
-       */
-      freight?: number;
-      /**
-       * Applied discount value
-       */
-      discount?: number;
-      /**
-       * Value deducted via balance in wallet or loyalty points
-       */
-      balance?: number;
-      /**
-       * The sum of all the taxes applied to the order
-       */
-      tax?: number;
-      /**
-       * Sum of optional extra costs applied
-       */
-      extra?: number;
-    };
-    /**
-     * Name or summary of order payment method(s)
-     */
-    payment_method_label?: string;
-    /**
-     * Name of order shipping method(s)
-     */
-    shipping_method_label?: string;
-  }[];
-  /**
-   * List of customer saved credit cards
-   *
-   * @maxItems 40
-   */
-  credit_cards?: {
-    /**
-     * Full name of the holder, as it is on the credit card
-     */
-    holder_name?: string;
-    /**
-     * Issuer identification number (IIN), known as bank identification number (BIN)
-     */
-    bin?: number;
-    /**
-     * Credit card issuer name, eg.: Visa, American Express, MasterCard
-     */
-    company?: string;
-    /**
-     * Last digits (up to 4) of credit card number
-     */
-    last_digits: string;
-    /**
-     * Unique credit card token
-     */
-    token: string;
-    /**
-     * Payment intermediator
-     */
-    intermediator: {
-      /**
-       * Gateway name standardized as identification code
-       */
-      code: string;
-      /**
-       * ID of respective customer account in the intermediator
-       */
-      buyer_id?: 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;
-    };
-  }[];
-  /**
-   * List of custom attributes
-   *
-   * @maxItems 100
-   */
-  hidden_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 customer
-   */
-  notes?: string;
-  /**
-   * Description and notes about this customer, available only for shop administrators
-   */
-  staff_notes?: string;
-}

package/lib/types.d.ts

@@ -1,132 +0,0 @@
-import type { Products } from './types/products';
-import type { Categories } from './types/categories';
-import type { Brands } from './types/brands';
-import type { Collections } from './types/collections';
-import type { Grids } from './types/grids';
-import type { Carts } from './types/carts';
-import type { Orders } from './types/orders';
-import type { Customers } from './types/customers';
-import type { Stores } from './types/stores';
-import type { Applications } from './types/applications';
-import type { Authentications } from './types/authentications';
-type Resource = 'products' | 'categories' | 'brands' | 'collections' | 'grids' | 'carts' | 'orders' | 'customers' | 'stores' | 'applications' | 'authentications';
-type ResourceId = string & {
-    length: 24;
-};
-type ResourceAndId = `${Resource}/${ResourceId}`;
-type ResourceOpQuery = Resource | `${Resource}?${string}`;
-type EventsEndpoint = `events/${Resource}` | `events/${ResourceAndId}` | 'events/me';
-type Endpoint = ResourceOpQuery | ResourceAndId | `${ResourceAndId}/${string}` | `slugs/${string}` | 'search/v1' | EventsEndpoint | 'login' | 'authenticate' | 'ask-auth-callback' | 'check-username' | `$aggregate/${Exclude<Resource, 'stores' | 'applications' | 'authentications'>}` | `schemas/${Resource}`;
-type Method = 'get' | 'post' | 'put' | 'patch' | 'delete';
-type Config = {
-    baseUrl?: string;
-    storeId?: number;
-    accessToken?: string;
-    authenticationId?: string;
-    apiKey?: string;
-    isNoAuth?: boolean;
-    lang?: string;
-    method?: Method;
-    endpoint: Endpoint;
-    params?: Record<string, string | number | boolean | string[] | number[]> | string;
-    headers?: Headers | Record<string, string>;
-    timeout?: number;
-    maxRetries?: number;
-    canCache?: boolean;
-    cacheMaxAge?: number;
-    fetch?: typeof fetch;
-};
-type BaseListResultMeta = {
-    offset: number;
-    limit: number;
-    fields: Array<string>;
-};
-type ListResultDocs<Document extends any> = Array<Partial<Document> & {
-    _id: ResourceId;
-}>;
-type ProductsList = ListResultDocs<Products>;
-type CategoriesList = ListResultDocs<Categories>;
-type BrandsList = ListResultDocs<Brands>;
-type CollectionsList = ListResultDocs<Collections>;
-type GridsList = ListResultDocs<Grids>;
-type CartsList = ListResultDocs<Carts>;
-type OrdersList = ListResultDocs<Orders>;
-type CustomersList = ListResultDocs<Customers>;
-type StoresList = ListResultDocs<Stores>;
-type ApplicationsList = ListResultDocs<Applications>;
-type AuthenticationsList = ListResultDocs<Authentications>;
-type ListEndpoint<TResource extends Resource> = TResource | `${TResource}?${string}`;
-type ResourceListResult<TEndpoint extends ResourceOpQuery> = {
-    result: TEndpoint extends ListEndpoint<'products'> ? ProductsList : TEndpoint extends ListEndpoint<'categories'> ? CategoriesList : TEndpoint extends ListEndpoint<'brands'> ? BrandsList : TEndpoint extends ListEndpoint<'collections'> ? CollectionsList : TEndpoint extends ListEndpoint<'grids'> ? GridsList : TEndpoint extends ListEndpoint<'carts'> ? CartsList : TEndpoint extends ListEndpoint<'orders'> ? OrdersList : TEndpoint extends ListEndpoint<'customers'> ? CustomersList : TEndpoint extends ListEndpoint<'stores'> ? StoresList : TEndpoint extends ListEndpoint<'applications'> ? ApplicationsList : TEndpoint extends ListEndpoint<'authentications'> ? AuthenticationsList : never;
-    meta: BaseListResultMeta & {
-        count?: number;
-        sort: Array<{
-            field: string;
-            order: 1 | -1;
-        }>;
-        query: {
-            [key: string]: any;
-        };
-    };
-};
-type EventFieldsByEndpoint<TEndpoint extends EventsEndpoint> = TEndpoint extends `events/${Resource}` ? {
-    resource_id: ResourceId;
-    authentication_id: ResourceId | null;
-} : TEndpoint extends `events/${ResourceAndId}` ? {
-    authentication_id: ResourceId | null;
-} : TEndpoint extends 'events/me' ? {
-    resource: Resource;
-    resource_id: ResourceId;
-} : never;
-type EventsResult<TEndpoint extends EventsEndpoint> = {
-    result: Array<{
-        timestamp: string;
-        store_id?: number;
-        resource?: string;
-        authentication_id?: ResourceId | null;
-        resource_id?: ResourceId;
-        action: string;
-        modified_fields: string[];
-        method?: number | undefined;
-        endpoint?: string;
-        body?: any;
-        ip?: string;
-    } & EventFieldsByEndpoint<TEndpoint>>;
-    meta: BaseListResultMeta;
-};
-type ResponseBody<TConfig extends Config> = TConfig['method'] extends 'post' ? TConfig['endpoint'] extends 'login' ? {
-    _id: ResourceId;
-    store_ids: number[];
-    api_key: string;
-} : TConfig['endpoint'] extends 'authenticate' ? {
-    my_id: string;
-    access_token: string;
-    expires: string;
-} : {
-    _id: ResourceId;
-} : TConfig['method'] extends 'put' | 'patch' | 'delete' ? null : TConfig['endpoint'] extends `${string}/${ResourceId}/${string}` ? any : TConfig['endpoint'] extends `products/${ResourceId}` ? Products : TConfig['endpoint'] extends `categories/${ResourceId}` ? Categories : TConfig['endpoint'] extends `brands/${ResourceId}` ? Brands : TConfig['endpoint'] extends `collections/${ResourceId}` ? Collections : TConfig['endpoint'] extends `grids/${ResourceId}` ? Grids : TConfig['endpoint'] extends `carts/${ResourceId}` ? Carts : TConfig['endpoint'] extends `orders/${ResourceId}` ? Orders : TConfig['endpoint'] extends `customers/${ResourceId}` ? Customers : TConfig['endpoint'] extends `stores/${ResourceId}` ? Stores : TConfig['endpoint'] extends `applications/${ResourceId}` ? Applications : TConfig['endpoint'] extends `authentications/${ResourceId}` ? Authentications : TConfig['endpoint'] extends ResourceOpQuery ? ResourceListResult<TConfig['endpoint']> : TConfig['endpoint'] extends EventsEndpoint ? EventsResult<TConfig['endpoint']> : any;
-type DocSchema<Document extends any> = Omit<Document, '_id' | 'store_id' | 'store_ids' | 'created_at' | 'updated_at'>;
-type CustomerSet = DocSchema<Customers>;
-type OrderSet = DocSchema<Orders>;
-type CartSet = DocSchema<Carts>;
-type ProductSet = DocSchema<Products>;
-type CategorySet = DocSchema<Categories>;
-type BrandSet = DocSchema<Brands>;
-type CollectionSet = DocSchema<Collections>;
-type GridSet = DocSchema<Grids>;
-type StoreSet = DocSchema<Stores>;
-type ApplicationSet = DocSchema<Applications>;
-type AuthenticationSet = DocSchema<Authentications>;
-type SetDocEndpoint<TResource extends Resource> = TResource | `${TResource}/${ResourceId}`;
-type RequestBody<TConfig extends Config> = TConfig['method'] extends undefined | 'get' | 'delete' ? undefined : TConfig['method'] extends 'patch' ? any : TConfig['endpoint'] extends SetDocEndpoint<'products'> ? ProductSet : TConfig['endpoint'] extends SetDocEndpoint<'categories'> ? CategorySet : TConfig['endpoint'] extends SetDocEndpoint<'brands'> ? BrandSet : TConfig['endpoint'] extends SetDocEndpoint<'collections'> ? CollectionSet : TConfig['endpoint'] extends SetDocEndpoint<'grids'> ? GridSet : TConfig['endpoint'] extends SetDocEndpoint<'carts'> ? CartSet : TConfig['endpoint'] extends SetDocEndpoint<'orders'> ? OrderSet : TConfig['endpoint'] extends SetDocEndpoint<'customers'> ? CustomerSet : TConfig['endpoint'] extends SetDocEndpoint<'stores'> ? StoreSet : TConfig['endpoint'] extends SetDocEndpoint<'applications'> ? ApplicationSet : TConfig['endpoint'] extends SetDocEndpoint<'authentications'> ? AuthenticationSet : any;
-type ErrorBody = {
-    status: number;
-    error_code: number;
-    message: string;
-    user_message?: {
-        en_us: string;
-        pt_br: string;
-    };
-    more_info?: string;
-};
-export type { Products, Categories, Brands, Collections, Grids, Carts, Orders, Customers, Stores, Applications, Authentications, ProductSet, CategorySet, BrandSet, CollectionSet, GridSet, CartSet, OrderSet, CustomerSet, StoreSet, ApplicationSet, AuthenticationSet, ProductsList, CategoriesList, BrandsList, CollectionsList, GridsList, CartsList, OrdersList, CustomersList, StoresList, ApplicationsList, AuthenticationsList, Resource, ResourceId, ResourceAndId, ResourceOpQuery, Endpoint, Method, Config, ResourceListResult, EventsResult, ResponseBody, RequestBody, ErrorBody, };

package/lib/types.js

@@ -1,2 +0,0 @@
-export {};
-// # sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}