bc-api-client 0.1.0-beta.1 → 0.1.0-beta.10

package/dist/endpoints.d.ts

@@ -0,0 +1,470 @@
+export declare const customerSegmentation: {
+    segments: string;
+    shopperProfileSegments: (profileId: string) => string;
+    shopperProfiles: string;
+    segmentShopperProfiles: (segmentId: string) => string;
+};
+export declare const geography: {
+    v2: {
+        countries: {
+            path: string;
+            byId: (id: string) => string;
+            count: string;
+            states: {
+                path: (id: string) => string;
+                byId: (countryId: string, id: string) => string;
+                count: (countryId: string) => string;
+            };
+        };
+        states: {
+            path: string;
+            count: string;
+        };
+    };
+};
+export declare const bc: {
+    catalogSummary: string;
+    products: {
+        path: string;
+        byId: (id: number) => string;
+        batchPrices: string;
+        metafields: {
+            batch: string;
+            product: {
+                path: (productId: number) => string;
+                byId: (productId: number, id: number) => string;
+            };
+        };
+        bulkPricingRules: {
+            path: (productId: number) => string;
+            byId: (productId: number, id: number) => string;
+        };
+        categoryAssignments: string;
+        channelAssignments: string;
+        complexRules: {
+            path: (productId: number) => string;
+            byId: (productId: number, id: number) => string;
+        };
+        customFields: {
+            path: (productId: number) => string;
+            byId: (productId: number, id: number) => string;
+        };
+        images: {
+            path: (productId: number) => string;
+            byId: (productId: number, id: number) => string;
+        };
+        reviews: {
+            path: (productId: number) => string;
+            byId: (productId: number, id: number) => string;
+        };
+        videos: {
+            path: (productId: number) => string;
+            byId: (productId: number, id: number) => string;
+        };
+    };
+    modifiers: {
+        path: (productId: number) => string;
+        byId: (productId: number, id: number) => string;
+        values: {
+            path: (productId: number, modifierId: number) => string;
+            byId: (productId: number, modifierId: number, id: number) => string;
+            createImage: (productId: number, modifierId: number, id: number) => string;
+        };
+    };
+    variantOptions: {
+        path: (productId: number) => string;
+        byId: (productId: number, id: number) => string;
+        values: {
+            path: (productId: number, optionId: number) => string;
+            byId: (productId: number, optionId: number, id: number) => string;
+        };
+    };
+    variants: {
+        batch: string;
+        path: (productId: number) => string;
+        byId: (productId: number, id: number) => string;
+        createImage: (productId: number, id: number) => string;
+        metafields: {
+            batch: string;
+            path: (productId: number, id: number) => string;
+            byId: (productId: number, variantId: number, id: number) => string;
+        };
+    };
+    brands: {
+        path: string;
+        byId: (id: number) => string;
+        image: (id: number) => string;
+        metafields: {
+            batch: string;
+            path: (id: number) => string;
+            byId: (brandId: number, id: number) => string;
+        };
+    };
+    categories: {
+        deprecated: {
+            path: string;
+            byId: (id: number) => string;
+        };
+        image: (id: number) => string;
+        metafields: {
+            batch: string;
+            path: (id: number) => string;
+            byId: (categoryId: number, id: number) => string;
+        };
+        sortOrder: (id: number) => string;
+    };
+    trees: {
+        path: string;
+        byId: (id: number) => string;
+        categories: (id: number) => string;
+    };
+    abandonedCarts: {
+        path: (token: string) => string;
+        settings: {
+            global: string;
+            channel: (channelId: number) => string;
+        };
+    };
+    carts: {
+        path: string;
+        byId: (uuid: string) => string;
+        createRedirectUrl: (uuid: string) => string;
+        items: {
+            path: (uuid: string) => string;
+            byId: (cartUuid: string, itemUuid: string) => string;
+        };
+        metafields: {
+            batch: string;
+            path: (uuid: string) => string;
+            byId: (cartUuid: string, metafieldUuid: string) => string;
+        };
+        settings: {
+            global: string;
+            channel: (channelId: number) => string;
+        };
+    };
+    channels: {
+        path: string;
+        byId: (id: number) => string;
+        activeTheme: (id: number) => string;
+        site: (id: number) => string;
+        menus: (id: number) => string;
+        checkoutUrl: (id: number) => string;
+        currencyAssignments: {
+            path: (id: number) => string;
+            byId: (channelId: number, id: number) => string;
+        };
+        listings: {
+            path: (id: number) => string;
+            byId: (channelId: number, id: number) => string;
+        };
+        metafields: {
+            batch: string;
+            path: (id: number) => string;
+            byId: (channelId: number, id: number) => string;
+        };
+    };
+    checkouts: {
+        path: (uuid: string) => string;
+        billingAddress: (uuid: string) => string;
+        consignments: {
+            path: (uuid: string) => string;
+            byId: (checkoutUuid: string, consignmentUuid: string) => string;
+        };
+        coupons: {
+            add: (uuid: string) => string;
+            delete: (uuid: string, code: string) => string;
+        };
+        discounts: (uuid: string) => string;
+        fees: (uuid: string) => string;
+        createOrder: (uuid: string) => string;
+        settings: string;
+        createToken: (uuid: string) => string;
+    };
+    currencies: {
+        v2: {
+            path: string;
+            byId: (id: string) => string;
+        };
+    };
+    customers: {
+        path: string;
+        addresses: (id: number) => string;
+        attributes: (id: number) => string;
+        attributesValues: (id: number) => string;
+        settings: {
+            channel: (channelId: number) => string;
+            global: string;
+        };
+        consent: (id: number) => string;
+        formFieldValues: string;
+        storedInstruments: (id: number) => string;
+        validateCredentials: string;
+        metafields: {
+            batch: string;
+            path: (id: number) => string;
+            byId: (customerId: number, id: number) => string;
+        };
+        v2: {
+            groups: {
+                path: string;
+                byId: (id: number) => string;
+                count: string;
+            };
+            deprecated: {
+                path: string;
+                byId: (id: number) => string;
+                addresses: {
+                    path: (id: number) => string;
+                    byId: (customerId: number, id: number) => string;
+                };
+                validatePassword: (id: number) => string;
+            };
+        };
+        subscribers: {
+            path: string;
+            byId: (id: number) => string;
+        };
+    };
+    customerSegmentation: {
+        segments: string;
+        shopperProfileSegments: (profileId: string) => string;
+        shopperProfiles: string;
+        segmentShopperProfiles: (segmentId: string) => string;
+    };
+    geography: {
+        v2: {
+            countries: {
+                path: string;
+                byId: (id: string) => string;
+                count: string;
+                states: {
+                    path: (id: string) => string;
+                    byId: (countryId: string, id: string) => string;
+                    count: (countryId: string) => string;
+                };
+            };
+            states: {
+                path: string;
+                count: string;
+            };
+        };
+    };
+    inventory: {
+        adjustments: {
+            absolute: string;
+            relative: string;
+        };
+        items: {
+            path: string;
+            atLocation: (locationId: string) => string;
+            updateLocationSettings: (locationId: string) => string;
+        };
+    };
+    locations: {
+        path: string;
+        metafields: {
+            batch: string;
+            path: (id: string) => string;
+            byId: (locationId: string, id: string) => string;
+        };
+    };
+    orders: {
+        v2: {
+            path: string;
+            byId: (id: number) => string;
+            count: string;
+            consignments: {
+                path: (id: number) => string;
+                shippingQuotes: (orderId: number, consignmentId: number) => string;
+            };
+            coupons: (id: number) => string;
+            fees: (id: number) => string;
+            messages: (id: number) => string;
+            products: {
+                path: (id: number) => string;
+                byId: (orderId: number, id: number) => string;
+            };
+            shipments: {
+                path: (id: number) => string;
+                count: (id: number) => string;
+                byId: (orderId: number, id: number) => string;
+            };
+            shippingAddresses: {
+                path: (id: number) => string;
+                byId: (orderId: number, id: number) => string;
+                quotes: (orderId: number, id: number) => string;
+            };
+            statuses: {
+                path: string;
+                byId: (id: number) => string;
+            };
+            taxes: (id: number) => string;
+        };
+        transactions: (id: number) => string;
+        metafields: {
+            batch: string;
+            path: (id: number) => string;
+            byId: (orderId: number, id: number) => string;
+        };
+        settings: {
+            global: string;
+            channel: (channelId: number) => string;
+        };
+        payments: {
+            capture: (id: number) => string;
+            void: (id: number) => string;
+        };
+        refunds: {
+            path: string;
+            byId: (refundId: number) => string;
+            quote: (id: number) => string;
+            forOrder: (id: number) => string;
+        };
+        pickups: {
+            path: string;
+            methods: string;
+            options: string;
+        };
+    };
+    priceLists: {
+        path: string;
+        byId: (id: number) => string;
+        assignments: {
+            path: string;
+            byId: (id: number) => string;
+        };
+        records: {
+            path: string;
+            forList: (id: number) => string;
+            byVariant: (listId: number, variantId: number) => string;
+            byCurrency: (listId: number, variantId: number, currencyCode: string) => string;
+        };
+    };
+    promotions: {
+        path: string;
+        byId: (id: number) => string;
+        coupons: {
+            path: (promotionId: number) => string;
+            byId: (promotionId: number, id: number) => string;
+        };
+        settings: string;
+    };
+    redirects: {
+        path: string;
+        imexJobs: string;
+        createExportJob: string;
+        createImportJob: string;
+        exportEventStream: (jobUuid: string) => string;
+        importEventStream: (jobUuid: string) => string;
+        downloadExport: (jobUuid: string) => string;
+    };
+    scripts: {
+        path: string;
+        byId: (uuid: string) => string;
+    };
+    settings: {
+        analytics: {
+            providers: string;
+            provider: (providerId: string) => string;
+        };
+        catalog: string;
+        emailStatuses: string;
+        createFavicon: string;
+        inventory: {
+            path: string;
+            notifications: string;
+        };
+        logo: {
+            path: string;
+            image: string;
+        };
+        filters: {
+            enabled: string;
+            available: string;
+            contextual: string;
+        };
+        locale: string;
+        profile: string;
+        storefront: {
+            category: string;
+            product: string;
+            robotstxt: string;
+            search: string;
+            security: string;
+            seo: string;
+            status: string;
+            uom: string;
+        };
+    };
+    shipping: {
+        v2: {
+            carrierConnections: string;
+            methods: {
+                path: (zoneId: number) => string;
+                byId: (zoneId: number, id: number) => string;
+            };
+            zones: {
+                path: string;
+                byId: (id: number) => string;
+            };
+        };
+        customsInformation: string;
+        settings: {
+            global: string;
+            channel: (channelId: number) => string;
+        };
+    };
+    sites: {
+        path: string;
+        byId: (id: number) => string;
+        certificates: {
+            all: string;
+            forSite: (id: number) => string;
+        };
+        routes: {
+            path: (siteId: number) => string;
+            byId: (siteId: number, id: number) => string;
+        };
+    };
+    store: {
+        v2: {
+            info: string;
+            time: string;
+        };
+        metafields: {
+            batch: string;
+            path: (id: number) => string;
+            byId: (storeId: number, id: number) => string;
+        };
+        logs: string;
+    };
+    tax: {
+        v2: {
+            classes: {
+                path: string;
+                byId: (id: number) => string;
+            };
+        };
+        customers: string;
+        rates: string;
+        zones: string;
+        properties: string;
+        productProperties: string;
+        settings: string;
+    };
+    wishlists: {
+        path: string;
+        byId: (id: number) => string;
+        items: {
+            delete: (id: number, itemId: number) => string;
+            add: (id: number) => string;
+        };
+    };
+    webhooks: {
+        path: string;
+        byId: (id: number) => string;
+        admin: string;
+        upsertEmailNotifications: string;
+    };
+};