@commercelayer/sdk 4.41.0 → 4.42.0

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

@@ -1,119 +1,130 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { Market } from './markets';
-import type { PromotionRule } from './promotion_rules';
-import type { OrderAmountPromotionRule } from './order_amount_promotion_rules';
-import type { SkuListPromotionRule } from './sku_list_promotion_rules';
-import type { CouponCodesPromotionRule } from './coupon_codes_promotion_rules';
-import type { Coupon } from './coupons';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Market, MarketType } from './markets';
+import type { PromotionRule, PromotionRuleType } from './promotion_rules';
+import type { OrderAmountPromotionRule, OrderAmountPromotionRuleType } from './order_amount_promotion_rules';
+import type { SkuListPromotionRule, SkuListPromotionRuleType } from './sku_list_promotion_rules';
+import type { CouponCodesPromotionRule, CouponCodesPromotionRuleType } from './coupon_codes_promotion_rules';
+import type { CustomPromotionRule, CustomPromotionRuleType } from './custom_promotion_rules';
+import type { Coupon, CouponType } from './coupons';
 import type { SkuList } from './sku_lists';
 import type { Attachment } from './attachments';
 import type { Event } from './events';
-import type { Tag } from './tags';
+import type { Tag, TagType } from './tags';
 import type { Version } from './versions';
+type FreeShippingPromotionType = 'free_shipping_promotions';
 type FreeShippingPromotionRel = ResourceRel & {
-    type: typeof FreeShippingPromotions.TYPE;
+    type: FreeShippingPromotionType;
 };
 type MarketRel = ResourceRel & {
-    type: 'markets';
+    type: MarketType;
 };
 type PromotionRuleRel = ResourceRel & {
-    type: 'promotion_rules';
+    type: PromotionRuleType;
 };
 type OrderAmountPromotionRuleRel = ResourceRel & {
-    type: 'order_amount_promotion_rules';
+    type: OrderAmountPromotionRuleType;
 };
 type SkuListPromotionRuleRel = ResourceRel & {
-    type: 'sku_list_promotion_rules';
+    type: SkuListPromotionRuleType;
 };
 type CouponCodesPromotionRuleRel = ResourceRel & {
-    type: 'coupon_codes_promotion_rules';
+    type: CouponCodesPromotionRuleType;
+};
+type CustomPromotionRuleRel = ResourceRel & {
+    type: CustomPromotionRuleType;
 };
 type CouponRel = ResourceRel & {
-    type: 'coupons';
+    type: CouponType;
 };
 type TagRel = ResourceRel & {
-    type: 'tags';
+    type: TagType;
 };
 interface FreeShippingPromotion extends Resource {
-    name?: string;
-    currency_code?: string;
-    exclusive?: boolean;
-    priority?: number;
-    starts_at?: string;
-    expires_at?: string;
-    total_usage_limit?: number;
-    total_usage_count?: number;
-    active?: boolean;
-    disabled_at?: string;
-    market?: Market;
-    promotion_rules?: PromotionRule[];
-    order_amount_promotion_rule?: OrderAmountPromotionRule;
-    sku_list_promotion_rule?: SkuListPromotionRule;
-    coupon_codes_promotion_rule?: CouponCodesPromotionRule;
-    coupons?: Coupon[];
-    sku_list?: SkuList;
-    attachments?: Attachment[];
-    events?: Event[];
-    tags?: Tag[];
-    versions?: Version[];
+    readonly type: FreeShippingPromotionType;
+    name: string;
+    currency_code?: string | null;
+    exclusive?: boolean | null;
+    priority?: number | null;
+    starts_at: string;
+    expires_at: string;
+    total_usage_limit?: number | null;
+    total_usage_count?: number | null;
+    active?: boolean | null;
+    disabled_at?: string | null;
+    market?: Market | null;
+    promotion_rules?: PromotionRule[] | null;
+    order_amount_promotion_rule?: OrderAmountPromotionRule | null;
+    sku_list_promotion_rule?: SkuListPromotionRule | null;
+    coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
+    custom_promotion_rule?: CustomPromotionRule | null;
+    coupons?: Coupon[] | null;
+    sku_list?: SkuList | null;
+    attachments?: Attachment[] | null;
+    events?: Event[] | null;
+    tags?: Tag[] | null;
+    versions?: Version[] | null;
 }
 interface FreeShippingPromotionCreate extends ResourceCreate {
     name: string;
-    currency_code?: string;
-    exclusive?: boolean;
-    priority?: number;
+    currency_code?: string | null;
+    exclusive?: boolean | null;
+    priority?: number | null;
     starts_at: string;
     expires_at: string;
-    total_usage_limit?: number;
-    _disable?: boolean;
-    _enable?: boolean;
-    market?: MarketRel;
-    promotion_rules?: PromotionRuleRel[];
-    order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
-    sku_list_promotion_rule?: SkuListPromotionRuleRel;
-    coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
-    coupons?: CouponRel[];
-    tags?: TagRel[];
+    total_usage_limit?: number | null;
+    _disable?: boolean | null;
+    _enable?: boolean | null;
+    market?: MarketRel | null;
+    promotion_rules?: PromotionRuleRel[] | null;
+    order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
+    sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
+    coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
+    custom_promotion_rule?: CustomPromotionRuleRel | null;
+    coupons?: CouponRel[] | null;
+    tags?: TagRel[] | null;
 }
 interface FreeShippingPromotionUpdate extends ResourceUpdate {
-    name?: string;
-    currency_code?: string;
-    exclusive?: boolean;
-    priority?: number;
-    starts_at?: string;
-    expires_at?: string;
-    total_usage_limit?: number;
-    _disable?: boolean;
-    _enable?: boolean;
-    market?: MarketRel;
-    promotion_rules?: PromotionRuleRel[];
-    order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
-    sku_list_promotion_rule?: SkuListPromotionRuleRel;
-    coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
-    coupons?: CouponRel[];
-    tags?: TagRel[];
+    name?: string | null;
+    currency_code?: string | null;
+    exclusive?: boolean | null;
+    priority?: number | null;
+    starts_at?: string | null;
+    expires_at?: string | null;
+    total_usage_limit?: number | null;
+    _disable?: boolean | null;
+    _enable?: boolean | null;
+    market?: MarketRel | null;
+    promotion_rules?: PromotionRuleRel[] | null;
+    order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
+    sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
+    coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
+    custom_promotion_rule?: CustomPromotionRuleRel | null;
+    coupons?: CouponRel[] | null;
+    tags?: TagRel[] | null;
 }
