@commercelayer/sdk 7.0.0-rc.11 → 7.0.0-rc.13

package/lib/{api-Hgzs8bs4.d.ts → api-C7ddKOtt.d.ts}

@@ -904,6 +904,11 @@ interface AdyenPayment extends Resource {
      * Indicates if the order current amount differs form the one of the associated authorization.
      */
     mismatched_amounts?: boolean | null;
+    /**
+     * The balance remaining on a shopper's gift card, must be computed by using its related trigger attribute.
+     * @example ```1000```
+     */
+    balance?: number | null;
     /**
      * Information about the payment instrument used in the transaction.
      * @example ```{"issuer":"cl bank","card_type":"visa"}```
@@ -937,6 +942,11 @@ interface AdyenPaymentUpdate extends ResourceUpdate {
      * @example ```true```
      */
     _details?: boolean | null;
+    /**
+     * Send this attribute if you want retrieve the balance remaining on a shopper's gift card.
+     * @example ```true```
+     */
+    _balance?: boolean | null;
     order?: OrderRel$k | null;
 }
 declare class AdyenPayments extends ApiResource<AdyenPayment> {
@@ -949,6 +959,7 @@ declare class AdyenPayments extends ApiResource<AdyenPayment> {
     versions(adyenPaymentId: string | AdyenPayment, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     _authorize(id: string | AdyenPayment, params?: QueryParamsRetrieve<AdyenPayment>, options?: ResourcesConfig): Promise<AdyenPayment>;
     _details(id: string | AdyenPayment, params?: QueryParamsRetrieve<AdyenPayment>, options?: ResourcesConfig): Promise<AdyenPayment>;
+    _balance(id: string | AdyenPayment, params?: QueryParamsRetrieve<AdyenPayment>, options?: ResourcesConfig): Promise<AdyenPayment>;
     isAdyenPayment(resource: any): resource is AdyenPayment;
     relationship(id: string | ResourceId | null): AdyenPaymentRel$3;
     relationshipToMany(...ids: string[]): AdyenPaymentRel$3[];
@@ -1177,12 +1188,7 @@ interface CheckoutComPayment extends Resource {
      */
     public_key?: string | null;
     /**
-     * The payment source type.
-     * @example ```"token"```
-     */
-    payment_type: string;
-    /**
-     * The Checkout.com card or digital wallet token.
+     * The Checkout.com payment or digital wallet token.
      * @example ```"tok_4gzeau5o2uqubbk6fufs3m7p54"```
      */
     token: string;
@@ -1236,12 +1242,7 @@ interface CheckoutComPayment extends Resource {
 }
 interface CheckoutComPaymentCreate extends ResourceCreate {
     /**
-     * The payment source type.
-     * @example ```"token"```
-     */
-    payment_type: string;
-    /**
-     * The Checkout.com card or digital wallet token.
+     * The Checkout.com payment or digital wallet token.
      * @example ```"tok_4gzeau5o2uqubbk6fufs3m7p54"```
      */
     token: string;
@@ -1259,12 +1260,7 @@ interface CheckoutComPaymentCreate extends ResourceCreate {
 }
 interface CheckoutComPaymentUpdate extends ResourceUpdate {
     /**
-     * The payment source type.
-     * @example ```"token"```
-     */
-    payment_type?: string | null;
-    /**
-     * The Checkout.com card or digital wallet token.
+     * The Checkout.com payment or digital wallet token.
      * @example ```"tok_4gzeau5o2uqubbk6fufs3m7p54"```
      */
     token?: string | null;
@@ -3972,6 +3968,11 @@ interface ShippingMethod extends Resource {
      * @example ```5```
      */
     circuit_failure_count?: number | null;
+    /**
+     * The shared secret used to sign the external request payload.
+     * @example ```"1c0994cc4e996e8c6ee56a2198f66f3c"```
+     */
+    shared_secret: string;
     market?: Market | null;
     shipping_zone?: ShippingZone | null;
     shipping_category?: ShippingCategory | null;
@@ -5565,6 +5566,11 @@ interface ExternalPromotion extends Resource {
      * @example ```"pending"```
      */
     status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
+    /**
+     * The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.
+     * @example ```112```
+     */
+    weight?: number | null;
     /**
      * Time at which this resource was disabled.
      * @example ```"2018-01-01T12:00:00.000Z"```
@@ -5842,6 +5848,11 @@ interface FixedAmountPromotion extends Resource {
      * @example ```"pending"```
      */
     status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
+    /**
+     * The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.
+     * @example ```112```
+     */
+    weight?: number | null;
     /**
      * Time at which this resource was disabled.
      * @example ```"2018-01-01T12:00:00.000Z"```
@@ -6093,16 +6104,16 @@ interface FlexPromotion extends Resource {
      * @example ```{}```
      */
     rules: Record<string, any>;
+    /**
+     * The rule outcomes.
+     * @example ```[]```
+     */
+    rule_outcomes?: Record<string, any> | null;
     /**
      * Time at which this resource was disabled.
      * @example ```"2018-01-01T12:00:00.000Z"```
      */
     disabled_at?: string | null;
-    /**
-     * The rule outcomes.
-     * @example ```{}```
-     */
-    rule_outcomes?: Record<string, any> | null;
     /**
      * The payload used to evaluate the rules.
      * @example ```{}```
@@ -6341,6 +6352,11 @@ interface FixedPricePromotion extends Resource {
      * @example ```"pending"```
      */
     status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
+    /**
+     * The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.
+     * @example ```112```
+     */
+    weight?: number | null;
     /**
      * Time at which this resource was disabled.
      * @example ```"2018-01-01T12:00:00.000Z"```
@@ -6675,6 +6691,11 @@ interface FreeGiftPromotion extends Resource {
      * @example ```"pending"```
      */
     status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
+    /**
+     * The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.
+     * @example ```112```
+     */
+    weight?: number | null;
     /**
      * Time at which this resource was disabled.
      * @example ```"2018-01-01T12:00:00.000Z"```
@@ -6991,6 +7012,11 @@ interface BuyXPayYPromotion extends Resource {
      * @example ```"pending"```
      */
     status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
+    /**
+     * The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.
+     * @example ```112```
+     */
+    weight?: number | null;
     /**
      * Time at which this resource was disabled.
      * @example ```"2018-01-01T12:00:00.000Z"```
@@ -7369,6 +7395,11 @@ interface FreeShippingPromotion extends Resource {
      * @example ```"pending"```
      */
     status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
+    /**
+     * The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.
+     * @example ```112```
+     */
+    weight?: number | null;
     /**
      * Time at which this resource was disabled.
      * @example ```"2018-01-01T12:00:00.000Z"```
@@ -7701,6 +7732,11 @@ interface PercentageDiscountPromotion extends Resource {
      * @example ```"pending"```
      */
     status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
+    /**
+     * The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.
+     * @example ```112```
+     */
+    weight?: number | null;
     /**
      * Time at which this resource was disabled.
      * @example ```"2018-01-01T12:00:00.000Z"```
@@ -8092,6 +8128,11 @@ interface LineItem extends Resource {
      * @example ```"SUMMERDISCOUNT"```
      */
     coupon_code?: string | null;
+    /**
+     * The rule outcomes.
+     * @example ```[]```
+     */
+    rule_outcomes?: Record<string, any> | null;
     /**
      * The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.
      * @example ```"closed"```
@@ -8937,12 +8978,12 @@ interface CustomerUpdate extends ResourceUpdate {
      */
     _remove_tags?: string | null;
     /**
-     * Send this attribute if you want to trigger anonymization.
+     * Send this attribute if you want to trigger anonymization. Cannot be passed by sales channels.
      * @example ```true```
      */
     _request_anonymization?: boolean | null;
     /**
-     * Send this attribute if you want to trigger a cancellation of anonymization.
+     * Send this attribute if you want to trigger a cancellation of anonymization. Cannot be passed by sales channels.
      * @example ```true```
      */
     _cancel_anonymization?: boolean | null;
@@ -9078,10 +9119,10 @@ interface PaymentOption extends Resource {
      */
     name?: string | null;
     /**
-     * The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'credit_cards', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.
+     * The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.
      * @example ```"stripe_payments"```
      */
-    payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'credit_cards' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
+    payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
     /**
      * The payment options data to be added to the payment source payload. Check payment specific API for more details.
      * @example ```{"application_fee_amount":1000,"on_behalf_of":"pm_xxx"}```
@@ -9097,10 +9138,10 @@ interface PaymentOptionCreate extends ResourceCreate {
      */
     name?: string | null;
     /**
-     * The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'credit_cards', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.
+     * The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.
      * @example ```"stripe_payments"```
      */
-    payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'credit_cards' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
+    payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
     /**
      * The payment options data to be added to the payment source payload. Check payment specific API for more details.
      * @example ```{"application_fee_amount":1000,"on_behalf_of":"pm_xxx"}```
@@ -12240,6 +12281,11 @@ interface Price extends Resource {
      * @example ```"€130,00"```
      */
     formatted_compare_at_amount?: string | null;
+    /**
+     * The rule outcomes.
+     * @example ```[]```
+     */
+    rule_outcomes?: Record<string, any> | null;
     /**
      * Time at which the resource was processed by API.
      * @example ```"2018-01-01T12:00:00.000Z"```
@@ -12250,11 +12296,6 @@ interface Price extends Resource {
      * @example ```{}```
      */
     rules?: Record<string, any> | null;
-    /**
-     * The rule outcomes.
-     * @example ```{}```
-     */
-    rule_outcomes?: Record<string, any> | null;
     /**
      * The payload used to evaluate the rules.
      * @example ```{}```
@@ -12505,15 +12546,15 @@ interface PriceList extends Resource {
      */
     tax_included?: boolean | null;
     /**
-     * The rules (using Rules Engine) to be applied.
-     * @example ```{}```
+     * The rule outcomes.
+     * @example ```[]```
      */
-    rules?: Record<string, any> | null;
+    rule_outcomes?: Record<string, any> | null;
     /**
-     * The rule outcomes.
+     * The rules (using Rules Engine) to be applied.
      * @example ```{}```
      */
-    rule_outcomes?: Record<string, any> | null;
+    rules?: Record<string, any> | null;
     /**
      * The payload used to evaluate the rules.
      * @example ```{}```
@@ -12731,6 +12772,11 @@ interface Promotion extends Resource {
      * @example ```"pending"```
      */
     status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
+    /**
+     * The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.
+     * @example ```112```
+     */
+    weight?: number | null;
     /**
      * Time at which this resource was disabled.
      * @example ```"2018-01-01T12:00:00.000Z"```
@@ -14146,10 +14192,10 @@ interface PaymentMethod extends Resource {
      */
     name?: string | null;
     /**
-     * The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'credit_cards', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.
+     * The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.
      * @example ```"stripe_payments"```
      */
-    payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'credit_cards' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
+    payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
     /**
      * The international 3-letter currency code as defined by the ISO 4217 standard.
      * @example ```"EUR"```
@@ -14217,10 +14263,10 @@ interface PaymentMethodCreate extends ResourceCreate {
      */
     name?: string | null;
     /**
-     * The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'credit_cards', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.
+     * The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.
      * @example ```"stripe_payments"```
      */
-    payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'credit_cards' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
+    payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
     /**
      * The international 3-letter currency code as defined by the ISO 4217 standard.
      * @example ```"EUR"```
@@ -14273,10 +14319,10 @@ interface PaymentMethodUpdate extends ResourceUpdate {
      */
     name?: string | null;
     /**
-     * The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'credit_cards', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.
+     * The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.
      * @example ```"stripe_payments"```
      */
-    payment_source_type?: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'credit_cards' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers' | null;
+    payment_source_type?: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers' | null;
     /**
      * The international 3-letter currency code as defined by the ISO 4217 standard.
      * @example ```"EUR"```
@@ -14529,7 +14575,7 @@ interface Application extends Resource {
      * The application's kind. One of 'sales_channel', 'integration', or 'webapp'.
      * @example ```"sales-channel"```
      */
-    kind?: 'dashboard' | 'user' | 'metrics' | 'contentful' | 'bundles' | 'customers' | 'datocms' | 'exports' | 'external' | 'gift_cards' | 'imports' | 'integration' | 'inventory' | 'orders' | 'price_lists' | 'promotions' | 'resources' | 'returns' | 'sales_channel' | 'sanity' | 'shipments' | 'skus' | 'sku_lists' | 'stock_transfers' | 'subscriptions' | 'tags' | 'webapp' | 'webhooks' | 'zapier' | null;
+    kind?: 'dashboard' | 'user' | 'metrics' | 'contentful' | 'bundles' | 'customers' | 'datocms' | 'exports' | 'external' | 'generic' | 'gift_cards' | 'imports' | 'integration' | 'inventory' | 'orders' | 'price_lists' | 'promotions' | 'resources' | 'returns' | 'sales_channel' | 'sanity' | 'shipments' | 'skus' | 'sku_lists' | 'stock_transfers' | 'subscriptions' | 'tags' | 'webapp' | 'webhooks' | 'zapier' | null;
     /**
      * Indicates if the application has public access.
      * @example ```true```
@@ -15955,7 +16001,11 @@ interface Organization extends Resource {
      */
     addresses_phone_required?: boolean | null;
     /**
-     * The minimum lapse in fraction of seconds to be observed between two consecutive order refreshes. If refresh is triggered within the minimum lapse, the update is performed, but no order refresh is done, until the lapse is observed.
+     * The minimum lapse in fraction of seconds to be observed between two consecutive shipments rebuilt. If shipments rebuilt is triggered within the minimum lapse, the update is performed, but no rebuilt is done.
+     */
+    orders_min_rebuild_shipments_lapse?: number | null;
+    /**
+     * The minimum lapse in fraction of seconds to be observed between two consecutive order refreshes. If refresh is triggered within the minimum lapse, the update is performed, but no order refresh is done.
      */
     orders_min_refresh_lapse?: number | null;
     /**
@@ -15986,6 +16036,11 @@ interface Organization extends Resource {
      * @example ```true```
      */
     orders_invalid_coupon_errors?: boolean | null;
+    /**
+     * Enables raising of API errors in case the provided gift card code is invalid, default is true.
+     * @example ```true```
+     */
+    orders_invalid_gift_card_errors?: boolean | null;
     /**
      * The maximum number of SKUs allowed for bundles, default is 10.
      * @example ```10```
@@ -16001,6 +16056,10 @@ interface Organization extends Resource {
      * @example ```40```
      */
     coupons_max_code_length?: number | null;
+    /**
+     * Enables matching the gift card code by its exact value, instead of by its first charachters, default is false.
+     */
+    gift_cards_exact_code_matching?: boolean | null;
     /**
      * The minimum length for gift card code, default is 8.
      * @example ```8```
@@ -16035,6 +16094,11 @@ interface Organization extends Resource {
      * Disables the interruption of the import in case its errors exceeds the 10% threshold, default is false.
      */
     imports_skip_errors?: boolean | null;
+    /**
+     * The maximum number for stock locations cutoff, default is 10.
+     * @example ```10```
+     */
+    inventory_models_max_stock_locations_cutoff?: number | null;
     /**
      * The maximum number of active concurrent promotions allowed for your organization, default is 10.
      * @example ```10```
@@ -16383,6 +16447,10 @@ interface TalonOneAccountCreate extends ResourceCreate {
      * @example ```"Personal discount engine"```
      */
     name: string;
+    /**
+     * Indicates if the discount engine manages both promotions and gift cards application at once.
+     */
+    manage_gift_cards?: boolean | null;
     /**
      * The Talon.One account API key.
      * @example ```"TALON_ONE_API_KEY"```
@@ -16400,6 +16468,10 @@ interface TalonOneAccountUpdate extends ResourceUpdate {
      * @example ```"Personal discount engine"```
      */
     name?: string | null;
+    /**
+     * Indicates if the discount engine manages both promotions and gift cards application at once.
+     */
+    manage_gift_cards?: boolean | null;
     /**
      * The Talon.One account API key.
      * @example ```"TALON_ONE_API_KEY"```