offers
@bosonprotocol/core-sdk / Exports / offers
Namespace: offers
Table of contents
Namespaces
Enumerations
Classes
Type Aliases
Variables
Functions
Type Aliases
AdditionalOfferMetadata
Ƭ AdditionalOfferMetadata: Object
Type declaration
| Name | Type |
|---|---|
disputeResolverContactMethod | string |
escalationDeposit | BigNumberish |
escalationResponsePeriodInSec | BigNumberish |
returnPeriodInDays | number |
sellerContactMethod | string |
sellerTradingName | string |
Defined in
src/offers/renderContractualAgreement.ts:16
BaseOfferData
Ƭ BaseOfferData: Object
Type declaration
| Name | Type |
|---|---|
agentId | BigNumberish |
buyerCancelPenalty | BigNumberish |
disputePeriodDurationInMS | BigNumberish |
disputeResolverId | BigNumberish |
exchangeToken | string |
metadataHash | string |
metadataUri | string |
price | BigNumberish |
quantityAvailable | BigNumberish |
resolutionPeriodDurationInMS | BigNumberish |
sellerDeposit | BigNumberish |
validFromDateInMS | BigNumberish |
validUntilDateInMS | BigNumberish |
voucherRedeemableFromDateInMS | BigNumberish |
voucherRedeemableUntilDateInMS | BigNumberish |
Defined in
src/offers/renderContractualAgreement.ts:73
CreateOfferArgs
Ƭ CreateOfferArgs: Object
Type declaration
| Name | Type |
|---|---|
agentId | BigNumberish |
buyerCancelPenalty | BigNumberish |
disputePeriodDurationInMS | BigNumberish |
disputeResolverId | BigNumberish |
exchangeToken | string |
metadataHash | string |
metadataUri | string |
price | BigNumberish |
quantityAvailable | BigNumberish |
resolutionPeriodDurationInMS | BigNumberish |
sellerDeposit | BigNumberish |
validFromDateInMS | BigNumberish |
validUntilDateInMS | BigNumberish |
voucherRedeemableFromDateInMS | BigNumberish |
voucherRedeemableUntilDateInMS | BigNumberish |
voucherValidDurationInMS? | BigNumberish |
Defined in
node_modules/@bosonprotocol/common/dist/cjs/types/offers.d.ts:2
TemplateRenderingData
Ƭ TemplateRenderingData: CreateOfferArgs & AdditionalOfferMetadata & { buyerCancelPenaltyValue: string ; escalationDepositValue: string ; exchangeTokenSymbol: string ; msecToDay: () => void ; priceValue: string ; secToDay: () => void ; sellerDepositValue: string ; toISOString: () => void }
Defined in
src/offers/renderContractualAgreement.ts:25
Variables
baseOfferDataSchema
• Const baseOfferDataSchema: yup.SchemaOf<BaseOfferData>
Defined in
src/offers/renderContractualAgreement.ts:55
baseOfferMetadataSchema
• Const baseOfferMetadataSchema: yup.SchemaOf<AdditionalOfferMetadata>
Defined in
src/offers/renderContractualAgreement.ts:91
validation
• Const validation: Object
Type declaration
| Name | Type |
|---|---|
createOfferArgsSchema | typeof createOfferArgsSchema |
Defined in
Functions
getOfferStatus
▸ getOfferStatus(offer): OfferState
Parameters
| Name | Type |
|---|---|
offer | OfferFieldsFragment |
Returns
OfferState
Defined in
src/offers/getOfferStatus.ts:10
prepareRenderingData
▸ prepareRenderingData(offerData, offerMetadata, tokenInfo): Promise<TemplateRenderingData>
Parameters
| Name | Type |
|---|---|
offerData | CreateOfferArgs |
offerMetadata | AdditionalOfferMetadata |
tokenInfo | ITokenInfo |
Returns
Promise<TemplateRenderingData>
Defined in
src/offers/renderContractualAgreement.ts:207
renderContractualAgreement
▸ renderContractualAgreement(template, offerData, offerMetadata, tokenInfo): Promise<string>
Parameters
| Name | Type |
|---|---|
template | string |
offerData | CreateOfferArgs |
offerMetadata | AdditionalOfferMetadata |
tokenInfo | ITokenInfo |
Returns
Promise<string>
Defined in
src/offers/renderContractualAgreement.ts:264
renderContractualAgreementForOffer
▸ renderContractualAgreementForOffer(existingOfferData): Promise<string>
Parameters
| Name | Type |
|---|---|
existingOfferData | OfferFieldsFragment |
Returns
Promise<string>