@wix/auto_sdk_ecom_orders 1.0.31 → 1.0.32
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/build/cjs/src/ecom-v1-order-orders.context.d.ts +1 -1
- package/build/cjs/src/ecom-v1-order-orders.meta.d.ts +22 -22
- package/build/cjs/src/ecom-v1-order-orders.meta.js.map +1 -1
- package/build/cjs/src/ecom-v1-order-orders.public.d.ts +13 -13
- package/build/cjs/src/ecom-v1-order-orders.public.js.map +1 -1
- package/build/cjs/src/ecom-v1-order-orders.types.d.ts +0 -513
- package/build/cjs/src/ecom-v1-order-orders.universal.d.ts +19 -512
- package/build/cjs/src/ecom-v1-order-orders.universal.js.map +1 -1
- package/build/es/src/ecom-v1-order-orders.context.d.ts +1 -1
- package/build/es/src/ecom-v1-order-orders.meta.d.ts +22 -22
- package/build/es/src/ecom-v1-order-orders.meta.js.map +1 -1
- package/build/es/src/ecom-v1-order-orders.public.d.ts +13 -13
- package/build/es/src/ecom-v1-order-orders.public.js.map +1 -1
- package/build/es/src/ecom-v1-order-orders.types.d.ts +0 -513
- package/build/es/src/ecom-v1-order-orders.universal.d.ts +19 -512
- package/build/es/src/ecom-v1-order-orders.universal.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.context.d.ts +1 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.meta.d.ts +22 -22
- package/build/internal/cjs/src/ecom-v1-order-orders.meta.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.public.d.ts +24 -24
- package/build/internal/cjs/src/ecom-v1-order-orders.public.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.types.d.ts +0 -735
- package/build/internal/cjs/src/ecom-v1-order-orders.universal.d.ts +48 -747
- package/build/internal/cjs/src/ecom-v1-order-orders.universal.js.map +1 -1
- package/build/internal/es/src/ecom-v1-order-orders.context.d.ts +1 -1
- package/build/internal/es/src/ecom-v1-order-orders.meta.d.ts +22 -22
- package/build/internal/es/src/ecom-v1-order-orders.meta.js.map +1 -1
- package/build/internal/es/src/ecom-v1-order-orders.public.d.ts +24 -24
- package/build/internal/es/src/ecom-v1-order-orders.public.js.map +1 -1
- package/build/internal/es/src/ecom-v1-order-orders.types.d.ts +0 -735
- package/build/internal/es/src/ecom-v1-order-orders.universal.d.ts +48 -747
- package/build/internal/es/src/ecom-v1-order-orders.universal.js.map +1 -1
- package/package.json +3 -3
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
1
2
|
export interface Order {
|
|
2
3
|
/**
|
|
3
4
|
* Order ID.
|
|
@@ -6070,507 +6071,6 @@ export interface TriggerSideEffectsFromLegacyData {
|
|
|
6070
6071
|
orderId?: string;
|
|
6071
6072
|
ordersExperiments?: OrdersExperiments;
|
|
6072
6073
|
}
|
|
6073
|
-
export interface PreparePaymentCollectionResponseNonNullableFields {
|
|
6074
|
-
paymentGatewayOrderId: string;
|
|
6075
|
-
}
|
|
6076
|
-
interface PriceNonNullableFields {
|
|
6077
|
-
amount: string;
|
|
6078
|
-
formattedAmount: string;
|
|
6079
|
-
}
|
|
6080
|
-
export interface GetPaymentCollectabilityStatusResponseNonNullableFields {
|
|
6081
|
-
status: PaymentCollectabilityStatus;
|
|
6082
|
-
amount?: PriceNonNullableFields;
|
|
6083
|
-
}
|
|
6084
|
-
interface ProductNameNonNullableFields {
|
|
6085
|
-
original: string;
|
|
6086
|
-
}
|
|
6087
|
-
interface CatalogReferenceNonNullableFields {
|
|
6088
|
-
catalogItemId: string;
|
|
6089
|
-
appId: string;
|
|
6090
|
-
}
|
|
6091
|
-
interface PlainTextValueNonNullableFields {
|
|
6092
|
-
original: string;
|
|
6093
|
-
}
|
|
6094
|
-
interface ColorNonNullableFields {
|
|
6095
|
-
original: string;
|
|
6096
|
-
}
|
|
6097
|
-
interface DescriptionLineNameNonNullableFields {
|
|
6098
|
-
original: string;
|
|
6099
|
-
}
|
|
6100
|
-
interface DescriptionLineNonNullableFields {
|
|
6101
|
-
plainText?: PlainTextValueNonNullableFields;
|
|
6102
|
-
colorInfo?: ColorNonNullableFields;
|
|
6103
|
-
plainTextValue?: PlainTextValueNonNullableFields;
|
|
6104
|
-
color: string;
|
|
6105
|
-
name?: DescriptionLineNameNonNullableFields;
|
|
6106
|
-
lineType: DescriptionLineType;
|
|
6107
|
-
}
|
|
6108
|
-
interface PhysicalPropertiesNonNullableFields {
|
|
6109
|
-
shippable: boolean;
|
|
6110
|
-
}
|
|
6111
|
-
interface ItemTypeNonNullableFields {
|
|
6112
|
-
preset: ItemTypeItemType;
|
|
6113
|
-
custom: string;
|
|
6114
|
-
}
|
|
6115
|
-
interface ItemTaxFullDetailsNonNullableFields {
|
|
6116
|
-
taxableAmount?: PriceNonNullableFields;
|
|
6117
|
-
taxRate: string;
|
|
6118
|
-
totalTax?: PriceNonNullableFields;
|
|
6119
|
-
}
|
|
6120
|
-
interface LineItemTaxBreakdownNonNullableFields {
|
|
6121
|
-
taxAmount?: PriceNonNullableFields;
|
|
6122
|
-
jurisdictionType: JurisdictionType;
|
|
6123
|
-
nonTaxableAmount?: PriceNonNullableFields;
|
|
6124
|
-
taxableAmount?: PriceNonNullableFields;
|
|
6125
|
-
}
|
|
6126
|
-
interface LineItemTaxInfoNonNullableFields {
|
|
6127
|
-
taxAmount?: PriceNonNullableFields;
|
|
6128
|
-
taxableAmount?: PriceNonNullableFields;
|
|
6129
|
-
taxIncludedInPrice: boolean;
|
|
6130
|
-
taxBreakdown: LineItemTaxBreakdownNonNullableFields[];
|
|
6131
|
-
}
|
|
6132
|
-
interface DigitalFileNonNullableFields {
|
|
6133
|
-
fileId: string;
|
|
6134
|
-
}
|
|
6135
|
-
interface SubscriptionSettingsNonNullableFields {
|
|
6136
|
-
frequency: SubscriptionFrequency;
|
|
6137
|
-
autoRenewal: boolean;
|
|
6138
|
-
}
|
|
6139
|
-
interface SubscriptionInfoNonNullableFields {
|
|
6140
|
-
cycleNumber: number;
|
|
6141
|
-
subscriptionOptionTitle: string;
|
|
6142
|
-
subscriptionSettings?: SubscriptionSettingsNonNullableFields;
|
|
6143
|
-
}
|
|
6144
|
-
interface PriceDescriptionNonNullableFields {
|
|
6145
|
-
original: string;
|
|
6146
|
-
}
|
|
6147
|
-
interface LocationAndQuantityNonNullableFields {
|
|
6148
|
-
_id: string;
|
|
6149
|
-
quantity: number;
|
|
6150
|
-
}
|
|
6151
|
-
interface OrderLineItemNonNullableFields {
|
|
6152
|
-
_id: string;
|
|
6153
|
-
productName?: ProductNameNonNullableFields;
|
|
6154
|
-
catalogReference?: CatalogReferenceNonNullableFields;
|
|
6155
|
-
quantity: number;
|
|
6156
|
-
totalDiscount?: PriceNonNullableFields;
|
|
6157
|
-
descriptionLines: DescriptionLineNonNullableFields[];
|
|
6158
|
-
image: string;
|
|
6159
|
-
physicalProperties?: PhysicalPropertiesNonNullableFields;
|
|
6160
|
-
itemType?: ItemTypeNonNullableFields;
|
|
6161
|
-
price?: PriceNonNullableFields;
|
|
6162
|
-
priceBeforeDiscounts?: PriceNonNullableFields;
|
|
6163
|
-
totalPriceBeforeTax?: PriceNonNullableFields;
|
|
6164
|
-
totalPriceAfterTax?: PriceNonNullableFields;
|
|
6165
|
-
paymentOption: PaymentOptionType;
|
|
6166
|
-
taxDetails?: ItemTaxFullDetailsNonNullableFields;
|
|
6167
|
-
taxInfo?: LineItemTaxInfoNonNullableFields;
|
|
6168
|
-
digitalFile?: DigitalFileNonNullableFields;
|
|
6169
|
-
subscriptionInfo?: SubscriptionInfoNonNullableFields;
|
|
6170
|
-
priceDescription?: PriceDescriptionNonNullableFields;
|
|
6171
|
-
depositAmount?: PriceNonNullableFields;
|
|
6172
|
-
locations: LocationAndQuantityNonNullableFields[];
|
|
6173
|
-
lineItemPrice?: PriceNonNullableFields;
|
|
6174
|
-
}
|
|
6175
|
-
interface BuyerInfoNonNullableFields {
|
|
6176
|
-
visitorId: string;
|
|
6177
|
-
memberId: string;
|
|
6178
|
-
}
|
|
6179
|
-
interface PriceSummaryNonNullableFields {
|
|
6180
|
-
subtotal?: PriceNonNullableFields;
|
|
6181
|
-
shipping?: PriceNonNullableFields;
|
|
6182
|
-
tax?: PriceNonNullableFields;
|
|
6183
|
-
discount?: PriceNonNullableFields;
|
|
6184
|
-
totalPrice?: PriceNonNullableFields;
|
|
6185
|
-
total?: PriceNonNullableFields;
|
|
6186
|
-
totalWithGiftCard?: PriceNonNullableFields;
|
|
6187
|
-
totalWithoutGiftCard?: PriceNonNullableFields;
|
|
6188
|
-
totalAdditionalFees?: PriceNonNullableFields;
|
|
6189
|
-
}
|
|
6190
|
-
interface StreetAddressNonNullableFields {
|
|
6191
|
-
number: string;
|
|
6192
|
-
name: string;
|
|
6193
|
-
apt: string;
|
|
6194
|
-
}
|
|
6195
|
-
interface AddressNonNullableFields {
|
|
6196
|
-
streetAddress?: StreetAddressNonNullableFields;
|
|
6197
|
-
}
|
|
6198
|
-
interface VatIdNonNullableFields {
|
|
6199
|
-
_id: string;
|
|
6200
|
-
type: VatType;
|
|
6201
|
-
}
|
|
6202
|
-
interface FullAddressContactDetailsNonNullableFields {
|
|
6203
|
-
vatId?: VatIdNonNullableFields;
|
|
6204
|
-
}
|
|
6205
|
-
interface AddressWithContactNonNullableFields {
|
|
6206
|
-
address?: AddressNonNullableFields;
|
|
6207
|
-
contactDetails?: FullAddressContactDetailsNonNullableFields;
|
|
6208
|
-
}
|
|
6209
|
-
interface PickupAddressNonNullableFields {
|
|
6210
|
-
streetAddress?: StreetAddressNonNullableFields;
|
|
6211
|
-
}
|
|
6212
|
-
interface PickupDetailsNonNullableFields {
|
|
6213
|
-
address?: PickupAddressNonNullableFields;
|
|
6214
|
-
pickupMethod: PickupMethod;
|
|
6215
|
-
}
|
|
6216
|
-
interface DeliveryLogisticsNonNullableFields {
|
|
6217
|
-
shippingDestination?: AddressWithContactNonNullableFields;
|
|
6218
|
-
pickupDetails?: PickupDetailsNonNullableFields;
|
|
6219
|
-
}
|
|
6220
|
-
interface ShippingPriceNonNullableFields {
|
|
6221
|
-
price?: PriceNonNullableFields;
|
|
6222
|
-
totalPriceBeforeTax?: PriceNonNullableFields;
|
|
6223
|
-
totalPriceAfterTax?: PriceNonNullableFields;
|
|
6224
|
-
taxDetails?: ItemTaxFullDetailsNonNullableFields;
|
|
6225
|
-
discount?: PriceNonNullableFields;
|
|
6226
|
-
}
|
|
6227
|
-
interface V1ShippingInformationNonNullableFields {
|
|
6228
|
-
title: string;
|
|
6229
|
-
logistics?: DeliveryLogisticsNonNullableFields;
|
|
6230
|
-
cost?: ShippingPriceNonNullableFields;
|
|
6231
|
-
}
|
|
6232
|
-
interface TaxSummaryNonNullableFields {
|
|
6233
|
-
totalTax?: PriceNonNullableFields;
|
|
6234
|
-
}
|
|
6235
|
-
interface OrderTaxBreakdownNonNullableFields {
|
|
6236
|
-
taxName: string;
|
|
6237
|
-
taxType: string;
|
|
6238
|
-
jurisdiction: string;
|
|
6239
|
-
jurisdictionType: JurisdictionType;
|
|
6240
|
-
rate: string;
|
|
6241
|
-
aggregatedTaxAmount?: PriceNonNullableFields;
|
|
6242
|
-
aggregatedTaxableAmount?: PriceNonNullableFields;
|
|
6243
|
-
}
|
|
6244
|
-
interface OrderTaxInfoNonNullableFields {
|
|
6245
|
-
totalTax?: PriceNonNullableFields;
|
|
6246
|
-
taxBreakdown: OrderTaxBreakdownNonNullableFields[];
|
|
6247
|
-
}
|
|
6248
|
-
interface CouponNonNullableFields {
|
|
6249
|
-
_id: string;
|
|
6250
|
-
code: string;
|
|
6251
|
-
name: string;
|
|
6252
|
-
amount?: PriceNonNullableFields;
|
|
6253
|
-
}
|
|
6254
|
-
interface MerchantDiscountNonNullableFields {
|
|
6255
|
-
discountReason: DiscountReason;
|
|
6256
|
-
amount?: PriceNonNullableFields;
|
|
6257
|
-
}
|
|
6258
|
-
interface DiscountRuleNameNonNullableFields {
|
|
6259
|
-
original: string;
|
|
6260
|
-
}
|
|
6261
|
-
interface DiscountRuleNonNullableFields {
|
|
6262
|
-
_id: string;
|
|
6263
|
-
name?: DiscountRuleNameNonNullableFields;
|
|
6264
|
-
amount?: PriceNonNullableFields;
|
|
6265
|
-
}
|
|
6266
|
-
interface AppliedDiscountNonNullableFields {
|
|
6267
|
-
coupon?: CouponNonNullableFields;
|
|
6268
|
-
merchantDiscount?: MerchantDiscountNonNullableFields;
|
|
6269
|
-
discountRule?: DiscountRuleNonNullableFields;
|
|
6270
|
-
discountType: DiscountType;
|
|
6271
|
-
lineItemIds: string[];
|
|
6272
|
-
}
|
|
6273
|
-
interface CustomActivityNonNullableFields {
|
|
6274
|
-
appId: string;
|
|
6275
|
-
type: string;
|
|
6276
|
-
}
|
|
6277
|
-
interface MerchantCommentNonNullableFields {
|
|
6278
|
-
message: string;
|
|
6279
|
-
}
|
|
6280
|
-
interface OrderRefundedNonNullableFields {
|
|
6281
|
-
manual: boolean;
|
|
6282
|
-
amount?: PriceNonNullableFields;
|
|
6283
|
-
reason: string;
|
|
6284
|
-
}
|
|
6285
|
-
interface OrderCreatedFromExchangeNonNullableFields {
|
|
6286
|
-
originalOrderId: string;
|
|
6287
|
-
}
|
|
6288
|
-
interface LineItemExchangeDataNonNullableFields {
|
|
6289
|
-
lineItemId: string;
|
|
6290
|
-
quantity: number;
|
|
6291
|
-
}
|
|
6292
|
-
interface NewExchangeOrderCreatedNonNullableFields {
|
|
6293
|
-
exchangeOrderId: string;
|
|
6294
|
-
lineItems: LineItemExchangeDataNonNullableFields[];
|
|
6295
|
-
}
|
|
6296
|
-
interface ActivityNonNullableFields {
|
|
6297
|
-
customActivity?: CustomActivityNonNullableFields;
|
|
6298
|
-
merchantComment?: MerchantCommentNonNullableFields;
|
|
6299
|
-
orderRefunded?: OrderRefundedNonNullableFields;
|
|
6300
|
-
orderCreatedFromExchange?: OrderCreatedFromExchangeNonNullableFields;
|
|
6301
|
-
newExchangeOrderCreated?: NewExchangeOrderCreatedNonNullableFields;
|
|
6302
|
-
type: ActivityType;
|
|
6303
|
-
}
|
|
6304
|
-
interface CreatedByNonNullableFields {
|
|
6305
|
-
userId: string;
|
|
6306
|
-
memberId: string;
|
|
6307
|
-
visitorId: string;
|
|
6308
|
-
appId: string;
|
|
6309
|
-
}
|
|
6310
|
-
interface ChannelInfoNonNullableFields {
|
|
6311
|
-
type: ChannelType;
|
|
6312
|
-
}
|
|
6313
|
-
interface CustomFieldNonNullableFields {
|
|
6314
|
-
title: string;
|
|
6315
|
-
}
|
|
6316
|
-
interface BalanceNonNullableFields {
|
|
6317
|
-
amount: string;
|
|
6318
|
-
formattedAmount: string;
|
|
6319
|
-
}
|
|
6320
|
-
interface BalanceSummaryNonNullableFields {
|
|
6321
|
-
balance?: BalanceNonNullableFields;
|
|
6322
|
-
paid?: PriceNonNullableFields;
|
|
6323
|
-
refunded?: PriceNonNullableFields;
|
|
6324
|
-
authorized?: PriceNonNullableFields;
|
|
6325
|
-
pending?: PriceNonNullableFields;
|
|
6326
|
-
}
|
|
6327
|
-
interface AdditionalFeeNonNullableFields {
|
|
6328
|
-
name: string;
|
|
6329
|
-
price?: PriceNonNullableFields;
|
|
6330
|
-
taxDetails?: ItemTaxFullDetailsNonNullableFields;
|
|
6331
|
-
priceBeforeTax?: PriceNonNullableFields;
|
|
6332
|
-
priceAfterTax?: PriceNonNullableFields;
|
|
6333
|
-
_id: string;
|
|
6334
|
-
lineItemIds: string[];
|
|
6335
|
-
}
|
|
6336
|
-
interface TagListNonNullableFields {
|
|
6337
|
-
tagIds: string[];
|
|
6338
|
-
}
|
|
6339
|
-
interface TagsNonNullableFields {
|
|
6340
|
-
privateTags?: TagListNonNullableFields;
|
|
6341
|
-
tags?: TagListNonNullableFields;
|
|
6342
|
-
}
|
|
6343
|
-
interface LocationNonNullableFields {
|
|
6344
|
-
_id: string;
|
|
6345
|
-
name: string;
|
|
6346
|
-
}
|
|
6347
|
-
export interface OrderNonNullableFields {
|
|
6348
|
-
number: string;
|
|
6349
|
-
lineItems: OrderLineItemNonNullableFields[];
|
|
6350
|
-
buyerInfo?: BuyerInfoNonNullableFields;
|
|
6351
|
-
paymentStatus: PaymentStatus;
|
|
6352
|
-
fulfillmentStatus: FulfillmentStatus;
|
|
6353
|
-
weightUnit: WeightUnit;
|
|
6354
|
-
taxIncludedInPrices: boolean;
|
|
6355
|
-
priceSummary?: PriceSummaryNonNullableFields;
|
|
6356
|
-
billingInfo?: AddressWithContactNonNullableFields;
|
|
6357
|
-
shippingInfo?: V1ShippingInformationNonNullableFields;
|
|
6358
|
-
status: OrderStatus;
|
|
6359
|
-
taxSummary?: TaxSummaryNonNullableFields;
|
|
6360
|
-
taxInfo?: OrderTaxInfoNonNullableFields;
|
|
6361
|
-
appliedDiscounts: AppliedDiscountNonNullableFields[];
|
|
6362
|
-
activities: ActivityNonNullableFields[];
|
|
6363
|
-
attributionSource: AttributionSource;
|
|
6364
|
-
createdBy?: CreatedByNonNullableFields;
|
|
6365
|
-
channelInfo?: ChannelInfoNonNullableFields;
|
|
6366
|
-
customFields: CustomFieldNonNullableFields[];
|
|
6367
|
-
isInternalOrderCreate: boolean;
|
|
6368
|
-
payNow?: PriceSummaryNonNullableFields;
|
|
6369
|
-
balanceSummary?: BalanceSummaryNonNullableFields;
|
|
6370
|
-
additionalFees: AdditionalFeeNonNullableFields[];
|
|
6371
|
-
recipientInfo?: AddressWithContactNonNullableFields;
|
|
6372
|
-
tags?: TagsNonNullableFields;
|
|
6373
|
-
businessLocation?: LocationNonNullableFields;
|
|
6374
|
-
}
|
|
6375
|
-
export interface MarkOrderAsPaidResponseNonNullableFields {
|
|
6376
|
-
order?: OrderNonNullableFields;
|
|
6377
|
-
}
|
|
6378
|
-
interface ApplicationErrorNonNullableFields {
|
|
6379
|
-
code: string;
|
|
6380
|
-
description: string;
|
|
6381
|
-
}
|
|
6382
|
-
interface ItemMetadataNonNullableFields {
|
|
6383
|
-
originalIndex: number;
|
|
6384
|
-
success: boolean;
|
|
6385
|
-
error?: ApplicationErrorNonNullableFields;
|
|
6386
|
-
}
|
|
6387
|
-
interface BulkOrderResultNonNullableFields {
|
|
6388
|
-
itemMetadata?: ItemMetadataNonNullableFields;
|
|
6389
|
-
item?: OrderNonNullableFields;
|
|
6390
|
-
}
|
|
6391
|
-
interface BulkActionMetadataNonNullableFields {
|
|
6392
|
-
totalSuccesses: number;
|
|
6393
|
-
totalFailures: number;
|
|
6394
|
-
undetailedFailures: number;
|
|
6395
|
-
}
|
|
6396
|
-
export interface BulkMarkOrdersAsPaidResponseNonNullableFields {
|
|
6397
|
-
results: BulkOrderResultNonNullableFields[];
|
|
6398
|
-
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
6399
|
-
}
|
|
6400
|
-
interface RefundabilityNonNullableFields {
|
|
6401
|
-
nonRefundableReason: NonRefundableReason;
|
|
6402
|
-
manuallyRefundableReason: ManuallyRefundableReason;
|
|
6403
|
-
paymentId: string;
|
|
6404
|
-
refundabilityStatus: RefundableStatus;
|
|
6405
|
-
}
|
|
6406
|
-
export interface GetRefundabilityStatusResponseNonNullableFields {
|
|
6407
|
-
refundabilities: RefundabilityNonNullableFields[];
|
|
6408
|
-
refundablePerItem: boolean;
|
|
6409
|
-
}
|
|
6410
|
-
export interface CreatePaymentGatewayOrderResponseNonNullableFields {
|
|
6411
|
-
paymentGatewayOrderId: string;
|
|
6412
|
-
}
|
|
6413
|
-
interface AuthorizationActionFailureDetailsNonNullableFields {
|
|
6414
|
-
failureCode: string;
|
|
6415
|
-
}
|
|
6416
|
-
interface AuthorizationCaptureNonNullableFields {
|
|
6417
|
-
status: AuthorizationCaptureStatus;
|
|
6418
|
-
amount?: PriceNonNullableFields;
|
|
6419
|
-
failureDetails?: AuthorizationActionFailureDetailsNonNullableFields;
|
|
6420
|
-
}
|
|
6421
|
-
interface AuthorizationVoidNonNullableFields {
|
|
6422
|
-
status: AuthorizationVoidStatus;
|
|
6423
|
-
failureDetails?: AuthorizationActionFailureDetailsNonNullableFields;
|
|
6424
|
-
reason: Reason;
|
|
6425
|
-
}
|
|
6426
|
-
interface V1ScheduledActionNonNullableFields {
|
|
6427
|
-
actionType: ActionType;
|
|
6428
|
-
}
|
|
6429
|
-
interface AuthorizationDetailsNonNullableFields {
|
|
6430
|
-
delayedCapture: boolean;
|
|
6431
|
-
captures: AuthorizationCaptureNonNullableFields[];
|
|
6432
|
-
void?: AuthorizationVoidNonNullableFields;
|
|
6433
|
-
scheduledAction?: V1ScheduledActionNonNullableFields;
|
|
6434
|
-
}
|
|
6435
|
-
interface RegularPaymentDetailsNonNullableFields {
|
|
6436
|
-
offlinePayment: boolean;
|
|
6437
|
-
status: TransactionStatus;
|
|
6438
|
-
savedPaymentMethod: boolean;
|
|
6439
|
-
authorizationDetails?: AuthorizationDetailsNonNullableFields;
|
|
6440
|
-
}
|
|
6441
|
-
interface GiftCardPaymentDetailsNonNullableFields {
|
|
6442
|
-
giftCardPaymentId: string;
|
|
6443
|
-
giftCardId: string;
|
|
6444
|
-
appId: string;
|
|
6445
|
-
voided: boolean;
|
|
6446
|
-
}
|
|
6447
|
-
interface MembershipNameNonNullableFields {
|
|
6448
|
-
original: string;
|
|
6449
|
-
}
|
|
6450
|
-
interface MembershipPaymentDetailsNonNullableFields {
|
|
6451
|
-
membershipId: string;
|
|
6452
|
-
lineItemId: string;
|
|
6453
|
-
status: MembershipPaymentStatus;
|
|
6454
|
-
name?: MembershipNameNonNullableFields;
|
|
6455
|
-
voided: boolean;
|
|
6456
|
-
providerAppId: string;
|
|
6457
|
-
}
|
|
6458
|
-
interface PaymentNonNullableFields {
|
|
6459
|
-
regularPaymentDetails?: RegularPaymentDetailsNonNullableFields;
|
|
6460
|
-
giftcardPaymentDetails?: GiftCardPaymentDetailsNonNullableFields;
|
|
6461
|
-
membershipPaymentDetails?: MembershipPaymentDetailsNonNullableFields;
|
|
6462
|
-
amount?: PriceNonNullableFields;
|
|
6463
|
-
refundDisabled: boolean;
|
|
6464
|
-
}
|
|
6465
|
-
interface RefundTransactionNonNullableFields {
|
|
6466
|
-
paymentId: string;
|
|
6467
|
-
amount?: PriceNonNullableFields;
|
|
6468
|
-
refundStatus: RefundStatus;
|
|
6469
|
-
externalRefund: boolean;
|
|
6470
|
-
}
|
|
6471
|
-
interface RefundItemNonNullableFields {
|
|
6472
|
-
lineItemId: string;
|
|
6473
|
-
quantity: number;
|
|
6474
|
-
}
|
|
6475
|
-
interface LineItemRefundNonNullableFields {
|
|
6476
|
-
lineItemId: string;
|
|
6477
|
-
quantity: number;
|
|
6478
|
-
}
|
|
6479
|
-
interface AdditionalFeeRefundNonNullableFields {
|
|
6480
|
-
additionalFeeId: string;
|
|
6481
|
-
amount?: PriceNonNullableFields;
|
|
6482
|
-
}
|
|
6483
|
-
interface ShippingRefundNonNullableFields {
|
|
6484
|
-
amount?: PriceNonNullableFields;
|
|
6485
|
-
}
|
|
6486
|
-
interface RefundDetailsNonNullableFields {
|
|
6487
|
-
items: RefundItemNonNullableFields[];
|
|
6488
|
-
shippingIncluded: boolean;
|
|
6489
|
-
lineItems: LineItemRefundNonNullableFields[];
|
|
6490
|
-
additionalFees: AdditionalFeeRefundNonNullableFields[];
|
|
6491
|
-
shipping?: ShippingRefundNonNullableFields;
|
|
6492
|
-
}
|
|
6493
|
-
interface LineItemRefundSummaryNonNullableFields {
|
|
6494
|
-
lineItemId: string;
|
|
6495
|
-
totalRefundedAmount?: PriceNonNullableFields;
|
|
6496
|
-
}
|
|
6497
|
-
interface RefundItemsBreakdownNonNullableFields {
|
|
6498
|
-
lineItems: LineItemRefundSummaryNonNullableFields[];
|
|
6499
|
-
}
|
|
6500
|
-
interface AggregatedRefundSummaryNonNullableFields {
|
|
6501
|
-
requestedRefund?: PriceNonNullableFields;
|
|
6502
|
-
pendingRefund?: PriceNonNullableFields;
|
|
6503
|
-
refunded?: PriceNonNullableFields;
|
|
6504
|
-
failedRefundAmount?: PriceNonNullableFields;
|
|
6505
|
-
pending: boolean;
|
|
6506
|
-
breakdown?: RefundItemsBreakdownNonNullableFields;
|
|
6507
|
-
}
|
|
6508
|
-
interface RefundNonNullableFields {
|
|
6509
|
-
_id: string;
|
|
6510
|
-
transactions: RefundTransactionNonNullableFields[];
|
|
6511
|
-
details?: RefundDetailsNonNullableFields;
|
|
6512
|
-
summary?: AggregatedRefundSummaryNonNullableFields;
|
|
6513
|
-
}
|
|
6514
|
-
interface OrderTransactionsNonNullableFields {
|
|
6515
|
-
orderId: string;
|
|
6516
|
-
payments: PaymentNonNullableFields[];
|
|
6517
|
-
refunds: RefundNonNullableFields[];
|
|
6518
|
-
}
|
|
6519
|
-
export interface TriggerRefundResponseNonNullableFields {
|
|
6520
|
-
orderTransactions?: OrderTransactionsNonNullableFields;
|
|
6521
|
-
failedPaymentIds: ItemMetadataNonNullableFields[];
|
|
6522
|
-
}
|
|
6523
|
-
export interface VoidAuthorizedPaymentsResponseNonNullableFields {
|
|
6524
|
-
orderTransactions?: OrderTransactionsNonNullableFields;
|
|
6525
|
-
}
|
|
6526
|
-
export interface CaptureAuthorizedPaymentsResponseNonNullableFields {
|
|
6527
|
-
orderTransactions?: OrderTransactionsNonNullableFields;
|
|
6528
|
-
}
|
|
6529
|
-
export interface GetOrderResponseNonNullableFields {
|
|
6530
|
-
order?: OrderNonNullableFields;
|
|
6531
|
-
}
|
|
6532
|
-
export interface SearchOrdersResponseNonNullableFields {
|
|
6533
|
-
orders: OrderNonNullableFields[];
|
|
6534
|
-
}
|
|
6535
|
-
export interface CreateOrderResponseNonNullableFields {
|
|
6536
|
-
order?: OrderNonNullableFields;
|
|
6537
|
-
}
|
|
6538
|
-
export interface UpdateOrderResponseNonNullableFields {
|
|
6539
|
-
order?: OrderNonNullableFields;
|
|
6540
|
-
}
|
|
6541
|
-
export interface BulkUpdateOrdersResponseNonNullableFields {
|
|
6542
|
-
results: BulkOrderResultNonNullableFields[];
|
|
6543
|
-
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
6544
|
-
}
|
|
6545
|
-
export interface CommitDeltasResponseNonNullableFields {
|
|
6546
|
-
order?: OrderNonNullableFields;
|
|
6547
|
-
}
|
|
6548
|
-
export interface UpdateOrderLineItemResponseNonNullableFields {
|
|
6549
|
-
order?: OrderNonNullableFields;
|
|
6550
|
-
}
|
|
6551
|
-
export interface AddActivityResponseNonNullableFields {
|
|
6552
|
-
order?: OrderNonNullableFields;
|
|
6553
|
-
activityId: string;
|
|
6554
|
-
}
|
|
6555
|
-
export interface UpdateActivityResponseNonNullableFields {
|
|
6556
|
-
order?: OrderNonNullableFields;
|
|
6557
|
-
}
|
|
6558
|
-
export interface DeleteActivityResponseNonNullableFields {
|
|
6559
|
-
order?: OrderNonNullableFields;
|
|
6560
|
-
}
|
|
6561
|
-
export interface CancelOrderResponseNonNullableFields {
|
|
6562
|
-
order?: OrderNonNullableFields;
|
|
6563
|
-
}
|
|
6564
|
-
export interface UpdateOrderStatusResponseNonNullableFields {
|
|
6565
|
-
order?: OrderNonNullableFields;
|
|
6566
|
-
}
|
|
6567
|
-
interface BulkUpdateOrderTagsResultNonNullableFields {
|
|
6568
|
-
itemMetadata?: ItemMetadataNonNullableFields;
|
|
6569
|
-
}
|
|
6570
|
-
export interface BulkUpdateOrderTagsResponseNonNullableFields {
|
|
6571
|
-
results: BulkUpdateOrderTagsResultNonNullableFields[];
|
|
6572
|
-
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
6573
|
-
}
|
|
6574
6074
|
export interface BaseEventMetadata {
|
|
6575
6075
|
/**
|
|
6576
6076
|
* App instance ID.
|
|
@@ -6735,6 +6235,7 @@ export interface OrderCreatedEnvelope {
|
|
|
6735
6235
|
* @slug created
|
|
6736
6236
|
*/
|
|
6737
6237
|
export declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
|
|
6238
|
+
type OrderNonNullablePaths = `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.descriptionLines` | `lineItems.${number}.descriptionLines.${number}.plainText.original` | `lineItems.${number}.descriptionLines.${number}.colorInfo.original` | `lineItems.${number}.descriptionLines.${number}.name.original` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.taxInfo.taxBreakdown` | `lineItems.${number}.taxInfo.taxBreakdown.${number}.jurisdictionType` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.locations` | `lineItems.${number}.locations.${number}._id` | `lineItems.${number}.locations.${number}.quantity` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `priceSummary.subtotal.amount` | `priceSummary.subtotal.formattedAmount` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.shippingDestination.address.streetAddress.number` | `shippingInfo.logistics.shippingDestination.address.streetAddress.name` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId._id` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId.type` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `shippingInfo.cost.price.amount` | `shippingInfo.cost.price.formattedAmount` | `shippingInfo.cost.taxDetails.taxRate` | `status` | `taxSummary.totalTax.amount` | `taxSummary.totalTax.formattedAmount` | `taxInfo.totalTax.amount` | `taxInfo.totalTax.formattedAmount` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.coupon.amount.amount` | `appliedDiscounts.${number}.coupon.amount.formattedAmount` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `appliedDiscounts.${number}.lineItemIds` | `activities` | `activities.${number}.customActivity.appId` | `activities.${number}.customActivity.type` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.amount.amount` | `activities.${number}.orderRefunded.amount.formattedAmount` | `activities.${number}.orderRefunded.reason` | `activities.${number}.type` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `balanceSummary.paid.amount` | `balanceSummary.paid.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}.price.amount` | `additionalFees.${number}.price.formattedAmount` | `additionalFees.${number}.taxDetails.taxRate` | `additionalFees.${number}._id` | `additionalFees.${number}.lineItemIds` | `recipientInfo.address.streetAddress.number` | `recipientInfo.address.streetAddress.name` | `recipientInfo.contactDetails.vatId._id` | `recipientInfo.contactDetails.vatId.type` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name`;
|
|
6738
6239
|
/**
|
|
6739
6240
|
* Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.
|
|
6740
6241
|
* Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.
|
|
@@ -6755,7 +6256,7 @@ export declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) =>
|
|
|
6755
6256
|
* @applicableIdentity APP
|
|
6756
6257
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.PreparePaymentCollection
|
|
6757
6258
|
*/
|
|
6758
|
-
export declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<PreparePaymentCollectionResponse
|
|
6259
|
+
export declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<NonNullablePaths<PreparePaymentCollectionResponse, `paymentGatewayOrderId`>>;
|
|
6759
6260
|
export interface PreparePaymentCollectionOptions {
|
|
6760
6261
|
/**
|
|
6761
6262
|
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
@@ -6791,7 +6292,7 @@ export interface PreparePaymentCollectionOptions {
|
|
|
6791
6292
|
* @applicableIdentity APP
|
|
6792
6293
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetPaymentCollectabilityStatus
|
|
6793
6294
|
*/
|
|
6794
|
-
export declare function getPaymentCollectabilityStatus(ecomOrderId: string): Promise<GetPaymentCollectabilityStatusResponse
|
|
6295
|
+
export declare function getPaymentCollectabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetPaymentCollectabilityStatusResponse, `status` | `amount.amount` | `amount.formattedAmount`>>;
|
|
6795
6296
|
export interface PaymentCollectionCreatePaymentGatewayOrderOptions {
|
|
6796
6297
|
/** Information about the user who initiated the payment. */
|
|
6797
6298
|
chargedBy?: ChargedBy;
|
|
@@ -6833,7 +6334,7 @@ export interface TriggerRefundOptions {
|
|
|
6833
6334
|
* @applicableIdentity APP
|
|
6834
6335
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.VoidAuthorizedPayments
|
|
6835
6336
|
*/
|
|
6836
|
-
export declare function voidAuthorizedPayments(ecomOrderId: string, paymentIds: string[]): Promise<VoidAuthorizedPaymentsResponse
|
|
6337
|
+
export declare function voidAuthorizedPayments(ecomOrderId: string, paymentIds: string[]): Promise<NonNullablePaths<VoidAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.amount.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.amount.formattedAmount` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.failureDetails.failureCode` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.transactions` | `orderTransactions.refunds.${number}.transactions.${number}.paymentId` | `orderTransactions.refunds.${number}.transactions.${number}.refundStatus` | `orderTransactions.refunds.${number}.transactions.${number}.externalRefund` | `orderTransactions.refunds.${number}.details.items` | `orderTransactions.refunds.${number}.details.items.${number}.lineItemId` | `orderTransactions.refunds.${number}.details.items.${number}.quantity` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.details.lineItems` | `orderTransactions.refunds.${number}.details.lineItems.${number}.lineItemId` | `orderTransactions.refunds.${number}.details.lineItems.${number}.quantity` | `orderTransactions.refunds.${number}.details.additionalFees` | `orderTransactions.refunds.${number}.details.additionalFees.${number}.additionalFeeId` | `orderTransactions.refunds.${number}.summary.pending` | `orderTransactions.refunds.${number}.summary.breakdown.lineItems` | `orderTransactions.refunds.${number}.summary.breakdown.lineItems.${number}.lineItemId`>>;
|
|
6837
6338
|
/**
|
|
6838
6339
|
* Capture authorized payments
|
|
6839
6340
|
* Transaction statuses for related payments will be updated in async way
|
|
@@ -6858,7 +6359,7 @@ export declare function voidAuthorizedPayments(ecomOrderId: string, paymentIds:
|
|
|
6858
6359
|
* @applicableIdentity APP
|
|
6859
6360
|
* @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CaptureAuthorizedPayments
|
|
6860
6361
|
*/
|
|
6861
|
-
export declare function captureAuthorizedPayments(ecomOrderId: string, payments: PaymentCapture[]): Promise<CaptureAuthorizedPaymentsResponse
|
|
6362
|
+
export declare function captureAuthorizedPayments(ecomOrderId: string, payments: NonNullablePaths<PaymentCapture, `paymentId`>[]): Promise<NonNullablePaths<CaptureAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.amount.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.amount.formattedAmount` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.captures.${number}.failureDetails.failureCode` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.transactions` | `orderTransactions.refunds.${number}.transactions.${number}.paymentId` | `orderTransactions.refunds.${number}.transactions.${number}.refundStatus` | `orderTransactions.refunds.${number}.transactions.${number}.externalRefund` | `orderTransactions.refunds.${number}.details.items` | `orderTransactions.refunds.${number}.details.items.${number}.lineItemId` | `orderTransactions.refunds.${number}.details.items.${number}.quantity` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.details.lineItems` | `orderTransactions.refunds.${number}.details.lineItems.${number}.lineItemId` | `orderTransactions.refunds.${number}.details.lineItems.${number}.quantity` | `orderTransactions.refunds.${number}.details.additionalFees` | `orderTransactions.refunds.${number}.details.additionalFees.${number}.additionalFeeId` | `orderTransactions.refunds.${number}.summary.pending` | `orderTransactions.refunds.${number}.summary.breakdown.lineItems` | `orderTransactions.refunds.${number}.summary.breakdown.lineItems.${number}.lineItemId`>>;
|
|
6862
6363
|
/**
|
|
6863
6364
|
* Retrieves an order.
|
|
6864
6365
|
*
|
|
@@ -6891,7 +6392,7 @@ export declare function captureAuthorizedPayments(ecomOrderId: string, payments:
|
|
|
6891
6392
|
* @returns Fulfilled - The requested order.
|
|
6892
6393
|
* @fqn com.wix.ecom.orders.v1.Orders.GetOrder
|
|
6893
6394
|
*/
|
|
6894
|
-
export declare function getOrder(_id: string): Promise<Order
|
|
6395
|
+
export declare function getOrder(_id: string): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
|
|
6895
6396
|
/**
|
|
6896
6397
|
* Retrieves a list of orders, given the provided paging, filtering, and sorting.
|
|
6897
6398
|
*
|
|
@@ -6928,7 +6429,9 @@ export declare function getOrder(_id: string): Promise<Order & OrderNonNullableF
|
|
|
6928
6429
|
* @applicableIdentity APP
|
|
6929
6430
|
* @fqn com.wix.ecom.orders.v1.Orders.SearchOrders
|
|
6930
6431
|
*/
|
|
6931
|
-
export declare function searchOrders(options?: SearchOrdersOptions): Promise<SearchOrdersResponse
|
|
6432
|
+
export declare function searchOrders(options?: SearchOrdersOptions): Promise<NonNullablePaths<SearchOrdersResponse, {
|
|
6433
|
+
[P in OrderNonNullablePaths]: `orders.${number}.${P}`;
|
|
6434
|
+
}[OrderNonNullablePaths]>>;
|
|
6932
6435
|
export interface SearchOrdersOptions {
|
|
6933
6436
|
/** Search options. */
|
|
6934
6437
|
search?: CursorSearch;
|
|
@@ -6974,7 +6477,7 @@ export interface SearchOrdersOptions {
|
|
|
6974
6477
|
* @returns Newly created order.
|
|
6975
6478
|
* @fqn com.wix.ecom.orders.v1.Orders.CreateOrder
|
|
6976
6479
|
*/
|
|
6977
|
-
export declare function createOrder(order: Order, options?: CreateOrderOptions): Promise<Order
|
|
6480
|
+
export declare function createOrder(order: NonNullablePaths<Order, `billingInfo.contactDetails` | `channelInfo` | `currencyConversionDetails.conversionRate` | `currencyConversionDetails.originalCurrency` | `lineItems` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.itemType` | `lineItems.${number}.price` | `lineItems.${number}.productName` | `lineItems.${number}.productName.original` | `lineItems.${number}.quantity` | `priceSummary`>, options?: CreateOrderOptions): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
|
|
6978
6481
|
export interface CreateOrderOptions {
|
|
6979
6482
|
/** Determine order lifecycle */
|
|
6980
6483
|
settings?: OrderCreationSettings;
|
|
@@ -7025,7 +6528,7 @@ export interface CreateOrderOptions {
|
|
|
7025
6528
|
* @returns Newly created order.
|
|
7026
6529
|
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrder
|
|
7027
6530
|
*/
|
|
7028
|
-
export declare function updateOrder(_id: string
|
|
6531
|
+
export declare function updateOrder(_id: string, order: UpdateOrder): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
|
|
7029
6532
|
export interface UpdateOrder {
|
|
7030
6533
|
/**
|
|
7031
6534
|
* Order ID.
|
|
@@ -7239,7 +6742,9 @@ export interface UpdateOrder {
|
|
|
7239
6742
|
* @applicableIdentity APP
|
|
7240
6743
|
* @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrders
|
|
7241
6744
|
*/
|
|
7242
|
-
export declare function bulkUpdateOrders(orders: MaskedOrder[], options?: BulkUpdateOrdersOptions): Promise<BulkUpdateOrdersResponse
|
|
6745
|
+
export declare function bulkUpdateOrders(orders: NonNullablePaths<MaskedOrder, `order` | `order._id`>[], options?: BulkUpdateOrdersOptions): Promise<NonNullablePaths<BulkUpdateOrdersResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
6746
|
+
[P in OrderNonNullablePaths]: `results.${number}.item.${P}`;
|
|
6747
|
+
}[OrderNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
7243
6748
|
export interface BulkUpdateOrdersOptions {
|
|
7244
6749
|
/**
|
|
7245
6750
|
* Whether to return the full order entities.
|
|
@@ -7441,7 +6946,9 @@ export interface DeleteActivityIdentifiers {
|
|
|
7441
6946
|
* @applicableIdentity APP
|
|
7442
6947
|
* @fqn com.wix.ecom.orders.v1.Orders.CancelOrder
|
|
7443
6948
|
*/
|
|
7444
|
-
export declare function cancelOrder(_id: string, options?: CancelOrderOptions): Promise<CancelOrderResponse
|
|
6949
|
+
export declare function cancelOrder(_id: string, options?: CancelOrderOptions): Promise<NonNullablePaths<CancelOrderResponse, {
|
|
6950
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
6951
|
+
}[OrderNonNullablePaths]>>;
|
|
7445
6952
|
export interface CancelOrderOptions {
|
|
7446
6953
|
/** Whether to send an order canceled email to the buyer. */
|
|
7447
6954
|
sendOrderCanceledEmail?: boolean;
|
|
@@ -7502,7 +7009,7 @@ export interface AggregateOrdersOptions {
|
|
|
7502
7009
|
* @applicableIdentity APP
|
|
7503
7010
|
* @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrderTags
|
|
7504
7011
|
*/
|
|
7505
|
-
export declare function bulkUpdateOrderTags(orderIds: string[], options?: BulkUpdateOrderTagsOptions): Promise<BulkUpdateOrderTagsResponse
|
|
7012
|
+
export declare function bulkUpdateOrderTags(orderIds: string[], options?: BulkUpdateOrderTagsOptions): Promise<NonNullablePaths<BulkUpdateOrderTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
7506
7013
|
export interface BulkUpdateOrderTagsOptions {
|
|
7507
7014
|
/** Tags to be added to orders */
|
|
7508
7015
|
assignTags?: Tags;
|