-declare class FreeShippingPromotions extends ApiResource {
-    static readonly TYPE: 'free_shipping_promotions';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<FreeShippingPromotion>>;
+declare class FreeShippingPromotions extends ApiResource<FreeShippingPromotion> {
+    static readonly TYPE: FreeShippingPromotionType;
     create(resource: FreeShippingPromotionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FreeShippingPromotion>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FreeShippingPromotion>;
     update(resource: FreeShippingPromotionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FreeShippingPromotion>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     market(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
     order_amount_promotion_rule(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderAmountPromotionRule>;
     sku_list_promotion_rule(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
     coupon_codes_promotion_rule(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
+    custom_promotion_rule(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CustomPromotionRule>;
     coupons(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Coupon>>;
     sku_list(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuList>;
     attachments(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     events(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     tags(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
     versions(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
+    _disable(id: string | FreeShippingPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FreeShippingPromotion>;
+    _enable(id: string | FreeShippingPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FreeShippingPromotion>;
     isFreeShippingPromotion(resource: any): resource is FreeShippingPromotion;
     relationship(id: string | ResourceId | null): FreeShippingPromotionRel;
-    type(): string;
+    type(): FreeShippingPromotionType;
 }
 export default FreeShippingPromotions;
-export { FreeShippingPromotion, FreeShippingPromotionCreate, FreeShippingPromotionUpdate };
+export type { FreeShippingPromotion, FreeShippingPromotionCreate, FreeShippingPromotionUpdate, FreeShippingPromotionType };

package/lib/esm/resources/free_shipping_promotions.js

@@ -1,20 +1,13 @@
 import { ApiResource } from '../resource';
 class FreeShippingPromotions extends ApiResource {
-    // static readonly PATH = 'free_shipping_promotions'
-    async list(params, options) {
-        return this.resources.list({ type: FreeShippingPromotions.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: FreeShippingPromotions.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: FreeShippingPromotions.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: FreeShippingPromotions.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: FreeShippingPromotions.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: FreeShippingPromotions.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: FreeShippingPromotions.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: FreeShippingPromotions.TYPE } : id, options);
     }
     async market(freeShippingPromotionId, params, options) {
         const _freeShippingPromotionId = freeShippingPromotionId.id || freeShippingPromotionId;
@@ -32,6 +25,10 @@ class FreeShippingPromotions extends ApiResource {
         const _freeShippingPromotionId = freeShippingPromotionId.id || freeShippingPromotionId;
         return this.resources.fetch({ type: 'coupon_codes_promotion_rules' }, `free_shipping_promotions/${_freeShippingPromotionId}/coupon_codes_promotion_rule`, params, options);
     }
+    async custom_promotion_rule(freeShippingPromotionId, params, options) {
+        const _freeShippingPromotionId = freeShippingPromotionId.id || freeShippingPromotionId;
+        return this.resources.fetch({ type: 'custom_promotion_rules' }, `free_shipping_promotions/${_freeShippingPromotionId}/custom_promotion_rule`, params, options);
+    }
     async coupons(freeShippingPromotionId, params, options) {
         const _freeShippingPromotionId = freeShippingPromotionId.id || freeShippingPromotionId;
         return this.resources.fetch({ type: 'coupons' }, `free_shipping_promotions/${_freeShippingPromotionId}/coupons`, params, options);
@@ -56,7 +53,12 @@ class FreeShippingPromotions extends ApiResource {
         const _freeShippingPromotionId = freeShippingPromotionId.id || freeShippingPromotionId;
         return this.resources.fetch({ type: 'versions' }, `free_shipping_promotions/${_freeShippingPromotionId}/versions`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    async _disable(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: FreeShippingPromotions.TYPE, _disable: true }, params, options);
+    }
+    async _enable(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: FreeShippingPromotions.TYPE, _enable: true }, params, options);
+    }
     isFreeShippingPromotion(resource) {
         return resource.type && (resource.type === FreeShippingPromotions.TYPE);
     }

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

@@ -1,24 +1,25 @@
-import { ApiResource, Resource, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList } from '../query';
 import type { Address } from './addresses';
 import type { Attachment } from './attachments';
+type GeocoderType = 'geocoders';
 type GeocoderRel = ResourceRel & {
-    type: typeof Geocoders.TYPE;
+    type: GeocoderType;
 };
 interface Geocoder extends Resource {
-    name?: string;
-    addresses?: Address[];
-    attachments?: Attachment[];
+    readonly type: GeocoderType;
+    name: string;
+    addresses?: Address[] | null;
+    attachments?: Attachment[] | null;
 }
-declare class Geocoders extends ApiResource {
-    static readonly TYPE: 'geocoders';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Geocoder>>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Geocoder>;
+declare class Geocoders extends ApiResource<Geocoder> {
+    static readonly TYPE: GeocoderType;
     addresses(geocoderId: string | Geocoder, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Address>>;
     attachments(geocoderId: string | Geocoder, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     isGeocoder(resource: any): resource is Geocoder;
     relationship(id: string | ResourceId | null): GeocoderRel;
-    type(): string;
+    type(): GeocoderType;
 }
 export default Geocoders;
-export { Geocoder };
+export type { Geocoder, GeocoderType };

package/lib/esm/resources/geocoders.js

@@ -1,12 +1,5 @@
 import { ApiResource } from '../resource';
 class Geocoders extends ApiResource {
-    // static readonly PATH = 'geocoders'
-    async list(params, options) {
-        return this.resources.list({ type: Geocoders.TYPE }, params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: Geocoders.TYPE, id }, params, options);
-    }
     async addresses(geocoderId, params, options) {
         const _geocoderId = geocoderId.id || geocoderId;
         return this.resources.fetch({ type: 'addresses' }, `geocoders/${_geocoderId}/addresses`, params, options);
@@ -15,7 +8,6 @@ class Geocoders extends ApiResource {
         const _geocoderId = geocoderId.id || geocoderId;
         return this.resources.fetch({ type: 'attachments' }, `geocoders/${_geocoderId}/attachments`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isGeocoder(resource) {
         return resource.type && (resource.type === Geocoders.TYPE);
     }

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

@@ -1,47 +1,48 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { Customer } from './customers';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Customer, CustomerType } from './customers';
 import type { Attachment } from './attachments';
 import type { Version } from './versions';
+type GiftCardRecipientType = 'gift_card_recipients';
 type GiftCardRecipientRel = ResourceRel & {
-    type: typeof GiftCardRecipients.TYPE;
+    type: GiftCardRecipientType;
 };
 type CustomerRel = ResourceRel & {
-    type: 'customers';
+    type: CustomerType;
 };
 interface GiftCardRecipient extends Resource {
-    email?: string;
-    first_name?: string;
-    last_name?: string;
-    customer?: Customer;
-    attachments?: Attachment[];
-    versions?: Version[];
+    readonly type: GiftCardRecipientType;
+    email: string;
+    first_name?: string | null;
+    last_name?: string | null;
+    customer?: Customer | null;
+    attachments?: Attachment[] | null;
+    versions?: Version[] | null;
 }
 interface GiftCardRecipientCreate extends ResourceCreate {
     email: string;
-    first_name?: string;
-    last_name?: string;
-    customer?: CustomerRel;
+    first_name?: string | null;
+    last_name?: string | null;
+    customer?: CustomerRel | null;
 }
 interface GiftCardRecipientUpdate extends ResourceUpdate {
-    email?: string;
-    first_name?: string;
-    last_name?: string;
-    customer?: CustomerRel;
+    email?: string | null;
+    first_name?: string | null;
+    last_name?: string | null;
+    customer?: CustomerRel | null;
 }
-declare class GiftCardRecipients extends ApiResource {
-    static readonly TYPE: 'gift_card_recipients';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<GiftCardRecipient>>;
+declare class GiftCardRecipients extends ApiResource<GiftCardRecipient> {
+    static readonly TYPE: GiftCardRecipientType;
     create(resource: GiftCardRecipientCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<GiftCardRecipient>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<GiftCardRecipient>;
     update(resource: GiftCardRecipientUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<GiftCardRecipient>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     customer(giftCardRecipientId: string | GiftCardRecipient, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Customer>;
     attachments(giftCardRecipientId: string | GiftCardRecipient, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     versions(giftCardRecipientId: string | GiftCardRecipient, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isGiftCardRecipient(resource: any): resource is GiftCardRecipient;
     relationship(id: string | ResourceId | null): GiftCardRecipientRel;
-    type(): string;
+    type(): GiftCardRecipientType;
 }
 export default GiftCardRecipients;
-export { GiftCardRecipient, GiftCardRecipientCreate, GiftCardRecipientUpdate };
+export type { GiftCardRecipient, GiftCardRecipientCreate, GiftCardRecipientUpdate, GiftCardRecipientType };

package/lib/esm/resources/gift_card_recipients.js

@@ -1,20 +1,13 @@
 import { ApiResource } from '../resource';
 class GiftCardRecipients extends ApiResource {
-    // static readonly PATH = 'gift_card_recipients'
-    async list(params, options) {
-        return this.resources.list({ type: GiftCardRecipients.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: GiftCardRecipients.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: GiftCardRecipients.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: GiftCardRecipients.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: GiftCardRecipients.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: GiftCardRecipients.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: GiftCardRecipients.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: GiftCardRecipients.TYPE } : id, options);
     }
     async customer(giftCardRecipientId, params, options) {
         const _giftCardRecipientId = giftCardRecipientId.id || giftCardRecipientId;
@@ -28,7 +21,6 @@ class GiftCardRecipients extends ApiResource {
         const _giftCardRecipientId = giftCardRecipientId.id || giftCardRecipientId;
         return this.resources.fetch({ type: 'versions' }, `gift_card_recipients/${_giftCardRecipientId}/versions`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isGiftCardRecipient(resource) {
         return resource.type && (resource.type === GiftCardRecipients.TYPE);
     }

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

@@ -1,96 +1,101 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { Market } from './markets';
-import type { GiftCardRecipient } from './gift_card_recipients';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Market, MarketType } from './markets';
+import type { GiftCardRecipient, GiftCardRecipientType } from './gift_card_recipients';
 import type { Attachment } from './attachments';
 import type { Event } from './events';
-import type { Tag } from './tags';
+import type { Tag, TagType } from './tags';
 import type { Version } from './versions';
+type GiftCardType = 'gift_cards';
 type GiftCardRel = ResourceRel & {
-    type: typeof GiftCards.TYPE;
+    type: GiftCardType;
 };
 type MarketRel = ResourceRel & {
-    type: 'markets';
+    type: MarketType;
 };
 type GiftCardRecipientRel = ResourceRel & {
-    type: 'gift_card_recipients';
+    type: GiftCardRecipientType;
 };
 type TagRel = ResourceRel & {
-    type: 'tags';
+    type: TagType;
 };
 interface GiftCard extends Resource {
-    status?: string;
-    code?: string;
-    currency_code?: string;
-    initial_balance_cents?: number;
-    initial_balance_float?: number;
-    formatted_initial_balance?: string;
-    balance_cents?: number;
-    balance_float?: number;
-    formatted_balance?: string;
-    balance_max_cents?: string;
-    balance_max_float?: number;
-    formatted_balance_max?: string;
-    balance_log?: object[];
-    single_use?: boolean;
-    rechargeable?: boolean;
-    image_url?: string;
-    expires_at?: string;
-    recipient_email?: string;
-    market?: Market;
-    gift_card_recipient?: GiftCardRecipient;
-    attachments?: Attachment[];
-    events?: Event[];
-    tags?: Tag[];
-    versions?: Version[];
+    readonly type: GiftCardType;
+    status: 'draft' | 'inactive' | 'active' | 'redeemed';
+    code?: string | null;
+    currency_code?: string | null;
+    initial_balance_cents: number;
+    initial_balance_float: number;
+    formatted_initial_balance: string;
+    balance_cents: number;
+    balance_float: number;
+    formatted_balance: string;
+    balance_max_cents?: string | null;
+    balance_max_float?: number | null;
+    formatted_balance_max?: string | null;
+    balance_log: Array<Record<string, any>>;
+    single_use?: boolean | null;
+    rechargeable?: boolean | null;
+    image_url?: string | null;
+    expires_at?: string | null;
+    recipient_email?: string | null;
+    market?: Market | null;
+    gift_card_recipient?: GiftCardRecipient | null;
+    attachments?: Attachment[] | null;
+    events?: Event[] | null;
+    tags?: Tag[] | null;
+    versions?: Version[] | null;
 }
 interface GiftCardCreate extends ResourceCreate {
-    code?: string;
-    currency_code?: string;
+    code?: string | null;
+    currency_code?: string | null;
     balance_cents: number;
-    balance_max_cents?: string;
-    single_use?: boolean;
-    rechargeable?: boolean;
-    image_url?: string;
-    expires_at?: string;
-    recipient_email?: string;
-    market?: MarketRel;
-    gift_card_recipient?: GiftCardRecipientRel;
-    tags?: TagRel[];
+    balance_max_cents?: string | null;
+    single_use?: boolean | null;
+    rechargeable?: boolean | null;
+    image_url?: string | null;
+    expires_at?: string | null;
+    recipient_email?: string | null;
+    market?: MarketRel | null;
+    gift_card_recipient?: GiftCardRecipientRel | null;
+    tags?: TagRel[] | null;
 }
 interface GiftCardUpdate extends ResourceUpdate {
-    currency_code?: string;
-    balance_cents?: number;
-    balance_max_cents?: string;
-    single_use?: boolean;
-    rechargeable?: boolean;
-    image_url?: string;
-    expires_at?: string;
-    recipient_email?: string;
-    _purchase?: boolean;
-    _activate?: boolean;
-    _deactivate?: boolean;
-    _balance_change_cents?: number;
-    market?: MarketRel;
-    gift_card_recipient?: GiftCardRecipientRel;
-    tags?: TagRel[];
+    currency_code?: string | null;
+    balance_cents?: number | null;
+    balance_max_cents?: string | null;
+    single_use?: boolean | null;
+    rechargeable?: boolean | null;
+    image_url?: string | null;
+    expires_at?: string | null;
+    recipient_email?: string | null;
+    _purchase?: boolean | null;
+    _activate?: boolean | null;
+    _deactivate?: boolean | null;
+    _balance_change_cents?: number | null;
+    market?: MarketRel | null;
+    gift_card_recipient?: GiftCardRecipientRel | null;
+    tags?: TagRel[] | null;
 }
-declare class GiftCards extends ApiResource {
-    static readonly TYPE: 'gift_cards';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<GiftCard>>;
+declare class GiftCards extends ApiResource<GiftCard> {
+    static readonly TYPE: GiftCardType;
     create(resource: GiftCardCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<GiftCard>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<GiftCard>;
     update(resource: GiftCardUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<GiftCard>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     market(giftCardId: string | GiftCard, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
     gift_card_recipient(giftCardId: string | GiftCard, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<GiftCardRecipient>;
     attachments(giftCardId: string | GiftCard, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     events(giftCardId: string | GiftCard, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     tags(giftCardId: string | GiftCard, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
     versions(giftCardId: string | GiftCard, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
+    _purchase(id: string | GiftCard, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<GiftCard>;
+    _activate(id: string | GiftCard, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<GiftCard>;
+    _deactivate(id: string | GiftCard, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<GiftCard>;
+    _balance_change_cents(id: string | GiftCard, triggerValue: number, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<GiftCard>;
     isGiftCard(resource: any): resource is GiftCard;
     relationship(id: string | ResourceId | null): GiftCardRel;
-    type(): string;
+    type(): GiftCardType;
 }
 export default GiftCards;
-export { GiftCard, GiftCardCreate, GiftCardUpdate };
+export type { GiftCard, GiftCardCreate, GiftCardUpdate, GiftCardType };

package/lib/esm/resources/gift_cards.js

@@ -1,20 +1,13 @@
 import { ApiResource } from '../resource';
 class GiftCards extends ApiResource {
-    // static readonly PATH = 'gift_cards'
-    async list(params, options) {
-        return this.resources.list({ type: GiftCards.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: GiftCards.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: GiftCards.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: GiftCards.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: GiftCards.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: GiftCards.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: GiftCards.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: GiftCards.TYPE } : id, options);
     }
     async market(giftCardId, params, options) {
         const _giftCardId = giftCardId.id || giftCardId;
@@ -40,7 +33,18 @@ class GiftCards extends ApiResource {
         const _giftCardId = giftCardId.id || giftCardId;
         return this.resources.fetch({ type: 'versions' }, `gift_cards/${_giftCardId}/versions`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    async _purchase(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: GiftCards.TYPE, _purchase: true }, params, options);
+    }
+    async _activate(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: GiftCards.TYPE, _activate: true }, params, options);
+    }
+    async _deactivate(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: GiftCards.TYPE, _deactivate: true }, params, options);
+    }
+    async _balance_change_cents(id, triggerValue, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: GiftCards.TYPE, _balance_change_cents: triggerValue }, params, options);
+    }
     isGiftCard(resource) {
         return resource.type && (resource.type === GiftCards.TYPE);
     }