@commercelayer/sdk 5.0.0-beta.1 → 5.0.0-beta.3

package/lib/esm/debug.js

@@ -1,6 +1,3 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/no-unused-vars */
-// import Debug from 'debug'
 /* Nope debugger */
 const debuggerFunction = (_pattern, ..._args) => {
     // console.log(_pattern)

package/lib/esm/error.js

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
 var ErrorType;
 (function (ErrorType) {
     ErrorType["CLIENT"] = "client";

package/lib/esm/query.d.ts

@@ -18,7 +18,8 @@ interface QueryParamsList extends QueryParamsRetrieve {
 }
 type QueryParams = QueryParamsRetrieve | QueryParamsList;
 export { QueryParamsRetrieve, QueryParamsList, QueryParams, QueryFilter };
+declare const isParamsList: (params: any) => params is QueryParamsList;
 declare const generateQueryStringParams: (params: QueryParamsRetrieve | QueryParamsList | undefined, res: string | ResourceType) => {
     [key: string]: string;
 };
-export { generateQueryStringParams };
+export { generateQueryStringParams, isParamsList };

package/lib/esm/query.js

@@ -42,4 +42,4 @@ const generateQueryStringParams = (params, res) => {
     debug('query string params: %O', qp);
     return qp;
 };
-export { generateQueryStringParams };
+export { generateQueryStringParams, isParamsList };

package/lib/esm/resource.d.ts

@@ -78,7 +78,7 @@ declare abstract class ApiResourceBase<R extends Resource> {
     abstract relationship(id: string | ResourceId | null): ResourceRel;
     abstract type(): ResourceTypeLock;
     update(resource: ResourceUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
-    count(filter?: QueryFilter, options?: ResourcesConfig): Promise<number>;
+    count(filter?: QueryFilter | QueryParamsList, options?: ResourcesConfig): Promise<number>;
 }
 declare abstract class ApiResource<R extends Resource> extends ApiResourceBase<R> {
     retrieve(id: string | ResourceId, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;

package/lib/esm/resource.js

@@ -12,7 +12,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _ResourceAdapter_client, _ResourceAdapter_config;
 import ApiClient from './client';
 import { denormalize, normalize } from './jsonapi';
-import { generateQueryStringParams } from './query';
+import { generateQueryStringParams, isParamsList } from './query';
 import config from './config';
 import Debug from './debug';
 const debug = Debug('resource');
@@ -141,7 +141,7 @@ class ApiResourceBase {
         return this.resources.update(Object.assign(Object.assign({}, resource), { type: this.type() }), params, options);
     }
     async count(filter, options) {
-        const params = { filters: filter, pageNumber: 1, pageSize: 1 };
+        const params = { filters: isParamsList(filter) ? filter.filters : filter, pageNumber: 1, pageSize: 1 };
         const response = await this.resources.list({ type: this.type() }, params, options);
         return Promise.resolve(response.meta.recordCount);
     }

package/lib/esm/resources/addresses.d.ts

@@ -15,13 +15,13 @@ interface Address extends Resource {
     last_name?: string;
     company?: string;
     full_name?: string;
-    line_1?: string;
+    line_1: string;
     line_2?: string;
-    city?: string;
+    city: string;
     zip_code?: string;
-    state_code?: string;
-    country_code?: string;
-    phone?: string;
+    state_code: string;
+    country_code: string;
+    phone: string;
     full_address?: string;
     name?: string;
     email?: string;
@@ -60,13 +60,13 @@ interface AddressUpdate extends ResourceUpdate {
     first_name?: string;
     last_name?: string;
     company?: string;
-    line_1?: string;
+    line_1: string;
     line_2?: string;
-    city?: string;
+    city: string;
     zip_code?: string;
-    state_code?: string;
-    country_code?: string;
-    phone?: string;
+    state_code: string;
+    country_code: string;
+    phone: string;
     email?: string;
     notes?: string;
     lat?: number;

package/lib/esm/resources/adjustments.d.ts

@@ -6,11 +6,11 @@ type AdjustmentRel = ResourceRel & {
 };
 interface Adjustment extends Resource {
     readonly type: AdjustmentType;
-    name?: string;
-    currency_code?: string;
-    amount_cents?: number;
-    amount_float?: number;
-    formatted_amount?: string;
+    name: string;
+    currency_code: string;
+    amount_cents: number;
+    amount_float: number;
+    formatted_amount: string;
 }
 interface AdjustmentCreate extends ResourceCreate {
     name: string;
@@ -18,9 +18,9 @@ interface AdjustmentCreate extends ResourceCreate {
     amount_cents: number;
 }
 interface AdjustmentUpdate extends ResourceUpdate {
-    name?: string;
-    currency_code?: string;
-    amount_cents?: number;
+    name: string;
+    currency_code: string;
+    amount_cents: number;
 }
 declare class Adjustments extends ApiResource<Adjustment> {
     static readonly TYPE: AdjustmentType;

package/lib/esm/resources/adyen_gateways.d.ts

@@ -11,8 +11,8 @@ type AdyenPaymentRel = ResourceRel & {
 };
 interface AdyenGateway extends Resource {
     readonly type: AdyenGatewayType;
-    name?: string;
-    live_url_prefix?: string;
+    name: string;
+    live_url_prefix: string;
     async_api?: boolean;
     webhook_endpoint_secret?: string;
     webhook_endpoint_url?: string;
@@ -31,11 +31,11 @@ interface AdyenGatewayCreate extends ResourceCreate {
     adyen_payments?: AdyenPaymentRel[];
 }
 interface AdyenGatewayUpdate extends ResourceUpdate {
-    name?: string;
+    name: string;
     merchant_account?: string;
     api_key?: string;
     public_key?: string;
-    live_url_prefix?: string;
+    live_url_prefix: string;
     api_version?: string;
     async_api?: boolean;
     webhook_endpoint_secret?: string;

package/lib/esm/resources/adyen_payments.d.ts

@@ -12,7 +12,7 @@ type OrderRel = ResourceRel & {
 interface AdyenPayment extends Resource {
     readonly type: AdyenPaymentType;
     public_key?: string;
-    payment_methods?: object;
+    payment_methods: object;
     payment_request_data?: object;
     payment_request_details?: object;
     payment_response?: object;

package/lib/esm/resources/attachments.d.ts

@@ -126,7 +126,7 @@ type TaxCategoryRel = ResourceRel & {
 };
 interface Attachment extends Resource {
     readonly type: AttachmentType;
-    name?: string;
+    name: string;
     description?: string;
     url?: string;
     attachable?: Bundle | CarrierAccount | CustomerGroup | Customer | DeliveryLeadTime | Geocoder | GiftCardRecipient | GiftCard | InventoryModel | Market | Merchant | BillingInfoValidationRule | Order | Package | Parcel | PaymentMethod | PriceList | Price | Promotion | Return | Shipment | ShippingCategory | ShippingMethod | ShippingZone | SkuOption | Sku | StockItem | StockLocation | TaxCalculator | TaxCategory;
@@ -138,7 +138,7 @@ interface AttachmentCreate extends ResourceCreate {
     attachable: BundleRel | CarrierAccountRel | CustomerGroupRel | CustomerRel | DeliveryLeadTimeRel | GeocoderRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel | MarketRel | MerchantRel | BillingInfoValidationRuleRel | OrderRel | PackageRel | ParcelRel | PaymentMethodRel | PriceListRel | PriceRel | PromotionRel | ReturnRel | ShipmentRel | ShippingCategoryRel | ShippingMethodRel | ShippingZoneRel | SkuOptionRel | SkuRel | StockItemRel | StockLocationRel | TaxCalculatorRel | TaxCategoryRel;
 }
 interface AttachmentUpdate extends ResourceUpdate {
-    name?: string;
+    name: string;
     description?: string;
     url?: string;
     attachable?: BundleRel | CarrierAccountRel | CustomerGroupRel | CustomerRel | DeliveryLeadTimeRel | GeocoderRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel | MarketRel | MerchantRel | BillingInfoValidationRuleRel | OrderRel | PackageRel | ParcelRel | PaymentMethodRel | PriceListRel | PriceRel | PromotionRel | ReturnRel | ShipmentRel | ShippingCategoryRel | ShippingMethodRel | ShippingZoneRel | SkuOptionRel | SkuRel | StockItemRel | StockLocationRel | TaxCalculatorRel | TaxCategoryRel;

package/lib/esm/resources/authorizations.d.ts

@@ -10,12 +10,12 @@ type AuthorizationRel = ResourceRel & {
 };
 interface Authorization extends Resource {
     readonly type: AuthorizationType;
-    number?: string;
-    currency_code?: string;
-    amount_cents?: number;
-    amount_float?: number;
-    formatted_amount?: string;
-    succeeded?: boolean;
+    number: string;
+    currency_code: string;
+    amount_cents: number;
+    amount_float: number;
+    formatted_amount: string;
+    succeeded: boolean;
     message?: string;
     error_code?: string;
     error_detail?: string;

package/lib/esm/resources/avalara_accounts.d.ts

@@ -12,9 +12,9 @@ type TaxCategoryRel = ResourceRel & {
 };
 interface AvalaraAccount extends Resource {
     readonly type: AvalaraAccountType;
-    name?: string;
-    username?: string;
-    company_code?: string;
+    name: string;
+    username: string;
+    company_code: string;
     commit_invoice?: string;
     ddp?: string;
     markets?: Market[];
@@ -31,10 +31,10 @@ interface AvalaraAccountCreate extends ResourceCreate {
     tax_categories?: TaxCategoryRel[];
 }
 interface AvalaraAccountUpdate extends ResourceUpdate {
-    name?: string;
-    username?: string;
+    name: string;
+    username: string;
     password?: string;
-    company_code?: string;
+    company_code: string;
     commit_invoice?: string;
     ddp?: string;
     tax_categories?: TaxCategoryRel[];

package/lib/esm/resources/axerve_gateways.d.ts

@@ -11,8 +11,8 @@ type AxervePaymentRel = ResourceRel & {
 };
 interface AxerveGateway extends Resource {
     readonly type: AxerveGatewayType;
-    name?: string;
-    login?: string;
+    name: string;
+    login: string;
     payment_methods?: PaymentMethod[];
     axerve_payments?: AxervePayment[];
 }
@@ -23,8 +23,8 @@ interface AxerveGatewayCreate extends ResourceCreate {
     axerve_payments?: AxervePaymentRel[];
 }
 interface AxerveGatewayUpdate extends ResourceUpdate {
-    name?: string;
-    login?: string;
+    name: string;
+    login: string;
     api_key?: string;
     axerve_payments?: AxervePaymentRel[];
 }

package/lib/esm/resources/axerve_payments.d.ts

@@ -11,11 +11,11 @@ type OrderRel = ResourceRel & {
 };
 interface AxervePayment extends Resource {
     readonly type: AxervePaymentType;
-    login?: string;
-    return_url?: string;
+    login: string;
+    return_url: string;
     payment_request_data?: object;
     mismatched_amounts?: boolean;
-    intent_amount_cents?: number;
+    intent_amount_cents: number;
     intent_amount_float?: number;
     formatted_intent_amount?: string;
     payment_instrument?: object;

package/lib/esm/resources/bing_geocoders.d.ts

@@ -8,7 +8,7 @@ type BingGeocoderRel = ResourceRel & {
 };
 interface BingGeocoder extends Resource {
     readonly type: BingGeocoderType;
-    name?: string;
+    name: string;
     addresses?: Address[];
     attachments?: Attachment[];
 }
@@ -17,7 +17,7 @@ interface BingGeocoderCreate extends ResourceCreate {
     key: string;
 }
 interface BingGeocoderUpdate extends ResourceUpdate {
-    name?: string;
+    name: string;
     key?: string;
 }
 declare class BingGeocoders extends ApiResource<BingGeocoder> {

package/lib/esm/resources/braintree_gateways.d.ts

@@ -11,7 +11,7 @@ type BraintreePaymentRel = ResourceRel & {
 };
 interface BraintreeGateway extends Resource {
     readonly type: BraintreeGatewayType;
-    name?: string;
+    name: string;
     descriptor_name?: string;
     descriptor_phone?: string;
     descriptor_url?: string;
@@ -31,7 +31,7 @@ interface BraintreeGatewayCreate extends ResourceCreate {
     braintree_payments?: BraintreePaymentRel[];
 }
 interface BraintreeGatewayUpdate extends ResourceUpdate {
-    name?: string;
+    name: string;
     merchant_account_id?: string;
     merchant_id?: string;
     public_key?: string;

package/lib/esm/resources/braintree_payments.d.ts

@@ -11,7 +11,7 @@ type OrderRel = ResourceRel & {
 };
 interface BraintreePayment extends Resource {
     readonly type: BraintreePaymentType;
-    client_token?: string;
+    client_token: string;
     payment_method_nonce?: string;
     payment_id?: string;
     local?: boolean;

package/lib/esm/resources/bundles.d.ts

@@ -16,19 +16,19 @@ type SkuListRel = ResourceRel & {
 };
 interface Bundle extends Resource {
     readonly type: BundleType;
-    code?: string;
-    name?: string;
+    code: string;
+    name: string;
     currency_code?: string;
     description?: string;
     image_url?: string;
     do_not_ship?: boolean;
     do_not_track?: boolean;
-    price_amount_cents?: number;
-    price_amount_float?: number;
-    formatted_price_amount?: string;
-    compare_at_amount_cents?: number;
-    compare_at_amount_float?: number;
-    formatted_compare_at_amount?: string;
+    price_amount_cents: number;
+    price_amount_float: number;
+    formatted_price_amount: string;
+    compare_at_amount_cents: number;
+    compare_at_amount_float: number;
+    formatted_compare_at_amount: string;
     skus_count?: number;
     market?: Market;
     sku_list?: SkuList;
@@ -49,13 +49,13 @@ interface BundleCreate extends ResourceCreate {
     sku_list: SkuListRel;
 }
 interface BundleUpdate extends ResourceUpdate {
-    code?: string;
-    name?: string;
+    code: string;
+    name: string;
     currency_code?: string;
     description?: string;
     image_url?: string;
-    price_amount_cents?: number;
-    compare_at_amount_cents?: number;
+    price_amount_cents: number;
+    compare_at_amount_cents: number;
     _compute_price_amount?: boolean;
     _compute_compare_at_amount?: boolean;
 }

package/lib/esm/resources/captures.d.ts

@@ -10,12 +10,12 @@ type CaptureRel = ResourceRel & {
 };
 interface Capture extends Resource {
     readonly type: CaptureType;
-    number?: string;
-    currency_code?: string;
-    amount_cents?: number;
-    amount_float?: number;
-    formatted_amount?: string;
-    succeeded?: boolean;
+    number: string;
+    currency_code: string;
+    amount_cents: number;
+    amount_float: number;
+    formatted_amount: string;
+    succeeded: boolean;
     message?: string;
     error_code?: string;
     error_detail?: string;

package/lib/esm/resources/checkout_com_gateways.d.ts

@@ -11,7 +11,7 @@ type CheckoutComPaymentRel = ResourceRel & {
 };
 interface CheckoutComGateway extends Resource {
     readonly type: CheckoutComGatewayType;
-    name?: string;
+    name: string;
     webhook_endpoint_id?: string;
     webhook_endpoint_secret?: string;
     webhook_endpoint_url?: string;
@@ -25,7 +25,7 @@ interface CheckoutComGatewayCreate extends ResourceCreate {
     checkout_com_payments?: CheckoutComPaymentRel[];
 }
 interface CheckoutComGatewayUpdate extends ResourceUpdate {
-    name?: string;
+    name: string;
     secret_key?: string;
     public_key?: string;
     checkout_com_payments?: CheckoutComPaymentRel[];

package/lib/esm/resources/checkout_com_payments.d.ts

@@ -12,8 +12,8 @@ type OrderRel = ResourceRel & {
 interface CheckoutComPayment extends Resource {
     readonly type: CheckoutComPaymentType;
     public_key?: string;
-    payment_type?: string;
-    token?: string;
+    payment_type: string;
+    token: string;
     session_id?: string;
     success_url?: string;
     failure_url?: string;
@@ -35,8 +35,8 @@ interface CheckoutComPaymentCreate extends ResourceCreate {
     order: OrderRel;
 }
 interface CheckoutComPaymentUpdate extends ResourceUpdate {
-    payment_type?: string;
-    token?: string;
+    payment_type: string;
+    token: string;
     session_id?: string;
     success_url?: string;
     failure_url?: string;

package/lib/esm/resources/cleanups.d.ts

@@ -7,7 +7,7 @@ type CleanupRel = ResourceRel & {
 };
 interface Cleanup extends Resource {
     readonly type: CleanupType;
-    resource_type?: string;
+    resource_type: string;
     status?: 'pending' | 'in_progress' | 'interrupted' | 'completed';
     started_at?: string;
     completed_at?: string;

package/lib/esm/resources/coupon_recipients.d.ts

@@ -11,7 +11,7 @@ type CustomerRel = ResourceRel & {
 };
 interface CouponRecipient extends Resource {
     readonly type: CouponRecipientType;
-    email?: string;
+    email: string;
     first_name?: string;
     last_name?: string;
     customer?: Customer;
@@ -24,7 +24,7 @@ interface CouponRecipientCreate extends ResourceCreate {
     customer?: CustomerRel;
 }
 interface CouponRecipientUpdate extends ResourceUpdate {
-    email?: string;
+    email: string;
     first_name?: string;
     last_name?: string;
     customer?: CustomerRel;

package/lib/esm/resources/coupons.d.ts

@@ -10,9 +10,9 @@ type CouponCodesPromotionRuleRel = ResourceRel & {
 };
 interface Coupon extends Resource {
     readonly type: CouponType;
-    code?: string;
+    code: string;
     customer_single_use?: boolean;
-    usage_limit?: number;
+    usage_limit: number;
     usage_count?: number;
     recipient_email?: string;
     promotion_rule?: CouponCodesPromotionRule;
@@ -25,9 +25,9 @@ interface CouponCreate extends ResourceCreate {
     promotion_rule: CouponCodesPromotionRuleRel;
 }
 interface CouponUpdate extends ResourceUpdate {
-    code?: string;
+    code: string;
     customer_single_use?: boolean;
-    usage_limit?: number;
+    usage_limit: number;
     recipient_email?: string;
     promotion_rule?: CouponCodesPromotionRuleRel;
 }

package/lib/esm/resources/customer_groups.d.ts

@@ -9,7 +9,7 @@ type CustomerGroupRel = ResourceRel & {
 };
 interface CustomerGroup extends Resource {
     readonly type: CustomerGroupType;
-    name?: string;
+    name: string;
     customers?: Customer[];
     markets?: Market[];
     attachments?: Attachment[];
@@ -18,7 +18,7 @@ interface CustomerGroupCreate extends ResourceCreate {
     name: string;
 }
 interface CustomerGroupUpdate extends ResourceUpdate {
-    name?: string;
+    name: string;
 }
 declare class CustomerGroups extends ApiResource<CustomerGroup> {
     static readonly TYPE: CustomerGroupType;

package/lib/esm/resources/customer_password_resets.d.ts

@@ -8,7 +8,7 @@ type CustomerPasswordResetRel = ResourceRel & {
 };
 interface CustomerPasswordReset extends Resource {
     readonly type: CustomerPasswordResetType;
-    customer_email?: string;
+    customer_email: string;
     reset_password_token?: string;
     reset_password_at?: string;
     customer?: Customer;

package/lib/esm/resources/customer_subscriptions.d.ts

@@ -8,7 +8,7 @@ type CustomerSubscriptionRel = ResourceRel & {
 };
 interface CustomerSubscription extends Resource {
     readonly type: CustomerSubscriptionType;
-    customer_email?: string;
+    customer_email: string;
     customer?: Customer;
     events?: Event[];
 }

package/lib/esm/resources/customers.d.ts

@@ -19,7 +19,7 @@ type CustomerGroupRel = ResourceRel & {
 };
 interface Customer extends Resource {
     readonly type: CustomerType;
-    email?: string;
+    email: string;
     status?: 'prospect' | 'acquired' | 'repeat';
     has_password?: boolean;
     customer_group?: CustomerGroup;
@@ -39,7 +39,7 @@ interface CustomerCreate extends ResourceCreate {
     customer_group?: CustomerGroupRel;
 }
 interface CustomerUpdate extends ResourceUpdate {
-    email?: string;
+    email: string;
     password?: string;
     customer_group?: CustomerGroupRel;
 }

package/lib/esm/resources/delivery_lead_times.d.ts

@@ -15,8 +15,8 @@ type ShippingMethodRel = ResourceRel & {
 };
 interface DeliveryLeadTime extends Resource {
     readonly type: DeliveryLeadTimeType;
-    min_hours?: number;
-    max_hours?: number;
+    min_hours: number;
+    max_hours: number;
     min_days?: number;
     max_days?: number;
     stock_location?: StockLocation;
@@ -30,8 +30,8 @@ interface DeliveryLeadTimeCreate extends ResourceCreate {
     shipping_method: ShippingMethodRel;
 }
 interface DeliveryLeadTimeUpdate extends ResourceUpdate {
-    min_hours?: number;
-    max_hours?: number;
+    min_hours: number;
+    max_hours: number;
     stock_location?: StockLocationRel;
     shipping_method?: ShippingMethodRel;
 }

package/lib/esm/resources/event_callbacks.d.ts

@@ -7,7 +7,7 @@ type EventCallbackRel = ResourceRel & {
 };
 interface EventCallback extends Resource {
     readonly type: EventCallbackType;
-    callback_url?: string;
+    callback_url: string;
     payload?: object;
     response_code?: string;
     response_message?: string;

package/lib/esm/resources/events.d.ts

@@ -8,7 +8,7 @@ type EventRel = ResourceRel & {
 };
 interface Event extends Resource {
     readonly type: EventType;
-    name?: string;
+    name: string;
     last_event_callbacks?: EventCallback[];
     webhooks?: Webhook[];
 }

package/lib/esm/resources/exports.d.ts

@@ -7,7 +7,7 @@ type ExportRel = ResourceRel & {
 };
 interface Export extends Resource {
     readonly type: ExportType;
-    resource_type?: string;
+    resource_type: string;
     format?: string;
     status?: 'pending' | 'in_progress' | 'completed';
     includes?: string[];

package/lib/esm/resources/external_gateways.d.ts

@@ -8,8 +8,8 @@ type ExternalGatewayRel = ResourceRel & {
 };
 interface ExternalGateway extends Resource {
     readonly type: ExternalGatewayType;
-    name?: string;
-    shared_secret?: string;
+    name: string;
+    shared_secret: string;
     authorize_url?: string;
     capture_url?: string;
     void_url?: string;
@@ -27,7 +27,7 @@ interface ExternalGatewayCreate extends ResourceCreate {
     token_url?: string;
 }
 interface ExternalGatewayUpdate extends ResourceUpdate {
-    name?: string;
+    name: string;
     authorize_url?: string;
     capture_url?: string;
     void_url?: string;

package/lib/esm/resources/external_payments.d.ts

@@ -12,7 +12,7 @@ type OrderRel = ResourceRel & {
 };
 interface ExternalPayment extends Resource {
     readonly type: ExternalPaymentType;
-    payment_source_token?: string;
+    payment_source_token: string;
     options?: object;
     payment_instrument?: object;
     order?: Order;