@edgebound/bigcommerce 0.3.2 → 0.4.0

package/dist/bigcommerce-entities/companies/schemas/user.schema.d.ts

@@ -0,0 +1,51 @@
+import * as z from 'zod';
+export declare const CreateCompanyUserSchema: z.ZodObject<{
+    acceptWelcomeEmail: z.ZodBoolean;
+    companyId: z.ZodInt;
+    companyRoleId: z.ZodInt;
+    email: z.ZodEmail;
+    firstName: z.ZodString;
+    lastName: z.ZodString;
+    phoneNumber: z.ZodString;
+}, z.core.$strip>;
+export declare const CreateCompanyUserResponseSchema: z.ZodObject<{
+    code: z.ZodNumber;
+    data: z.ZodObject<{
+        bcId: z.ZodNumber;
+        userId: z.ZodInt;
+    }, z.core.$strip>;
+    meta: z.ZodObject<{
+        message: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const GetUserDetailsByCustomerIdResponseSchema: z.ZodObject<{
+    code: z.ZodInt;
+    data: z.ZodObject<{
+        firstName: z.ZodString;
+        lastName: z.ZodString;
+        email: z.ZodEmail;
+        phoneNumber: z.ZodString;
+        role: z.ZodInt;
+        companyRoleId: z.ZodInt;
+        uuid: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        extraFields: z.ZodArray<z.ZodObject<{
+            fieldName: z.ZodString;
+            fieldValue: z.ZodString;
+        }, z.core.$strip>>;
+        companyId: z.ZodInt;
+        customerId: z.ZodInt;
+        companyRoleName: z.ZodString;
+        channelList: z.ZodArray<z.ZodObject<{
+            channelId: z.ZodInt;
+            channelName: z.ZodString;
+            iconUrl: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    meta: z.ZodObject<{
+        message: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const GetUserDetailsByCustomerIdInputSchema: z.ZodObject<{
+    customerId: z.ZodInt;
+}, z.core.$strip>;
+//# sourceMappingURL=user.schema.d.ts.map

package/dist/bigcommerce-entities/companies/schemas/user.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.schema.d.ts","sourceRoot":"","sources":["../../../../src/bigcommerce-entities/companies/schemas/user.schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,eAAO,MAAM,uBAAuB;;;;;;;;iBAQlC,CAAC;AAEH,eAAO,MAAM,+BAA+B;;;;;;;;;iBAS1C,CAAC;AAEH,eAAO,MAAM,wCAAwC;;;;;;;;;;;;;;;;;;;;;;;;;;iBA8BnD,CAAC;AAEH,eAAO,MAAM,qCAAqC;;iBAEhD,CAAC"}

package/dist/bigcommerce-entities/companies/schemas/user.schema.js

@@ -0,0 +1,91 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetUserDetailsByCustomerIdInputSchema = exports.GetUserDetailsByCustomerIdResponseSchema = exports.CreateCompanyUserResponseSchema = exports.CreateCompanyUserSchema = void 0;
+const z = __importStar(require("zod"));
+exports.CreateCompanyUserSchema = z.object({
+    acceptWelcomeEmail: z.boolean(),
+    companyId: z.int(),
+    companyRoleId: z.int(),
+    email: z.email(),
+    firstName: z.string(),
+    lastName: z.string(),
+    phoneNumber: z.string(),
+});
+exports.CreateCompanyUserResponseSchema = z.object({
+    code: z.number(),
+    data: z.object({
+        bcId: z.number(),
+        userId: z.int(),
+    }),
+    meta: z.object({
+        message: z.string(),
+    }),
+});
+exports.GetUserDetailsByCustomerIdResponseSchema = z.object({
+    code: z.int(),
+    data: z.object({
+        firstName: z.string(),
+        lastName: z.string(),
+        email: z.email(),
+        phoneNumber: z.string(),
+        role: z.int(),
+        companyRoleId: z.int(),
+        uuid: z.string().optional().nullable(),
+        extraFields: z
+            .object({
+            fieldName: z.string(),
+            fieldValue: z.string(),
+        })
+            .array(),
+        companyId: z.int(),
+        customerId: z.int(),
+        companyRoleName: z.string(),
+        channelList: z
+            .object({
+            channelId: z.int(),
+            channelName: z.string(),
+            iconUrl: z.string(),
+        })
+            .array(),
+    }),
+    meta: z.object({
+        message: z.string(),
+    }),
+});
+exports.GetUserDetailsByCustomerIdInputSchema = z.object({
+    customerId: z.int(),
+});
+//# sourceMappingURL=user.schema.js.map

package/dist/bigcommerce-entities/companies/schemas/user.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.schema.js","sourceRoot":"","sources":["../../../../src/bigcommerce-entities/companies/schemas/user.schema.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAyB;AACZ,QAAA,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE;IAC/B,SAAS,EAAE,CAAC,CAAC,GAAG,EAAE;IAClB,aAAa,EAAE,CAAC,CAAC,GAAG,EAAE;IACtB,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE;IAChB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;CACxB,CAAC,CAAC;AAEU,QAAA,+BAA+B,GAAG,CAAC,CAAC,MAAM,CAAC;IACtD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACb,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE;KAChB,CAAC;IACF,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACb,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;KACpB,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,wCAAwC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/D,IAAI,EAAE,CAAC,CAAC,GAAG,EAAE;IACb,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACb,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;QACrB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;QACpB,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE;QAChB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;QACvB,IAAI,EAAE,CAAC,CAAC,GAAG,EAAE;QACb,aAAa,EAAE,CAAC,CAAC,GAAG,EAAE;QACtB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QACtC,WAAW,EAAE,CAAC;aACX,MAAM,CAAC;YACN,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;YACrB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;SACvB,CAAC;aACD,KAAK,EAAE;QACV,SAAS,EAAE,CAAC,CAAC,GAAG,EAAE;QAClB,UAAU,EAAE,CAAC,CAAC,GAAG,EAAE;QACnB,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE;QAC3B,WAAW,EAAE,CAAC;aACX,MAAM,CAAC;YACN,SAAS,EAAE,CAAC,CAAC,GAAG,EAAE;YAClB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;YACvB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;SACpB,CAAC;aACD,KAAK,EAAE;KACX,CAAC;IACF,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACb,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;KACpB,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,qCAAqC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5D,UAAU,EAAE,CAAC,CAAC,GAAG,EAAE;CACpB,CAAC,CAAC"}

package/dist/bigcommerce-entities/currencies/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/bigcommerce-entities/currencies/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/bigcommerce-entities/currencies/index.ts"],"names":[],"mappings":""}

package/dist/bigcommerce-entities/currencies/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/bigcommerce-entities/currencies/index.js.map

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

package/dist/bigcommerce-entities/customers/customers.service.d.ts

@@ -0,0 +1,270 @@
+import * as z from 'zod';
+import type { BigCommerceFetcherService } from '../../core';
+import { CreateCustomerGroupSchema, FindCustomerAddressesCriteriaSchema, FindCustomerGroupsCriteriaSchema, FindCustomersCriteriaSchema, SetCustomerGroupPriceListSchema } from './schemas';
+/**
+ * Service for managing BigCommerce customers, customer groups, and addresses.
+ *
+ * Provides methods for creating customer groups, finding customers and addresses,
+ * and managing customer group price lists.
+ *
+ * @example
+ * ```typescript
+ * @Injectable()
+ * export class MyService {
+ *   constructor(private readonly customersService: BigCommerceCustomersService) {}
+ *
+ *   async createGroup() {
+ *     const result = await this.customersService.createCustomerGroup({
+ *       name: 'VIP Customers',
+ *       discount_rules: [{ type: 'price_list', price_list_id: 1 }]
+ *     });
+ *   }
+ * }
+ * ```
+ */
+export declare class BigCommerceCustomersService {
+    private readonly fetcher;
+    constructor(fetcher: BigCommerceFetcherService);
+    /**
+     * Creates a new customer group.
+     *
+     * @param data - Customer group details including name and discount rules
+     * @returns ResultAsync with the created customer group
+     *
+     * @example
+     * ```typescript
+     * const result = await customersService.createCustomerGroup({
+     *   name: 'VIP Customers',
+     *   discount_rules: [{ type: 'price_list', price_list_id: 1 }]
+     * });
+     * ```
+     */
+    createCustomerGroup(data: z.input<typeof CreateCustomerGroupSchema>): import("neverthrow").ResultAsync<{
+        id: number;
+    }, import("../../core").SomeBigCommerceError | import("../../utils/validation.error").InputDataValidationError>;
+    /**
+     * Finds customer addresses with pagination.
+     *
+     * @param criteria - Search criteria including customer IDs and pagination
+     * @returns ResultAsync with paginated customer addresses
+     *
+     * @example
+     * ```typescript
+     * const result = await customersService.findCustomerAddresses({
+     *   'customer_id:in': [1, 2, 3],
+     *   page: 1,
+     *   limit: 50
+     * });
+     * ```
+     */
+    findCustomerAddresses(criteria?: z.input<typeof FindCustomerAddressesCriteriaSchema>): import("neverthrow").ResultAsync<{
+        data: {
+            address1: string;
+            address2: string;
+            address_type: string;
+            city: string;
+            company: string;
+            country: string;
+            country_code: string;
+            customer_id: number;
+            first_name: string;
+            id: number;
+            last_name: string;
+            phone: string;
+            postal_code: string;
+            state_or_province: string;
+        }[];
+        meta: {
+            pagination: {
+                total: number;
+                count: number;
+                per_page: number;
+                current_page: number;
+                total_pages: number;
+            };
+        };
+    }, import("../../core").SomeBigCommerceError | import("../../utils/validation.error").InputDataValidationError>;
+    /**
+     * Retrieves all customer addresses by automatically handling pagination.
+     *
+     * @param criteria - Search criteria (excluding pagination params)
+     * @returns ResultAsync with all customer addresses
+     *
+     * @example
+     * ```typescript
+     * const result = await customersService.getAllCustomerAddressesBy({
+     *   'customer_id:in': [1, 2, 3]
+     * });
+     * ```
+     */
+    getAllCustomerAddressesBy(criteria: Omit<z.input<typeof FindCustomerAddressesCriteriaSchema>, 'page' | 'limit'>): import("neverthrow").ResultAsync<{
+        address1: string;
+        address2: string;
+        address_type: string;
+        city: string;
+        company: string;
+        country: string;
+        country_code: string;
+        customer_id: number;
+        first_name: string;
+        id: number;
+        last_name: string;
+        phone: string;
+        postal_code: string;
+        state_or_province: string;
+    }[], import("../../core").SomeBigCommerceError | import("../../utils/validation.error").InputDataValidationError>;
+    /**
+     * Finds customers with pagination.
+     *
+     * @param criteria - Search criteria including filters and pagination
+     * @returns ResultAsync with paginated customers
+     *
+     * @example
+     * ```typescript
+     * const result = await customersService.findCustomers({
+     *   'email:in': ['john@example.com'],
+     *   page: 1,
+     *   limit: 50
+     * });
+     * ```
+     */
+    findCustomers(criteria?: z.input<typeof FindCustomersCriteriaSchema>): import("neverthrow").ResultAsync<{
+        data: {
+            email: string;
+            first_name: string;
+            last_name: string;
+            phone: string;
+            customer_group_id: number;
+            id: number;
+            channel_ids: number[];
+            company?: string | undefined;
+        }[];
+        meta: {
+            pagination: {
+                total: number;
+                count: number;
+                per_page: number;
+                current_page: number;
+                total_pages: number;
+                links: {
+                    current: string;
+                    previous?: string | null | undefined;
+                    next?: string | null | undefined;
+                };
+            };
+        };
+    }, import("../../core").SomeBigCommerceError | import("../../utils/validation.error").InputDataValidationError>;
+    /**
+     * Retrieves all customers by automatically handling pagination.
+     *
+     * @param criteria - Search criteria (excluding pagination params)
+     * @returns ResultAsync with all customers
+     *
+     * @example
+     * ```typescript
+     * const result = await customersService.getAllCustomersBy({
+     *   'company:in': ['Acme Corp']
+     * });
+     * ```
+     */
+    getAllCustomersBy(criteria: Omit<z.input<typeof FindCustomersCriteriaSchema>, 'page' | 'limit'>): import("neverthrow").ResultAsync<{
+        email: string;
+        first_name: string;
+        last_name: string;
+        phone: string;
+        customer_group_id: number;
+        id: number;
+        channel_ids: number[];
+        company?: string | undefined;
+    }[], import("../../core").SomeBigCommerceError | import("../../utils/validation.error").InputDataValidationError>;
+    /**
+     * Finds customer groups with pagination.
+     *
+     * @param criteria - Search criteria including pagination
+     * @returns ResultAsync with paginated customer groups
+     */
+    findCustomersGroups(criteria?: z.input<typeof FindCustomerGroupsCriteriaSchema>): import("neverthrow").ResultAsync<{
+        data: {
+            email: string;
+            first_name: string;
+            last_name: string;
+            phone: string;
+            customer_group_id: number;
+            id: number;
+            channel_ids: number[];
+            company?: string | undefined;
+        }[];
+        meta: {
+            pagination: {
+                total: number;
+                count: number;
+                per_page: number;
+                current_page: number;
+                total_pages: number;
+                links: {
+                    current: string;
+                    previous?: string | null | undefined;
+                    next?: string | null | undefined;
+                };
+            };
+        };
+    }, import("../../core").SomeBigCommerceError | import("../../utils/validation.error").InputDataValidationError>;
+    /**
+     * Retrieves all customer groups by automatically handling pagination.
+     *
+     * @param criteria - Optional search criteria (excluding pagination params)
+     * @returns ResultAsync with all customer groups
+     */
+    getAllCustomerGroupsBy: (criteria?: Omit<z.input<typeof FindCustomerGroupsCriteriaSchema>, "page" | "limit">) => import("neverthrow").ResultAsync<{
+        email: string;
+        first_name: string;
+        last_name: string;
+        phone: string;
+        customer_group_id: number;
+        id: number;
+        channel_ids: number[];
+        company?: string | undefined;
+    }[], import("../../core").SomeBigCommerceError | import("../../utils/validation.error").InputDataValidationError>;
+    /**
+     * Retrieves a specific customer by ID.
+     *
+     * @param customerId - The customer ID
+     * @returns ResultAsync with customer details
+     *
+     * @example
+     * ```typescript
+     * const result = await customersService.getCustomer(123);
+     * ```
+     */
+    getCustomer(customerId: number): import("neverthrow").ResultAsync<{
+        email: string;
+        first_name: string;
+        last_name: string;
+        phone: string;
+        customer_group_id: number;
+        id: number;
+        channel_ids: number[];
+        company?: string | undefined;
+    } | undefined, import("../../core").SomeBigCommerceError | import("../../utils/validation.error").InputDataValidationError>;
+    /**
+     * Sets or updates the price list for a customer group.
+     *
+     * @param input - Customer group ID and price list configuration
+     * @returns ResultAsync with updated customer group
+     *
+     * @example
+     * ```typescript
+     * const result = await customersService.setCustomerGroupPriceList({
+     *   customerGroupId: 1,
+     *   data: {
+     *     discount_rules: [{ type: 'price_list', price_list_id: 2 }]
+     *   }
+     * });
+     * ```
+     */
+    setCustomerGroupPriceList(input: z.input<typeof SetCustomerGroupPriceListSchema>): import("neverthrow").ResultAsync<{
+        id: number;
+        name: string;
+    }, import("../../core").SomeBigCommerceError | import("../../utils/validation.error").InputDataValidationError>;
+}
+//# sourceMappingURL=customers.service.d.ts.map

package/dist/bigcommerce-entities/customers/customers.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"customers.service.d.ts","sourceRoot":"","sources":["../../../src/bigcommerce-entities/customers/customers.service.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AAG5D,OAAO,EAEL,yBAAyB,EACzB,mCAAmC,EAEnC,gCAAgC,EAEhC,2BAA2B,EAE3B,+BAA+B,EAChC,MAAM,WAAW,CAAC;AACnB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBACa,2BAA2B;IAC1B,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,EAAE,yBAAyB;IAE/D;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC;;;IAgBnE;;;;;;;;;;;;;;OAcG;IACH,qBAAqB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,mCAAmC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;IAiBpF;;;;;;;;;;;;OAYG;IACH,yBAAyB,CACvB,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,mCAAmC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;;;;;;;;;;;;;;;;IAoBvF;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;IAiBpE;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;;;;;;;;;;IAY/F;;;;;OAKG;IACH,mBAAmB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;IAa/E;;;;;OAKG;IACH,sBAAsB,GACpB,WAAW,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;;;;;;;;;sHAYnF;IAEF;;;;;;;;;;OAUG;IACH,WAAW,CAAC,UAAU,EAAE,MAAM;;;;;;;;;;IAM9B;;;;;;;;;;;;;;;OAeG;IACH,yBAAyB,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC;;;;CAgBjF"}