Class Bundles

Index

Methods

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

Methods

As

As(): this
Returns this
Description
enables impersonation by calling the subsequent method with the stored impersonation token
Example
```
Bundles.As().List() // lists Bundles using the impersonated users' token
```
- Defined in api/Bundles.ts:321

Create

Create<TBundle extends Bundle<any>>(
bundle: Bundle,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TBundle>>
Create a bundle Check out the docs for more info
Type Parameters
- TBundle extends Bundle<any>
Parameters
- bundle: Bundle
  Required fields: Name
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
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 = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
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 } = {}
  - OptionalsellerID?: string
    
    ID of the seller.
  - OptionaluserGroupID?: string
    
    ID of the user group.
  - OptionaluserID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
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 = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Bundles.ts:210

Get

Get<TBundle extends Bundle<any>>(
bundleID: string,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TBundle>>
Retrieve a bundle Check out the docs for more info
Type Parameters
- TBundle extends Bundle<any>
Parameters
- bundleID: string
  ID of the bundle.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TBundle>>
- Defined in api/Bundles.ts:98

List

List<TBundle extends Bundle<any>>(
    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>
Parameters
- listOptions: {
      catalogID?: string;
      categoryID?: string;
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: string[];
      searchType?: SearchType;
      sortBy?: string[];
      supplierID?: string;
  } = {}
  - OptionalcatalogID?: string
    
    ID of the catalog.
  - OptionalcategoryID?: string
    
    ID of the category.
  - Optionalfilters?: 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.???'
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: string[]
    
    Comma-delimited list of fields to search on.
  - OptionalsearchType?: SearchType
    
    Type of search to perform.
  - OptionalsortBy?: string[]
    
    Comma-delimited list of fields to sort by.
  - OptionalsupplierID?: string
    
    ID of the supplier.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPageWithFacets<TBundle, any>>>
- Defined in api/Bundles.ts:56

ListAssignments

ListAssignments<TBundleAssignment extends BundleAssignment>(
    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;
  } = {}
  - OptionalbundleID?: string
    
    ID of the bundle.
  - OptionalbuyerID?: string
    
    ID of the buyer.
  - Optionallevel?: "Group" | "Company"
    
    Level of the bundle assignment. Possible values: Group, Company, BuyerGroup.
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - OptionaluserGroupID?: string
    
    ID of the user group.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TBundleAssignment>>>
- Defined in api/Bundles.ts:236

ListProductAssignments

ListProductAssignments<TBundleProductAssignment extends BundleProductAssignment>(
    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 } = {}
  - OptionalbundleID?: string
    
    ID of the bundle.
  - Optionalpage?: 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.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - OptionalproductID?: string
    
    ID of the product.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TBundleProductAssignment>>>
- Defined in api/Bundles.ts:281

Patch

Patch<TBundle extends Bundle<any>>(
    bundleID: string,
    bundle: PartialDeep<Bundle>,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TBundle>>
Partially update a bundle Check out the docs for more info
Type Parameters
- TBundle extends Bundle<any>
Parameters
- bundleID: string
  ID of the bundle.
- bundle: PartialDeep<Bundle>
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TBundle>>
- Defined in api/Bundles.ts:163

Save

Save<TBundle extends Bundle<any>>(
    bundleID: string,
    bundle: Bundle,
    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>
Parameters
- bundleID: string
  ID of the bundle.
- bundle: Bundle
  Required fields: Name
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
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 = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
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 = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/Bundles.ts:302

Class Bundles

Index

Methods

Methods

As

Returns this

Description

Example

Create

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TBundle>>

Delete

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<void>

DeleteAssignment

Parameters

OptionalsellerID?: string

OptionaluserGroupID?: string

OptionaluserID?: string

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<void>

DeleteProductAssignment

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<void>

Get

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TBundle>>

List

Type Parameters

Parameters

OptionalcatalogID?: string

OptionalcategoryID?: string

Optionalfilters?: Filters

Optionalpage?: number

OptionalpageSize?: number

Optionalsearch?: string

OptionalsearchOn?: string[]

OptionalsearchType?: SearchType

OptionalsortBy?: string[]

OptionalsupplierID?: string

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

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

ListAssignments

Type Parameters

Parameters

OptionalbundleID?: string

OptionalbuyerID?: string

Optionallevel?: "Group" | "Company"

Optionalpage?: number

OptionalpageSize?: number

OptionaluserGroupID?: string

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredObjectDeep<ListPage<TBundleAssignment>>>

ListProductAssignments

Type Parameters

Parameters

OptionalbundleID?: string

Optionalpage?: number

OptionalpageSize?: number

OptionalproductID?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`sellerID?: string

`Optional`userGroupID?: string

`Optional`userID?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: 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

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`bundleID?: string

`Optional`buyerID?: string

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

`Optional`page?: number

`Optional`pageSize?: number

`Optional`userGroupID?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`bundleID?: string

`Optional`page?: number

`Optional`pageSize?: number

`Optional`productID?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string