@commercelayer/sdk 6.12.0 → 6.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.d.mts +91 -34
- package/lib/index.d.ts +91 -34
- package/lib/index.js +1 -1
- package/lib/index.mjs +1 -1
- package/package.json +4 -4
package/lib/index.d.mts
CHANGED
@@ -57,7 +57,7 @@ type RequestConfig = {
|
|
57
57
|
refreshToken?: RefreshToken;
|
58
58
|
};
|
59
59
|
type ApiConfig = {
|
60
|
-
organization
|
60
|
+
organization?: string;
|
61
61
|
domain?: string;
|
62
62
|
accessToken: string;
|
63
63
|
};
|
@@ -935,11 +935,11 @@ type MarketRel$j = ResourceRel & {
|
|
935
935
|
type PaymentGatewayRel = ResourceRel & {
|
936
936
|
type: PaymentGatewayType;
|
937
937
|
};
|
938
|
-
type PaymentMethodSort = Pick<PaymentMethod, 'id' | 'payment_source_type' | 'currency_code' | 'price_amount_cents' | 'disabled_at'> & ResourceSort;
|
938
|
+
type PaymentMethodSort = Pick<PaymentMethod, 'id' | 'name' | 'payment_source_type' | 'currency_code' | 'price_amount_cents' | 'disabled_at'> & ResourceSort;
|
939
939
|
interface PaymentMethod extends Resource {
|
940
940
|
readonly type: PaymentMethodType;
|
941
941
|
/**
|
942
|
-
*
|
942
|
+
* The payment method's internal name.
|
943
943
|
* @example ```"Stripe Payment"```
|
944
944
|
*/
|
945
945
|
name?: string | null;
|
@@ -1008,6 +1008,11 @@ interface PaymentMethod extends Resource {
|
|
1008
1008
|
versions?: Version[] | null;
|
1009
1009
|
}
|
1010
1010
|
interface PaymentMethodCreate extends ResourceCreate {
|
1011
|
+
/**
|
1012
|
+
* The payment method's internal name.
|
1013
|
+
* @example ```"Stripe Payment"```
|
1014
|
+
*/
|
1015
|
+
name?: string | null;
|
1011
1016
|
/**
|
1012
1017
|
* 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'.
|
1013
1018
|
* @example ```"stripe_payments"```
|
@@ -1058,6 +1063,11 @@ interface PaymentMethodCreate extends ResourceCreate {
|
|
1058
1063
|
payment_gateway: PaymentGatewayRel;
|
1059
1064
|
}
|
1060
1065
|
interface PaymentMethodUpdate extends ResourceUpdate {
|
1066
|
+
/**
|
1067
|
+
* The payment method's internal name.
|
1068
|
+
* @example ```"Stripe Payment"```
|
1069
|
+
*/
|
1070
|
+
name?: string | null;
|
1061
1071
|
/**
|
1062
1072
|
* 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'.
|
1063
1073
|
* @example ```"stripe_payments"```
|
@@ -3763,10 +3773,10 @@ interface Link extends Resource {
|
|
3763
3773
|
*/
|
3764
3774
|
active?: boolean | null;
|
3765
3775
|
/**
|
3766
|
-
* The link status. One of '
|
3776
|
+
* The link status. One of 'disabled', 'expired', 'pending', or 'active'.
|
3767
3777
|
* @example ```"pending"```
|
3768
3778
|
*/
|
3769
|
-
status?: '
|
3779
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | null;
|
3770
3780
|
/**
|
3771
3781
|
* The link URL second level domain.
|
3772
3782
|
* @example ```"commercelayer.link"```
|
@@ -4942,10 +4952,10 @@ interface ExternalPromotion extends Resource {
|
|
4942
4952
|
*/
|
4943
4953
|
active?: boolean | null;
|
4944
4954
|
/**
|
4945
|
-
* The promotion status. One of '
|
4955
|
+
* The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.
|
4946
4956
|
* @example ```"pending"```
|
4947
4957
|
*/
|
4948
|
-
status?: '
|
4958
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
4949
4959
|
/**
|
4950
4960
|
* Time at which this resource was disabled.
|
4951
4961
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -5208,10 +5218,10 @@ interface FixedAmountPromotion extends Resource {
|
|
5208
5218
|
*/
|
5209
5219
|
active?: boolean | null;
|
5210
5220
|
/**
|
5211
|
-
* The promotion status. One of '
|
5221
|
+
* The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.
|
5212
5222
|
* @example ```"pending"```
|
5213
5223
|
*/
|
5214
|
-
status?: '
|
5224
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
5215
5225
|
/**
|
5216
5226
|
* Time at which this resource was disabled.
|
5217
5227
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -5482,10 +5492,10 @@ interface FixedPricePromotion extends Resource {
|
|
5482
5492
|
*/
|
5483
5493
|
active?: boolean | null;
|
5484
5494
|
/**
|
5485
|
-
* The promotion status. One of '
|
5495
|
+
* The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.
|
5486
5496
|
* @example ```"pending"```
|
5487
5497
|
*/
|
5488
|
-
status?: '
|
5498
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
5489
5499
|
/**
|
5490
5500
|
* Time at which this resource was disabled.
|
5491
5501
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -5801,10 +5811,10 @@ interface FreeGiftPromotion extends Resource {
|
|
5801
5811
|
*/
|
5802
5812
|
active?: boolean | null;
|
5803
5813
|
/**
|
5804
|
-
* The promotion status. One of '
|
5814
|
+
* The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.
|
5805
5815
|
* @example ```"pending"```
|
5806
5816
|
*/
|
5807
|
-
status?: '
|
5817
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
5808
5818
|
/**
|
5809
5819
|
* Time at which this resource was disabled.
|
5810
5820
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -6102,10 +6112,10 @@ interface BuyXPayYPromotion extends Resource {
|
|
6102
6112
|
*/
|
6103
6113
|
active?: boolean | null;
|
6104
6114
|
/**
|
6105
|
-
* The promotion status. One of '
|
6115
|
+
* The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.
|
6106
6116
|
* @example ```"pending"```
|
6107
6117
|
*/
|
6108
|
-
status?: '
|
6118
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
6109
6119
|
/**
|
6110
6120
|
* Time at which this resource was disabled.
|
6111
6121
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -6465,10 +6475,10 @@ interface FreeShippingPromotion extends Resource {
|
|
6465
6475
|
*/
|
6466
6476
|
active?: boolean | null;
|
6467
6477
|
/**
|
6468
|
-
* The promotion status. One of '
|
6478
|
+
* The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.
|
6469
6479
|
* @example ```"pending"```
|
6470
6480
|
*/
|
6471
|
-
status?: '
|
6481
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
6472
6482
|
/**
|
6473
6483
|
* Time at which this resource was disabled.
|
6474
6484
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -6782,10 +6792,10 @@ interface PercentageDiscountPromotion extends Resource {
|
|
6782
6792
|
*/
|
6783
6793
|
active?: boolean | null;
|
6784
6794
|
/**
|
6785
|
-
* The promotion status. One of '
|
6795
|
+
* The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.
|
6786
6796
|
* @example ```"pending"```
|
6787
6797
|
*/
|
6788
|
-
status?: '
|
6798
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
6789
6799
|
/**
|
6790
6800
|
* Time at which this resource was disabled.
|
6791
6801
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -11671,10 +11681,10 @@ interface PriceListScheduler extends Resource {
|
|
11671
11681
|
*/
|
11672
11682
|
active?: boolean | null;
|
11673
11683
|
/**
|
11674
|
-
* The price list scheduler status. One of '
|
11684
|
+
* The price list scheduler status. One of 'disabled', 'expired', 'pending', or 'active'.
|
11675
11685
|
* @example ```"pending"```
|
11676
11686
|
*/
|
11677
|
-
status?: '
|
11687
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | null;
|
11678
11688
|
/**
|
11679
11689
|
* Time at which this resource was disabled.
|
11680
11690
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -11982,10 +11992,10 @@ interface Promotion extends Resource {
|
|
11982
11992
|
*/
|
11983
11993
|
active?: boolean | null;
|
11984
11994
|
/**
|
11985
|
-
* The promotion status. One of '
|
11995
|
+
* The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.
|
11986
11996
|
* @example ```"pending"```
|
11987
11997
|
*/
|
11988
|
-
status?: '
|
11998
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
11989
11999
|
/**
|
11990
12000
|
* Time at which this resource was disabled.
|
11991
12001
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -12089,6 +12099,7 @@ interface AvalaraAccount extends Resource {
|
|
12089
12099
|
attachments?: Attachment[] | null;
|
12090
12100
|
versions?: Version[] | null;
|
12091
12101
|
tax_categories?: TaxCategory[] | null;
|
12102
|
+
events?: Event[] | null;
|
12092
12103
|
}
|
12093
12104
|
interface AvalaraAccountCreate extends ResourceCreate {
|
12094
12105
|
/**
|
@@ -12165,6 +12176,7 @@ declare class AvalaraAccounts extends ApiResource<AvalaraAccount> {
|
|
12165
12176
|
attachments(avalaraAccountId: string | AvalaraAccount, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
12166
12177
|
versions(avalaraAccountId: string | AvalaraAccount, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
12167
12178
|
tax_categories(avalaraAccountId: string | AvalaraAccount, params?: QueryParamsList<TaxCategory>, options?: ResourcesConfig): Promise<ListResponse<TaxCategory>>;
|
12179
|
+
events(avalaraAccountId: string | AvalaraAccount, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
12168
12180
|
isAvalaraAccount(resource: any): resource is AvalaraAccount;
|
12169
12181
|
relationship(id: string | ResourceId | null): AvalaraAccountRel$2;
|
12170
12182
|
relationshipToMany(...ids: string[]): AvalaraAccountRel$2[];
|
@@ -12954,6 +12966,11 @@ interface Market extends Resource {
|
|
12954
12966
|
* @example ```"true"```
|
12955
12967
|
*/
|
12956
12968
|
private?: boolean | null;
|
12969
|
+
/**
|
12970
|
+
* When specified indicates the maximum number of shipping line items with cost that will be added to an order.
|
12971
|
+
* @example ```"3"```
|
12972
|
+
*/
|
12973
|
+
shipping_cost_cutoff?: number | null;
|
12957
12974
|
/**
|
12958
12975
|
* Time at which this resource was disabled.
|
12959
12976
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -13006,6 +13023,11 @@ interface MarketCreate extends ResourceCreate {
|
|
13006
13023
|
* @example ```"https://external_validation.yourbrand.com"```
|
13007
13024
|
*/
|
13008
13025
|
external_order_validation_url?: string | null;
|
13026
|
+
/**
|
13027
|
+
* When specified indicates the maximum number of shipping line items with cost that will be added to an order.
|
13028
|
+
* @example ```"3"```
|
13029
|
+
*/
|
13030
|
+
shipping_cost_cutoff?: number | null;
|
13009
13031
|
/**
|
13010
13032
|
* Send this attribute if you want to mark this resource as disabled.
|
13011
13033
|
* @example ```"true"```
|
@@ -13055,6 +13077,11 @@ interface MarketUpdate extends ResourceUpdate {
|
|
13055
13077
|
* @example ```"https://external_validation.yourbrand.com"```
|
13056
13078
|
*/
|
13057
13079
|
external_order_validation_url?: string | null;
|
13080
|
+
/**
|
13081
|
+
* When specified indicates the maximum number of shipping line items with cost that will be added to an order.
|
13082
|
+
* @example ```"3"```
|
13083
|
+
*/
|
13084
|
+
shipping_cost_cutoff?: number | null;
|
13058
13085
|
/**
|
13059
13086
|
* Send this attribute if you want to mark this resource as disabled.
|
13060
13087
|
* @example ```"true"```
|
@@ -14868,33 +14895,63 @@ interface Organization extends Resource {
|
|
14868
14895
|
*/
|
14869
14896
|
gtm_id_test?: string | null;
|
14870
14897
|
/**
|
14871
|
-
*
|
14898
|
+
* Indicates if the phone attribute is required for addresses, default is true.
|
14899
|
+
* @example ```"true"```
|
14900
|
+
*/
|
14901
|
+
addresses_phone_required?: boolean | null;
|
14902
|
+
/**
|
14903
|
+
* The maximum number of SKUs allowed for bundles, default is 10.
|
14872
14904
|
* @example ```"10"```
|
14873
14905
|
*/
|
14874
|
-
|
14906
|
+
bundles_max_items_count?: number | null;
|
14907
|
+
/**
|
14908
|
+
* The minimum length for coupon code, default is 8.
|
14909
|
+
* @example ```"8"```
|
14910
|
+
*/
|
14911
|
+
coupons_min_code_length?: number | null;
|
14875
14912
|
/**
|
14876
|
-
* The maximum
|
14913
|
+
* The maximum length for coupon code, default is 40.
|
14914
|
+
* @example ```"40"```
|
14915
|
+
*/
|
14916
|
+
coupons_max_code_length?: number | null;
|
14917
|
+
/**
|
14918
|
+
* The maximum number of active concurrent promotions allowed for your organization, default is 10.
|
14877
14919
|
* @example ```"10"```
|
14878
14920
|
*/
|
14879
|
-
|
14921
|
+
promotions_max_concurrent_count?: number | null;
|
14880
14922
|
/**
|
14881
|
-
* The maximum number of concurrent
|
14923
|
+
* The maximum number of concurrent imports allowed for your organization, default is 10.
|
14882
14924
|
* @example ```"10"```
|
14883
14925
|
*/
|
14884
|
-
|
14926
|
+
imports_max_concurrent_count?: number | null;
|
14885
14927
|
/**
|
14886
|
-
* The maximum number of concurrent
|
14928
|
+
* The maximum number of concurrent exports allowed for your organization, default is 10.
|
14887
14929
|
* @example ```"10"```
|
14888
14930
|
*/
|
14889
|
-
|
14931
|
+
exports_max_concurrent_count?: number | null;
|
14932
|
+
/**
|
14933
|
+
* The maximum number of concurrent cleanups allowed for your organization, default is 10.
|
14934
|
+
* @example ```"10"```
|
14935
|
+
*/
|
14936
|
+
cleanups_max_concurrent_count?: number | null;
|
14890
14937
|
/**
|
14891
14938
|
* Enables orders number editing as a string in test (for enterprise plans only).
|
14892
14939
|
*/
|
14893
|
-
|
14940
|
+
orders_number_editable_test?: boolean | null;
|
14894
14941
|
/**
|
14895
14942
|
* Enables orders number editing as a string in live (for enterprise plans only).
|
14896
14943
|
*/
|
14897
|
-
|
14944
|
+
orders_number_editable_live?: boolean | null;
|
14945
|
+
/**
|
14946
|
+
* Enables raising of API errors in case of tax calculation failure, default is false.
|
14947
|
+
* @example ```"true"```
|
14948
|
+
*/
|
14949
|
+
tax_calculators_errors?: boolean | null;
|
14950
|
+
/**
|
14951
|
+
* Enables raising of API errors in case of external promotion failure, default is false.
|
14952
|
+
* @example ```"true"```
|
14953
|
+
*/
|
14954
|
+
external_promotions_errors?: boolean | null;
|
14898
14955
|
/**
|
14899
14956
|
* The organization's configuration.
|
14900
14957
|
* @example ```"[object Object]"```
|
@@ -15449,7 +15506,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
|
|
15449
15506
|
type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
|
15450
15507
|
declare class CommerceLayerClient {
|
15451
15508
|
#private;
|
15452
|
-
readonly openApiSchemaVersion = "6.
|
15509
|
+
readonly openApiSchemaVersion = "6.3.0";
|
15453
15510
|
constructor(config: CommerceLayerInitConfig);
|
15454
15511
|
get addresses(): Addresses;
|
15455
15512
|
get adjustments(): Adjustments;
|
package/lib/index.d.ts
CHANGED
@@ -57,7 +57,7 @@ type RequestConfig = {
|
|
57
57
|
refreshToken?: RefreshToken;
|
58
58
|
};
|
59
59
|
type ApiConfig = {
|
60
|
-
organization
|
60
|
+
organization?: string;
|
61
61
|
domain?: string;
|
62
62
|
accessToken: string;
|
63
63
|
};
|
@@ -935,11 +935,11 @@ type MarketRel$j = ResourceRel & {
|
|
935
935
|
type PaymentGatewayRel = ResourceRel & {
|
936
936
|
type: PaymentGatewayType;
|
937
937
|
};
|
938
|
-
type PaymentMethodSort = Pick<PaymentMethod, 'id' | 'payment_source_type' | 'currency_code' | 'price_amount_cents' | 'disabled_at'> & ResourceSort;
|
938
|
+
type PaymentMethodSort = Pick<PaymentMethod, 'id' | 'name' | 'payment_source_type' | 'currency_code' | 'price_amount_cents' | 'disabled_at'> & ResourceSort;
|
939
939
|
interface PaymentMethod extends Resource {
|
940
940
|
readonly type: PaymentMethodType;
|
941
941
|
/**
|
942
|
-
*
|
942
|
+
* The payment method's internal name.
|
943
943
|
* @example ```"Stripe Payment"```
|
944
944
|
*/
|
945
945
|
name?: string | null;
|
@@ -1008,6 +1008,11 @@ interface PaymentMethod extends Resource {
|
|
1008
1008
|
versions?: Version[] | null;
|
1009
1009
|
}
|
1010
1010
|
interface PaymentMethodCreate extends ResourceCreate {
|
1011
|
+
/**
|
1012
|
+
* The payment method's internal name.
|
1013
|
+
* @example ```"Stripe Payment"```
|
1014
|
+
*/
|
1015
|
+
name?: string | null;
|
1011
1016
|
/**
|
1012
1017
|
* 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'.
|
1013
1018
|
* @example ```"stripe_payments"```
|
@@ -1058,6 +1063,11 @@ interface PaymentMethodCreate extends ResourceCreate {
|
|
1058
1063
|
payment_gateway: PaymentGatewayRel;
|
1059
1064
|
}
|
1060
1065
|
interface PaymentMethodUpdate extends ResourceUpdate {
|
1066
|
+
/**
|
1067
|
+
* The payment method's internal name.
|
1068
|
+
* @example ```"Stripe Payment"```
|
1069
|
+
*/
|
1070
|
+
name?: string | null;
|
1061
1071
|
/**
|
1062
1072
|
* 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'.
|
1063
1073
|
* @example ```"stripe_payments"```
|
@@ -3763,10 +3773,10 @@ interface Link extends Resource {
|
|
3763
3773
|
*/
|
3764
3774
|
active?: boolean | null;
|
3765
3775
|
/**
|
3766
|
-
* The link status. One of '
|
3776
|
+
* The link status. One of 'disabled', 'expired', 'pending', or 'active'.
|
3767
3777
|
* @example ```"pending"```
|
3768
3778
|
*/
|
3769
|
-
status?: '
|
3779
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | null;
|
3770
3780
|
/**
|
3771
3781
|
* The link URL second level domain.
|
3772
3782
|
* @example ```"commercelayer.link"```
|
@@ -4942,10 +4952,10 @@ interface ExternalPromotion extends Resource {
|
|
4942
4952
|
*/
|
4943
4953
|
active?: boolean | null;
|
4944
4954
|
/**
|
4945
|
-
* The promotion status. One of '
|
4955
|
+
* The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.
|
4946
4956
|
* @example ```"pending"```
|
4947
4957
|
*/
|
4948
|
-
status?: '
|
4958
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
4949
4959
|
/**
|
4950
4960
|
* Time at which this resource was disabled.
|
4951
4961
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -5208,10 +5218,10 @@ interface FixedAmountPromotion extends Resource {
|
|
5208
5218
|
*/
|
5209
5219
|
active?: boolean | null;
|
5210
5220
|
/**
|
5211
|
-
* The promotion status. One of '
|
5221
|
+
* The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.
|
5212
5222
|
* @example ```"pending"```
|
5213
5223
|
*/
|
5214
|
-
status?: '
|
5224
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
5215
5225
|
/**
|
5216
5226
|
* Time at which this resource was disabled.
|
5217
5227
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -5482,10 +5492,10 @@ interface FixedPricePromotion extends Resource {
|
|
5482
5492
|
*/
|
5483
5493
|
active?: boolean | null;
|
5484
5494
|
/**
|
5485
|
-
* The promotion status. One of '
|
5495
|
+
* The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.
|
5486
5496
|
* @example ```"pending"```
|
5487
5497
|
*/
|
5488
|
-
status?: '
|
5498
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
5489
5499
|
/**
|
5490
5500
|
* Time at which this resource was disabled.
|
5491
5501
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -5801,10 +5811,10 @@ interface FreeGiftPromotion extends Resource {
|
|
5801
5811
|
*/
|
5802
5812
|
active?: boolean | null;
|
5803
5813
|
/**
|
5804
|
-
* The promotion status. One of '
|
5814
|
+
* The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.
|
5805
5815
|
* @example ```"pending"```
|
5806
5816
|
*/
|
5807
|
-
status?: '
|
5817
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
5808
5818
|
/**
|
5809
5819
|
* Time at which this resource was disabled.
|
5810
5820
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -6102,10 +6112,10 @@ interface BuyXPayYPromotion extends Resource {
|
|
6102
6112
|
*/
|
6103
6113
|
active?: boolean | null;
|
6104
6114
|
/**
|
6105
|
-
* The promotion status. One of '
|
6115
|
+
* The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.
|
6106
6116
|
* @example ```"pending"```
|
6107
6117
|
*/
|
6108
|
-
status?: '
|
6118
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
6109
6119
|
/**
|
6110
6120
|
* Time at which this resource was disabled.
|
6111
6121
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -6465,10 +6475,10 @@ interface FreeShippingPromotion extends Resource {
|
|
6465
6475
|
*/
|
6466
6476
|
active?: boolean | null;
|
6467
6477
|
/**
|
6468
|
-
* The promotion status. One of '
|
6478
|
+
* The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.
|
6469
6479
|
* @example ```"pending"```
|
6470
6480
|
*/
|
6471
|
-
status?: '
|
6481
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
6472
6482
|
/**
|
6473
6483
|
* Time at which this resource was disabled.
|
6474
6484
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -6782,10 +6792,10 @@ interface PercentageDiscountPromotion extends Resource {
|
|
6782
6792
|
*/
|
6783
6793
|
active?: boolean | null;
|
6784
6794
|
/**
|
6785
|
-
* The promotion status. One of '
|
6795
|
+
* The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.
|
6786
6796
|
* @example ```"pending"```
|
6787
6797
|
*/
|
6788
|
-
status?: '
|
6798
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
6789
6799
|
/**
|
6790
6800
|
* Time at which this resource was disabled.
|
6791
6801
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -11671,10 +11681,10 @@ interface PriceListScheduler extends Resource {
|
|
11671
11681
|
*/
|
11672
11682
|
active?: boolean | null;
|
11673
11683
|
/**
|
11674
|
-
* The price list scheduler status. One of '
|
11684
|
+
* The price list scheduler status. One of 'disabled', 'expired', 'pending', or 'active'.
|
11675
11685
|
* @example ```"pending"```
|
11676
11686
|
*/
|
11677
|
-
status?: '
|
11687
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | null;
|
11678
11688
|
/**
|
11679
11689
|
* Time at which this resource was disabled.
|
11680
11690
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -11982,10 +11992,10 @@ interface Promotion extends Resource {
|
|
11982
11992
|
*/
|
11983
11993
|
active?: boolean | null;
|
11984
11994
|
/**
|
11985
|
-
* The promotion status. One of '
|
11995
|
+
* The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.
|
11986
11996
|
* @example ```"pending"```
|
11987
11997
|
*/
|
11988
|
-
status?: '
|
11998
|
+
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
11989
11999
|
/**
|
11990
12000
|
* Time at which this resource was disabled.
|
11991
12001
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -12089,6 +12099,7 @@ interface AvalaraAccount extends Resource {
|
|
12089
12099
|
attachments?: Attachment[] | null;
|
12090
12100
|
versions?: Version[] | null;
|
12091
12101
|
tax_categories?: TaxCategory[] | null;
|
12102
|
+
events?: Event[] | null;
|
12092
12103
|
}
|
12093
12104
|
interface AvalaraAccountCreate extends ResourceCreate {
|
12094
12105
|
/**
|
@@ -12165,6 +12176,7 @@ declare class AvalaraAccounts extends ApiResource<AvalaraAccount> {
|
|
12165
12176
|
attachments(avalaraAccountId: string | AvalaraAccount, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
12166
12177
|
versions(avalaraAccountId: string | AvalaraAccount, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
12167
12178
|
tax_categories(avalaraAccountId: string | AvalaraAccount, params?: QueryParamsList<TaxCategory>, options?: ResourcesConfig): Promise<ListResponse<TaxCategory>>;
|
12179
|
+
events(avalaraAccountId: string | AvalaraAccount, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
12168
12180
|
isAvalaraAccount(resource: any): resource is AvalaraAccount;
|
12169
12181
|
relationship(id: string | ResourceId | null): AvalaraAccountRel$2;
|
12170
12182
|
relationshipToMany(...ids: string[]): AvalaraAccountRel$2[];
|
@@ -12954,6 +12966,11 @@ interface Market extends Resource {
|
|
12954
12966
|
* @example ```"true"```
|
12955
12967
|
*/
|
12956
12968
|
private?: boolean | null;
|
12969
|
+
/**
|
12970
|
+
* When specified indicates the maximum number of shipping line items with cost that will be added to an order.
|
12971
|
+
* @example ```"3"```
|
12972
|
+
*/
|
12973
|
+
shipping_cost_cutoff?: number | null;
|
12957
12974
|
/**
|
12958
12975
|
* Time at which this resource was disabled.
|
12959
12976
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -13006,6 +13023,11 @@ interface MarketCreate extends ResourceCreate {
|
|
13006
13023
|
* @example ```"https://external_validation.yourbrand.com"```
|
13007
13024
|
*/
|
13008
13025
|
external_order_validation_url?: string | null;
|
13026
|
+
/**
|
13027
|
+
* When specified indicates the maximum number of shipping line items with cost that will be added to an order.
|
13028
|
+
* @example ```"3"```
|
13029
|
+
*/
|
13030
|
+
shipping_cost_cutoff?: number | null;
|
13009
13031
|
/**
|
13010
13032
|
* Send this attribute if you want to mark this resource as disabled.
|
13011
13033
|
* @example ```"true"```
|
@@ -13055,6 +13077,11 @@ interface MarketUpdate extends ResourceUpdate {
|
|
13055
13077
|
* @example ```"https://external_validation.yourbrand.com"```
|
13056
13078
|
*/
|
13057
13079
|
external_order_validation_url?: string | null;
|
13080
|
+
/**
|
13081
|
+
* When specified indicates the maximum number of shipping line items with cost that will be added to an order.
|
13082
|
+
* @example ```"3"```
|
13083
|
+
*/
|
13084
|
+
shipping_cost_cutoff?: number | null;
|
13058
13085
|
/**
|
13059
13086
|
* Send this attribute if you want to mark this resource as disabled.
|
13060
13087
|
* @example ```"true"```
|
@@ -14868,33 +14895,63 @@ interface Organization extends Resource {
|
|
14868
14895
|
*/
|
14869
14896
|
gtm_id_test?: string | null;
|
14870
14897
|
/**
|
14871
|
-
*
|
14898
|
+
* Indicates if the phone attribute is required for addresses, default is true.
|
14899
|
+
* @example ```"true"```
|
14900
|
+
*/
|
14901
|
+
addresses_phone_required?: boolean | null;
|
14902
|
+
/**
|
14903
|
+
* The maximum number of SKUs allowed for bundles, default is 10.
|
14872
14904
|
* @example ```"10"```
|
14873
14905
|
*/
|
14874
|
-
|
14906
|
+
bundles_max_items_count?: number | null;
|
14907
|
+
/**
|
14908
|
+
* The minimum length for coupon code, default is 8.
|
14909
|
+
* @example ```"8"```
|
14910
|
+
*/
|
14911
|
+
coupons_min_code_length?: number | null;
|
14875
14912
|
/**
|
14876
|
-
* The maximum
|
14913
|
+
* The maximum length for coupon code, default is 40.
|
14914
|
+
* @example ```"40"```
|
14915
|
+
*/
|
14916
|
+
coupons_max_code_length?: number | null;
|
14917
|
+
/**
|
14918
|
+
* The maximum number of active concurrent promotions allowed for your organization, default is 10.
|
14877
14919
|
* @example ```"10"```
|
14878
14920
|
*/
|
14879
|
-
|
14921
|
+
promotions_max_concurrent_count?: number | null;
|
14880
14922
|
/**
|
14881
|
-
* The maximum number of concurrent
|
14923
|
+
* The maximum number of concurrent imports allowed for your organization, default is 10.
|
14882
14924
|
* @example ```"10"```
|
14883
14925
|
*/
|
14884
|
-
|
14926
|
+
imports_max_concurrent_count?: number | null;
|
14885
14927
|
/**
|
14886
|
-
* The maximum number of concurrent
|
14928
|
+
* The maximum number of concurrent exports allowed for your organization, default is 10.
|
14887
14929
|
* @example ```"10"```
|
14888
14930
|
*/
|
14889
|
-
|
14931
|
+
exports_max_concurrent_count?: number | null;
|
14932
|
+
/**
|
14933
|
+
* The maximum number of concurrent cleanups allowed for your organization, default is 10.
|
14934
|
+
* @example ```"10"```
|
14935
|
+
*/
|
14936
|
+
cleanups_max_concurrent_count?: number | null;
|
14890
14937
|
/**
|
14891
14938
|
* Enables orders number editing as a string in test (for enterprise plans only).
|
14892
14939
|
*/
|
14893
|
-
|
14940
|
+
orders_number_editable_test?: boolean | null;
|
14894
14941
|
/**
|
14895
14942
|
* Enables orders number editing as a string in live (for enterprise plans only).
|
14896
14943
|
*/
|
14897
|
-
|
14944
|
+
orders_number_editable_live?: boolean | null;
|
14945
|
+
/**
|
14946
|
+
* Enables raising of API errors in case of tax calculation failure, default is false.
|
14947
|
+
* @example ```"true"```
|
14948
|
+
*/
|
14949
|
+
tax_calculators_errors?: boolean | null;
|
14950
|
+
/**
|
14951
|
+
* Enables raising of API errors in case of external promotion failure, default is false.
|
14952
|
+
* @example ```"true"```
|
14953
|
+
*/
|
14954
|
+
external_promotions_errors?: boolean | null;
|
14898
14955
|
/**
|
14899
14956
|
* The organization's configuration.
|
14900
14957
|
* @example ```"[object Object]"```
|
@@ -15449,7 +15506,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
|
|
15449
15506
|
type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
|
15450
15507
|
declare class CommerceLayerClient {
|
15451
15508
|
#private;
|
15452
|
-
readonly openApiSchemaVersion = "6.
|
15509
|
+
readonly openApiSchemaVersion = "6.3.0";
|
15453
15510
|
constructor(config: CommerceLayerInitConfig);
|
15454
15511
|
get addresses(): Addresses;
|
15455
15512
|
get adjustments(): Adjustments;
|