Class CatalogDefaultAdapterRestSdk

Default Adapter for Catalog

Description

This class is used to define the default adapter for Catalog. This adapter uses the REST SDK to communicate with Catalog functionality.

Implements

CatalogDefaultAdapterAPI

Constructors

constructor

new CatalogDefaultAdapterRestSdk(catalogServiceEndpoint, internalToken, customPathConfig?): CatalogDefaultAdapterRestSdk
Parameters
- catalogServiceEndpoint: string
- internalToken: string
- Optional customPathConfig: CatalogDefaultAdapterSDKCustomPathConfig
Returns CatalogDefaultAdapterRestSdk
- Defined in src/catalog.ts:333

Properties

`Private` catalogServiceEndpoint

catalogServiceEndpoint: string

`Private` createProductPath

createProductPath: string

`Private` deleteMultipleProductsPath

deleteMultipleProductsPath: string

`Private` getAllProductsPath

getAllProductsPath: string

getAttachmentByIds

getAttachmentByIds: ((idList, requestContext?) => Promise<(null | AttachmentResponse)[]>)

Type declaration

- (idList, requestContext?): Promise<(null | AttachmentResponse)[]>
- Parameters
  - idList: string[]
  - Optional requestContext: RequestContext
  Returns Promise<(null | AttachmentResponse)[]>

`Private` getAttachmentsPath

getAttachmentsPath: string

`Private` getAttributesPath

getAttributesPath: string

`Private` getCategoriesPath

getCategoriesPath: string

`Private` getOneProductPath

getOneProductPath: string

`Private` getProductsPath

getProductsPath: string

`Private` internalToken

internalToken: string

`Private` updateMultipleProductsPath

updateMultipleProductsPath: string

`Static` `Private` `Readonly` DEFAULT_CREATE_PRODUCT

DEFAULT_CREATE_PRODUCT: "/orgs/:orgId/products" = '/orgs/:orgId/products'

`Static` `Private` `Readonly` DEFAULT_DELETE_MULTIPLE_PRODUCTS

DEFAULT_DELETE_MULTIPLE_PRODUCTS: "/orgs/:orgId/products:batchDelete" = '/orgs/:orgId/products:batchDelete'

`Static` `Private` `Readonly` DEFAULT_GET_ALL_PRODUCTS

DEFAULT_GET_ALL_PRODUCTS: "/admin/products" = '/admin/products'

`Static` `Private` `Readonly` DEFAULT_GET_ATTACHMENTS

DEFAULT_GET_ATTACHMENTS: "/attachments" = '/attachments'

`Static` `Private` `Readonly` DEFAULT_GET_ATTRIBUTES

DEFAULT_GET_ATTRIBUTES: "/attributes" = '/attributes'

`Static` `Private` `Readonly` DEFAULT_GET_CATEGORIES

DEFAULT_GET_CATEGORIES: "/categories" = '/categories'

`Static` `Private` `Readonly` DEFAULT_GET_ONE_PRODUCT

DEFAULT_GET_ONE_PRODUCT: "/products/:productId" = '/products/:productId'

`Static` `Private` `Readonly` DEFAULT_GET_PRODUCTS

DEFAULT_GET_PRODUCTS: "/products" = '/products'

`Static` `Private` `Readonly` DEFAULT_UPDATE_MULTIPLE_PRODUCTS

DEFAULT_UPDATE_MULTIPLE_PRODUCTS: "/orgs/:orgId/products:batchPatch" = '/orgs/:orgId/products:batchPatch'

Catalog

createProduct

createProduct(args, requestContext?): Promise<ProductResponse>
API for creating a single product
Parameters
- args: {
      options?: {
          expand?: string;
      };
      orgId: string;
      product: Partial<CreateProductDto>;
  }
  Input containing properties for creating product.
  - Optional options?: {
    expand?: string;
    }
    - Optional expand?: string
  - orgId: string
  - product: Partial<CreateProductDto>
- Optional requestContext: RequestContext
Returns Promise<ProductResponse>
Product data that was created.

Description
This API is used to create a single product in the Catalog service.
Implementation of CatalogDefaultAdapterAPI.createProduct
- Defined in src/catalog.ts:496

deleteMultipleProducts

deleteMultipleProducts(args, requestContext?): Promise<void>
API for deleting multiple products
Parameters
- args: DeleteManyProductsDto
  Input containing properties for delete product.
- Optional requestContext: RequestContext
Returns Promise<void>
Void

Description
This API is used to delete products in the Catalog service.
Implementation of CatalogDefaultAdapterAPI.deleteMultipleProducts
- Defined in src/catalog.ts:541

getAllProducts

getAllProducts(args, requestContext?): Promise<PaginatedQueryResult<ProductResponse>>
API for getting multiple products, regardless of their publication status
Parameters
- args: {
  queryOptions?: PaginatedListQueryOptions;
  }
  Input containing property for fetching products.
  - Optional queryOptions?: PaginatedListQueryOptions
