@commercelayer/sdk 4.33.0 → 4.35.0

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

@@ -1,45 +1,47 @@
-import { ApiResource } from '../resource';
-import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
-import type { QueryParamsRetrieve } from '../query';
-import type { Order, OrderType } from './orders';
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import type { Order } from './orders';
 import type { PaymentGateway } from './payment_gateways';
 import type { CustomerPaymentSource } from './customer_payment_sources';
-type ExternalPaymentType = 'external_payments';
+import type { Version } from './versions';
 type ExternalPaymentRel = ResourceRel & {
-    type: ExternalPaymentType;
+    type: typeof ExternalPayments.TYPE;
 };
 type OrderRel = ResourceRel & {
-    type: OrderType;
+    type: 'orders';
 };
 interface ExternalPayment extends Resource {
-    readonly type: ExternalPaymentType;
-    payment_source_token: string;
-    options?: Record<string, any> | null;
-    payment_instrument?: Record<string, any> | null;
-    order?: Order | null;
-    payment_gateway?: PaymentGateway | null;
-    wallet?: CustomerPaymentSource | null;
+    payment_source_token?: string;
+    options?: object;
+    payment_instrument?: object;
+    order?: Order;
+    payment_gateway?: PaymentGateway;
+    wallet?: CustomerPaymentSource;
+    versions?: Version[];
 }
 interface ExternalPaymentCreate extends ResourceCreate {
     payment_source_token: string;
-    options?: Record<string, any> | null;
+    options?: object;
     order: OrderRel;
 }
 interface ExternalPaymentUpdate extends ResourceUpdate {
-    options?: Record<string, any> | null;
-    order?: OrderRel | null;
+    options?: object;
+    order?: OrderRel;
 }
