Class Bundles

Hierarchy

Bundles

Index

Properties

Methods

As Create Delete DeleteAssignment DeleteProductAssignment Get List ListAssignments ListProductAssignments Patch Save SaveAssignment SaveProductAssignment

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

As(): Bundles
Description
enables impersonation by calling the subsequent method with the stored impersonation token

Example
```
Bundles.As().List() // lists Bundles using the impersonated users' token
```
Returns Bundles
- Defined in api/Bundles.ts:321

Create

Create<TBundle>(bundle: Bundle<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TBundle>>
Create a bundle Check out the docs for more info
Type Parameters
- TBundle extends Bundle<any, TBundle>
Parameters
- bundle: Bundle<any>
  
  Required fields: Name
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TBundle>>
- Defined in api/Bundles.ts:77

Delete

Delete(bundleID: string, requestOptions?: RequestOptions): Promise<void>
Delete a bundle Check out the docs for more info
Parameters
- bundleID: string
  
  ID of the bundle.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Bundles.ts:141

DeleteAssignment

DeleteAssignment(bundleID: string, buyerID: string, listOptions?: {
    sellerID?: string;
    userGroupID?: string;
    userID?: string;
}, requestOptions?: RequestOptions): Promise<void>
Delete a bundle assignment Check out the docs for more info
Parameters
- bundleID: string
  
  ID of the bundle.
- buyerID: string
  
  ID of the buyer.
- listOptions: {
      sellerID?: string;
      userGroupID?: string;
      userID?: string;
  } = {}
  - Optional sellerID?: string
    
    ID of the seller.
  - Optional userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Bundles.ts:188

DeleteProductAssignment

DeleteProductAssignment(bundleID: string, productID: string, requestOptions?: RequestOptions): Promise<void>
Delete a bundle product assignment Check out the docs for more info
Parameters
- bundleID: string
  
  ID of the bundle.
- productID: string
  
  ID of the product.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Bundles.ts:210

Get

Get<TBundle>(bundleID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TBundle>>
Retrieve a bundle Check out the docs for more info
Type Parameters
- TBundle extends Bundle<any, TBundle>
Parameters
- bundleID: string
  
  ID of the bundle.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TBundle>>
- Defined in api/Bundles.ts:98

List

List<TBundle>(listOptions?: {
    catalogID?: string;
    categoryID?: string;
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: string[];
    searchType?: SearchType;
    sortBy?: string[];
    supplierID?: string;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPageWithFacets<TBundle, any>>>
List bundles Check out the docs for more info
Type Parameters
- TBundle extends Bundle<any, TBundle>
Parameters
- listOptions: {
      catalogID?: string;
      categoryID?: string;
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: string[];
      searchType?: SearchType;
      sortBy?: string[];
      supplierID?: string;
  } = {}
  - Optional catalogID?: string
    
    ID of the catalog.
  - Optional categoryID?: string
    
    ID of the category.
  - Optional filters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optional page?: number
    
    Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: string[]
    
    Comma-delimited list of fields to search on.
  - Optional searchType?: SearchType
    
    Type of search to perform.
  - Optional sortBy?: string[]
    
    Comma-delimited list of fields to sort by.
  - Optional supplierID?: string
    
    ID of the supplier.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPageWithFacets<TBundle, any>>>
- Defined in api/Bundles.ts:56

ListAssignments

ListAssignments<TBundleAssignment>(listOptions?: {
    bundleID?: string;
    buyerID?: string;
    level?: "Group" | "Company";
    page?: number;
    pageSize?: number;
    userGroupID?: string;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TBundleAssignment>>>
List bundle assignments Check out the docs for more info
Type Parameters
- TBundleAssignment extends BundleAssignment
Parameters
- listOptions: {
      bundleID?: string;
      buyerID?: string;
      level?: "Group" | "Company";
      page?: number;
      pageSize?: number;
      userGroupID?: string;
  } = {}
  - Optional bundleID?: string
    
    ID of the bundle.
  - Optional buyerID?: string
    
    ID of the buyer.
  - Optional level?: "Group" | "Company"
    
    Level of the bundle assignment. Possible values: Group, Company.
  - Optional page?: number
    
    Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page.
  - Optional userGroupID?: string
    
    ID of the user group.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TBundleAssignment>>>
- Defined in api/Bundles.ts:236

ListProductAssignments

ListProductAssignments<TBundleProductAssignment>(listOptions?: {
    bundleID?: string;
    page?: number;
    pageSize?: number;
    productID?: string;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TBundleProductAssignment>>>
List bundle product assignments Check out the docs for more info
Type Parameters
- TBundleProductAssignment extends BundleProductAssignment
Parameters
- listOptions: {
      bundleID?: string;
      page?: number;
      pageSize?: number;
      productID?: string;
  } = {}
  - Optional bundleID?: string
    
    ID of the bundle.
  - Optional page?: number
    
    Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page.
  - Optional productID?: string
    
    ID of the product.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TBundleProductAssignment>>>
- Defined in api/Bundles.ts:281

Patch

Patch<TBundle>(bundleID: string, bundle: PartialObjectDeep<Bundle<any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TBundle>>
Partially update a bundle Check out the docs for more info
Type Parameters
- TBundle extends Bundle<any, TBundle>
Parameters
- bundleID: string
  
  ID of the bundle.
- bundle: PartialObjectDeep<Bundle<any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TBundle>>
- Defined in api/Bundles.ts:163

Save

Save<TBundle>(bundleID: string, bundle: Bundle<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TBundle>>
Create or update a bundle If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TBundle extends Bundle<any, TBundle>
Parameters
- bundleID: string
  
  ID of the bundle.
- bundle: Bundle<any>
  
  Required fields: Name
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TBundle>>
- Defined in api/Bundles.ts:120

SaveAssignment

SaveAssignment(bundleAssignment: BundleAssignment, requestOptions?: RequestOptions): Promise<void>
Create or update a bundle assignment Check out the docs for more info
Parameters
- bundleAssignment: BundleAssignment
  
  Required fields: BundleID, BuyerID
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Bundles.ts:257

SaveProductAssignment

SaveProductAssignment(bundleProductAssignment: BundleProductAssignment, requestOptions?: RequestOptions): Promise<void>
Create or update a bundle product assignment Check out the docs for more info
Parameters
- bundleProductAssignment: BundleProductAssignment
  
  Required fields: ProductID, BundleID, Required
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Bundles.ts:302

Class Bundles

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns Bundles

Create

Type Parameters

TBundle extends Bundle<any, TBundle>

Parameters

bundle: Bundle<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TBundle>>

Delete

Parameters

bundleID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteAssignment

Parameters

bundleID: string

buyerID: string

listOptions: { sellerID?: string; userGroupID?: string; userID?: string; } = {}

Optional sellerID?: string

Optional userGroupID?: string

Optional userID?: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteProductAssignment

Parameters

bundleID: string

productID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TBundle extends Bundle<any, TBundle>

Parameters

bundleID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TBundle>>

List

Type Parameters

TBundle extends Bundle<any, TBundle>

Parameters

listOptions: { catalogID?: string; categoryID?: string; filters?: Filters; page?: number; pageSize?: number; search?: string; searchOn?: string[]; searchType?: SearchType; sortBy?: string[]; supplierID?: string; } = {}

Optional catalogID?: string

Optional categoryID?: string

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: string[]

Optional searchType?: SearchType

Optional sortBy?: string[]

Optional supplierID?: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPageWithFacets<TBundle, any>>>

ListAssignments

Type Parameters

TBundleAssignment extends BundleAssignment

Parameters

listOptions: { bundleID?: string; buyerID?: string; level?: "Group" | "Company"; page?: number; pageSize?: number; userGroupID?: string; } = {}

Optional bundleID?: string

Optional buyerID?: string

Optional level?: "Group" | "Company"

Optional page?: number

Optional pageSize?: number

Optional userGroupID?: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TBundleAssignment>>>

ListProductAssignments

Type Parameters

TBundleProductAssignment extends BundleProductAssignment

`Private` impersonating

listOptions: {
sellerID?: string;
userGroupID?: string;
userID?: string;
} = {}

`Optional` sellerID?: string

`Optional` userGroupID?: string

`Optional` userID?: string

listOptions: {
catalogID?: string;
categoryID?: string;
filters?: Filters;
page?: number;
pageSize?: number;
search?: string;
searchOn?: string[];
searchType?: SearchType;
sortBy?: string[];
supplierID?: string;
} = {}

`Optional` catalogID?: string

`Optional` categoryID?: string

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: string[]

`Optional` searchType?: SearchType

`Optional` sortBy?: string[]

`Optional` supplierID?: string

listOptions: {
bundleID?: string;
buyerID?: string;
level?: "Group" | "Company";
page?: number;
pageSize?: number;
userGroupID?: string;
} = {}

`Optional` bundleID?: string

`Optional` buyerID?: string

`Optional` level?: "Group" | "Company"

`Optional` page?: number

`Optional` pageSize?: number

`Optional` userGroupID?: string

listOptions: {
bundleID?: string;
page?: number;
pageSize?: number;
productID?: string;
} = {}

`Optional` bundleID?: string

`Optional` page?: number

`Optional` pageSize?: number

`Optional` productID?: string