- Optional requestContext: RequestContext
Returns Promise<PaginatedQueryResult<ProductResponse>>
Paginated list of products.

Description
This API is used to get multiple products from the Catalog service.
Implementation of CatalogDefaultAdapterAPI.getAllProducts
- Defined in src/catalog.ts:476

getAttributes

getAttributes(args, requestContext?): Promise<PaginatedQueryResult<AttributesResponse>>
API for getting attributes
Parameters
- args: {
  queryOptions?: PaginatedListQueryOptions;
  }
  Input containing properties for fetching attributes.
  - Optional queryOptions?: PaginatedListQueryOptions
- Optional requestContext: RequestContext
Returns Promise<PaginatedQueryResult<AttributesResponse>>
Paginated list of attributes.

Description
This API is used to get the attributes from the Catalog service.
Implementation of CatalogDefaultAdapterAPI.getAttributes
- Defined in src/catalog.ts:376

getAvailableProducts

getAvailableProducts(args, requestContext?): Promise<PaginatedQueryResult<ProductResponse>>
API for getting multiple products that are:
- publication.status is ACTIVE
- publication.since is less than or equal to current date
- publication.until is greater than or equal to current date
Parameters
- args: {
  queryOptions?: PaginatedListQueryOptions;
  }
  Input containing properties for fetching products.
  - Optional queryOptions?: PaginatedListQueryOptions
- Optional requestContext: RequestContext
Returns Promise<PaginatedQueryResult<ProductResponse>>
Paginated list of products.

Description
This API is used to get multiple products from the Catalog service.
Implementation of CatalogDefaultAdapterAPI.getAvailableProducts
- Defined in src/catalog.ts:457

getCategories

getCategories(args, requestContext?): Promise<PaginatedQueryResult<CategoryResponse>>
API for getting categories
Parameters
- args: {
  queryOptions?: PaginatedListQueryOptions;
  }
  Input containing properties for fetching categories.
  - Optional queryOptions?: PaginatedListQueryOptions
- Optional requestContext: RequestContext
Returns Promise<PaginatedQueryResult<CategoryResponse>>
Paginated list of categories.

Description
This API is used to get the categories from the Catalog service.
Implementation of CatalogDefaultAdapterAPI.getCategories
- Defined in src/catalog.ts:396

getOneProduct

getOneProduct(args, requestContext?): Promise<ProductResponse>
API for getting a single product
Parameters
- args: {
  expand?: string;
  productId: string;
  }
  Input containing properties for fetching product.
  - Optional expand?: string
  - productId: string
- Optional requestContext: RequestContext
  request context (requestId, serviceHistory)
Returns Promise<ProductResponse>
Product data that was fetched.

Description
This API is used to get a single product from the Catalog service.
Implementation of CatalogDefaultAdapterAPI.getOneProduct
- Defined in src/catalog.ts:418

getProducts

getProducts(args, requestContext?): Promise<PaginatedQueryResult<ProductResponse>>
API for getting multiple products that are:
- publication.status is ACTIVE
- publication.since is less than or equal to current date
- publication.until is greater than or equal to current date
Parameters
- args: {
  queryOptions?: PaginatedListQueryOptions;
  }
  Input containing properties for fetching products.
  - Optional queryOptions?: PaginatedListQueryOptions
- Optional requestContext: RequestContext
Returns Promise<PaginatedQueryResult<ProductResponse>>
Paginated list of products.

Deprecated
Use getAvailableProducts instead

Description
This API is used to get multiple products from the Catalog service.
Implementation of CatalogDefaultAdapterAPI.getProducts
- Defined in src/catalog.ts:437

updateMultipleProducts

updateMultipleProducts(args, requestContext?): Promise<void>
API for updating multiple products
Parameters
- args: {
  orgId: string;
  updates: UpdateManyProductsDto;
  }
  Input containing properties for update product.
  - orgId: string
  - updates: UpdateManyProductsDto
- Optional requestContext: RequestContext
Returns Promise<void>
Void

Description
This API is used to update products in the Catalog service.
Implementation of CatalogDefaultAdapterAPI.updateMultipleProducts
- Defined in src/catalog.ts:521

Class CatalogDefaultAdapterRestSdk

Description

Implements

Index

Constructors

Properties

Catalog

Constructors

constructor

Parameters

catalogServiceEndpoint: string

internalToken: string

Optional customPathConfig: CatalogDefaultAdapterSDKCustomPathConfig

Returns CatalogDefaultAdapterRestSdk

Properties

Private catalogServiceEndpoint

Private createProductPath

Private deleteMultipleProductsPath

Private getAllProductsPath

getAttachmentByIds

Type declaration

Parameters

idList: string[]

Optional requestContext: RequestContext

