@voucherify/sdk 2.9.2 → 2.9.4

package/dist/types/ProductCollections.d.ts

@@ -1,96 +1,99 @@
-import { WithRequiredProperty } from './UtilityTypes';
-export interface ProductIdentity {
-    id?: string;
-    object?: 'product';
-}
-export interface SkuIdentity {
-    id?: string;
-    product_id?: string;
-    object?: 'sku';
-}
-export interface ProductBase {
-    name?: string | null;
-    price?: number | null;
-    attributes?: string[];
-    metadata?: Record<string, unknown>;
-}
-export interface SkuBase {
-    sku?: string | null;
-    price?: number | null;
-    attributes?: Record<string, unknown>;
-    metadata?: Record<string, unknown>;
-    product?: Required<ProductIdentity> & Required<ProductBase> & {
-        source_id: string | null;
-        object: 'product';
-    };
-    image_url?: string | null;
-}
-export interface ProductSaved {
-    created_at?: string;
-    updated_at?: string | null;
-    image_url?: string | null;
-    object?: 'product';
-}
-export interface SkuSaved {
-    created_at?: string;
-    updated_at?: string | null;
-    image_url?: string | null;
-    object?: 'sku';
-}
-export declare type ProductOrSkuIdentity = Required<SkuIdentity> | Required<ProductIdentity>;
-export interface ProductCollectionIdentity {
-    id?: string;
-}
-export interface ProductCollectionSaved {
-    created_at?: string;
-    object?: 'products_collection';
-}
-export declare type ProductCollectionBase = StaticProductCollectionBase | DynamicProductCollectionBase;
-export interface StaticProductCollectionBase {
-    name?: string;
-    type?: 'STATIC';
-    products?: ProductOrSkuIdentity[];
-}
-export interface DynamicProductCollectionBase {
-    name?: string;
-    type?: 'AUTO_UPDATE';
-    filter?: Filter;
-}
-export declare type ProductCollection = ProductCollectionBase & ProductCollectionIdentity & ProductCollectionSaved;
-export declare type Filter = Partial<Record<string, Junction | {
-    conditions: Partial<Record<FiltersCondition, unknown>>;
-}>>;
-export declare type Junction = 'and' | 'AND' | 'or' | 'OR';
-/**
- * @deprecated
- */
-export declare type AllowedFiltersKeys = 'id' | 'name' | 'attributes' | 'source_id' | 'price' | 'image_url' | 'product_id' | 'skus' | 'created_at' | 'updated_at' | 'object' | `metadata.${string}`;
-export declare type FiltersCondition = '$in' | '$not_in' | '$is' | '$is_days_ago' | '$is_days_in_future' | '$is_not' | '$has_value' | '$is_unknown' | '$contains' | '$not_contain' | '$starts_with' | '$ends_with' | '$more_than' | '$less_than' | '$more_than_ago' | '$less_than_ago' | '$more_than_future' | '$less_than_future' | '$more_than_equal' | '$less_than_equal' | '$after' | '$before' | '$count' | '$count_less' | '$count_more';
-export declare type ProductCollectionsCreateRequestBody = WithRequiredProperty<StaticProductCollectionBase, 'name' | 'type'> | Required<DynamicProductCollectionBase>;
-export declare type ProductCollectionsCreateResponseBody = Required<ProductCollectionBase> & Required<ProductCollectionIdentity> & Required<ProductCollectionSaved>;
-export interface ProductCollectionsListRequestQuery {
-    limit?: number;
-    page?: number;
-    order?: 'created_at' | '-created_at';
-}
-export interface ProductCollectionsListResponseBody {
-    object: 'list';
-    data_ref: 'data';
-    data: Required<ProductCollection>[];
-    total: number;
-}
-export declare type ProductCollectionsGetResponseBody = Required<ProductCollection>;
-export interface ProductCollectionsListProductsRequestQuery {
-    limit?: number;
-    page?: number;
-}
-export interface ProductCollectionsListProductsResponseBody {
-    object: 'list';
-    data_ref: 'data';
-    data: ((Required<SkuIdentity> & Required<SkuSaved> & Required<SkuBase> & {
-        source_id: string | null;
-    }) | (Required<ProductIdentity> & Required<ProductSaved> & Required<ProductBase> & {
-        source_id: string | null;
-    }))[];
-    total: number;
-}
+import { WithRequiredProperty } from './UtilityTypes.js';
+
+interface ProductIdentity {
+    id?: string;
+    object?: 'product';
+}
+interface SkuIdentity {
+    id?: string;
+    product_id?: string;
+    object?: 'sku';
+}
+interface ProductBase {
+    name?: string | null;
+    price?: number | null;
+    attributes?: string[];
+    metadata?: Record<string, unknown>;
+}
+interface SkuBase {
+    sku?: string | null;
+    price?: number | null;
+    attributes?: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+    product?: Required<ProductIdentity> & Required<ProductBase> & {
+        source_id: string | null;
+        object: 'product';
+    };
+    image_url?: string | null;
+}
+interface ProductSaved {
+    created_at?: string;
+    updated_at?: string | null;
+    image_url?: string | null;
+    object?: 'product';
+}
+interface SkuSaved {
+    created_at?: string;
+    updated_at?: string | null;
+    image_url?: string | null;
+    object?: 'sku';
+}
+type ProductOrSkuIdentity = Required<SkuIdentity> | Required<ProductIdentity>;
+interface ProductCollectionIdentity {
+    id?: string;
+}
+interface ProductCollectionSaved {
+    created_at?: string;
+    object?: 'products_collection';
+}
+type ProductCollectionBase = StaticProductCollectionBase | DynamicProductCollectionBase;
+interface StaticProductCollectionBase {
+    name?: string;
+    type?: 'STATIC';
+    products?: ProductOrSkuIdentity[];
+}
+interface DynamicProductCollectionBase {
+    name?: string;
+    type?: 'AUTO_UPDATE';
+    filter?: Filter;
+}
+type ProductCollection = ProductCollectionBase & ProductCollectionIdentity & ProductCollectionSaved;
+type Filter = Partial<Record<string, Junction | {
+    conditions: Partial<Record<FiltersCondition, unknown>>;
+}>>;
+declare type Junction = 'and' | 'AND' | 'or' | 'OR';
+/**
+ * @deprecated
+ */
+type AllowedFiltersKeys = 'id' | 'name' | 'attributes' | 'source_id' | 'price' | 'image_url' | 'product_id' | 'skus' | 'created_at' | 'updated_at' | 'object' | `metadata.${string}`;
+declare type FiltersCondition = '$in' | '$not_in' | '$is' | '$is_days_ago' | '$is_days_in_future' | '$is_not' | '$has_value' | '$is_unknown' | '$contains' | '$not_contain' | '$starts_with' | '$ends_with' | '$more_than' | '$less_than' | '$more_than_ago' | '$less_than_ago' | '$more_than_future' | '$less_than_future' | '$more_than_equal' | '$less_than_equal' | '$after' | '$before' | '$count' | '$count_less' | '$count_more';
+type ProductCollectionsCreateRequestBody = WithRequiredProperty<StaticProductCollectionBase, 'name' | 'type'> | Required<DynamicProductCollectionBase>;
+type ProductCollectionsCreateResponseBody = Required<ProductCollectionBase> & Required<ProductCollectionIdentity> & Required<ProductCollectionSaved>;
+interface ProductCollectionsListRequestQuery {
+    limit?: number;
+    page?: number;
+    order?: 'created_at' | '-created_at';
+}
+interface ProductCollectionsListResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: Required<ProductCollection>[];
+    total: number;
+}
+type ProductCollectionsGetResponseBody = Required<ProductCollection>;
+interface ProductCollectionsListProductsRequestQuery {
+    limit?: number;
+    page?: number;
+}
+interface ProductCollectionsListProductsResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: ((Required<SkuIdentity> & Required<SkuSaved> & Required<SkuBase> & {
+        source_id: string | null;
+    }) | (Required<ProductIdentity> & Required<ProductSaved> & Required<ProductBase> & {
+        source_id: string | null;
+    }))[];
+    total: number;
+}
+
+export type { AllowedFiltersKeys, DynamicProductCollectionBase, Filter, FiltersCondition, Junction, ProductBase, ProductCollection, ProductCollectionBase, ProductCollectionIdentity, ProductCollectionSaved, ProductCollectionsCreateRequestBody, ProductCollectionsCreateResponseBody, ProductCollectionsGetResponseBody, ProductCollectionsListProductsRequestQuery, ProductCollectionsListProductsResponseBody, ProductCollectionsListRequestQuery, ProductCollectionsListResponseBody, ProductIdentity, ProductOrSkuIdentity, ProductSaved, SkuBase, SkuIdentity, SkuSaved, StaticProductCollectionBase };

