@elasticpath/js-sdk 2.0.0 → 3.0.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/dist/index.cjs.js +367 -13
- package/dist/index.d.ts +1050 -393
- package/dist/index.esm.js +367 -13
- package/dist/index.js +367 -13
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1003,6 +1003,7 @@ interface PcmProductBase extends PcmProductRelationships {
|
|
|
1003
1003
|
locales?: { [key in Locales]?: { name?: string; description?: string } }
|
|
1004
1004
|
components?: ProductComponents
|
|
1005
1005
|
custom_inputs?: CustomInputs
|
|
1006
|
+
tags?: string[]
|
|
1006
1007
|
}
|
|
1007
1008
|
}
|
|
1008
1009
|
|
|
@@ -1016,8 +1017,8 @@ interface PcmJob extends Identifiable, PcmJobBase {
|
|
|
1016
1017
|
interface ProductComponents {
|
|
1017
1018
|
[key: string]: {
|
|
1018
1019
|
name: string
|
|
1019
|
-
min?: number
|
|
1020
|
-
max?: number
|
|
1020
|
+
min?: number | null
|
|
1021
|
+
max?: number | null
|
|
1021
1022
|
sort_order?: number | null
|
|
1022
1023
|
options: ProductComponentOption[]
|
|
1023
1024
|
}
|
|
@@ -1049,6 +1050,7 @@ interface ProductComponentOption {
|
|
|
1049
1050
|
quantity: number
|
|
1050
1051
|
type: string
|
|
1051
1052
|
sort_order?: number | null
|
|
1053
|
+
default?: boolean
|
|
1052
1054
|
meta: {
|
|
1053
1055
|
name: string
|
|
1054
1056
|
sku: string
|
|
@@ -1207,7 +1209,7 @@ interface PcmProductsEndpoint
|
|
|
1207
1209
|
* @param filter - products filters
|
|
1208
1210
|
* @constructor
|
|
1209
1211
|
*/
|
|
1210
|
-
ExportProducts(filter?: PcmProductFilter): Promise<Resource<PcmJob>>
|
|
1212
|
+
ExportProducts(filter?: PcmProductFilter, useTemplateSlugs?: boolean): Promise<Resource<PcmJob>>
|
|
1211
1213
|
}
|
|
1212
1214
|
|
|
1213
1215
|
/**
|
|
@@ -3143,6 +3145,11 @@ interface SubscriptionSettings {
|
|
|
3143
3145
|
subscription_preview_enabled: boolean
|
|
3144
3146
|
}
|
|
3145
3147
|
|
|
3148
|
+
interface PromotionSettings {
|
|
3149
|
+
type: 'promotion_settings'
|
|
3150
|
+
rule_promotions_preview_enabled: boolean
|
|
3151
|
+
}
|
|
3152
|
+
|
|
3146
3153
|
/**
|
|
3147
3154
|
* Settings Endpoints
|
|
3148
3155
|
*/
|
|
@@ -3193,6 +3200,18 @@ interface SettingsEndpoint {
|
|
|
3193
3200
|
* Description: You can get the Subscriptions Settings using this endpoint
|
|
3194
3201
|
*/
|
|
3195
3202
|
Subscriptions(): Promise<Resource<SubscriptionSettings>>
|
|
3203
|
+
|
|
3204
|
+
/**
|
|
3205
|
+
* Update Subscriptions Settings
|
|
3206
|
+
* Description: You can update the Subscriptions Settings using this endpoint
|
|
3207
|
+
*/
|
|
3208
|
+
UpdateSubscriptions(body: SubscriptionSettings): Promise<Resource<SubscriptionSettings>>
|
|
3209
|
+
|
|
3210
|
+
/**
|
|
3211
|
+
* Get Promotions Settings
|
|
3212
|
+
* Description: You can get the Promotions Settings using this endpoint
|
|
3213
|
+
*/
|
|
3214
|
+
Promotions(): Promise<Resource<PromotionSettings>>
|
|
3196
3215
|
}
|
|
3197
3216
|
|
|
3198
3217
|
/**
|
|
@@ -3380,9 +3399,9 @@ interface PromotionCode {
|
|
|
3380
3399
|
code: string
|
|
3381
3400
|
uses?: number
|
|
3382
3401
|
user?: string
|
|
3383
|
-
created_by
|
|
3384
|
-
max_uses
|
|
3385
|
-
meta
|
|
3402
|
+
created_by?: string
|
|
3403
|
+
max_uses?: number
|
|
3404
|
+
meta?: PromotionMeta
|
|
3386
3405
|
consume_unit?: 'per_cart' | 'per_item'
|
|
3387
3406
|
}
|
|
3388
3407
|
|
|
@@ -3427,10 +3446,11 @@ interface PromotionJob extends Identifiable {
|
|
|
3427
3446
|
|
|
3428
3447
|
/** BE Doesnt support commented filter now, TO DO**/
|
|
3429
3448
|
|
|
3430
|
-
interface
|
|
3449
|
+
interface PromotionFilter {
|
|
3431
3450
|
eq?: {
|
|
3432
3451
|
job_type?: string
|
|
3433
3452
|
status?: string
|
|
3453
|
+
code?: string
|
|
3434
3454
|
// name?: string
|
|
3435
3455
|
// created_by?: string
|
|
3436
3456
|
}
|
|
@@ -3467,13 +3487,14 @@ interface PromotionsEndpoint
|
|
|
3467
3487
|
Promotion,
|
|
3468
3488
|
PromotionBase,
|
|
3469
3489
|
Identifiable & Partial<PromotionBase>,
|
|
3470
|
-
|
|
3490
|
+
PromotionFilter,
|
|
3471
3491
|
never,
|
|
3472
3492
|
never
|
|
3473
3493
|
> {
|
|
3494
|
+
|
|
3474
3495
|
endpoint: 'promotions'
|
|
3475
3496
|
|
|
3476
|
-
Filter(filter:
|
|
3497
|
+
Filter(filter: PromotionFilter): PromotionsEndpoint
|
|
3477
3498
|
|
|
3478
3499
|
Attributes(): Promise<Attributes>
|
|
3479
3500
|
|
|
@@ -3487,6 +3508,7 @@ interface PromotionsEndpoint
|
|
|
3487
3508
|
/**
|
|
3488
3509
|
* DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/carts-and-checkout/promotions/create-promotion-codes.html
|
|
3489
3510
|
*/
|
|
3511
|
+
|
|
3490
3512
|
AddCodes(
|
|
3491
3513
|
promotionId: string,
|
|
3492
3514
|
codes: PromotionCode[]
|
|
@@ -4256,6 +4278,14 @@ interface CartItemsResponse {
|
|
|
4256
4278
|
snapshot_date?: string
|
|
4257
4279
|
}
|
|
4258
4280
|
|
|
4281
|
+
interface AccountAssociationData{
|
|
4282
|
+
type: string
|
|
4283
|
+
id: string
|
|
4284
|
+
}
|
|
4285
|
+
|
|
4286
|
+
interface AccountAssociationResponse extends ResourceList<AccountAssociationData> {}
|
|
4287
|
+
|
|
4288
|
+
|
|
4259
4289
|
interface BulkAddOptions {
|
|
4260
4290
|
add_all_or_nothing: boolean
|
|
4261
4291
|
}
|
|
@@ -4609,7 +4639,6 @@ interface CartEndpoint
|
|
|
4609
4639
|
/**
|
|
4610
4640
|
* Customer Cart Associations
|
|
4611
4641
|
* Description: You can create an association between a customer and a cart with the capability to delete any associations as required.
|
|
4612
|
-
* DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/carts-and-orders/carts/customer-cart-associations.html
|
|
4613
4642
|
* @param customerId the id of the customer.
|
|
4614
4643
|
* @param token a customer token to access specific customer orders.
|
|
4615
4644
|
*/
|
|
@@ -4619,16 +4648,29 @@ interface CartEndpoint
|
|
|
4619
4648
|
): Promise<CartItemsResponse>
|
|
4620
4649
|
|
|
4621
4650
|
/**
|
|
4622
|
-
*
|
|
4651
|
+
* Add an Account Cart Associations
|
|
4623
4652
|
* Description: You can create an association between a customer and a cart with the capability to delete any associations as required.
|
|
4624
|
-
*
|
|
4625
|
-
* @param
|
|
4653
|
+
*
|
|
4654
|
+
* @param accountId the id of the account.
|
|
4626
4655
|
* @param token a customer token to access specific customer orders.
|
|
4627
4656
|
*/
|
|
4628
|
-
|
|
4629
|
-
|
|
4657
|
+
AddAccountAssociation(
|
|
4658
|
+
accountId: string,
|
|
4630
4659
|
token: string
|
|
4631
|
-
): Promise<
|
|
4660
|
+
): Promise<AccountAssociationResponse>
|
|
4661
|
+
|
|
4662
|
+
/**
|
|
4663
|
+
* Remove an Account Cart Associations
|
|
4664
|
+
* Description: You can create an association between a customer and a cart with the capability to delete any associations as required.
|
|
4665
|
+
*
|
|
4666
|
+
* @param accountId the id of the account.
|
|
4667
|
+
* @param token a customer token to access specific customer orders.
|
|
4668
|
+
*/
|
|
4669
|
+
RemoveAccountAssociation(
|
|
4670
|
+
accountId: string,
|
|
4671
|
+
token: string
|
|
4672
|
+
): Promise<{}>
|
|
4673
|
+
|
|
4632
4674
|
|
|
4633
4675
|
/**
|
|
4634
4676
|
* @deprecated Use UpdateItem method
|
|
@@ -5068,6 +5110,10 @@ interface ProductResponse extends Identifiable {
|
|
|
5068
5110
|
}
|
|
5069
5111
|
}
|
|
5070
5112
|
}
|
|
5113
|
+
bread_crumbs?: {
|
|
5114
|
+
[key: string]: string[]
|
|
5115
|
+
}
|
|
5116
|
+
bread_crumb_nodes?: string[]
|
|
5071
5117
|
component_products?: {
|
|
5072
5118
|
[key: string]: {
|
|
5073
5119
|
display_price: {
|
|
@@ -6129,6 +6175,7 @@ interface AccountAuthenticationSettingsBase {
|
|
|
6129
6175
|
type: string
|
|
6130
6176
|
enable_self_signup: boolean,
|
|
6131
6177
|
auto_create_account_for_account_members: boolean,
|
|
6178
|
+
account_management_authentication_token_timeout_secs?: number,
|
|
6132
6179
|
account_member_self_management: string
|
|
6133
6180
|
meta: object
|
|
6134
6181
|
relationships: {
|
|
@@ -6496,354 +6543,388 @@ interface PasswordProfileEndpoint {
|
|
|
6496
6543
|
*/
|
|
6497
6544
|
|
|
6498
6545
|
|
|
6499
|
-
|
|
6500
|
-
|
|
6501
|
-
|
|
6502
|
-
|
|
6503
|
-
|
|
6504
|
-
|
|
6505
|
-
|
|
6506
|
-
}
|
|
6546
|
+
/**
|
|
6547
|
+
* Product Variations Base Interface
|
|
6548
|
+
*/
|
|
6549
|
+
interface PCMVariationBase {
|
|
6550
|
+
attributes: {
|
|
6551
|
+
name: string
|
|
6552
|
+
sort_order?: number
|
|
6507
6553
|
}
|
|
6554
|
+
}
|
|
6508
6555
|
|
|
6509
|
-
|
|
6510
|
-
|
|
6511
|
-
|
|
6512
|
-
|
|
6513
|
-
|
|
6514
|
-
}
|
|
6556
|
+
interface PCMVariation extends Identifiable, PCMVariationBase {
|
|
6557
|
+
type: 'product-variation'
|
|
6558
|
+
meta?: {
|
|
6559
|
+
options?: PCMVariationMetaOption[]
|
|
6560
|
+
owner: 'organization' | 'store'
|
|
6515
6561
|
}
|
|
6562
|
+
}
|
|
6516
6563
|
|
|
6517
|
-
|
|
6518
|
-
|
|
6519
|
-
|
|
6520
|
-
|
|
6521
|
-
|
|
6522
|
-
|
|
6523
|
-
name: string
|
|
6524
|
-
description: string
|
|
6525
|
-
}
|
|
6564
|
+
interface UpdateVariationBody
|
|
6565
|
+
extends Omit<PCMVariationBase, 'attributes'>,
|
|
6566
|
+
Identifiable {
|
|
6567
|
+
attributes: {
|
|
6568
|
+
name: string
|
|
6569
|
+
sort_order?: number | null
|
|
6526
6570
|
}
|
|
6571
|
+
}
|
|
6527
6572
|
|
|
6528
|
-
|
|
6529
|
-
|
|
6530
|
-
|
|
6531
|
-
|
|
6532
|
-
|
|
6533
|
-
|
|
6534
|
-
|
|
6535
|
-
|
|
6536
|
-
relationships: {
|
|
6537
|
-
modifiers: {
|
|
6538
|
-
data: VariationsModifierTypeObj[]
|
|
6539
|
-
}
|
|
6540
|
-
}
|
|
6573
|
+
/**
|
|
6574
|
+
* Product variation option base interface
|
|
6575
|
+
*/
|
|
6576
|
+
interface PCMVariationOptionBase {
|
|
6577
|
+
attributes: {
|
|
6578
|
+
name: string
|
|
6579
|
+
description: string
|
|
6580
|
+
sort_order?: number
|
|
6541
6581
|
}
|
|
6582
|
+
}
|
|
6542
6583
|
|
|
6543
|
-
|
|
6544
|
-
|
|
6545
|
-
|
|
6546
|
-
|
|
6547
|
-
|
|
6548
|
-
|
|
6549
|
-
|
|
6550
|
-
*/
|
|
6551
|
-
interface VariationsModifier {
|
|
6552
|
-
attributes: {
|
|
6553
|
-
type: VariationsModifierType
|
|
6554
|
-
value?: string
|
|
6555
|
-
seek?: string
|
|
6556
|
-
set?: string
|
|
6557
|
-
reference_name?: string
|
|
6558
|
-
}
|
|
6584
|
+
interface PCMVariationOption
|
|
6585
|
+
extends Identifiable,
|
|
6586
|
+
PCMVariationOptionBase {
|
|
6587
|
+
type: 'product-variation-option'
|
|
6588
|
+
meta: {
|
|
6589
|
+
owner?: 'organization' | 'store'
|
|
6590
|
+
modifiers?: VariationsModifierTypeObj[]
|
|
6559
6591
|
}
|
|
6592
|
+
}
|
|
6560
6593
|
|
|
6561
|
-
|
|
6562
|
-
|
|
6563
|
-
|
|
6564
|
-
|
|
6565
|
-
|
|
6566
|
-
|
|
6567
|
-
|
|
6568
|
-
| { name_prepend: string }
|
|
6569
|
-
| { description_equals: string }
|
|
6570
|
-
| { description_append: string }
|
|
6571
|
-
| { description_prepend: string }
|
|
6572
|
-
| { commoditytype: string }
|
|
6573
|
-
| { slug_equals: string }
|
|
6574
|
-
| { slug_append: string }
|
|
6575
|
-
| { slug_prepend: string }
|
|
6576
|
-
| { slug_builder: VariationsBuilderModifier }
|
|
6577
|
-
| { sku_equals: string }
|
|
6578
|
-
| { sku_append: string }
|
|
6579
|
-
| { sku_prepend: string }
|
|
6580
|
-
| { sku_builder: VariationsBuilderModifier }
|
|
6581
|
-
| { status: string }
|
|
6582
|
-
|
|
6583
|
-
type VariationsModifierType =
|
|
6584
|
-
| 'name_equals'
|
|
6585
|
-
| 'name_append'
|
|
6586
|
-
| 'name_prepend'
|
|
6587
|
-
| 'description_equals'
|
|
6588
|
-
| 'description_append'
|
|
6589
|
-
| 'description_prepend'
|
|
6590
|
-
| 'commodity_type'
|
|
6591
|
-
| 'slug_equals'
|
|
6592
|
-
| 'slug_append'
|
|
6593
|
-
| 'slug_prepend'
|
|
6594
|
-
| 'slug_builder'
|
|
6595
|
-
| 'sku_equals'
|
|
6596
|
-
| 'sku_append'
|
|
6597
|
-
| 'sku_prepend'
|
|
6598
|
-
| 'sku_builder'
|
|
6599
|
-
| 'status'
|
|
6600
|
-
| 'price'
|
|
6601
|
-
|
|
6602
|
-
interface VariationsBuilderModifier {
|
|
6603
|
-
seek: string
|
|
6604
|
-
set: string
|
|
6605
|
-
}
|
|
6606
|
-
|
|
6607
|
-
/**
|
|
6608
|
-
* Variations Endpoints
|
|
6609
|
-
* Get DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/catalog/product-variations/get-a-product-variation.html
|
|
6610
|
-
* Get All DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/catalog/product-variations/create-a-product-variation.html
|
|
6611
|
-
* Delete DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/catalog/product-variations/delete-a-product-variation.html
|
|
6612
|
-
*/
|
|
6613
|
-
interface PCMVariationsEndpoint
|
|
6614
|
-
extends CrudQueryableResource<
|
|
6615
|
-
PCMVariation,
|
|
6616
|
-
PCMVariationBase,
|
|
6617
|
-
VariationsOptionResponse,
|
|
6618
|
-
never,
|
|
6619
|
-
never,
|
|
6620
|
-
never
|
|
6621
|
-
> {
|
|
6622
|
-
endpoint: 'pcm/variations'
|
|
6623
|
-
|
|
6624
|
-
Limit(value: number): PCMVariationsEndpoint
|
|
6625
|
-
|
|
6626
|
-
Offset(value: number): PCMVariationsEndpoint
|
|
6627
|
-
|
|
6628
|
-
/**
|
|
6629
|
-
* Create a product variation
|
|
6630
|
-
* @param body - The variation object.
|
|
6631
|
-
* @constructor
|
|
6632
|
-
*/
|
|
6633
|
-
CreateVariation(body: PCMVariationBase): Promise<Resource<PCMVariation>>
|
|
6634
|
-
|
|
6635
|
-
/**
|
|
6636
|
-
* Update a product variation
|
|
6637
|
-
* @param id - ID of the variation.
|
|
6638
|
-
* @param body - The variation object.
|
|
6639
|
-
* @param token - a token to access specific data.
|
|
6640
|
-
* @constructor
|
|
6641
|
-
*/
|
|
6642
|
-
UpdateVariation(
|
|
6643
|
-
id: string,
|
|
6644
|
-
body: UpdateVariation,
|
|
6645
|
-
token?: string
|
|
6646
|
-
): Promise<Resource<PCMVariation>>
|
|
6647
|
-
|
|
6648
|
-
/**
|
|
6649
|
-
* Get a product variation option
|
|
6650
|
-
* Description: Use this endpoint to retrieve a single variation option.
|
|
6651
|
-
* DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/catalog/product-variations/options/get-a-product-variation-option.html
|
|
6652
|
-
* @param variationId - ID of the variation.
|
|
6653
|
-
* @param optionId - ID of the option.
|
|
6654
|
-
* @constructor
|
|
6655
|
-
*/
|
|
6656
|
-
VariationsOption(
|
|
6657
|
-
variationId: string,
|
|
6658
|
-
optionId: string
|
|
6659
|
-
): Promise<Resource<VariationsOptionResponse>>
|
|
6660
|
-
|
|
6661
|
-
/**
|
|
6662
|
-
* Get all product variation options
|
|
6663
|
-
* @param variationId - ID of the variation.
|
|
6664
|
-
* @constructor
|
|
6665
|
-
*/
|
|
6666
|
-
VariationsOptions(variationId: string): Promise<ResourcePage<VariationsOptionResponse>>
|
|
6667
|
-
|
|
6668
|
-
/**
|
|
6669
|
-
* Create a product variation option
|
|
6670
|
-
* @param variationId - ID of the variation.
|
|
6671
|
-
* @param body - The option object.
|
|
6672
|
-
* @constructor
|
|
6673
|
-
*/
|
|
6674
|
-
CreateVariationsOption(variationId: string, body: VariationsOption): Promise<Resource<VariationsOptionResponse>>
|
|
6675
|
-
|
|
6676
|
-
/**
|
|
6677
|
-
* Update product variation option
|
|
6678
|
-
* @param variationId - ID of the variation.
|
|
6679
|
-
* @param optionId - ID of the option.
|
|
6680
|
-
* @param body - The option object.
|
|
6681
|
-
* @constructor
|
|
6682
|
-
*/
|
|
6683
|
-
UpdateVariationsOption(variationId: string, optionId: string, body: UpdateVariationOption): Promise<Resource<VariationsOptionResponse>>
|
|
6684
|
-
|
|
6685
|
-
/**
|
|
6686
|
-
* Delete product variation option
|
|
6687
|
-
* @param variationId - ID of the variation.
|
|
6688
|
-
* @param optionId - ID of the option.
|
|
6689
|
-
* @constructor
|
|
6690
|
-
*/
|
|
6691
|
-
DeleteVariationsOption(variationId: string, optionId: string): Promise<{}>
|
|
6692
|
-
|
|
6693
|
-
/**
|
|
6694
|
-
* Get a product modifier
|
|
6695
|
-
* @param variationId - ID of the variation.
|
|
6696
|
-
* @param optionId - ID of the option.
|
|
6697
|
-
* @param modifierId - ID of the modifier.
|
|
6698
|
-
* @constructor
|
|
6699
|
-
*/
|
|
6700
|
-
VariationsModifier(
|
|
6701
|
-
variationId: string,
|
|
6702
|
-
optionId: string,
|
|
6703
|
-
modifierId: string
|
|
6704
|
-
): Promise<Resource<VariationsModifierResponse>>
|
|
6705
|
-
|
|
6706
|
-
/**
|
|
6707
|
-
* Get all product modifiers
|
|
6708
|
-
* @param variationId - ID of the variation.
|
|
6709
|
-
* @param optionId - ID of the option.
|
|
6710
|
-
* @constructor
|
|
6711
|
-
*/
|
|
6712
|
-
VariationsModifiers(variationId: string, optionId: string): Promise<ResourceList<VariationsModifierResponse>>
|
|
6713
|
-
|
|
6714
|
-
/**
|
|
6715
|
-
* Create a new product modifier
|
|
6716
|
-
* @param variationId - ID of the variation.
|
|
6717
|
-
* @param optionId - ID of the option.
|
|
6718
|
-
* @param body - The modifier object.
|
|
6719
|
-
* @constructor
|
|
6720
|
-
*/
|
|
6721
|
-
CreateVariationsModifier(
|
|
6722
|
-
variationId: string,
|
|
6723
|
-
optionId: string,
|
|
6724
|
-
body: VariationsModifier
|
|
6725
|
-
): Promise<Resource<VariationsModifierResponse>>
|
|
6726
|
-
|
|
6727
|
-
/**
|
|
6728
|
-
* Update a product modifier
|
|
6729
|
-
* @param variationId - ID of the variation.
|
|
6730
|
-
* @param optionId - ID of the option.
|
|
6731
|
-
* @param modifierId - ID of the modifier.
|
|
6732
|
-
* @param body - The modifier object.
|
|
6733
|
-
* @constructor
|
|
6734
|
-
*/
|
|
6735
|
-
UpdateVariationsModifier(
|
|
6736
|
-
variationId: string,
|
|
6737
|
-
optionId: string,
|
|
6738
|
-
modifierId: string,
|
|
6739
|
-
body: VariationsModifier
|
|
6740
|
-
): Promise<Resource<VariationsModifierResponse>>
|
|
6741
|
-
|
|
6742
|
-
/**
|
|
6743
|
-
* Delete a product modifier
|
|
6744
|
-
* @param variationId - ID of the variation.
|
|
6745
|
-
* @param optionId - ID of the option.
|
|
6746
|
-
* @param modifierId - ID of the modifier.
|
|
6747
|
-
* @constructor
|
|
6748
|
-
*/
|
|
6749
|
-
DeleteVariationsModifier(variationId: string, optionId: string, modifierId: string): Promise<{}>
|
|
6594
|
+
interface UpdateVariationOptionBody
|
|
6595
|
+
extends Omit<PCMVariationOptionBase, 'attributes'>,
|
|
6596
|
+
Identifiable {
|
|
6597
|
+
attributes: {
|
|
6598
|
+
name: string
|
|
6599
|
+
description: string
|
|
6600
|
+
sort_order?: number | null
|
|
6750
6601
|
}
|
|
6602
|
+
}
|
|
6751
6603
|
|
|
6752
6604
|
/**
|
|
6753
|
-
*
|
|
6754
|
-
* Description: A User Authentication Password Profile Info resource represents username and password for user authentication info.
|
|
6755
|
-
* DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/single-sign-on/user-authentication-password-profiles/index.html
|
|
6605
|
+
* Interface for options that are in a PCM Variation's meta.options field
|
|
6756
6606
|
*/
|
|
6757
|
-
|
|
6607
|
+
type PCMVariationMetaOption = Identifiable &
|
|
6608
|
+
PCMVariationOptionBase['attributes']
|
|
6758
6609
|
|
|
6759
6610
|
/**
|
|
6760
|
-
*
|
|
6761
|
-
*
|
|
6611
|
+
* Modifiers object
|
|
6612
|
+
* Modifiers help augmenting properties of a variation of a product, price, etc., by creating an array of child products or prices.
|
|
6762
6613
|
*/
|
|
6763
|
-
|
|
6764
|
-
|
|
6765
|
-
type:
|
|
6766
|
-
|
|
6767
|
-
|
|
6768
|
-
|
|
6614
|
+
interface VariationsModifier {
|
|
6615
|
+
attributes: {
|
|
6616
|
+
type: VariationsModifierType
|
|
6617
|
+
value?: string
|
|
6618
|
+
seek?: string
|
|
6619
|
+
set?: string
|
|
6620
|
+
reference_name?: string
|
|
6621
|
+
}
|
|
6769
6622
|
}
|
|
6770
6623
|
|
|
6771
|
-
interface
|
|
6772
|
-
|
|
6773
|
-
|
|
6774
|
-
|
|
6624
|
+
interface VariationsModifierResponse
|
|
6625
|
+
extends Identifiable,
|
|
6626
|
+
VariationsModifier {
|
|
6627
|
+
type: 'product-variation-modifier'
|
|
6775
6628
|
}
|
|
6776
6629
|
|
|
6777
|
-
|
|
6778
|
-
|
|
6779
|
-
|
|
6780
|
-
|
|
6781
|
-
|
|
6782
|
-
|
|
6783
|
-
|
|
6784
|
-
|
|
6785
|
-
|
|
6786
|
-
}
|
|
6630
|
+
type VariationsModifierTypeObj =
|
|
6631
|
+
| { name_equals: string }
|
|
6632
|
+
| { name_append: string }
|
|
6633
|
+
| { name_prepend: string }
|
|
6634
|
+
| { description_equals: string }
|
|
6635
|
+
| { description_append: string }
|
|
6636
|
+
| { description_prepend: string }
|
|
6637
|
+
| { commoditytype: string }
|
|
6638
|
+
| { slug_equals: string }
|
|
6639
|
+
| { slug_append: string }
|
|
6640
|
+
| { slug_prepend: string }
|
|
6641
|
+
| { slug_builder: VariationsBuilderModifier }
|
|
6642
|
+
| { sku_equals: string }
|
|
6643
|
+
| { sku_append: string }
|
|
6644
|
+
| { sku_prepend: string }
|
|
6645
|
+
| { sku_builder: VariationsBuilderModifier }
|
|
6646
|
+
| { status: string }
|
|
6787
6647
|
|
|
6788
|
-
|
|
6789
|
-
|
|
6790
|
-
|
|
6791
|
-
|
|
6648
|
+
type VariationsModifierType =
|
|
6649
|
+
| 'name_equals'
|
|
6650
|
+
| 'name_append'
|
|
6651
|
+
| 'name_prepend'
|
|
6652
|
+
| 'description_equals'
|
|
6653
|
+
| 'description_append'
|
|
6654
|
+
| 'description_prepend'
|
|
6655
|
+
| 'commodity_type'
|
|
6656
|
+
| 'slug_equals'
|
|
6657
|
+
| 'slug_append'
|
|
6658
|
+
| 'slug_prepend'
|
|
6659
|
+
| 'slug_builder'
|
|
6660
|
+
| 'sku_equals'
|
|
6661
|
+
| 'sku_append'
|
|
6662
|
+
| 'sku_prepend'
|
|
6663
|
+
| 'sku_builder'
|
|
6664
|
+
| 'status'
|
|
6665
|
+
| 'price'
|
|
6666
|
+
|
|
6667
|
+
interface VariationsBuilderModifier {
|
|
6668
|
+
seek: string
|
|
6669
|
+
set: string
|
|
6792
6670
|
}
|
|
6793
6671
|
|
|
6794
6672
|
/**
|
|
6795
|
-
*
|
|
6796
|
-
* DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/
|
|
6673
|
+
* Variations Endpoints
|
|
6674
|
+
* Get DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/catalog/product-variations/get-a-product-variation.html
|
|
6675
|
+
* Get All DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/catalog/product-variations/create-a-product-variation.html
|
|
6676
|
+
* Delete DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/catalog/product-variations/delete-a-product-variation.html
|
|
6797
6677
|
*/
|
|
6798
|
-
interface
|
|
6799
|
-
|
|
6800
|
-
|
|
6801
|
-
|
|
6802
|
-
|
|
6803
|
-
|
|
6804
|
-
|
|
6805
|
-
|
|
6806
|
-
|
|
6807
|
-
|
|
6808
|
-
* DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/single-sign-on/user-authentication-password-profiles/get-a-user-authentication-password-profile.html
|
|
6809
|
-
* @param realmId - The ID for the authentication-realm.
|
|
6810
|
-
* @param userAuthenticationInfoId - The ID for the user authentication info.
|
|
6811
|
-
* @param userAuthenticationPasswordProfileId - The ID for the user authentication password profile info.
|
|
6812
|
-
*/
|
|
6813
|
-
Get(realmId: string, userAuthenticationInfoId: string, userAuthenticationPasswordProfileId: string, token?: string): Promise<UserAuthenticationPasswordProfileResponse>
|
|
6678
|
+
interface PCMVariationsEndpoint
|
|
6679
|
+
extends CrudQueryableResource<
|
|
6680
|
+
PCMVariation,
|
|
6681
|
+
PCMVariationBase,
|
|
6682
|
+
PCMVariationOption,
|
|
6683
|
+
never,
|
|
6684
|
+
never,
|
|
6685
|
+
never
|
|
6686
|
+
> {
|
|
6687
|
+
endpoint: 'pcm/variations'
|
|
6814
6688
|
|
|
6815
|
-
|
|
6816
|
-
* Create an User Authentication Password Info Profile
|
|
6817
|
-
* DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/single-sign-on/user-authentication-password-profiles/create-a-user-authentication-password-profile.html
|
|
6818
|
-
* @param realmId - The ID for the authentication-realm.
|
|
6819
|
-
* @param userAuthenticationInfoId - The ID for the user authentication info.
|
|
6820
|
-
* @param body - The User Authentication Password Profile Info object
|
|
6821
|
-
*/
|
|
6822
|
-
Create(realmId: string, userAuthenticationInfoId: string, body: { data: UserAuthenticationPasswordProfileBody }, token?: string): Promise<UserAuthenticationPasswordProfileResponse>
|
|
6689
|
+
Limit(value: number): PCMVariationsEndpoint
|
|
6823
6690
|
|
|
6824
|
-
|
|
6825
|
-
* Update an User Authentication Password Profile Info
|
|
6826
|
-
* DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/single-sign-on/user-authentication-password-profiles/update-a-user-authentication-password-profile.html
|
|
6827
|
-
* @param realmId - The ID for the authentication-realm.
|
|
6828
|
-
* @param userAuthenticationInfoId - The ID for the user authentication info.
|
|
6829
|
-
* @param userAuthenticationPasswordProfileId - The ID for the user authentication password profile info.
|
|
6830
|
-
* @param body - The User Authentication Password Profile Info object
|
|
6831
|
-
*/
|
|
6832
|
-
Update(realmId: string, userAuthenticationInfoId: string,userAuthenticationPasswordProfileId: string, body: { data: UserAuthenticationPasswordProfileUpdateBody }, token?: string): Promise<UserAuthenticationPasswordProfileResponse>
|
|
6691
|
+
Offset(value: number): PCMVariationsEndpoint
|
|
6833
6692
|
|
|
6834
|
-
|
|
6835
|
-
|
|
6836
|
-
|
|
6837
|
-
|
|
6838
|
-
|
|
6839
|
-
|
|
6840
|
-
*/
|
|
6841
|
-
Delete(realmId: string, userAuthenticationInfoId: string, userAuthenticationPasswordProfileId: string, token?: string)
|
|
6842
|
-
}
|
|
6693
|
+
/**
|
|
6694
|
+
* Create a product variation
|
|
6695
|
+
* @param body - The base variation object.
|
|
6696
|
+
* @constructor
|
|
6697
|
+
*/
|
|
6698
|
+
CreateVariation(body: PCMVariationBase): Promise<Resource<PCMVariation>>
|
|
6843
6699
|
|
|
6844
|
-
|
|
6845
|
-
|
|
6846
|
-
|
|
6700
|
+
/**
|
|
6701
|
+
* Update a product variation
|
|
6702
|
+
* @param id - ID of the variation.
|
|
6703
|
+
* @param body - The variation object.
|
|
6704
|
+
* @param token - a token to access specific data.
|
|
6705
|
+
* @constructor
|
|
6706
|
+
*/
|
|
6707
|
+
UpdateVariation(
|
|
6708
|
+
id: string,
|
|
6709
|
+
body: UpdateVariationBody,
|
|
6710
|
+
token?: string
|
|
6711
|
+
): Promise<Resource<PCMVariation>>
|
|
6712
|
+
|
|
6713
|
+
/**
|
|
6714
|
+
* Get a product variation option
|
|
6715
|
+
* Description: Use this endpoint to retrieve a single variation option.
|
|
6716
|
+
* DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/catalog/product-variations/options/get-a-product-variation-option.html
|
|
6717
|
+
* @param variationId - ID of the variation.
|
|
6718
|
+
* @param optionId - ID of the option.
|
|
6719
|
+
* @constructor
|
|
6720
|
+
*/
|
|
6721
|
+
VariationsOption(
|
|
6722
|
+
variationId: string,
|
|
6723
|
+
optionId: string
|
|
6724
|
+
): Promise<Resource<PCMVariationOption>>
|
|
6725
|
+
|
|
6726
|
+
/**
|
|
6727
|
+
* Get all product variation options
|
|
6728
|
+
* @param variationId - ID of the variation.
|
|
6729
|
+
* @constructor
|
|
6730
|
+
*/
|
|
6731
|
+
VariationsOptions(
|
|
6732
|
+
variationId: string
|
|
6733
|
+
): Promise<ResourcePage<PCMVariationOption>>
|
|
6734
|
+
|
|
6735
|
+
/**
|
|
6736
|
+
* Create a product variation option
|
|
6737
|
+
* @param variationId - ID of the variation.
|
|
6738
|
+
* @param body - The option object.
|
|
6739
|
+
* @constructor
|
|
6740
|
+
*/
|
|
6741
|
+
CreateVariationsOption(
|
|
6742
|
+
variationId: string,
|
|
6743
|
+
body: PCMVariationOptionBase
|
|
6744
|
+
): Promise<Resource<PCMVariationOption>>
|
|
6745
|
+
|
|
6746
|
+
/**
|
|
6747
|
+
* Update product variation option
|
|
6748
|
+
* @param variationId - ID of the variation.
|
|
6749
|
+
* @param optionId - ID of the option.
|
|
6750
|
+
* @param body - The option object.
|
|
6751
|
+
* @constructor
|
|
6752
|
+
*/
|
|
6753
|
+
UpdateVariationsOption(
|
|
6754
|
+
variationId: string,
|
|
6755
|
+
optionId: string,
|
|
6756
|
+
body: UpdateVariationOptionBody
|
|
6757
|
+
): Promise<Resource<PCMVariationOption>>
|
|
6758
|
+
|
|
6759
|
+
/**
|
|
6760
|
+
* Delete product variation option
|
|
6761
|
+
* @param variationId - ID of the variation.
|
|
6762
|
+
* @param optionId - ID of the option.
|
|
6763
|
+
* @constructor
|
|
6764
|
+
*/
|
|
6765
|
+
DeleteVariationsOption(variationId: string, optionId: string): Promise<{}>
|
|
6766
|
+
|
|
6767
|
+
/**
|
|
6768
|
+
* Get a product modifier
|
|
6769
|
+
* @param variationId - ID of the variation.
|
|
6770
|
+
* @param optionId - ID of the option.
|
|
6771
|
+
* @param modifierId - ID of the modifier.
|
|
6772
|
+
* @constructor
|
|
6773
|
+
*/
|
|
6774
|
+
VariationsModifier(
|
|
6775
|
+
variationId: string,
|
|
6776
|
+
optionId: string,
|
|
6777
|
+
modifierId: string
|
|
6778
|
+
): Promise<Resource<VariationsModifierResponse>>
|
|
6779
|
+
|
|
6780
|
+
/**
|
|
6781
|
+
* Get all product modifiers
|
|
6782
|
+
* @param variationId - ID of the variation.
|
|
6783
|
+
* @param optionId - ID of the option.
|
|
6784
|
+
* @constructor
|
|
6785
|
+
*/
|
|
6786
|
+
VariationsModifiers(
|
|
6787
|
+
variationId: string,
|
|
6788
|
+
optionId: string
|
|
6789
|
+
): Promise<ResourceList<VariationsModifierResponse>>
|
|
6790
|
+
|
|
6791
|
+
/**
|
|
6792
|
+
* Create a new product modifier
|
|
6793
|
+
* @param variationId - ID of the variation.
|
|
6794
|
+
* @param optionId - ID of the option.
|
|
6795
|
+
* @param body - The modifier object.
|
|
6796
|
+
* @constructor
|
|
6797
|
+
*/
|
|
6798
|
+
CreateVariationsModifier(
|
|
6799
|
+
variationId: string,
|
|
6800
|
+
optionId: string,
|
|
6801
|
+
body: VariationsModifier
|
|
6802
|
+
): Promise<Resource<VariationsModifierResponse>>
|
|
6803
|
+
|
|
6804
|
+
/**
|
|
6805
|
+
* Update a product modifier
|
|
6806
|
+
* @param variationId - ID of the variation.
|
|
6807
|
+
* @param optionId - ID of the option.
|
|
6808
|
+
* @param modifierId - ID of the modifier.
|
|
6809
|
+
* @param body - The modifier object.
|
|
6810
|
+
* @constructor
|
|
6811
|
+
*/
|
|
6812
|
+
UpdateVariationsModifier(
|
|
6813
|
+
variationId: string,
|
|
6814
|
+
optionId: string,
|
|
6815
|
+
modifierId: string,
|
|
6816
|
+
body: VariationsModifier
|
|
6817
|
+
): Promise<Resource<VariationsModifierResponse>>
|
|
6818
|
+
|
|
6819
|
+
/**
|
|
6820
|
+
* Delete a product modifier
|
|
6821
|
+
* @param variationId - ID of the variation.
|
|
6822
|
+
* @param optionId - ID of the option.
|
|
6823
|
+
* @param modifierId - ID of the modifier.
|
|
6824
|
+
* @constructor
|
|
6825
|
+
*/
|
|
6826
|
+
DeleteVariationsModifier(
|
|
6827
|
+
variationId: string,
|
|
6828
|
+
optionId: string,
|
|
6829
|
+
modifierId: string
|
|
6830
|
+
): Promise<{}>
|
|
6831
|
+
}
|
|
6832
|
+
|
|
6833
|
+
/**
|
|
6834
|
+
* User Authentication Password Profile Info
|
|
6835
|
+
* Description: A User Authentication Password Profile Info resource represents username and password for user authentication info.
|
|
6836
|
+
* DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/single-sign-on/user-authentication-password-profiles/index.html
|
|
6837
|
+
*/
|
|
6838
|
+
|
|
6839
|
+
|
|
6840
|
+
/**
|
|
6841
|
+
* The User Authentication Password Profile Info object
|
|
6842
|
+
* DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/single-sign-on/user-authentication-password-profiles/index.html#The-User-Authentication-Password-Profile-Object
|
|
6843
|
+
*/
|
|
6844
|
+
|
|
6845
|
+
interface UserAuthenticationPasswordProfileBody {
|
|
6846
|
+
type: string
|
|
6847
|
+
password_profile_id: string
|
|
6848
|
+
username: string
|
|
6849
|
+
password : string
|
|
6850
|
+
}
|
|
6851
|
+
|
|
6852
|
+
interface UserAuthenticationPasswordProfileUpdateBody {
|
|
6853
|
+
type: string
|
|
6854
|
+
username: string
|
|
6855
|
+
password : string
|
|
6856
|
+
}
|
|
6857
|
+
|
|
6858
|
+
interface UserAuthenticationPasswordProfile extends UserAuthenticationPasswordProfileBody, Identifiable {
|
|
6859
|
+
meta: {
|
|
6860
|
+
timestamps: {
|
|
6861
|
+
created_at: string
|
|
6862
|
+
updated_at: string
|
|
6863
|
+
}
|
|
6864
|
+
}
|
|
6865
|
+
links: {}
|
|
6866
|
+
relationships: {}
|
|
6867
|
+
}
|
|
6868
|
+
|
|
6869
|
+
interface UserAuthenticationPasswordProfileResponse extends Resource<UserAuthenticationPasswordProfile> {
|
|
6870
|
+
links: {
|
|
6871
|
+
self: string
|
|
6872
|
+
}
|
|
6873
|
+
}
|
|
6874
|
+
|
|
6875
|
+
/**
|
|
6876
|
+
* User Authentication Password Profile Info Endpoints
|
|
6877
|
+
* DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/single-sign-on/user-authentication-password-profiles/index.html
|
|
6878
|
+
*/
|
|
6879
|
+
interface UserAuthenticationPasswordProfileEndpoint {
|
|
6880
|
+
/**
|
|
6881
|
+
* Read All User Authentication Password Info Profile
|
|
6882
|
+
* DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/single-sign-on/user-authentication-password-profiles/get-all-user-authentication-password-profile.html
|
|
6883
|
+
* @param realmId - The ID for the authentication-realm.
|
|
6884
|
+
* @param userAuthenticationInfoId - The ID for the user authentication info.
|
|
6885
|
+
*/
|
|
6886
|
+
All(realmId: string, userAuthenticationInfoId: string, token?: string, headers?): Promise<ResourceList<UserAuthenticationPasswordProfile>>
|
|
6887
|
+
/**
|
|
6888
|
+
* Get a User Authentication Password Info Profile
|
|
6889
|
+
* DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/single-sign-on/user-authentication-password-profiles/get-a-user-authentication-password-profile.html
|
|
6890
|
+
* @param realmId - The ID for the authentication-realm.
|
|
6891
|
+
* @param userAuthenticationInfoId - The ID for the user authentication info.
|
|
6892
|
+
* @param userAuthenticationPasswordProfileId - The ID for the user authentication password profile info.
|
|
6893
|
+
*/
|
|
6894
|
+
Get(realmId: string, userAuthenticationInfoId: string, userAuthenticationPasswordProfileId: string, token?: string): Promise<UserAuthenticationPasswordProfileResponse>
|
|
6895
|
+
|
|
6896
|
+
/**
|
|
6897
|
+
* Create an User Authentication Password Info Profile
|
|
6898
|
+
* DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/single-sign-on/user-authentication-password-profiles/create-a-user-authentication-password-profile.html
|
|
6899
|
+
* @param realmId - The ID for the authentication-realm.
|
|
6900
|
+
* @param userAuthenticationInfoId - The ID for the user authentication info.
|
|
6901
|
+
* @param body - The User Authentication Password Profile Info object
|
|
6902
|
+
*/
|
|
6903
|
+
Create(realmId: string, userAuthenticationInfoId: string, body: { data: UserAuthenticationPasswordProfileBody }, token?: string): Promise<UserAuthenticationPasswordProfileResponse>
|
|
6904
|
+
|
|
6905
|
+
/**
|
|
6906
|
+
* Update an User Authentication Password Profile Info
|
|
6907
|
+
* DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/single-sign-on/user-authentication-password-profiles/update-a-user-authentication-password-profile.html
|
|
6908
|
+
* @param realmId - The ID for the authentication-realm.
|
|
6909
|
+
* @param userAuthenticationInfoId - The ID for the user authentication info.
|
|
6910
|
+
* @param userAuthenticationPasswordProfileId - The ID for the user authentication password profile info.
|
|
6911
|
+
* @param body - The User Authentication Password Profile Info object
|
|
6912
|
+
*/
|
|
6913
|
+
Update(realmId: string, userAuthenticationInfoId: string,userAuthenticationPasswordProfileId: string, body: { data: UserAuthenticationPasswordProfileUpdateBody }, token?: string): Promise<UserAuthenticationPasswordProfileResponse>
|
|
6914
|
+
|
|
6915
|
+
/**
|
|
6916
|
+
* Delete an User Authentication Password Profile Info
|
|
6917
|
+
* DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/single-sign-on/password-profiles/delete-a-user-authentication-password-profile.html
|
|
6918
|
+
* @param realmId - The ID for the authentication-realm containing the Password profiles.
|
|
6919
|
+
* @param userAuthenticationInfoId - The ID for the user authentication info.
|
|
6920
|
+
* @param userAuthenticationPasswordProfileId - The ID for the user authentication password profile info.
|
|
6921
|
+
*/
|
|
6922
|
+
Delete(realmId: string, userAuthenticationInfoId: string, userAuthenticationPasswordProfileId: string, token?: string)
|
|
6923
|
+
}
|
|
6924
|
+
|
|
6925
|
+
interface MetricsBase {
|
|
6926
|
+
value: number
|
|
6927
|
+
time: string
|
|
6847
6928
|
}
|
|
6848
6929
|
|
|
6849
6930
|
interface MetricsQuery {
|
|
@@ -7021,12 +7102,10 @@ interface ApplicationKeysEndpoint extends CrudQueryableResource<
|
|
|
7021
7102
|
interface SubscriptionProductBase {
|
|
7022
7103
|
type: string
|
|
7023
7104
|
attributes: {
|
|
7024
|
-
created_at: string
|
|
7025
7105
|
description: string
|
|
7026
7106
|
main_image?: string | null
|
|
7027
7107
|
name: string
|
|
7028
7108
|
sku: string
|
|
7029
|
-
updated_at: string
|
|
7030
7109
|
price: {
|
|
7031
7110
|
[key: string]: {
|
|
7032
7111
|
amount: number
|
|
@@ -7041,10 +7120,23 @@ interface SubscriptionProductBase {
|
|
|
7041
7120
|
}
|
|
7042
7121
|
|
|
7043
7122
|
interface SubscriptionProduct extends Identifiable, SubscriptionProductBase {
|
|
7044
|
-
|
|
7123
|
+
meta: {
|
|
7124
|
+
display_price: {
|
|
7125
|
+
without_tax: {
|
|
7126
|
+
amount: number
|
|
7127
|
+
currency: string
|
|
7128
|
+
formatted: string
|
|
7129
|
+
}
|
|
7130
|
+
},
|
|
7131
|
+
owner: string
|
|
7132
|
+
timestamps: {
|
|
7133
|
+
created_at: string
|
|
7134
|
+
updated_at: string
|
|
7135
|
+
}
|
|
7136
|
+
}
|
|
7045
7137
|
}
|
|
7046
7138
|
type SubscriptionProductCreate = Omit<SubscriptionProductBase, 'attributes'> & {attributes: Partial<SubscriptionProductBase['attributes']>}
|
|
7047
|
-
type SubscriptionProductUpdate = Omit<
|
|
7139
|
+
type SubscriptionProductUpdate = Identifiable & Omit<SubscriptionProductBase, 'attributes'> & {attributes: Partial<SubscriptionProductBase['attributes']>}
|
|
7048
7140
|
|
|
7049
7141
|
/**
|
|
7050
7142
|
* Subscription Product Endpoints
|
|
@@ -7077,30 +7169,37 @@ interface SubscriptionProductsEndpoint
|
|
|
7077
7169
|
interface SubscriptionPlanBase {
|
|
7078
7170
|
type: string
|
|
7079
7171
|
attributes: {
|
|
7080
|
-
name: string
|
|
7081
|
-
description?: string
|
|
7082
|
-
|
|
7083
|
-
|
|
7084
|
-
|
|
7085
|
-
|
|
7086
|
-
|
|
7087
|
-
|
|
7088
|
-
|
|
7089
|
-
|
|
7090
|
-
|
|
7091
|
-
|
|
7092
|
-
|
|
7093
|
-
|
|
7094
|
-
|
|
7095
|
-
|
|
7172
|
+
name: string
|
|
7173
|
+
description?: string
|
|
7174
|
+
billing_interval_type: string
|
|
7175
|
+
billing_frequency: number
|
|
7176
|
+
trial_period?: number
|
|
7177
|
+
plan_length: number
|
|
7178
|
+
end_behavior: string
|
|
7179
|
+
can_pause: boolean
|
|
7180
|
+
can_resume: boolean
|
|
7181
|
+
can_cancel: boolean
|
|
7182
|
+
base_price_percentage: number | null | undefined
|
|
7183
|
+
fixed_price: {
|
|
7184
|
+
[key: string]: {
|
|
7185
|
+
amount: number
|
|
7186
|
+
includes_tax?: boolean
|
|
7187
|
+
}
|
|
7188
|
+
} | null | undefined
|
|
7096
7189
|
},
|
|
7097
7190
|
}
|
|
7098
7191
|
|
|
7099
7192
|
interface SubscriptionPlan extends Identifiable, SubscriptionPlanBase {
|
|
7100
|
-
|
|
7193
|
+
meta: {
|
|
7194
|
+
owner: string
|
|
7195
|
+
timestamps: {
|
|
7196
|
+
created_at: string
|
|
7197
|
+
updated_at: string
|
|
7198
|
+
}
|
|
7199
|
+
}
|
|
7101
7200
|
}
|
|
7102
7201
|
type SubscriptionPlanCreate = Omit<SubscriptionPlanBase, 'attributes'> & {attributes: Partial<SubscriptionPlanBase['attributes']>}
|
|
7103
|
-
type SubscriptionPlanUpdate = Omit<
|
|
7202
|
+
type SubscriptionPlanUpdate = Identifiable & Omit<SubscriptionPlanBase, 'attributes'> & {attributes: Partial<SubscriptionPlanBase['attributes']>}
|
|
7104
7203
|
|
|
7105
7204
|
/**
|
|
7106
7205
|
* Subscription Plan Endpoints
|
|
@@ -7260,7 +7359,7 @@ interface SubscriptionOfferingsEndpoint
|
|
|
7260
7359
|
SubscriptionOfferingFilter,
|
|
7261
7360
|
never,
|
|
7262
7361
|
never
|
|
7263
|
-
|
|
7362
|
+
> {
|
|
7264
7363
|
endpoint: 'offerings'
|
|
7265
7364
|
|
|
7266
7365
|
Build(body: SubscriptionOfferingBuildBody): Promise<Resource<SubscriptionOffering>>
|
|
@@ -7280,7 +7379,6 @@ interface SubscriptionOfferingsEndpoint
|
|
|
7280
7379
|
AttachProrationPolicy(offeringId: string, body: SubscriptionOfferingAttachProrationPolicyBody | null): Promise<Resource<SubscriptionOfferingAttachProrationPolicyBody>>
|
|
7281
7380
|
|
|
7282
7381
|
ReplaceProducts(offeringId: string, productIds: string[]): Promise<Resource<SubscriptionProduct[]>>
|
|
7283
|
-
}
|
|
7284
7382
|
|
|
7285
7383
|
/**
|
|
7286
7384
|
* One Time Password Token Request
|
|
@@ -7323,41 +7421,29 @@ interface OneTimePasswordTokenRequestEndpoint {
|
|
|
7323
7421
|
* DOCS: TODO: add docs when ready
|
|
7324
7422
|
*/
|
|
7325
7423
|
interface SubscriptionBase {
|
|
7326
|
-
type: "subscription"
|
|
7424
|
+
type: "subscription"
|
|
7327
7425
|
attributes: {
|
|
7328
|
-
|
|
7426
|
+
external_ref?: string
|
|
7427
|
+
account_id: string
|
|
7329
7428
|
offering: {
|
|
7330
7429
|
id: string
|
|
7331
|
-
type: "
|
|
7430
|
+
type: "subscription_offering"
|
|
7332
7431
|
attributes: {
|
|
7333
|
-
|
|
7334
|
-
|
|
7335
|
-
|
|
7336
|
-
|
|
7337
|
-
},
|
|
7338
|
-
relationships: {
|
|
7339
|
-
plans: {
|
|
7340
|
-
links: {
|
|
7341
|
-
related: string,
|
|
7342
|
-
self: string
|
|
7343
|
-
},
|
|
7344
|
-
data: {
|
|
7345
|
-
type: "offering-plan",
|
|
7346
|
-
id: string
|
|
7347
|
-
}
|
|
7348
|
-
}
|
|
7349
|
-
},
|
|
7432
|
+
external_ref?: string
|
|
7433
|
+
name: string
|
|
7434
|
+
description: string
|
|
7435
|
+
}
|
|
7350
7436
|
meta: {
|
|
7351
7437
|
owner: string
|
|
7438
|
+
timestamps: {
|
|
7439
|
+
updated_at: string
|
|
7440
|
+
created_at: string
|
|
7441
|
+
canceled_at: string | null
|
|
7442
|
+
}
|
|
7352
7443
|
}
|
|
7353
|
-
}
|
|
7354
|
-
plan_id: string
|
|
7355
|
-
currency: string
|
|
7356
|
-
updated_at: string,
|
|
7357
|
-
created_at: string
|
|
7358
|
-
},
|
|
7359
|
-
meta: {
|
|
7360
|
-
owner: string
|
|
7444
|
+
}
|
|
7445
|
+
plan_id: string
|
|
7446
|
+
currency: string
|
|
7361
7447
|
}
|
|
7362
7448
|
}
|
|
7363
7449
|
|
|
@@ -7371,6 +7457,13 @@ interface SubscriptionCreate {
|
|
|
7371
7457
|
}
|
|
7372
7458
|
}
|
|
7373
7459
|
|
|
7460
|
+
interface SubscriptionUpdate extends Identifiable {
|
|
7461
|
+
type: 'subscription'
|
|
7462
|
+
attributes: {
|
|
7463
|
+
plan_id: string
|
|
7464
|
+
}
|
|
7465
|
+
}
|
|
7466
|
+
|
|
7374
7467
|
interface SubscriptionInvoice extends Identifiable {
|
|
7375
7468
|
type: "subscription-invoice",
|
|
7376
7469
|
attributes: {
|
|
@@ -7401,9 +7494,42 @@ interface SubscriptionInvoice extends Identifiable {
|
|
|
7401
7494
|
}
|
|
7402
7495
|
}
|
|
7403
7496
|
|
|
7404
|
-
|
|
7405
|
-
|
|
7406
|
-
|
|
7497
|
+
interface SubscriptionFilter {
|
|
7498
|
+
eq?: {
|
|
7499
|
+
account_id?: string
|
|
7500
|
+
}
|
|
7501
|
+
}
|
|
7502
|
+
|
|
7503
|
+
|
|
7504
|
+
interface Subscription extends Identifiable, SubscriptionBase {
|
|
7505
|
+
relationships: {
|
|
7506
|
+
subscriber: {
|
|
7507
|
+
data: {
|
|
7508
|
+
id: string
|
|
7509
|
+
type: 'subscription_subscriber'
|
|
7510
|
+
}
|
|
7511
|
+
}
|
|
7512
|
+
}
|
|
7513
|
+
meta: {
|
|
7514
|
+
owner: string
|
|
7515
|
+
status: 'active' | 'inactive'
|
|
7516
|
+
canceled: boolean
|
|
7517
|
+
paused: boolean
|
|
7518
|
+
closed: boolean
|
|
7519
|
+
timestamps: {
|
|
7520
|
+
updated_at: string
|
|
7521
|
+
created_at: string
|
|
7522
|
+
canceled_at: string | null
|
|
7523
|
+
}
|
|
7524
|
+
}
|
|
7525
|
+
}
|
|
7526
|
+
|
|
7527
|
+
type SubscriptionsInclude = 'plans'
|
|
7528
|
+
|
|
7529
|
+
type SubscriptionsStateAction = 'cancel'| 'pause'| 'resume'
|
|
7530
|
+
|
|
7531
|
+
interface SubscriptionsIncluded {
|
|
7532
|
+
plans: SubscriptionOfferingPlan[]
|
|
7407
7533
|
}
|
|
7408
7534
|
|
|
7409
7535
|
/**
|
|
@@ -7414,14 +7540,538 @@ interface SubscriptionsEndpoint
|
|
|
7414
7540
|
extends Omit<CrudQueryableResource<
|
|
7415
7541
|
Subscription,
|
|
7416
7542
|
SubscriptionCreate,
|
|
7543
|
+
SubscriptionUpdate,
|
|
7544
|
+
SubscriptionFilter,
|
|
7545
|
+
never,
|
|
7546
|
+
SubscriptionsInclude
|
|
7547
|
+
>, "All" | "Attributes" | "Link" > {
|
|
7548
|
+
endpoint: 'subscriptions'
|
|
7549
|
+
|
|
7550
|
+
All(token?: string): Promise<ResourcePage<Subscription, SubscriptionsIncluded>>
|
|
7551
|
+
|
|
7552
|
+
GetInvoices(id: string): Promise<Resource<SubscriptionInvoice[]>>
|
|
7553
|
+
|
|
7554
|
+
GetAttachedProducts(id: string) : Promise<Resource<SubscriptionOfferingProduct[]>>
|
|
7555
|
+
|
|
7556
|
+
GetAttachedPlans(id: string) : Promise<Resource<SubscriptionOfferingPlan[]>>
|
|
7557
|
+
|
|
7558
|
+
CreateState(id: string, action: SubscriptionsStateAction) : Promise<void>
|
|
7559
|
+
}
|
|
7560
|
+
|
|
7561
|
+
/**
|
|
7562
|
+
* Promotions Builder
|
|
7563
|
+
* Description:Promotions allow you to provide discounts to customers.
|
|
7564
|
+
* A Promotion can be automatic which is applied provided any criteria are satisfied,
|
|
7565
|
+
* or require codes, which are then used by the end user to get a discount.
|
|
7566
|
+
*/
|
|
7567
|
+
|
|
7568
|
+
|
|
7569
|
+
interface ActionLimitation {
|
|
7570
|
+
max_discount?: number
|
|
7571
|
+
max_quantity?: number
|
|
7572
|
+
items?: {
|
|
7573
|
+
max_items?: number
|
|
7574
|
+
price_strategy?: string
|
|
7575
|
+
}
|
|
7576
|
+
}
|
|
7577
|
+
|
|
7578
|
+
interface ActionCondition {
|
|
7579
|
+
strategy: string
|
|
7580
|
+
operator?: string
|
|
7581
|
+
args?: any[]
|
|
7582
|
+
children?: {
|
|
7583
|
+
strategy?: string
|
|
7584
|
+
operator?: string
|
|
7585
|
+
args?: any[]
|
|
7586
|
+
}[]
|
|
7587
|
+
}
|
|
7588
|
+
|
|
7589
|
+
interface Action {
|
|
7590
|
+
strategy: string
|
|
7591
|
+
args: any[]
|
|
7592
|
+
limitations?: ActionLimitation
|
|
7593
|
+
condition?: ActionCondition
|
|
7594
|
+
}
|
|
7595
|
+
|
|
7596
|
+
interface Condition {
|
|
7597
|
+
strategy: string
|
|
7598
|
+
operator?: string
|
|
7599
|
+
args?: any[]
|
|
7600
|
+
children?: Condition[]
|
|
7601
|
+
}
|
|
7602
|
+
|
|
7603
|
+
/**
|
|
7604
|
+
* Promotions Builder
|
|
7605
|
+
* Description:Base Promotion Type
|
|
7606
|
+
*/
|
|
7607
|
+
interface RulePromotionBase {
|
|
7608
|
+
type: 'rule_promotion'
|
|
7609
|
+
name: string
|
|
7610
|
+
description: string
|
|
7611
|
+
enabled: boolean
|
|
7612
|
+
automatic?: boolean
|
|
7613
|
+
start: string
|
|
7614
|
+
end: string
|
|
7615
|
+
rule_set: {
|
|
7616
|
+
currencies: string[]
|
|
7617
|
+
catalog_ids: string[]
|
|
7618
|
+
rules: Condition
|
|
7619
|
+
actions: Action[]
|
|
7620
|
+
}
|
|
7621
|
+
}
|
|
7622
|
+
|
|
7623
|
+
interface RulePromotionMeta {
|
|
7624
|
+
timestamps: {
|
|
7625
|
+
created_at: string
|
|
7626
|
+
updated_at: string
|
|
7627
|
+
}
|
|
7628
|
+
}
|
|
7629
|
+
|
|
7630
|
+
interface RulePromotion extends Identifiable, RulePromotionBase {
|
|
7631
|
+
meta: RulePromotionMeta
|
|
7632
|
+
}
|
|
7633
|
+
|
|
7634
|
+
interface RulePromotionCode {
|
|
7635
|
+
code: string
|
|
7636
|
+
uses?: number
|
|
7637
|
+
user?: string
|
|
7638
|
+
created_by?: string
|
|
7639
|
+
max_uses?: number
|
|
7640
|
+
meta?: RulePromotionMeta
|
|
7641
|
+
consume_unit?: 'per_application' | 'per_checkout'
|
|
7642
|
+
}
|
|
7643
|
+
|
|
7644
|
+
interface DeleteRulePromotionCodes extends ResourceList<any> {
|
|
7645
|
+
code: string
|
|
7646
|
+
}
|
|
7647
|
+
|
|
7648
|
+
interface RulePromotionsEndpoint
|
|
7649
|
+
extends CrudQueryableResource<
|
|
7650
|
+
RulePromotion,
|
|
7651
|
+
RulePromotionBase,
|
|
7652
|
+
Partial<RulePromotionBase>,
|
|
7653
|
+
never,
|
|
7654
|
+
never,
|
|
7655
|
+
never
|
|
7656
|
+
> {
|
|
7657
|
+
endpoint: 'rule-promotions'
|
|
7658
|
+
|
|
7659
|
+
Codes(promotionId: string): Promise<ResourcePage<RulePromotionCode>>
|
|
7660
|
+
|
|
7661
|
+
AddCodes(
|
|
7662
|
+
promotionId: string,
|
|
7663
|
+
codes: RulePromotionCode[]
|
|
7664
|
+
): Promise<Resource<RulePromotionBase>>
|
|
7665
|
+
|
|
7666
|
+
DeleteCode(promotionId: string, codeId: string): Promise<{}>
|
|
7667
|
+
|
|
7668
|
+
DeleteCodes(
|
|
7669
|
+
promotionId: string,
|
|
7670
|
+
codes: DeleteRulePromotionCodes[]
|
|
7671
|
+
): Promise<{}>
|
|
7672
|
+
}
|
|
7673
|
+
|
|
7674
|
+
/**
|
|
7675
|
+
* Subscription Subscribers
|
|
7676
|
+
* Description: Subscription Subscribers.
|
|
7677
|
+
* DOCS: TODO: add docs when ready
|
|
7678
|
+
*/
|
|
7679
|
+
|
|
7680
|
+
|
|
7681
|
+
/**
|
|
7682
|
+
* Core Subscription Subscriber Base Interface
|
|
7683
|
+
* For custom flows, extend this interface
|
|
7684
|
+
* DOCS: TODO: add docs when ready
|
|
7685
|
+
*/
|
|
7686
|
+
interface SubscriptionSubscriberBase {
|
|
7687
|
+
type: "subscription_subscriber"
|
|
7688
|
+
attributes: {
|
|
7689
|
+
account_id: string
|
|
7690
|
+
name: string
|
|
7691
|
+
email: string
|
|
7692
|
+
}
|
|
7693
|
+
}
|
|
7694
|
+
interface SubscriptionSubscriber extends Identifiable, SubscriptionSubscriberBase {
|
|
7695
|
+
meta: {
|
|
7696
|
+
owner: string
|
|
7697
|
+
timestamps: {
|
|
7698
|
+
created_at: string
|
|
7699
|
+
updated_at: string
|
|
7700
|
+
}
|
|
7701
|
+
}
|
|
7702
|
+
}
|
|
7703
|
+
type SubscriptionSubscriberCreate = SubscriptionSubscriberBase
|
|
7704
|
+
type SubscriptionSubscriberUpdate = Identifiable & Omit<SubscriptionSubscriberBase, 'attributes'> & {attributes: Partial<SubscriptionSubscriberBase['attributes']>}
|
|
7705
|
+
|
|
7706
|
+
/**
|
|
7707
|
+
* Subscription Subscriber Endpoints
|
|
7708
|
+
* DOCS: TODO: add docs when ready
|
|
7709
|
+
*/
|
|
7710
|
+
interface SubscriptionSubscribersEndpoint
|
|
7711
|
+
extends CrudQueryableResource<
|
|
7712
|
+
SubscriptionSubscriber,
|
|
7713
|
+
SubscriptionSubscriberCreate,
|
|
7714
|
+
SubscriptionSubscriberUpdate,
|
|
7715
|
+
never,
|
|
7716
|
+
never,
|
|
7717
|
+
never
|
|
7718
|
+
> {
|
|
7719
|
+
endpoint: 'plans'
|
|
7720
|
+
}
|
|
7721
|
+
|
|
7722
|
+
/**
|
|
7723
|
+
* Subscription Jobs
|
|
7724
|
+
* Description: Subscription Jobs.
|
|
7725
|
+
* DOCS: TODO: add docs when ready
|
|
7726
|
+
*/
|
|
7727
|
+
|
|
7728
|
+
|
|
7729
|
+
/**
|
|
7730
|
+
* Core Subscription Job Base Interface
|
|
7731
|
+
* For custom flows, extend this interface
|
|
7732
|
+
* DOCS: TODO: add docs when ready
|
|
7733
|
+
*/
|
|
7734
|
+
interface SubscriptionJobBase {
|
|
7735
|
+
type: "subscription_job",
|
|
7736
|
+
attributes: {
|
|
7737
|
+
external_ref: string,
|
|
7738
|
+
job_type: "billing-run" | "payment-run" | "tax-run"
|
|
7739
|
+
taxes?: {
|
|
7740
|
+
invoice_id: string,
|
|
7741
|
+
tax_items: [
|
|
7742
|
+
{
|
|
7743
|
+
type: "tax_item",
|
|
7744
|
+
name?: string,
|
|
7745
|
+
code?: string,
|
|
7746
|
+
rate: number,
|
|
7747
|
+
jurisdiction?: string
|
|
7748
|
+
}
|
|
7749
|
+
]
|
|
7750
|
+
}[]
|
|
7751
|
+
}
|
|
7752
|
+
}
|
|
7753
|
+
|
|
7754
|
+
interface SubscriptionJob extends Identifiable, SubscriptionJobBase {
|
|
7755
|
+
attributes: SubscriptionJobBase['attributes'] & {
|
|
7756
|
+
status: 'pending' | 'started' | 'success' | 'failed'
|
|
7757
|
+
updated_at: string
|
|
7758
|
+
created_at: string
|
|
7759
|
+
}
|
|
7760
|
+
relationships: {
|
|
7761
|
+
[key: string]: {
|
|
7762
|
+
links: {
|
|
7763
|
+
related: string,
|
|
7764
|
+
self: string
|
|
7765
|
+
},
|
|
7766
|
+
data: {
|
|
7767
|
+
type: string,
|
|
7768
|
+
id: string
|
|
7769
|
+
}
|
|
7770
|
+
}
|
|
7771
|
+
},
|
|
7772
|
+
meta: {
|
|
7773
|
+
owner: 'store' | 'organization',
|
|
7774
|
+
timestamps: {
|
|
7775
|
+
updated_at: string,
|
|
7776
|
+
created_at: string,
|
|
7777
|
+
started_at?: string,
|
|
7778
|
+
finished_at?: string
|
|
7779
|
+
}
|
|
7780
|
+
}
|
|
7781
|
+
}
|
|
7782
|
+
|
|
7783
|
+
type SubscriptionJobCreate = SubscriptionJobBase
|
|
7784
|
+
|
|
7785
|
+
/**
|
|
7786
|
+
* Subscription Job Endpoints
|
|
7787
|
+
* DOCS: TODO: add docs when ready
|
|
7788
|
+
*/
|
|
7789
|
+
interface SubscriptionJobsEndpoint
|
|
7790
|
+
extends CrudQueryableResource<
|
|
7791
|
+
SubscriptionJob,
|
|
7792
|
+
SubscriptionJobCreate,
|
|
7417
7793
|
never,
|
|
7418
7794
|
never,
|
|
7419
7795
|
never,
|
|
7420
7796
|
never
|
|
7421
|
-
|
|
7422
|
-
endpoint: '
|
|
7797
|
+
> {
|
|
7798
|
+
endpoint: 'jobs'
|
|
7799
|
+
}
|
|
7423
7800
|
|
|
7424
|
-
|
|
7801
|
+
/**
|
|
7802
|
+
* Subscription Schedules
|
|
7803
|
+
* Description: Subscription Schedules.
|
|
7804
|
+
* DOCS: TODO: add docs when ready
|
|
7805
|
+
*/
|
|
7806
|
+
|
|
7807
|
+
|
|
7808
|
+
/**
|
|
7809
|
+
* Core Subscription Schedule Base Interface
|
|
7810
|
+
* For custom flows, extend this interface
|
|
7811
|
+
* DOCS: TODO: add docs when ready
|
|
7812
|
+
*/
|
|
7813
|
+
interface SubscriptionScheduleBase {
|
|
7814
|
+
type: 'subscription_schedule'
|
|
7815
|
+
attributes: {
|
|
7816
|
+
external_ref?: string | null
|
|
7817
|
+
name?: string
|
|
7818
|
+
specification: string
|
|
7819
|
+
location: string
|
|
7820
|
+
job: {
|
|
7821
|
+
job_type: SubscriptionJob['attributes']['job_type']
|
|
7822
|
+
}
|
|
7823
|
+
}
|
|
7824
|
+
}
|
|
7825
|
+
|
|
7826
|
+
interface SubscriptionSchedule extends Identifiable, SubscriptionScheduleBase {
|
|
7827
|
+
meta: {
|
|
7828
|
+
scheduled_for: string
|
|
7829
|
+
owner: 'store' | 'organization'
|
|
7830
|
+
timestamps: {
|
|
7831
|
+
updated_at: string
|
|
7832
|
+
created_at: string
|
|
7833
|
+
}
|
|
7834
|
+
}
|
|
7835
|
+
}
|
|
7836
|
+
|
|
7837
|
+
type SubscriptionScheduleCreate = SubscriptionScheduleBase
|
|
7838
|
+
type SubscriptionScheduleUpdate = Identifiable & Omit<SubscriptionScheduleBase, 'attributes'> & {attributes: Partial<SubscriptionSchedule['attributes']>}
|
|
7839
|
+
|
|
7840
|
+
/**
|
|
7841
|
+
* Subscription Schedule Endpoints
|
|
7842
|
+
* DOCS: TODO: add docs when ready
|
|
7843
|
+
*/
|
|
7844
|
+
interface SubscriptionSchedulesEndpoint
|
|
7845
|
+
extends CrudQueryableResource<
|
|
7846
|
+
SubscriptionSchedule,
|
|
7847
|
+
SubscriptionScheduleCreate,
|
|
7848
|
+
SubscriptionScheduleUpdate,
|
|
7849
|
+
never,
|
|
7850
|
+
never,
|
|
7851
|
+
never
|
|
7852
|
+
> {
|
|
7853
|
+
endpoint: 'schedules'
|
|
7854
|
+
}
|
|
7855
|
+
|
|
7856
|
+
/**
|
|
7857
|
+
* Commerce Extensions
|
|
7858
|
+
* Description: Commerce Extensions allows for the creation of Custom APIs that can manage large, private data sets efficiently, offering both simple and complex multidimensional filtering options.
|
|
7859
|
+
* DOCS: https://elasticpath.dev/docs/commerce-cloud/commerce-extensions/overview
|
|
7860
|
+
*/
|
|
7861
|
+
|
|
7862
|
+
|
|
7863
|
+
|
|
7864
|
+
interface CustomApiBase {
|
|
7865
|
+
name: string
|
|
7866
|
+
description: string
|
|
7867
|
+
api_type: string
|
|
7868
|
+
type: string
|
|
7869
|
+
slug: string
|
|
7870
|
+
}
|
|
7871
|
+
|
|
7872
|
+
interface CustomApi extends Identifiable, CustomApiBase {
|
|
7873
|
+
links: {
|
|
7874
|
+
self: string
|
|
7875
|
+
}
|
|
7876
|
+
meta: {
|
|
7877
|
+
timestamps: {
|
|
7878
|
+
created_at: string
|
|
7879
|
+
updated_at: string
|
|
7880
|
+
}
|
|
7881
|
+
}
|
|
7882
|
+
}
|
|
7883
|
+
|
|
7884
|
+
type CustomFieldValidation =
|
|
7885
|
+
| { string: { min_length?: number, max_length?: number, regex?: string, allow_null_values?: boolean } }
|
|
7886
|
+
| { integer: { min_value?: number, max_value?: number, allow_null_values?: boolean } }
|
|
7887
|
+
| { float: { min_value?: number, max_value?: number, allow_null_values?: boolean } }
|
|
7888
|
+
| { boolean: { allow_null_values?: boolean } }
|
|
7889
|
+
|
|
7890
|
+
interface CustomApiFieldBase {
|
|
7891
|
+
name: string
|
|
7892
|
+
description: string
|
|
7893
|
+
field_type: string
|
|
7894
|
+
type: string
|
|
7895
|
+
slug: string
|
|
7896
|
+
validation?: CustomFieldValidation
|
|
7897
|
+
}
|
|
7898
|
+
|
|
7899
|
+
interface CustomApiField extends Identifiable, CustomApiFieldBase {
|
|
7900
|
+
links: {
|
|
7901
|
+
self: string
|
|
7902
|
+
}
|
|
7903
|
+
meta: {
|
|
7904
|
+
timestamps: {
|
|
7905
|
+
created_at: string
|
|
7906
|
+
updated_at: string
|
|
7907
|
+
}
|
|
7908
|
+
}
|
|
7909
|
+
}
|
|
7910
|
+
|
|
7911
|
+
interface CustomApisEndpoint {
|
|
7912
|
+
endpoint: 'settings/extensions/custom-apis'
|
|
7913
|
+
entriesEndpoint: 'extensions'
|
|
7914
|
+
|
|
7915
|
+
All(token?: string): Promise<ResourcePage<CustomApi>>
|
|
7916
|
+
|
|
7917
|
+
Get(id: string, token?: string): Promise<Resource<CustomApi>>
|
|
7918
|
+
|
|
7919
|
+
Filter(filter: any): CustomApisEndpoint
|
|
7920
|
+
|
|
7921
|
+
Limit(value: number): CustomApisEndpoint
|
|
7922
|
+
|
|
7923
|
+
Offset(value: number): CustomApisEndpoint
|
|
7924
|
+
|
|
7925
|
+
Sort(value: string): CustomApisEndpoint
|
|
7926
|
+
|
|
7927
|
+
Create(body: CustomApiBase): Promise<Resource<CustomApi>>
|
|
7928
|
+
|
|
7929
|
+
Update(
|
|
7930
|
+
id: string,
|
|
7931
|
+
body: Partial<CustomApiBase>,
|
|
7932
|
+
token?: string
|
|
7933
|
+
): Promise<Resource<CustomApi>>
|
|
7934
|
+
|
|
7935
|
+
Delete(id: string): Promise<{}>
|
|
7936
|
+
|
|
7937
|
+
GetFields<T = any>(customApiId: string): Promise<T>
|
|
7938
|
+
|
|
7939
|
+
GetField<T = any>(customApiId: string, customApiFieldId:string): Promise<T>
|
|
7940
|
+
|
|
7941
|
+
CreateField<RequestBody = CustomApiFieldBase, ResponseBody = CustomApiField>(
|
|
7942
|
+
customApiId: string,
|
|
7943
|
+
body: RequestBody
|
|
7944
|
+
): Promise<ResponseBody>
|
|
7945
|
+
|
|
7946
|
+
UpdateField<RequestBody = CustomApiFieldBase, ResponseBody = CustomApiField>(
|
|
7947
|
+
customApiId: string,
|
|
7948
|
+
customApiFieldId: string,
|
|
7949
|
+
body: RequestBody
|
|
7950
|
+
): Promise<ResponseBody>
|
|
7951
|
+
|
|
7952
|
+
DeleteField<T = any>(customApiId: string, customApiFieldId: string): Promise<T>
|
|
7953
|
+
|
|
7954
|
+
GetEntries<T = any>(customApiId: string): Promise<T>
|
|
7955
|
+
|
|
7956
|
+
GetEntry<T = any>(customApiId: string, customApiEntryId: string): Promise<T>
|
|
7957
|
+
|
|
7958
|
+
CreateEntry<RequestBody = any, ResponseBody = any>(
|
|
7959
|
+
customApiId: string,
|
|
7960
|
+
body: RequestBody
|
|
7961
|
+
): Promise<ResponseBody>
|
|
7962
|
+
|
|
7963
|
+
UpdateEntry<RequestBody = any, ResponseBody = any>(
|
|
7964
|
+
customApiId: string,
|
|
7965
|
+
customApiEntryId: string,
|
|
7966
|
+
body: RequestBody
|
|
7967
|
+
): Promise<ResponseBody>
|
|
7968
|
+
|
|
7969
|
+
DeleteEntry<T = any>(customApiId: string, customApiEntryId: string): Promise<T>
|
|
7970
|
+
|
|
7971
|
+
}
|
|
7972
|
+
|
|
7973
|
+
/**
|
|
7974
|
+
* Subscription Dunning Rules
|
|
7975
|
+
* Description: Subscription Dunning Rules.
|
|
7976
|
+
* DOCS: TODO: add docs when ready
|
|
7977
|
+
*/
|
|
7978
|
+
|
|
7979
|
+
|
|
7980
|
+
/**
|
|
7981
|
+
* Core Subscription Dunning Rules Base Interface
|
|
7982
|
+
* For custom flows, extend this interface
|
|
7983
|
+
* DOCS: TODO: add docs when ready
|
|
7984
|
+
*/
|
|
7985
|
+
interface SubscriptionDunningRulesBase {
|
|
7986
|
+
type: 'subscription_dunning_rule'
|
|
7987
|
+
attributes: {
|
|
7988
|
+
payment_retry_type: 'fixed' | 'backoff' | 'tiered'
|
|
7989
|
+
payment_retry_interval?: number
|
|
7990
|
+
payment_retry_unit?: 'day' | 'week'
|
|
7991
|
+
payment_retry_multiplier?: number
|
|
7992
|
+
payment_retries_limit: number
|
|
7993
|
+
action: 'none' | 'pause' | 'close'
|
|
7994
|
+
default?: boolean
|
|
7995
|
+
}
|
|
7996
|
+
}
|
|
7997
|
+
|
|
7998
|
+
interface SubscriptionDunningRules extends Identifiable, SubscriptionDunningRulesBase {
|
|
7999
|
+
meta: {
|
|
8000
|
+
owner: 'store' | 'organization'
|
|
8001
|
+
timestamps: {
|
|
8002
|
+
updated_at: string
|
|
8003
|
+
created_at: string
|
|
8004
|
+
}
|
|
8005
|
+
}
|
|
8006
|
+
}
|
|
8007
|
+
|
|
8008
|
+
type SubscriptionDunningRulesCreate = SubscriptionDunningRulesBase
|
|
8009
|
+
type SubscriptionDunningRulesUpdate = Identifiable & Omit<SubscriptionDunningRulesBase, 'attributes'> & {attributes: Partial<SubscriptionDunningRules['attributes']>}
|
|
8010
|
+
|
|
8011
|
+
/**
|
|
8012
|
+
* Subscription Dunning Rules Endpoints
|
|
8013
|
+
* DOCS: TODO: add docs when ready
|
|
8014
|
+
*/
|
|
8015
|
+
interface SubscriptionDunningRulesEndpoint
|
|
8016
|
+
extends CrudQueryableResource<
|
|
8017
|
+
SubscriptionDunningRules,
|
|
8018
|
+
SubscriptionDunningRulesCreate,
|
|
8019
|
+
SubscriptionDunningRulesUpdate,
|
|
8020
|
+
never,
|
|
8021
|
+
never,
|
|
8022
|
+
never
|
|
8023
|
+
> {
|
|
8024
|
+
endpoint: 'dunning-rules'
|
|
8025
|
+
}
|
|
8026
|
+
|
|
8027
|
+
/**
|
|
8028
|
+
* Subscription Proration Policies
|
|
8029
|
+
* Description: Subscription Proration Policies.
|
|
8030
|
+
* DOCS: TODO: add docs when ready
|
|
8031
|
+
*/
|
|
8032
|
+
|
|
8033
|
+
|
|
8034
|
+
/**
|
|
8035
|
+
* Core Subscription Proration Policies Base Interface
|
|
8036
|
+
* For custom flows, extend this interface
|
|
8037
|
+
* DOCS: TODO: add docs when ready
|
|
8038
|
+
*/
|
|
8039
|
+
interface SubscriptionProrationPolicyBase {
|
|
8040
|
+
type: 'subscription_proration_policy'
|
|
8041
|
+
attributes: {
|
|
8042
|
+
name: string
|
|
8043
|
+
rounding: 'up' | 'down' | 'nearest'
|
|
8044
|
+
external_ref?: string
|
|
8045
|
+
}
|
|
8046
|
+
}
|
|
8047
|
+
|
|
8048
|
+
interface SubscriptionProrationPolicy extends Identifiable, SubscriptionProrationPolicyBase {
|
|
8049
|
+
meta: {
|
|
8050
|
+
owner: 'store' | 'organization'
|
|
8051
|
+
timestamps: {
|
|
8052
|
+
updated_at: string
|
|
8053
|
+
created_at: string
|
|
8054
|
+
}
|
|
8055
|
+
}
|
|
8056
|
+
}
|
|
8057
|
+
|
|
8058
|
+
type SubscriptionProrationPolicyCreate = SubscriptionProrationPolicyBase
|
|
8059
|
+
type SubscriptionProrationPolicyUpdate = Identifiable & Omit<SubscriptionProrationPolicyBase, 'attributes'> & {attributes: Partial<SubscriptionProrationPolicy['attributes']>}
|
|
8060
|
+
|
|
8061
|
+
/**
|
|
8062
|
+
* Subscription Proration Policies Endpoints
|
|
8063
|
+
* DOCS: TODO: add docs when ready
|
|
8064
|
+
*/
|
|
8065
|
+
interface SubscriptionProrationPoliciesEndpoint
|
|
8066
|
+
extends CrudQueryableResource<
|
|
8067
|
+
SubscriptionProrationPolicy,
|
|
8068
|
+
SubscriptionProrationPolicyCreate,
|
|
8069
|
+
SubscriptionProrationPolicyUpdate,
|
|
8070
|
+
never,
|
|
8071
|
+
never,
|
|
8072
|
+
never
|
|
8073
|
+
> {
|
|
8074
|
+
endpoint: 'proration-policies'
|
|
7425
8075
|
}
|
|
7426
8076
|
|
|
7427
8077
|
// Type definitions for @elasticpath/js-sdk
|
|
@@ -7484,6 +8134,13 @@ declare class ElasticPath {
|
|
|
7484
8134
|
SubscriptionOfferings: SubscriptionOfferingsEndpoint
|
|
7485
8135
|
OneTimePasswordTokenRequest: OneTimePasswordTokenRequestEndpoint
|
|
7486
8136
|
Subscriptions: SubscriptionsEndpoint
|
|
8137
|
+
RulePromotions : RulePromotionsEndpoint
|
|
8138
|
+
SubscriptionSubscribers : SubscriptionSubscribersEndpoint
|
|
8139
|
+
SubscriptionJobs : SubscriptionJobsEndpoint
|
|
8140
|
+
SubscriptionSchedules: SubscriptionSchedulesEndpoint
|
|
8141
|
+
CustomApis: CustomApisEndpoint
|
|
8142
|
+
SubscriptionDunningRules: SubscriptionDunningRulesEndpoint
|
|
8143
|
+
SubscriptionProrationPolicies: SubscriptionProrationPoliciesEndpoint
|
|
7487
8144
|
|
|
7488
8145
|
Cart(id?: string): CartEndpoint // This optional cart id is super worrying when using the SDK in a node server :/
|
|
7489
8146
|
constructor(config: Config)
|
|
@@ -7502,4 +8159,4 @@ declare namespace elasticpath {
|
|
|
7502
8159
|
}
|
|
7503
8160
|
}
|
|
7504
8161
|
|
|
7505
|
-
export { Account, AccountAddress, AccountAddressBase, AccountAddressEdit, AccountAddressesEndpoint, AccountAuthenticationSettings, AccountAuthenticationSettingsBase, AccountAuthenticationSettingsEndpoint, AccountBase, AccountEndpoint, AccountFilter, AccountManagementAuthenticationTokenBody, AccountMember, AccountMemberBase, AccountMemberFilter, AccountMembersEndpoint, AccountMembership, AccountMembershipCreateBody, AccountMembershipOnAccountMember, AccountMembershipSettings, AccountMembershipSettingsBase, AccountMembershipSettingsEndpoint, AccountMembershipsEndpoint, AccountMembershipsFilter, AccountMembershipsInclude, AccountMembershipsIncludeAccounts, AccountMembershipsIncluded, AccountMembershipsIncludedAccounts, AccountMembershipsOnAccountMember, AccountMembershipsResponse, AccountTokenBase, AccountUpdateBody, Address, AddressBase, AdyenPayment, AndCondition, AnonymizeOrder, AnonymizeOrderResponse, ApplicationKey, ApplicationKeyBase, ApplicationKeyResponse, ApplicationKeysEndpoint, Attribute, Attributes, AttributesMeta, AuthenticateResponseBody, AuthenticationRealmEndpoint, AuthenticationSettings, AuthenticationSettingsBase, AuthenticationSettingsEndpoint, AuthorizeNetPayment, AuthorizePaymentMethod, BraintreePayment, Brand, BrandBase, BrandEndpoint, BrandFilter, BuildChildProductsJob, BuildRules, BuilderModifier, BulkAddOptions, BulkCustomDiscountOptions, BundleDiscountSchema, BundleGiftSchema, CapturePaymentMethod, CardConnectPayment, Cart, CartAdditionalHeaders, CartCustomDiscount, CartEndpoint, CartInclude, CartIncluded, CartItem, CartItemBase, CartItemObject, CartItemsResponse, CartSettings, CartShippingGroupBase, CartTaxItemObject, Catalog, CatalogBase, CatalogFilter, CatalogReleaseProductFilter, CatalogReleaseProductFilterAttributes, CatalogUpdateBody, CatalogsEndpoint, CatalogsNodesEndpoint, CatalogsProductVariation, CatalogsProductsEndpoint, CatalogsReleasesEndpoint, CatalogsRulesEndpoint, Category, CategoryBase, CategoryEndpoint, CategoryFilter, CheckoutCustomer, CheckoutCustomerObject, CodeFileHref, Collection, CollectionBase, CollectionEndpoint, CollectionFilter, Conditions, Config, ConfigOptions, ConfirmPaymentBody, ConfirmPaymentBodyWithOptions, ConfirmPaymentResponse, CreateCartObject, CreateChildrenSortOrderBody, CrudQueryableResource, Currency, CurrencyAmount, CurrencyBase, CurrencyEndpoint, CurrencyPercentage, CustomAuthenticatorResponseBody, CustomDiscount, CustomDiscountResponse, CustomInputs, CustomInputsValidationRules, Customer, CustomerAddress, CustomerAddressBase, CustomerAddressEdit, CustomerAddressesEndpoint, CustomerBase, CustomerFilter, CustomerInclude, CustomerToken, CustomersEndpoint, CyberSourcePayment, DataEntriesEndpoint, DataEntryRecord, DeletePromotionCodesBodyItem, DuplicateHierarchyBody, DuplicateHierarchyJob, ElasticPath, ElasticPathStripePayment, ErasureRequestRecord, ErasureRequestsEndpoint, Exclude$1 as Exclude, Extensions, Field, FieldBase, FieldsEndpoint, File, FileBase, FileEndpoint, FileFilter, FileHref, FixedDiscountSchema, Flow, FlowBase, FlowEndpoint, FlowFilter, FormattedPrice, Gateway, GatewayBase, GatewaysEndpoint, GrantType, HierarchiesEndpoint, HierarchiesShopperCatalogEndpoint, Hierarchy, HierarchyBase, HierarchyFilter, HttpVerbs, Identifiable, Integration, IntegrationBase, IntegrationEndpoint, IntegrationFilter, IntegrationJob, IntegrationLog, IntegrationLogMeta, IntegrationLogsResponse, Inventory, InventoryActionTypes, InventoryBase, InventoryEndpoint, InventoryResponse, InvoicingResult, ItemFixedDiscountSchema, ItemPercentDiscountSchema, ItemTaxObject, ItemTaxObjectResponse, Job, JobBase, JobEndpoint, LocalStorageFactory, Locales, LogIntegration, ManualPayment, MatrixObject, MemoryStorageFactory, MerchantRealmMappings, MerchantRealmMappingsEndpoint, MergeCartOptions, MetricsBase, MetricsEndpoint, MetricsQuery, Modifier, ModifierResponse, ModifierType, ModifierTypeObj, Node, NodeBase, NodeBaseResponse, NodeFilter, NodeProduct, NodeProductResponse, NodeRelationship, NodeRelationshipBase, NodeRelationshipParent, NodeRelationshipsEndpoint, NodesEndpoint, NodesResponse, NodesShopperCatalogEndpoint, OidcProfileEndpoint, OnboardingLinkResponse, OneTimePasswordTokenRequestBody, OneTimePasswordTokenRequestEndpoint, Option, OptionResponse, Order, OrderAddressBase, OrderBase, OrderBillingAddress, OrderFilter, OrderInclude, OrderIncluded, OrderItem, OrderItemBase, OrderResponse, OrderShippingAddress, OrderSort, OrderSortAscend, OrderSortDescend, OrdersEndpoint, PCMVariation, PCMVariationBase, PCMVariationMetaOption, PCMVariationsEndpoint, PartialPcmProductBase, PasswordProfile, PasswordProfileBody, PasswordProfileEndpoint, PasswordProfileListItem, PasswordProfileResponse, PayPalExpressCheckoutPayment, PaymentMethod, PaymentRequestBody, PcmFileRelationship, PcmFileRelationshipEndpoint, PcmJob, PcmJobBase, PcmJobError, PcmJobsEndpoint, PcmMainImageRelationship, PcmMainImageRelationshipEndpoint, PcmProduct, PcmProductAttachmentBody, PcmProductAttachmentResponse, PcmProductBase, PcmProductFilter, PcmProductInclude, PcmProductRelationships, PcmProductResponse, PcmProductUpdateBody, PcmProductsEndpoint, PcmProductsResponse, PcmTemplateRelationship, PcmTemplateRelationshipEndpoint, PcmVariationsRelationshipResource, PcmVariationsRelationships, PcmVariationsRelationshipsEndpoint, PercentDiscountSchema, PersonalDataEndpoint, PersonalDataRecord, Price, PriceBook, PriceBookBase, PriceBookFilter, PriceBookPrice, PriceBookPriceBase, PriceBookPriceModifier, PriceBookPriceModifierBase, PriceBookPriceModifierEndpoint, PriceBookPricesCreateBody, PriceBookPricesEndpoint, PriceBookPricesUpdateBody, PriceBooksEndpoint, PriceBooksUpdateBody, PricesFilter, Product, ProductBase, ProductComponentOption, ProductComponents, ProductFileRelationshipResource, ProductFilter, ProductResponse, ProductTemplateRelationshipResource, ProductsEndpoint, Profile, ProfileBase, ProfileCreateUpdateBody, ProfileListItem, ProfileResponse, ProfileResponseBody, Promotion, PromotionAttribute, PromotionAttributeValues, PromotionBase, PromotionCode, PromotionCodesJob,
|
|
8162
|
+
export { Account, AccountAddress, AccountAddressBase, AccountAddressEdit, AccountAddressesEndpoint, AccountAssociationData, AccountAssociationResponse, AccountAuthenticationSettings, AccountAuthenticationSettingsBase, AccountAuthenticationSettingsEndpoint, AccountBase, AccountEndpoint, AccountFilter, AccountManagementAuthenticationTokenBody, AccountMember, AccountMemberBase, AccountMemberFilter, AccountMembersEndpoint, AccountMembership, AccountMembershipCreateBody, AccountMembershipOnAccountMember, AccountMembershipSettings, AccountMembershipSettingsBase, AccountMembershipSettingsEndpoint, AccountMembershipsEndpoint, AccountMembershipsFilter, AccountMembershipsInclude, AccountMembershipsIncludeAccounts, AccountMembershipsIncluded, AccountMembershipsIncludedAccounts, AccountMembershipsOnAccountMember, AccountMembershipsResponse, AccountTokenBase, AccountUpdateBody, Action, ActionCondition, ActionLimitation, Address, AddressBase, AdyenPayment, AndCondition, AnonymizeOrder, AnonymizeOrderResponse, ApplicationKey, ApplicationKeyBase, ApplicationKeyResponse, ApplicationKeysEndpoint, Attribute, Attributes, AttributesMeta, AuthenticateResponseBody, AuthenticationRealmEndpoint, AuthenticationSettings, AuthenticationSettingsBase, AuthenticationSettingsEndpoint, AuthorizeNetPayment, AuthorizePaymentMethod, BraintreePayment, Brand, BrandBase, BrandEndpoint, BrandFilter, BuildChildProductsJob, BuildRules, BuilderModifier, BulkAddOptions, BulkCustomDiscountOptions, BundleDiscountSchema, BundleGiftSchema, CapturePaymentMethod, CardConnectPayment, Cart, CartAdditionalHeaders, CartCustomDiscount, CartEndpoint, CartInclude, CartIncluded, CartItem, CartItemBase, CartItemObject, CartItemsResponse, CartSettings, CartShippingGroupBase, CartTaxItemObject, Catalog, CatalogBase, CatalogFilter, CatalogReleaseProductFilter, CatalogReleaseProductFilterAttributes, CatalogUpdateBody, CatalogsEndpoint, CatalogsNodesEndpoint, CatalogsProductVariation, CatalogsProductsEndpoint, CatalogsReleasesEndpoint, CatalogsRulesEndpoint, Category, CategoryBase, CategoryEndpoint, CategoryFilter, CheckoutCustomer, CheckoutCustomerObject, CodeFileHref, Collection, CollectionBase, CollectionEndpoint, CollectionFilter, Condition, Conditions, Config, ConfigOptions, ConfirmPaymentBody, ConfirmPaymentBodyWithOptions, ConfirmPaymentResponse, CreateCartObject, CreateChildrenSortOrderBody, CrudQueryableResource, Currency, CurrencyAmount, CurrencyBase, CurrencyEndpoint, CurrencyPercentage, CustomApi, CustomApiBase, CustomApiField, CustomApiFieldBase, CustomApisEndpoint, CustomAuthenticatorResponseBody, CustomDiscount, CustomDiscountResponse, CustomFieldValidation, CustomInputs, CustomInputsValidationRules, Customer, CustomerAddress, CustomerAddressBase, CustomerAddressEdit, CustomerAddressesEndpoint, CustomerBase, CustomerFilter, CustomerInclude, CustomerToken, CustomersEndpoint, CyberSourcePayment, DataEntriesEndpoint, DataEntryRecord, DeletePromotionCodesBodyItem, DeleteRulePromotionCodes, DuplicateHierarchyBody, DuplicateHierarchyJob, ElasticPath, ElasticPathStripePayment, ErasureRequestRecord, ErasureRequestsEndpoint, Exclude$1 as Exclude, Extensions, Field, FieldBase, FieldsEndpoint, File, FileBase, FileEndpoint, FileFilter, FileHref, FixedDiscountSchema, Flow, FlowBase, FlowEndpoint, FlowFilter, FormattedPrice, Gateway, GatewayBase, GatewaysEndpoint, GrantType, HierarchiesEndpoint, HierarchiesShopperCatalogEndpoint, Hierarchy, HierarchyBase, HierarchyFilter, HttpVerbs, Identifiable, Integration, IntegrationBase, IntegrationEndpoint, IntegrationFilter, IntegrationJob, IntegrationLog, IntegrationLogMeta, IntegrationLogsResponse, Inventory, InventoryActionTypes, InventoryBase, InventoryEndpoint, InventoryResponse, InvoicingResult, ItemFixedDiscountSchema, ItemPercentDiscountSchema, ItemTaxObject, ItemTaxObjectResponse, Job, JobBase, JobEndpoint, LocalStorageFactory, Locales, LogIntegration, ManualPayment, MatrixObject, MemoryStorageFactory, MerchantRealmMappings, MerchantRealmMappingsEndpoint, MergeCartOptions, MetricsBase, MetricsEndpoint, MetricsQuery, Modifier, ModifierResponse, ModifierType, ModifierTypeObj, Node, NodeBase, NodeBaseResponse, NodeFilter, NodeProduct, NodeProductResponse, NodeRelationship, NodeRelationshipBase, NodeRelationshipParent, NodeRelationshipsEndpoint, NodesEndpoint, NodesResponse, NodesShopperCatalogEndpoint, OidcProfileEndpoint, OnboardingLinkResponse, OneTimePasswordTokenRequestBody, OneTimePasswordTokenRequestEndpoint, Option, OptionResponse, Order, OrderAddressBase, OrderBase, OrderBillingAddress, OrderFilter, OrderInclude, OrderIncluded, OrderItem, OrderItemBase, OrderResponse, OrderShippingAddress, OrderSort, OrderSortAscend, OrderSortDescend, OrdersEndpoint, PCMVariation, PCMVariationBase, PCMVariationMetaOption, PCMVariationOption, PCMVariationOptionBase, PCMVariationsEndpoint, PartialPcmProductBase, PasswordProfile, PasswordProfileBody, PasswordProfileEndpoint, PasswordProfileListItem, PasswordProfileResponse, PayPalExpressCheckoutPayment, PaymentMethod, PaymentRequestBody, PcmFileRelationship, PcmFileRelationshipEndpoint, PcmJob, PcmJobBase, PcmJobError, PcmJobsEndpoint, PcmMainImageRelationship, PcmMainImageRelationshipEndpoint, PcmProduct, PcmProductAttachmentBody, PcmProductAttachmentResponse, PcmProductBase, PcmProductFilter, PcmProductInclude, PcmProductRelationships, PcmProductResponse, PcmProductUpdateBody, PcmProductsEndpoint, PcmProductsResponse, PcmTemplateRelationship, PcmTemplateRelationshipEndpoint, PcmVariationsRelationshipResource, PcmVariationsRelationships, PcmVariationsRelationshipsEndpoint, PercentDiscountSchema, PersonalDataEndpoint, PersonalDataRecord, Price, PriceBook, PriceBookBase, PriceBookFilter, PriceBookPrice, PriceBookPriceBase, PriceBookPriceModifier, PriceBookPriceModifierBase, PriceBookPriceModifierEndpoint, PriceBookPricesCreateBody, PriceBookPricesEndpoint, PriceBookPricesUpdateBody, PriceBooksEndpoint, PriceBooksUpdateBody, PricesFilter, Product, ProductBase, ProductComponentOption, ProductComponents, ProductFileRelationshipResource, ProductFilter, ProductResponse, ProductTemplateRelationshipResource, ProductsEndpoint, Profile, ProfileBase, ProfileCreateUpdateBody, ProfileListItem, ProfileResponse, ProfileResponseBody, Promotion, PromotionAttribute, PromotionAttributeValues, PromotionBase, PromotionCode, PromotionCodesJob, PromotionFilter, PromotionJob, PromotionMeta, PromotionSettings, PromotionsEndpoint, PurchasePaymentMethod, QueryableResource, Realm, RealmBase, RealmCreateBody, RealmUpdateBody, RefundPaymentMethod, Relationship, RelationshipToMany, RelationshipToOne, ReleaseBase, ReleaseBodyBase, ReleaseResponse, RequestFactory, Requirements, Resource, ResourceIncluded, ResourceList, ResourcePage, Rule, RuleBase, RuleFilter, RulePromotion, RulePromotionBase, RulePromotionCode, RulePromotionMeta, RulePromotionsEndpoint, RuleUpdateBody, Settings, SettingsEndpoint, ShippingGroupBase, ShippingGroupResponse, ShippingIncluded, ShopperCatalogEndpoint, ShopperCatalogProductsEndpoint, ShopperCatalogReleaseBase, ShopperCatalogResource, ShopperCatalogResourceList, ShopperCatalogResourcePage, StorageFactory, StripeConnectPayment, StripeIntentsPayment, StripePayment, StripePaymentBase, StripePaymentOptionBase, Subscription, SubscriptionBase, SubscriptionCreate, SubscriptionDunningRules, SubscriptionDunningRulesBase, SubscriptionDunningRulesCreate, SubscriptionDunningRulesEndpoint, SubscriptionDunningRulesUpdate, SubscriptionFilter, SubscriptionInvoice, SubscriptionJob, SubscriptionJobBase, SubscriptionJobCreate, SubscriptionJobsEndpoint, SubscriptionOffering, SubscriptionOfferingAttachPlanBody, SubscriptionOfferingAttachProductBody, SubscriptionOfferingAttachProrationPolicyBody, SubscriptionOfferingBase, SubscriptionOfferingBuildBody, SubscriptionOfferingBuildProduct, SubscriptionOfferingCreate, SubscriptionOfferingFilter, SubscriptionOfferingPlan, SubscriptionOfferingProduct, SubscriptionOfferingRelationships, SubscriptionOfferingUpdate, SubscriptionOfferingsEndpoint, SubscriptionPlan, SubscriptionPlanBase, SubscriptionPlanCreate, SubscriptionPlanUpdate, SubscriptionPlansEndpoint, SubscriptionProduct, SubscriptionProductBase, SubscriptionProductCreate, SubscriptionProductUpdate, SubscriptionProductsEndpoint, SubscriptionProrationPoliciesEndpoint, SubscriptionProrationPolicy, SubscriptionProrationPolicyBase, SubscriptionProrationPolicyCreate, SubscriptionProrationPolicyUpdate, SubscriptionSchedule, SubscriptionScheduleBase, SubscriptionScheduleCreate, SubscriptionScheduleUpdate, SubscriptionSchedulesEndpoint, SubscriptionSettings, SubscriptionSubscriber, SubscriptionSubscriberBase, SubscriptionSubscriberCreate, SubscriptionSubscriberUpdate, SubscriptionSubscribersEndpoint, SubscriptionUpdate, SubscriptionsEndpoint, SubscriptionsInclude, SubscriptionsIncluded, SubscriptionsStateAction, Subset, TargetCondition, Transaction, TransactionBase, TransactionEndpoint, TransactionsResponse, TtlSettings, UpdateNodeBody, UpdateVariationBody, UpdateVariationOptionBody, UserAuthenticationInfo, UserAuthenticationInfoBody, UserAuthenticationInfoEndpoint, UserAuthenticationInfoFilter, UserAuthenticationInfoResponse, UserAuthenticationPasswordProfile, UserAuthenticationPasswordProfileBody, UserAuthenticationPasswordProfileEndpoint, UserAuthenticationPasswordProfileResponse, UserAuthenticationPasswordProfileUpdateBody, Validation, Variation, VariationBase, VariationsBuilderModifier, VariationsEndpoint, VariationsModifier, VariationsModifierResponse, VariationsModifierType, VariationsModifierTypeObj, XforAmountSchema, XforYSchema, createJob, elasticpath, gateway };
|