Returns Promise<(null | AttachmentResponse)[]>

Private getAttachmentsPath

Private getAttributesPath

Private getCategoriesPath

Private getOneProductPath

Private getProductsPath

Private internalToken

Private updateMultipleProductsPath

Static Private Readonly DEFAULT_CREATE_PRODUCT

Static Private Readonly DEFAULT_DELETE_MULTIPLE_PRODUCTS

Static Private Readonly DEFAULT_GET_ALL_PRODUCTS

Static Private Readonly DEFAULT_GET_ATTACHMENTS

Static Private Readonly DEFAULT_GET_ATTRIBUTES

Static Private Readonly DEFAULT_GET_CATEGORIES

Static Private Readonly DEFAULT_GET_ONE_PRODUCT

Static Private Readonly DEFAULT_GET_PRODUCTS

Static Private Readonly DEFAULT_UPDATE_MULTIPLE_PRODUCTS

Catalog

createProduct

Parameters

args: { options?: { expand?: string; }; orgId: string; product: Partial<CreateProductDto>; }

Optional options?: { expand?: string; }

Optional expand?: string

orgId: string

product: Partial<CreateProductDto>

Optional requestContext: RequestContext

Returns Promise<ProductResponse>

Description

deleteMultipleProducts

Parameters

args: DeleteManyProductsDto

Optional requestContext: RequestContext

Returns Promise<void>

Description

getAllProducts

Parameters

args: { queryOptions?: PaginatedListQueryOptions; }

Optional queryOptions?: PaginatedListQueryOptions

Optional requestContext: RequestContext

Returns Promise<PaginatedQueryResult<ProductResponse>>

Description

getAttributes

Parameters

args: { queryOptions?: PaginatedListQueryOptions; }

Optional queryOptions?: PaginatedListQueryOptions

Optional requestContext: RequestContext

Returns Promise<PaginatedQueryResult<AttributesResponse>>

Description

getAvailableProducts

Parameters

args: { queryOptions?: PaginatedListQueryOptions; }

Optional queryOptions?: PaginatedListQueryOptions

Optional requestContext: RequestContext

Returns Promise<PaginatedQueryResult<ProductResponse>>

Description

getCategories

`Optional` customPathConfig: CatalogDefaultAdapterSDKCustomPathConfig

`Private` catalogServiceEndpoint

`Private` createProductPath

`Private` deleteMultipleProductsPath

`Private` getAllProductsPath

`Optional` requestContext: RequestContext

`Private` getAttachmentsPath

`Private` getAttributesPath

`Private` getCategoriesPath

`Private` getOneProductPath

`Private` getProductsPath

`Private` internalToken

`Private` updateMultipleProductsPath

`Static` `Private` `Readonly` DEFAULT_CREATE_PRODUCT

`Static` `Private` `Readonly` DEFAULT_DELETE_MULTIPLE_PRODUCTS

`Static` `Private` `Readonly` DEFAULT_GET_ALL_PRODUCTS

`Static` `Private` `Readonly` DEFAULT_GET_ATTACHMENTS

`Static` `Private` `Readonly` DEFAULT_GET_ATTRIBUTES

`Static` `Private` `Readonly` DEFAULT_GET_CATEGORIES

`Static` `Private` `Readonly` DEFAULT_GET_ONE_PRODUCT

`Static` `Private` `Readonly` DEFAULT_GET_PRODUCTS

`Static` `Private` `Readonly` DEFAULT_UPDATE_MULTIPLE_PRODUCTS

args: {
options?: {
expand?: string;
};
orgId: string;
product: Partial<CreateProductDto>;
}

`Optional` options?: {
expand?: string;
}

`Optional` expand?: string

`Optional` requestContext: RequestContext

`Optional` requestContext: RequestContext

args: {
queryOptions?: PaginatedListQueryOptions;
}

`Optional` queryOptions?: PaginatedListQueryOptions

`Optional` requestContext: RequestContext

args: {
queryOptions?: PaginatedListQueryOptions;
}

`Optional` queryOptions?: PaginatedListQueryOptions

`Optional` requestContext: RequestContext

args: {
queryOptions?: PaginatedListQueryOptions;
}

`Optional` queryOptions?: PaginatedListQueryOptions

`Optional` requestContext: RequestContext

args: {
queryOptions?: PaginatedListQueryOptions;
}

`Optional` queryOptions?: PaginatedListQueryOptions

`Optional` requestContext: RequestContext

args: {
expand?: string;
productId: string;
}

`Optional` expand?: string

`Optional` requestContext: RequestContext

args: {
queryOptions?: PaginatedListQueryOptions;
}

`Optional` queryOptions?: PaginatedListQueryOptions

`Optional` requestContext: RequestContext

args: {
orgId: string;
updates: UpdateManyProductsDto;
}

`Optional` requestContext: RequestContext