PrivateStoreCollectionOfferOperations interface

Interface representing a PrivateStoreCollectionOffer operations.

Properties

contextsView

Retrieve offer information with plans under required contexts restrictions.

createOrUpdate

Update or add an offer to a specific collection of the private store.

delete
get

Gets information about a specific offer.

list

Get a list of all private offers in the given private store and collection

listByContexts

Get a list of all offers in the given collection according to the required contexts.

post

Delete Private store offer. This is a workaround.

upsertOfferWithMultiContext

Upsert an offer with multiple context details.

Property Details

contextsView

Retrieve offer information with plans under required contexts restrictions.

contextsView: (privateStoreId: string, collectionId: string, offerId: string, options?: PrivateStoreCollectionOfferContextsViewOptionalParams) => Promise<Offer>

Property Value

(privateStoreId: string, collectionId: string, offerId: string, options?: PrivateStoreCollectionOfferContextsViewOptionalParams) => Promise<Offer>

createOrUpdate

Update or add an offer to a specific collection of the private store.

createOrUpdate: (privateStoreId: string, collectionId: string, offerId: string, payload: Offer, options?: PrivateStoreCollectionOfferCreateOrUpdateOptionalParams) => Promise<Offer>

Property Value

(privateStoreId: string, collectionId: string, offerId: string, payload: Offer, options?: PrivateStoreCollectionOfferCreateOrUpdateOptionalParams) => Promise<Offer>

delete

delete: (privateStoreId: string, collectionId: string, offerId: string, options?: PrivateStoreCollectionOfferDeleteOptionalParams) => Promise<void>

Property Value

(privateStoreId: string, collectionId: string, offerId: string, options?: PrivateStoreCollectionOfferDeleteOptionalParams) => Promise<void>

get

Gets information about a specific offer.

get: (privateStoreId: string, collectionId: string, offerId: string, options?: PrivateStoreCollectionOfferGetOptionalParams) => Promise<Offer>

Property Value

(privateStoreId: string, collectionId: string, offerId: string, options?: PrivateStoreCollectionOfferGetOptionalParams) => Promise<Offer>

list

Get a list of all private offers in the given private store and collection

list: (privateStoreId: string, collectionId: string, options?: PrivateStoreCollectionOfferListOptionalParams) => PagedAsyncIterableIterator<Offer, Offer[], PageSettings>

Property Value

(privateStoreId: string, collectionId: string, options?: PrivateStoreCollectionOfferListOptionalParams) => PagedAsyncIterableIterator<Offer, Offer[], PageSettings>

listByContexts

Get a list of all offers in the given collection according to the required contexts.

listByContexts: (privateStoreId: string, collectionId: string, options?: PrivateStoreCollectionOfferListByContextsOptionalParams) => PagedAsyncIterableIterator<CollectionOffersByContext, CollectionOffersByContext[], PageSettings>

Property Value

(privateStoreId: string, collectionId: string, options?: PrivateStoreCollectionOfferListByContextsOptionalParams) => PagedAsyncIterableIterator<CollectionOffersByContext, CollectionOffersByContext[], PageSettings>

post

Delete Private store offer. This is a workaround.

post: (privateStoreId: string, collectionId: string, offerId: string, options?: PrivateStoreCollectionOfferPostOptionalParams) => Promise<void>

Property Value

(privateStoreId: string, collectionId: string, offerId: string, options?: PrivateStoreCollectionOfferPostOptionalParams) => Promise<void>

upsertOfferWithMultiContext

Upsert an offer with multiple context details.

upsertOfferWithMultiContext: (privateStoreId: string, collectionId: string, offerId: string, options?: PrivateStoreCollectionOfferUpsertOfferWithMultiContextOptionalParams) => Promise<Offer>

Property Value

(privateStoreId: string, collectionId: string, offerId: string, options?: PrivateStoreCollectionOfferUpsertOfferWithMultiContextOptionalParams) => Promise<Offer>