-declare class ExternalPayments extends ApiResource<ExternalPayment> {
-    static readonly TYPE: ExternalPaymentType;
+declare class ExternalPayments extends ApiResource {
+    static readonly TYPE: 'external_payments';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ExternalPayment>>;
     create(resource: ExternalPaymentCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalPayment>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalPayment>;
     update(resource: ExternalPaymentUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalPayment>;
-    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    delete(id: string, options?: ResourcesConfig): Promise<void>;
     order(externalPaymentId: string | ExternalPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
     payment_gateway(externalPaymentId: string | ExternalPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentGateway>;
     wallet(externalPaymentId: string | ExternalPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CustomerPaymentSource>;
+    versions(externalPaymentId: string | ExternalPayment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isExternalPayment(resource: any): resource is ExternalPayment;
     relationship(id: string | ResourceId | null): ExternalPaymentRel;
-    type(): ExternalPaymentType;
+    type(): string;
 }
 export default ExternalPayments;
-export type { ExternalPayment, ExternalPaymentCreate, ExternalPaymentUpdate, ExternalPaymentType };
+export { ExternalPayment, ExternalPaymentCreate, ExternalPaymentUpdate };

package/lib/cjs/resources/external_payments.js

@@ -2,14 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class ExternalPayments extends resource_1.ApiResource {
+    // static readonly PATH = 'external_payments'
+    async list(params, options) {
+        return this.resources.list({ type: ExternalPayments.TYPE }, params, options);
+    }
     async create(resource, params, options) {
-        return this.resources.create({ ...resource, type: ExternalPayments.TYPE }, params, options);
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: ExternalPayments.TYPE }), params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: ExternalPayments.TYPE, id }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update({ ...resource, type: ExternalPayments.TYPE }, params, options);
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ExternalPayments.TYPE }), params, options);
     }
     async delete(id, options) {
-        await this.resources.delete((typeof id === 'string') ? { id, type: ExternalPayments.TYPE } : id, options);
+        await this.resources.delete({ type: ExternalPayments.TYPE, id }, options);
     }
     async order(externalPaymentId, params, options) {
         const _externalPaymentId = externalPaymentId.id || externalPaymentId;
@@ -23,6 +30,11 @@ class ExternalPayments extends resource_1.ApiResource {
         const _externalPaymentId = externalPaymentId.id || externalPaymentId;
         return this.resources.fetch({ type: 'customer_payment_sources' }, `external_payments/${_externalPaymentId}/wallet`, params, options);
     }
+    async versions(externalPaymentId, params, options) {
+        const _externalPaymentId = externalPaymentId.id || externalPaymentId;
+        return this.resources.fetch({ type: 'versions' }, `external_payments/${_externalPaymentId}/versions`, params, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isExternalPayment(resource) {
         return resource.type && (resource.type === ExternalPayments.TYPE);
     }

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

@@ -1,102 +1,112 @@
-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 { 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 type { SkuList } from './sku_lists';
 import type { Attachment } from './attachments';
 import type { Event } from './events';
-import type { Tag, TagType } from './tags';
-type ExternalPromotionType = 'external_promotions';
+import type { Tag } from './tags';
+import type { Version } from './versions';
 type ExternalPromotionRel = ResourceRel & {
-    type: ExternalPromotionType;
+    type: typeof ExternalPromotions.TYPE;
 };
 type MarketRel = ResourceRel & {
-    type: MarketType;
+    type: 'markets';
 };
 type PromotionRuleRel = ResourceRel & {
-    type: PromotionRuleType;
+    type: 'promotion_rules';
 };
 type OrderAmountPromotionRuleRel = ResourceRel & {
-    type: OrderAmountPromotionRuleType;
+    type: 'order_amount_promotion_rules';
 };
 type SkuListPromotionRuleRel = ResourceRel & {
-    type: SkuListPromotionRuleType;
+    type: 'sku_list_promotion_rules';
 };
 type CouponCodesPromotionRuleRel = ResourceRel & {
-    type: CouponCodesPromotionRuleType;
+    type: 'coupon_codes_promotion_rules';
+};
+type CouponRel = ResourceRel & {
+    type: 'coupons';
 };
 type TagRel = ResourceRel & {
-    type: TagType;
+    type: 'tags';
 };
 interface ExternalPromotion extends Resource {
-    readonly type: ExternalPromotionType;
-    name: string;
-    currency_code?: string | null;
-    starts_at: string;
-    expires_at: string;
-    total_usage_limit: number;
-    total_usage_count?: number | null;
-    active?: boolean | null;
-    promotion_url: string;
-    shared_secret: string;
-    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;
-    sku_list?: SkuList | null;
-    attachments?: Attachment[] | null;
-    events?: Event[] | null;
-    tags?: Tag[] | null;
+    name?: string;
+    currency_code?: string;
+    starts_at?: string;
+    expires_at?: string;
+    total_usage_limit?: number;
+    total_usage_count?: number;
+    active?: boolean;
+    promotion_url?: string;
+    shared_secret?: 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[];
 }
 interface ExternalPromotionCreate extends ResourceCreate {
     name: string;
-    currency_code?: string | null;
+    currency_code?: string;
     starts_at: string;
     expires_at: string;
     total_usage_limit: number;
     promotion_url: string;
-    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;
-    tags?: TagRel[] | null;
+    market?: MarketRel;
+    promotion_rules?: PromotionRuleRel[];
+    order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
+    sku_list_promotion_rule?: SkuListPromotionRuleRel;
+    coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
+    coupons?: CouponRel[];
+    tags?: TagRel[];
 }
 interface ExternalPromotionUpdate extends ResourceUpdate {
-    name?: string | null;
-    currency_code?: string | null;
-    starts_at?: string | null;
-    expires_at?: string | null;
-    total_usage_limit?: number | null;
-    promotion_url?: string | 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;
-    tags?: TagRel[] | null;
+    name?: string;
+    currency_code?: string;
+    starts_at?: string;
+    expires_at?: string;
+    total_usage_limit?: number;
+    promotion_url?: string;
+    market?: MarketRel;
+    promotion_rules?: PromotionRuleRel[];
+    order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
+    sku_list_promotion_rule?: SkuListPromotionRuleRel;
+    coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
+    coupons?: CouponRel[];
+    tags?: TagRel[];
 }
-declare class ExternalPromotions extends ApiResource<ExternalPromotion> {
-    static readonly TYPE: ExternalPromotionType;
+declare class ExternalPromotions extends ApiResource {
+    static readonly TYPE: 'external_promotions';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ExternalPromotion>>;
     create(resource: ExternalPromotionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalPromotion>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalPromotion>;
     update(resource: ExternalPromotionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalPromotion>;
-    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    delete(id: string, options?: ResourcesConfig): Promise<void>;
     market(externalPromotionId: string | ExternalPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
     order_amount_promotion_rule(externalPromotionId: string | ExternalPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderAmountPromotionRule>;
     sku_list_promotion_rule(externalPromotionId: string | ExternalPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
     coupon_codes_promotion_rule(externalPromotionId: string | ExternalPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
+    coupons(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Coupon>>;
     sku_list(externalPromotionId: string | ExternalPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuList>;
     attachments(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     events(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     tags(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
+    versions(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isExternalPromotion(resource: any): resource is ExternalPromotion;
     relationship(id: string | ResourceId | null): ExternalPromotionRel;
-    type(): ExternalPromotionType;
+    type(): string;
 }
 export default ExternalPromotions;
-export type { ExternalPromotion, ExternalPromotionCreate, ExternalPromotionUpdate, ExternalPromotionType };
+export { ExternalPromotion, ExternalPromotionCreate, ExternalPromotionUpdate };

package/lib/cjs/resources/external_promotions.js

@@ -2,14 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class ExternalPromotions extends resource_1.ApiResource {
+    // static readonly PATH = 'external_promotions'
+    async list(params, options) {
+        return this.resources.list({ type: ExternalPromotions.TYPE }, params, options);
+    }
     async create(resource, params, options) {
-        return this.resources.create({ ...resource, type: ExternalPromotions.TYPE }, params, options);
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: ExternalPromotions.TYPE }), params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: ExternalPromotions.TYPE, id }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update({ ...resource, type: ExternalPromotions.TYPE }, params, options);
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ExternalPromotions.TYPE }), params, options);
     }
     async delete(id, options) {
-        await this.resources.delete((typeof id === 'string') ? { id, type: ExternalPromotions.TYPE } : id, options);
+        await this.resources.delete({ type: ExternalPromotions.TYPE, id }, options);
     }
     async market(externalPromotionId, params, options) {
         const _externalPromotionId = externalPromotionId.id || externalPromotionId;
@@ -27,6 +34,10 @@ class ExternalPromotions extends resource_1.ApiResource {
         const _externalPromotionId = externalPromotionId.id || externalPromotionId;
         return this.resources.fetch({ type: 'coupon_codes_promotion_rules' }, `external_promotions/${_externalPromotionId}/coupon_codes_promotion_rule`, params, options);
     }
+    async coupons(externalPromotionId, params, options) {
+        const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+        return this.resources.fetch({ type: 'coupons' }, `external_promotions/${_externalPromotionId}/coupons`, params, options);
+    }
     async sku_list(externalPromotionId, params, options) {
         const _externalPromotionId = externalPromotionId.id || externalPromotionId;
         return this.resources.fetch({ type: 'sku_lists' }, `external_promotions/${_externalPromotionId}/sku_list`, params, options);
@@ -43,6 +54,11 @@ class ExternalPromotions extends resource_1.ApiResource {
         const _externalPromotionId = externalPromotionId.id || externalPromotionId;
         return this.resources.fetch({ type: 'tags' }, `external_promotions/${_externalPromotionId}/tags`, params, options);
     }
+    async versions(externalPromotionId, params, options) {
+        const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+        return this.resources.fetch({ type: 'versions' }, `external_promotions/${_externalPromotionId}/versions`, params, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isExternalPromotion(resource) {
         return resource.type && (resource.type === ExternalPromotions.TYPE);
     }

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

@@ -1,38 +1,40 @@
-import { ApiResource } from '../resource';
-import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList, QueryParamsRetrieve } from '../query';
 import type { Market } from './markets';
 import type { Attachment } from './attachments';
-type ExternalTaxCalculatorType = 'external_tax_calculators';
+import type { Version } from './versions';
 type ExternalTaxCalculatorRel = ResourceRel & {
-    type: ExternalTaxCalculatorType;
+    type: typeof ExternalTaxCalculators.TYPE;
 };
 interface ExternalTaxCalculator extends Resource {
-    readonly type: ExternalTaxCalculatorType;
-    name: string;
-    tax_calculator_url: string;
-    shared_secret: string;
-    markets?: Market[] | null;
-    attachments?: Attachment[] | null;
+    name?: string;
+    tax_calculator_url?: string;
+    shared_secret?: string;
+    markets?: Market[];
+    attachments?: Attachment[];
+    versions?: Version[];
 }
 interface ExternalTaxCalculatorCreate extends ResourceCreate {
     name: string;
     tax_calculator_url: string;
 }
 interface ExternalTaxCalculatorUpdate extends ResourceUpdate {
-    name?: string | null;
-    tax_calculator_url?: string | null;
+    name?: string;
+    tax_calculator_url?: string;
 }
-declare class ExternalTaxCalculators extends ApiResource<ExternalTaxCalculator> {
-    static readonly TYPE: ExternalTaxCalculatorType;
+declare class ExternalTaxCalculators extends ApiResource {
+    static readonly TYPE: 'external_tax_calculators';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ExternalTaxCalculator>>;
     create(resource: ExternalTaxCalculatorCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalTaxCalculator>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalTaxCalculator>;
     update(resource: ExternalTaxCalculatorUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalTaxCalculator>;
-    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    delete(id: string, options?: ResourcesConfig): Promise<void>;
     markets(externalTaxCalculatorId: string | ExternalTaxCalculator, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Market>>;
     attachments(externalTaxCalculatorId: string | ExternalTaxCalculator, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    versions(externalTaxCalculatorId: string | ExternalTaxCalculator, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isExternalTaxCalculator(resource: any): resource is ExternalTaxCalculator;
     relationship(id: string | ResourceId | null): ExternalTaxCalculatorRel;
-    type(): ExternalTaxCalculatorType;
+    type(): string;
 }
 export default ExternalTaxCalculators;
-export type { ExternalTaxCalculator, ExternalTaxCalculatorCreate, ExternalTaxCalculatorUpdate, ExternalTaxCalculatorType };
+export { ExternalTaxCalculator, ExternalTaxCalculatorCreate, ExternalTaxCalculatorUpdate };

package/lib/cjs/resources/external_tax_calculators.js

@@ -2,14 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class ExternalTaxCalculators extends resource_1.ApiResource {
+    // static readonly PATH = 'external_tax_calculators'
+    async list(params, options) {
+        return this.resources.list({ type: ExternalTaxCalculators.TYPE }, params, options);
+    }
     async create(resource, params, options) {
-        return this.resources.create({ ...resource, type: ExternalTaxCalculators.TYPE }, params, options);
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: ExternalTaxCalculators.TYPE }), params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: ExternalTaxCalculators.TYPE, id }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update({ ...resource, type: ExternalTaxCalculators.TYPE }, params, options);
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ExternalTaxCalculators.TYPE }), params, options);
     }
     async delete(id, options) {
-        await this.resources.delete((typeof id === 'string') ? { id, type: ExternalTaxCalculators.TYPE } : id, options);
+        await this.resources.delete({ type: ExternalTaxCalculators.TYPE, id }, options);
     }
     async markets(externalTaxCalculatorId, params, options) {
         const _externalTaxCalculatorId = externalTaxCalculatorId.id || externalTaxCalculatorId;
@@ -19,6 +26,11 @@ class ExternalTaxCalculators extends resource_1.ApiResource {
         const _externalTaxCalculatorId = externalTaxCalculatorId.id || externalTaxCalculatorId;
         return this.resources.fetch({ type: 'attachments' }, `external_tax_calculators/${_externalTaxCalculatorId}/attachments`, params, options);
     }
+    async versions(externalTaxCalculatorId, params, options) {
+        const _externalTaxCalculatorId = externalTaxCalculatorId.id || externalTaxCalculatorId;
+        return this.resources.fetch({ type: 'versions' }, `external_tax_calculators/${_externalTaxCalculatorId}/versions`, params, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isExternalTaxCalculator(resource) {
         return resource.type && (resource.type === ExternalTaxCalculators.TYPE);
     }

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

@@ -1,103 +1,113 @@
-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 { 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 type { SkuList } from './sku_lists';
 import type { Attachment } from './attachments';
 import type { Event } from './events';
-import type { Tag, TagType } from './tags';
-type FixedAmountPromotionType = 'fixed_amount_promotions';
+import type { Tag } from './tags';
+import type { Version } from './versions';
 type FixedAmountPromotionRel = ResourceRel & {
-    type: FixedAmountPromotionType;
+    type: typeof FixedAmountPromotions.TYPE;
 };
 type MarketRel = ResourceRel & {
-    type: MarketType;
+    type: 'markets';
 };
 type PromotionRuleRel = ResourceRel & {
-    type: PromotionRuleType;
+    type: 'promotion_rules';
 };
 type OrderAmountPromotionRuleRel = ResourceRel & {
-    type: OrderAmountPromotionRuleType;
+    type: 'order_amount_promotion_rules';
 };
 type SkuListPromotionRuleRel = ResourceRel & {
-    type: SkuListPromotionRuleType;
+    type: 'sku_list_promotion_rules';
 };
 type CouponCodesPromotionRuleRel = ResourceRel & {
-    type: CouponCodesPromotionRuleType;
+    type: 'coupon_codes_promotion_rules';
+};
+type CouponRel = ResourceRel & {
+    type: 'coupons';
 };
 type TagRel = ResourceRel & {
-    type: TagType;
+    type: 'tags';
 };
 interface FixedAmountPromotion extends Resource {
-    readonly type: FixedAmountPromotionType;
-    name: string;
-    currency_code?: string | null;
-    starts_at: string;
-    expires_at: string;
-    total_usage_limit: number;
-    total_usage_count?: number | null;
-    active?: boolean | null;
-    fixed_amount_cents: number;
-    fixed_amount_float?: number | null;
-    formatted_fixed_amount?: 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;
-    sku_list?: SkuList | null;
-    attachments?: Attachment[] | null;
-    events?: Event[] | null;
-    tags?: Tag[] | null;
+    name?: string;
+    currency_code?: string;
+    starts_at?: string;
+    expires_at?: string;
+    total_usage_limit?: number;
+    total_usage_count?: number;
+    active?: boolean;
+    fixed_amount_cents?: number;
+    fixed_amount_float?: number;
+    formatted_fixed_amount?: 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[];
 }
 interface FixedAmountPromotionCreate extends ResourceCreate {
     name: string;
-    currency_code?: string | null;
+    currency_code?: string;
     starts_at: string;
     expires_at: string;
     total_usage_limit: number;
     fixed_amount_cents: number;
-    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;
-    tags?: TagRel[] | null;
+    market?: MarketRel;
+    promotion_rules?: PromotionRuleRel[];
+    order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
+    sku_list_promotion_rule?: SkuListPromotionRuleRel;
+    coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
+    coupons?: CouponRel[];
+    tags?: TagRel[];
 }
 interface FixedAmountPromotionUpdate extends ResourceUpdate {
-    name?: string | null;
-    currency_code?: string | null;
-    starts_at?: string | null;
-    expires_at?: string | null;
-    total_usage_limit?: number | null;
-    fixed_amount_cents?: number | 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;
-    tags?: TagRel[] | null;
+    name?: string;
+    currency_code?: string;
+    starts_at?: string;
+    expires_at?: string;
+    total_usage_limit?: number;
+    fixed_amount_cents?: number;
+    market?: MarketRel;
+    promotion_rules?: PromotionRuleRel[];
+    order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
+    sku_list_promotion_rule?: SkuListPromotionRuleRel;
+    coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
+    coupons?: CouponRel[];
+    tags?: TagRel[];
 }
-declare class FixedAmountPromotions extends ApiResource<FixedAmountPromotion> {
-    static readonly TYPE: FixedAmountPromotionType;
+declare class FixedAmountPromotions extends ApiResource {
+    static readonly TYPE: 'fixed_amount_promotions';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<FixedAmountPromotion>>;
     create(resource: FixedAmountPromotionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FixedAmountPromotion>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FixedAmountPromotion>;
     update(resource: FixedAmountPromotionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FixedAmountPromotion>;
-    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    delete(id: string, options?: ResourcesConfig): Promise<void>;
     market(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
     order_amount_promotion_rule(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderAmountPromotionRule>;
     sku_list_promotion_rule(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
     coupon_codes_promotion_rule(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
+    coupons(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Coupon>>;
     sku_list(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuList>;
     attachments(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     events(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     tags(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
+    versions(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isFixedAmountPromotion(resource: any): resource is FixedAmountPromotion;
     relationship(id: string | ResourceId | null): FixedAmountPromotionRel;
-    type(): FixedAmountPromotionType;
+    type(): string;
 }
 export default FixedAmountPromotions;
-export type { FixedAmountPromotion, FixedAmountPromotionCreate, FixedAmountPromotionUpdate, FixedAmountPromotionType };
+export { FixedAmountPromotion, FixedAmountPromotionCreate, FixedAmountPromotionUpdate };