@commercelayer/sdk 5.0.0-alpha.5 → 5.0.0-beta.10

package/lib/cjs/resources/transactions.d.ts

@@ -0,0 +1,31 @@
+import { ApiResource, Resource, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
+import type { QueryParamsRetrieve } from '../query';
+import type { Order } from './orders';
+type TransactionType = 'transactions';
+type TransactionRel = ResourceRel & {
+    type: TransactionType;
+};
+interface Transaction extends Resource {
+    readonly type: TransactionType;
+    number: string;
+    currency_code: string;
+    amount_cents: number;
+    amount_float: number;
+    formatted_amount: string;
+    succeeded: boolean;
+    message?: string | null;
+    error_code?: string | null;
+    error_detail?: string | null;
+    token?: string | null;
+    gateway_transaction_id?: string | null;
+    order?: Order | null;
+}
+declare class Transactions extends ApiResource<Transaction> {
+    static readonly TYPE: TransactionType;
+    order(transactionId: string | Transaction, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    isTransaction(resource: any): resource is Transaction;
+    relationship(id: string | ResourceId | null): TransactionRel;
+    type(): TransactionType;
+}
+export default Transactions;
+export type { Transaction, TransactionType };

package/lib/cjs/resources/transactions.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class Transactions extends resource_1.ApiResource {
+    async order(transactionId, params, options) {
+        const _transactionId = transactionId.id || transactionId;
+        return this.resources.fetch({ type: 'orders' }, `transactions/${_transactionId}/order`, params, options);
+    }
+    isTransaction(resource) {
+        return resource.type && (resource.type === Transactions.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Transactions.TYPE } : { id: id.id, type: Transactions.TYPE };
+    }
+    type() {
+        return Transactions.TYPE;
+    }
+}
+Transactions.TYPE = 'transactions';
+exports.default = Transactions;

package/lib/cjs/resources/voids.d.ts

@@ -0,0 +1,37 @@
+import { ApiResource, Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Order } from './orders';
+import type { Authorization } from './authorizations';
+import type { Event } from './events';
+type VoidType = 'voids';
+type VoidRel = ResourceRel & {
+    type: VoidType;
+};
+interface Void extends Resource {
+    readonly type: VoidType;
+    number: string;
+    currency_code: string;
+    amount_cents: number;
+    amount_float: number;
+    formatted_amount: string;
+    succeeded: boolean;
+    message?: string | null;
+    error_code?: string | null;
+    error_detail?: string | null;
+    token?: string | null;
+    gateway_transaction_id?: string | null;
+    order?: Order | null;
+    reference_authorization?: Authorization | null;
+    events?: Event[] | null;
+}
+declare class Voids extends ApiResource<Void> {
+    static readonly TYPE: VoidType;
+    order(voidId: string | Void, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    reference_authorization(voidId: string | Void, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Authorization>;
+    events(voidId: string | Void, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    isVoid(resource: any): resource is Void;
+    relationship(id: string | ResourceId | null): VoidRel;
+    type(): VoidType;
+}
+export default Voids;
+export type { Void, VoidType };

package/lib/cjs/resources/voids.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class Voids extends resource_1.ApiResource {
+    async order(voidId, params, options) {
+        const _voidId = voidId.id || voidId;
+        return this.resources.fetch({ type: 'orders' }, `voids/${_voidId}/order`, params, options);
+    }
+    async reference_authorization(voidId, params, options) {
+        const _voidId = voidId.id || voidId;
+        return this.resources.fetch({ type: 'authorizations' }, `voids/${_voidId}/reference_authorization`, params, options);
+    }
+    async events(voidId, params, options) {
+        const _voidId = voidId.id || voidId;
+        return this.resources.fetch({ type: 'events' }, `voids/${_voidId}/events`, params, options);
+    }
+    isVoid(resource) {
+        return resource.type && (resource.type === Voids.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Voids.TYPE } : { id: id.id, type: Voids.TYPE };
+    }
+    type() {
+        return Voids.TYPE;
+    }
+}
+Voids.TYPE = 'voids';
+exports.default = Voids;

package/lib/cjs/resources/webhooks.d.ts

@@ -0,0 +1,43 @@
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { EventCallback } from './event_callbacks';
+type WebhookType = 'webhooks';
+type WebhookRel = ResourceRel & {
+    type: WebhookType;
+};
+interface Webhook extends Resource {
+    readonly type: WebhookType;
+    name?: string | null;
+    topic: string;
+    callback_url: string;
+    include_resources?: string[] | null;
+    circuit_state?: string | null;
+    circuit_failure_count?: number | null;
+    shared_secret: string;
+    last_event_callbacks?: EventCallback[] | null;
+}
+interface WebhookCreate extends ResourceCreate {
+    name?: string | null;
+    topic: string;
+    callback_url: string;
+    include_resources?: string[] | null;
+}
+interface WebhookUpdate extends ResourceUpdate {
+    name?: string | null;
+    topic?: string | null;
+    callback_url?: string | null;
+    include_resources?: string[] | null;
+    _reset_circuit?: boolean | null;
+}
+declare class Webhooks extends ApiResource<Webhook> {
+    static readonly TYPE: WebhookType;
+    create(resource: WebhookCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Webhook>;
+    update(resource: WebhookUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Webhook>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    last_event_callbacks(webhookId: string | Webhook, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<EventCallback>>;
+    isWebhook(resource: any): resource is Webhook;
+    relationship(id: string | ResourceId | null): WebhookRel;
+    type(): WebhookType;
+}
+export default Webhooks;
+export type { Webhook, WebhookCreate, WebhookUpdate, WebhookType };

package/lib/cjs/resources/webhooks.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class Webhooks extends resource_1.ApiResource {
+    async create(resource, params, options) {
+        return this.resources.create({ ...resource, type: Webhooks.TYPE }, params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update({ ...resource, type: Webhooks.TYPE }, params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: Webhooks.TYPE } : id, options);
+    }
+    async last_event_callbacks(webhookId, params, options) {
+        const _webhookId = webhookId.id || webhookId;
+        return this.resources.fetch({ type: 'event_callbacks' }, `webhooks/${_webhookId}/last_event_callbacks`, params, options);
+    }
+    isWebhook(resource) {
+        return resource.type && (resource.type === Webhooks.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Webhooks.TYPE } : { id: id.id, type: Webhooks.TYPE };
+    }
+    type() {
+        return Webhooks.TYPE;
+    }
+}
+Webhooks.TYPE = 'webhooks';
+exports.default = Webhooks;

package/lib/cjs/resources/wire_transfers.d.ts

@@ -0,0 +1,33 @@
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
+import type { QueryParamsRetrieve } from '../query';
+import type { Order, OrderType } from './orders';
+type WireTransferType = 'wire_transfers';
+type WireTransferRel = ResourceRel & {
+    type: WireTransferType;
+};
+type OrderRel = ResourceRel & {
+    type: OrderType;
+};
+interface WireTransfer extends Resource {
+    readonly type: WireTransferType;
+    payment_instrument?: object | null;
+    order?: Order | null;
+}
+interface WireTransferCreate extends ResourceCreate {
+    order: OrderRel;
+}
+interface WireTransferUpdate extends ResourceUpdate {
+    order?: OrderRel | null;
+}
+declare class WireTransfers extends ApiResource<WireTransfer> {
+    static readonly TYPE: WireTransferType;
+    create(resource: WireTransferCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<WireTransfer>;
+    update(resource: WireTransferUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<WireTransfer>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    order(wireTransferId: string | WireTransfer, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    isWireTransfer(resource: any): resource is WireTransfer;
+    relationship(id: string | ResourceId | null): WireTransferRel;
+    type(): WireTransferType;
+}
+export default WireTransfers;
+export type { WireTransfer, WireTransferCreate, WireTransferUpdate, WireTransferType };

package/lib/cjs/resources/wire_transfers.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class WireTransfers extends resource_1.ApiResource {
+    async create(resource, params, options) {
+        return this.resources.create({ ...resource, type: WireTransfers.TYPE }, params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update({ ...resource, type: WireTransfers.TYPE }, params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: WireTransfers.TYPE } : id, options);
+    }
+    async order(wireTransferId, params, options) {
+        const _wireTransferId = wireTransferId.id || wireTransferId;
+        return this.resources.fetch({ type: 'orders' }, `wire_transfers/${_wireTransferId}/order`, params, options);
+    }
+    isWireTransfer(resource) {
+        return resource.type && (resource.type === WireTransfers.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: WireTransfers.TYPE } : { id: id.id, type: WireTransfers.TYPE };
+    }
+    type() {
+        return WireTransfers.TYPE;
+    }
+}
+WireTransfers.TYPE = 'wire_transfers';
+exports.default = WireTransfers;

package/lib/cjs/static.d.ts

@@ -0,0 +1,9 @@
+import { SdkError, ApiError } from './error';
+import type { CommerceLayerClient, CommerceLayerInitConfig } from './commercelayer';
+export declare const CommerceLayerStatic: {
+    resources: () => readonly string[];
+    isSdkError: (error: unknown) => error is SdkError;
+    isApiError: (error: unknown) => error is ApiError;
+    init: (config: CommerceLayerInitConfig) => CommerceLayerClient;
+    readonly schemaVersion: string;
+};

package/lib/cjs/static.js

@@ -0,0 +1,45 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommerceLayerStatic = void 0;
+const api = __importStar(require("./api"));
+const error_1 = require("./error");
+const commercelayer_1 = __importStar(require("./commercelayer"));
+/* Static functions */
+exports.CommerceLayerStatic = {
+    resources: () => {
+        return api.resourceList;
+    },
+    isSdkError: (error) => {
+        return error_1.SdkError.isSdkError(error);
+    },
+    isApiError: (error) => {
+        return error_1.ApiError.isApiError(error);
+    },
+    init: (config) => {
+        return (0, commercelayer_1.default)(config);
+    },
+    get schemaVersion() { return commercelayer_1.OPEN_API_SCHEMA_VERSION; }
+};

package/lib/cjs/util.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+type ObjectType = {
+    [key: string]: any;
+};
+declare const sleep: (ms: number) => Promise<NodeJS.Timeout>;
+declare const sortObjectFields: (obj: ObjectType) => ObjectType;
+export { sleep, sortObjectFields };

package/lib/cjs/util.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sortObjectFields = exports.sleep = void 0;
+const sleep = async (ms) => {
+    return new Promise(resolve => setTimeout(resolve, ms));
+};
+exports.sleep = sleep;
+const sortObjectFields = (obj) => {
+    const sorted = Object.keys(obj).sort().reduce((accumulator, key) => {
+        accumulator[key] = obj[key];
+        return accumulator;
+    }, {});
+    return sorted;
+};
+exports.sortObjectFields = sortObjectFields;

package/lib/esm/api.d.ts

@@ -0,0 +1,128 @@
+/**
+ * ©2023 Commerce Layer Inc.
+ **/
+export { default as Addresses } from './resources/addresses';
+export { default as Adjustments } from './resources/adjustments';
+export { default as AdyenGateways } from './resources/adyen_gateways';
+export { default as AdyenPayments } from './resources/adyen_payments';
+export { default as Applications } from './resources/application';
+export { default as Attachments } from './resources/attachments';
+export { default as Authorizations } from './resources/authorizations';
+export { default as AvalaraAccounts } from './resources/avalara_accounts';
+export { default as AxerveGateways } from './resources/axerve_gateways';
+export { default as AxervePayments } from './resources/axerve_payments';
+export { default as BillingInfoValidationRules } from './resources/billing_info_validation_rules';
+export { default as BingGeocoders } from './resources/bing_geocoders';
+export { default as BraintreeGateways } from './resources/braintree_gateways';
+export { default as BraintreePayments } from './resources/braintree_payments';
+export { default as Bundles } from './resources/bundles';
+export { default as Captures } from './resources/captures';
+export { default as CarrierAccounts } from './resources/carrier_accounts';
+export { default as CheckoutComGateways } from './resources/checkout_com_gateways';
+export { default as CheckoutComPayments } from './resources/checkout_com_payments';
+export { default as Cleanups } from './resources/cleanups';
+export { default as CouponCodesPromotionRules } from './resources/coupon_codes_promotion_rules';
+export { default as CouponRecipients } from './resources/coupon_recipients';
+export { default as Coupons } from './resources/coupons';
+export { default as CustomerAddresses } from './resources/customer_addresses';
+export { default as CustomerGroups } from './resources/customer_groups';
+export { default as CustomerPasswordResets } from './resources/customer_password_resets';
+export { default as CustomerPaymentSources } from './resources/customer_payment_sources';
+export { default as CustomerSubscriptions } from './resources/customer_subscriptions';
+export { default as Customers } from './resources/customers';
+export { default as DeliveryLeadTimes } from './resources/delivery_lead_times';
+export { default as EventCallbacks } from './resources/event_callbacks';
+export { default as Events } from './resources/events';
+export { default as Exports } from './resources/exports';
+export { default as ExternalGateways } from './resources/external_gateways';
+export { default as ExternalPayments } from './resources/external_payments';
+export { default as ExternalPromotions } from './resources/external_promotions';
+export { default as ExternalTaxCalculators } from './resources/external_tax_calculators';
+export { default as FixedAmountPromotions } from './resources/fixed_amount_promotions';
+export { default as FixedPricePromotions } from './resources/fixed_price_promotions';
+export { default as FreeGiftPromotions } from './resources/free_gift_promotions';
+export { default as FreeShippingPromotions } from './resources/free_shipping_promotions';
+export { default as Geocoders } from './resources/geocoders';
+export { default as GiftCardRecipients } from './resources/gift_card_recipients';
+export { default as GiftCards } from './resources/gift_cards';
+export { default as GoogleGeocoders } from './resources/google_geocoders';
+export { default as Imports } from './resources/imports';
+export { default as InStockSubscriptions } from './resources/in_stock_subscriptions';
+export { default as InventoryModels } from './resources/inventory_models';
+export { default as InventoryReturnLocations } from './resources/inventory_return_locations';
+export { default as InventoryStockLocations } from './resources/inventory_stock_locations';
+export { default as KlarnaGateways } from './resources/klarna_gateways';
+export { default as KlarnaPayments } from './resources/klarna_payments';
+export { default as LineItemOptions } from './resources/line_item_options';
+export { default as LineItems } from './resources/line_items';
+export { default as ManualGateways } from './resources/manual_gateways';
+export { default as ManualTaxCalculators } from './resources/manual_tax_calculators';
+export { default as Markets } from './resources/markets';
+export { default as Merchants } from './resources/merchants';
+export { default as OrderAmountPromotionRules } from './resources/order_amount_promotion_rules';
+export { default as OrderCopies } from './resources/order_copies';
+export { default as OrderSubscriptions } from './resources/order_subscriptions';
+export { default as OrderValidationRules } from './resources/order_validation_rules';
+export { default as Orders } from './resources/orders';
+export { default as Organizations } from './resources/organization';
+export { default as Packages } from './resources/packages';
+export { default as ParcelLineItems } from './resources/parcel_line_items';
+export { default as Parcels } from './resources/parcels';
+export { default as PaymentGateways } from './resources/payment_gateways';
+export { default as PaymentMethods } from './resources/payment_methods';
+export { default as PaypalGateways } from './resources/paypal_gateways';
+export { default as PaypalPayments } from './resources/paypal_payments';
+export { default as PercentageDiscountPromotions } from './resources/percentage_discount_promotions';
+export { default as PriceLists } from './resources/price_lists';
+export { default as PriceTiers } from './resources/price_tiers';
+export { default as PriceVolumeTiers } from './resources/price_volume_tiers';
+export { default as Prices } from './resources/prices';
+export { default as PromotionRules } from './resources/promotion_rules';
+export { default as Promotions } from './resources/promotions';
+export { default as Refunds } from './resources/refunds';
+export { default as ReturnLineItems } from './resources/return_line_items';
+export { default as Returns } from './resources/returns';
+export { default as SatispayGateways } from './resources/satispay_gateways';
+export { default as SatispayPayments } from './resources/satispay_payments';
+export { default as Shipments } from './resources/shipments';
+export { default as ShippingCategories } from './resources/shipping_categories';
+export { default as ShippingMethodTiers } from './resources/shipping_method_tiers';
+export { default as ShippingMethods } from './resources/shipping_methods';
+export { default as ShippingWeightTiers } from './resources/shipping_weight_tiers';
+export { default as ShippingZones } from './resources/shipping_zones';
+export { default as SkuListItems } from './resources/sku_list_items';
+export { default as SkuListPromotionRules } from './resources/sku_list_promotion_rules';
+export { default as SkuLists } from './resources/sku_lists';
+export { default as SkuOptions } from './resources/sku_options';
+export { default as Skus } from './resources/skus';
+export { default as StockItems } from './resources/stock_items';
+export { default as StockLineItems } from './resources/stock_line_items';
+export { default as StockLocations } from './resources/stock_locations';
+export { default as StockTransfers } from './resources/stock_transfers';
+export { default as StripeGateways } from './resources/stripe_gateways';
+export { default as StripePayments } from './resources/stripe_payments';
+export { default as TaxCalculators } from './resources/tax_calculators';
+export { default as TaxCategories } from './resources/tax_categories';
+export { default as TaxRules } from './resources/tax_rules';
+export { default as TaxjarAccounts } from './resources/taxjar_accounts';
+export { default as Transactions } from './resources/transactions';
+export { default as Voids } from './resources/voids';
+export { default as Webhooks } from './resources/webhooks';
+export { default as WireTransfers } from './resources/wire_transfers';
+export type ResourceTypeLock = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'application' | 'attachments' | 'authorizations' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'captures' | 'carrier_accounts' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'event_callbacks' | 'events' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'geocoders' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'imports' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_copies' | 'order_subscriptions' | 'order_validation_rules' | 'orders' | 'organization' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_gateways' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_lists' | 'price_tiers' | 'price_volume_tiers' | 'prices' | 'promotion_rules' | 'promotions' | 'refunds' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipments' | 'shipping_categories' | 'shipping_method_tiers' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_line_items' | 'stock_locations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'tax_calculators' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'transactions' | 'voids' | 'webhooks' | 'wire_transfers';
+export declare const resourceList: readonly ["addresses", "adjustments", "adyen_gateways", "adyen_payments", "application", "attachments", "authorizations", "avalara_accounts", "axerve_gateways", "axerve_payments", "billing_info_validation_rules", "bing_geocoders", "braintree_gateways", "braintree_payments", "bundles", "captures", "carrier_accounts", "checkout_com_gateways", "checkout_com_payments", "cleanups", "coupon_codes_promotion_rules", "coupon_recipients", "coupons", "customer_addresses", "customer_groups", "customer_password_resets", "customer_payment_sources", "customer_subscriptions", "customers", "delivery_lead_times", "event_callbacks", "events", "exports", "external_gateways", "external_payments", "external_promotions", "external_tax_calculators", "fixed_amount_promotions", "fixed_price_promotions", "free_gift_promotions", "free_shipping_promotions", "geocoders", "gift_card_recipients", "gift_cards", "google_geocoders", "imports", "in_stock_subscriptions", "inventory_models", "inventory_return_locations", "inventory_stock_locations", "klarna_gateways", "klarna_payments", "line_item_options", "line_items", "manual_gateways", "manual_tax_calculators", "markets", "merchants", "order_amount_promotion_rules", "order_copies", "order_subscriptions", "order_validation_rules", "orders", "organization", "packages", "parcel_line_items", "parcels", "payment_gateways", "payment_methods", "paypal_gateways", "paypal_payments", "percentage_discount_promotions", "price_lists", "price_tiers", "price_volume_tiers", "prices", "promotion_rules", "promotions", "refunds", "return_line_items", "returns", "satispay_gateways", "satispay_payments", "shipments", "shipping_categories", "shipping_method_tiers", "shipping_methods", "shipping_weight_tiers", "shipping_zones", "sku_list_items", "sku_list_promotion_rules", "sku_lists", "sku_options", "skus", "stock_items", "stock_line_items", "stock_locations", "stock_transfers", "stripe_gateways", "stripe_payments", "tax_calculators", "tax_categories", "tax_rules", "taxjar_accounts", "transactions", "voids", "webhooks", "wire_transfers"];
+export type ResourceRetrievable = {
+    type: ResourceTypeLock;
+};
+export type ResourceListable = {
+    type: Exclude<ResourceTypeLock, 'application' | 'organization'>;
+};
+export type ResourceCreatable = {
+    type: 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'attachments' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'imports' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_copies' | 'order_subscriptions' | 'orders' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_lists' | 'price_volume_tiers' | 'prices' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipping_categories' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_locations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'webhooks' | 'wire_transfers';
+};
+export type ResourceUpdatable = {
+    type: 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'attachments' | 'authorizations' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'captures' | 'checkout_com_gateways' | 'checkout_com_payments' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_subscriptions' | 'orders' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_lists' | 'price_volume_tiers' | 'prices' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipments' | 'shipping_categories' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_locations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'webhooks' | 'wire_transfers';
+};
+export type ResourceDeletable = {
+    type: 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'attachments' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'imports' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_copies' | 'order_subscriptions' | 'orders' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_lists' | 'price_volume_tiers' | 'prices' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipping_categories' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_locations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'webhooks' | 'wire_transfers';
+};