package/dist/types/Products.d.ts

@@ -1,106 +1,108 @@
-export interface ProductsCreate {
-    name?: string;
-    source_id?: string;
-    price?: number;
-    attributes?: string[];
-    metadata?: Record<string, any>;
-    image_url?: string;
-}
-export interface ProductsGetResponseSkus {
-    skus?: {
-        object: 'list';
-        total: number;
-        data?: ProductsGetSkuResponse[];
-    };
-}
-export interface ProductsCreateResponse {
-    id: string;
-    source_id?: string;
-    object: 'product';
-    name?: string;
-    price?: number;
-    attributes?: string[];
-    created_at: string;
-    image_url?: string;
-    metadata?: Record<string, any>;
-}
-export declare type ProductsGetResponse = ProductsCreateResponse & ProductsGetResponseSkus;
-export declare type ProductsUpdate = {
-    name?: string;
-    id?: string;
-    source_id?: string;
-    attributes?: string[];
-    price?: number;
-    image_url?: string;
-    metadata?: Record<string, any>;
-};
-export declare type ProductsUpdateResponse = ProductsCreateResponse;
-export interface ProductsBulkUpdateMetadata {
-    source_ids: string[];
-    metadata: Record<string, any>;
-}
-export declare type ProductsBulkUpdate = ProductsCreate[];
-export declare type ProductsBulkUpdateResponse = {
-    async_action_id: string;
-};
-export declare type ProductsBulkUpdateMetadataResponse = {
-    async_action_id: string;
-};
-export interface ProductsDeleteParams {
-    force?: boolean;
-}
-export interface ProductsListParams {
-    page?: number;
-    limit?: number;
-}
-export interface ProductsListResponse {
-    object: 'list';
-    total: number;
-    data_ref: 'products';
-    products: ProductsGetResponse[];
-}
-export interface ProductsCreateSku {
-    sku: string;
-    source_id?: string;
-    attributes?: Record<string, string>;
-    metadata?: Record<string, any>;
-    price?: number;
-    image_url?: string;
-    currency?: string;
-}
-export interface ProductsCreateSkuResponse {
-    id: string;
-    source_id?: string;
-    sku?: string;
-    price?: number;
-    attributes?: Record<string, string>;
-    metadata?: Record<string, any>;
-    updated_at?: string;
-    currency?: string;
-    created_at: string;
-    object: 'sku';
-}
-export declare type ProductsGetSkuResponse = ProductsCreateSkuResponse;
-export declare type ProductsUpdateSku = ProductsCreateSku & {
-    id?: string;
-    source_id?: string;
-};
-export declare type ProductsUpdateSkuResponse = ProductsGetSkuResponse;
-export interface ProductsDeleteSkuParams {
-    force?: boolean;
-}
-export interface ProductsListSkus {
-    object: 'list';
-    total: number;
-    skus: ProductsGetSkuResponse[];
-}
-export interface SimpleProduct {
-    id: string;
-    source_id?: string;
-    name?: string;
-}
-export interface SimpleSku {
-    id: string;
-    source_id?: string;
-    sku?: string;
-}
+interface ProductsCreate {
+    name?: string;
+    source_id?: string;
+    price?: number;
+    attributes?: string[];
+    metadata?: Record<string, any>;
+    image_url?: string;
+}
+interface ProductsGetResponseSkus {
+    skus?: {
+        object: 'list';
+        total: number;
+        data?: ProductsGetSkuResponse[];
+    };
+}
+interface ProductsCreateResponse {
+    id: string;
+    source_id?: string;
+    object: 'product';
+    name?: string;
+    price?: number;
+    attributes?: string[];
+    created_at: string;
+    image_url?: string;
+    metadata?: Record<string, any>;
+}
+type ProductsGetResponse = ProductsCreateResponse & ProductsGetResponseSkus;
+type ProductsUpdate = {
+    name?: string;
+    id?: string;
+    source_id?: string;
+    attributes?: string[];
+    price?: number;
+    image_url?: string;
+    metadata?: Record<string, any>;
+};
+type ProductsUpdateResponse = ProductsCreateResponse;
+interface ProductsBulkUpdateMetadata {
+    source_ids: string[];
+    metadata: Record<string, any>;
+}
+type ProductsBulkUpdate = ProductsCreate[];
+type ProductsBulkUpdateResponse = {
+    async_action_id: string;
+};
+type ProductsBulkUpdateMetadataResponse = {
+    async_action_id: string;
+};
+interface ProductsDeleteParams {
+    force?: boolean;
+}
+interface ProductsListParams {
+    page?: number;
+    limit?: number;
+}
+interface ProductsListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'products';
+    products: ProductsGetResponse[];
+}
+interface ProductsCreateSku {
+    sku: string;
+    source_id?: string;
+    attributes?: Record<string, string>;
+    metadata?: Record<string, any>;
+    price?: number;
+    image_url?: string;
+    currency?: string;
+}
+interface ProductsCreateSkuResponse {
+    id: string;
+    source_id?: string;
+    sku?: string;
+    price?: number;
+    attributes?: Record<string, string>;
+    metadata?: Record<string, any>;
+    updated_at?: string;
+    currency?: string;
+    created_at: string;
+    object: 'sku';
+}
+type ProductsGetSkuResponse = ProductsCreateSkuResponse;
+type ProductsUpdateSku = ProductsCreateSku & {
+    id?: string;
+    source_id?: string;
+};
+type ProductsUpdateSkuResponse = ProductsGetSkuResponse;
+interface ProductsDeleteSkuParams {
+    force?: boolean;
+}
+interface ProductsListSkus {
+    object: 'list';
+    total: number;
+    skus: ProductsGetSkuResponse[];
+}
+interface SimpleProduct {
+    id: string;
+    source_id?: string;
+    name?: string;
+}
+interface SimpleSku {
+    id: string;
+    source_id?: string;
+    sku?: string;
+}
+
+export type { ProductsBulkUpdate, ProductsBulkUpdateMetadata, ProductsBulkUpdateMetadataResponse, ProductsBulkUpdateResponse, ProductsCreate, ProductsCreateResponse, ProductsCreateSku, ProductsCreateSkuResponse, ProductsDeleteParams, ProductsDeleteSkuParams, ProductsGetResponse, ProductsGetResponseSkus, ProductsGetSkuResponse, ProductsListParams, ProductsListResponse, ProductsListSkus, ProductsUpdate, ProductsUpdateResponse, ProductsUpdateSku, ProductsUpdateSkuResponse, SimpleProduct, SimpleSku };