shopify-api-types
Version:
typings for Shopify Admin API
187 lines • 9.46 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.CustomerSavedSearchQueries = exports.CustomerTaxExceptions = exports.CustomerAccountState = void 0;
var CustomerAccountState;
(function (CustomerAccountState) {
/**
* The customer doesn't have an active account
*/
CustomerAccountState["Disabled"] = "disabled";
/**
* The customer has recieved an email to create an account
*/
CustomerAccountState["Invited"] = "invited";
/**
* The customer has crated an account
*/
CustomerAccountState["Enabled"] = "enabled";
/**
* The customer declined the email invite to crate an account
*/
CustomerAccountState["Declined"] = "declined";
})(CustomerAccountState = exports.CustomerAccountState || (exports.CustomerAccountState = {}));
var CustomerTaxExceptions;
(function (CustomerTaxExceptions) {
/**
* This customer is exempt from all Canadian taxes.
*/
CustomerTaxExceptions["ExemptAll"] = "EXEMPT_ALL";
/**
* This customer is exempt from specific taxes for holding a valid STATUS_CARD_EXEMPTION in Canada.
*/
CustomerTaxExceptions["CAStatusCardExemption"] = "CA_STATUS_CARD_EXEMPTION";
/**
* This customer is exempt from specific taxes for holding a valid DIPLOMAT_EXEMPTION in Canada.
*/
CustomerTaxExceptions["CADiplomatExemption"] = "CA_DIPLOMAT_EXEMPTION";
/**
* This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in British Columbia.
*/
CustomerTaxExceptions["CABCResellerExemption"] = "CA_BC_RESELLER_EXEMPTION";
/**
* This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Manitoba.
*/
CustomerTaxExceptions["CAMBResellerExemption"] = "CA_MB_RESELLER_EXEMPTION";
/**
* This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Saskatchewan.
*/
CustomerTaxExceptions["CASKResellerExemption"] = "CA_SK_RESELLER_EXEMPTION";
/**
* This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in British Columbia.
*/
CustomerTaxExceptions["CABCCommercialFisheryExemption"] = "CA_BC_COMMERCIAL_FISHERY_EXEMPTION";
/**
* This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Manitoba.
*/
CustomerTaxExceptions["CAMBCommercialFisheryExemption"] = "CA_MB_COMMERCIAL_FISHERY_EXEMPTION";
/**
* This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Nova Scotia.
*/
CustomerTaxExceptions["CANSCommercialFisheryExemption"] = "CA_NS_COMMERCIAL_FISHERY_EXEMPTION";
/**
* This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Prince Edward Island.
*/
CustomerTaxExceptions["CAPECommercialFisheryExemption"] = "CA_PE_COMMERCIAL_FISHERY_EXEMPTION";
/**
* This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Saskatchewan.
*/
CustomerTaxExceptions["CASKCommercialFisheryExemption"] = "CA_SK_COMMERCIAL_FISHERY_EXEMPTION";
/**
* This customer is exempt from specific taxes for holding a valid PRODUCTION_AND_MACHINERY_EXEMPTION in British Columbia.
*/
CustomerTaxExceptions["CABCProductionAndMachineryExemption"] = "CA_BC_PRODUCTION_AND_MACHINERY_EXEMPTION";
/**
* This customer is exempt from specific taxes for holding a valid PRODUCTION_AND_MACHINERY_EXEMPTION in Saskatchewan.
*/
CustomerTaxExceptions["CASKProductionAndMachineryExemption"] = "CA_SK_PRODUCTION_AND_MACHINERY_EXEMPTION";
/**
* This customer is exempt from specific taxes for holding a valid SUB_CONTRACTOR_EXEMPTION in British Columbia.
*/
CustomerTaxExceptions["CABCSubContractorExemption"] = "CA_BC_SUB_CONTRACTOR_EXEMPTION";
/**
* This customer is exempt from specific taxes for holding a valid SUB_CONTRACTOR_EXEMPTION in Saskatchewan.
*/
CustomerTaxExceptions["CASKSubContractorExemption"] = "CA_SK_SUB_CONTRACTOR_EXEMPTION";
/**
* This customer is exempt from specific taxes for holding a valid CONTRACTOR_EXEMPTION in British Columbia.
*/
CustomerTaxExceptions["CABCContractorExemption"] = "CA_BC_CONTRACTOR_EXEMPTION";
/**
* This customer is exempt from specific taxes for holding a valid CONTRACTOR_EXEMPTION in Saskatchewan.
*/
CustomerTaxExceptions["CASKContractorExemption"] = "CA_SK_CONTRACTOR_EXEMPTION";
/**
* This customer is exempt from specific taxes for holding a valid PURCHASE_EXEMPTION in Ontario.
*/
CustomerTaxExceptions["CAONPurchaseExemption"] = "CA_ON_PURCHASE_EXEMPTION";
/**
* This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Manitoba.
*/
CustomerTaxExceptions["CAMBFarmerExemption"] = "CA_MB_FARMER_EXEMPTION";
/**
* This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Nova Scotia.
*/
CustomerTaxExceptions["CANSFarmerExemption"] = "CA_NS_FARMER_EXEMPTION";
/**
* This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Saskatchewan.
*/
CustomerTaxExceptions["CASKFarmerExemption"] = "CA_SK_FARMER_EXEMPTION";
})(CustomerTaxExceptions = exports.CustomerTaxExceptions || (exports.CustomerTaxExceptions = {}));
/**
* https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#customer-saved-search-queries-2020-04
*/
var CustomerSavedSearchQueries;
(function (CustomerSavedSearchQueries) {
/**
* Filters customers by whether they accept email marketing.
* 0 = doesn't accept
* 1 = accepts
*/
CustomerSavedSearchQueries["AcceptsMarketing"] = "accepts_marketing";
/**
* Retrieves customers from a specified country
*/
CustomerSavedSearchQueries["Country"] = "country";
/**
* Retrieves customers who were created within a set period of time:
*
* * `past_week`: Return customers who were created in the last week.
* * `past_month`: Return customers who were created in the last month.
* * `last_3_months`: Return customers who were created in the last 3 months.
* * `past_quarter`: Return customers who were created in the last quarter.
* * `past_year`: Return customers who were created in the last year.
* * `yyyy-m-d`: Return customers who were created on a set date.
* * `>yyyy-m-d`: Return customers who were created after a set date.
* * `<yyyy-m-d`: Return customers who were created before a set date.
*/
CustomerSavedSearchQueries["CustomerDate"] = "customer_date";
/**
* Retrieves customers who abandoned a cart within a set period of time:
*
* * `last_week`: Returns customers who abandoned a cart in the last week
* * `last_month`: Returns customers who abandoned a cart within the last month
*/
CustomerSavedSearchQueries["LastAbandonedOrderDate"] = "last_abandoned_order_date";
/**
* Retrieves customers who placed an order within a set period of time:
*
* * `last_week`: Return customers who placed an order in the last week.
* * `last_month`: Return customers who placed an order in the last month.
* * `last_3_months`: Return customers who placed an order in the last 3 months.
* * `last_year`: Return customers who placed an order in the last year.
* * `>yyyy-m-d`: Return customers who placed an order after a set date.
* * `<yyyy-m-d`: Return customers placed an order before a set date.
*/
CustomerSavedSearchQueries["OrderDate"] = "order_date";
/**
* Retreives customers by the number of orders they've placed with the store:
*
* * `>number_of_orders`: Returns customers who have placed fewer than the specified number of orders
* * `<number_of_orders`: Returns customers who have placed more than the specified number of orders
* * `number_of_orders`: Returns customers who have placed the specified number of orders
*/
CustomerSavedSearchQueries["OrdersCount"] = "orders_count";
/**
* Filter customers by their customer account status:
*
* * `declined`: Returns customers who have been invited to create an account but declined
* * `disabled`: Returns customers whose account is disabled
* * `enabled`: Returns customers who have a customer account
* * `invited`: Returns customers who have been invited to create an account
*/
CustomerSavedSearchQueries["Status"] = "status";
/**
* Filter customers by tag. Valid values are any existing customer tag contained in quotation marks:
* @example `"Big Spender"`
*/
CustomerSavedSearchQueries["Tag"] = "tag";
/**
* Retreives customers by the total amount that they have spent across all of their orders:
*
* * `>money_amount`: Returns customers who have spent less than the specified amount of money
* * `<money_amount`: Returns customers who have spent more than the specified amount of money
* * `money_amount`: Returns customers who have spent the specified amount of money
*/
CustomerSavedSearchQueries["TotalSpent"] = "total_spent";
})(CustomerSavedSearchQueries = exports.CustomerSavedSearchQueries || (exports.CustomerSavedSearchQueries = {}));
//# sourceMappingURL=customer.js.map