Options
All
  • Public
  • Public/Protected
  • All
Menu

@voucherify/sdk - v2.2.3

Index

Enumerations

Classes

Interfaces

Type aliases

Functions

Type aliases

ApplicableToEffect

ApplicableToEffect: "APPLY_TO_EVERY" | "APPLY_TO_CHEAPEST" | "APPLY_TO_MOST_EXPENSIVE"

CampaignsAddCertainVoucherParams

CampaignsAddCertainVoucherParams: Pick<Partial<VouchersImport>, "category" | "redemption" | "metadata" | "additional_info">

CampaignsAddCertainVoucherResponse

CampaignsAddCertainVoucherResponse: CampaignsAddVoucherResponse

CampaignsAddVoucherBody

CampaignsAddVoucherBody: Pick<Partial<VouchersImport>, "code_config" | "category" | "redemption" | "metadata" | "additional_info">

CampaignsAddVoucherResponse

CampaignsAddVoucherResponse: Pick<VouchersResponse, "code" | "object" | "campaign" | "category" | "created_at" | "type" | "discount" | "gift" | "start_date" | "expiration_date" | "publish" | "redemption" | "active" | "additional_info" | "metadata" | "assets">

CampaignsCreateCampaign

CampaignsCreateCampaign: Omit<CampaignResponse, "id" | "protected" | "vouchers_generation_status" | "validation_rules_assignments" | "object" | "created_at" | "active"> & { active?: boolean }

CampaignsCreateCampaignResponse

CampaignsCreateCampaignResponse: CampaignResponse

CampaignsGetCampaignResponse

CampaignsGetCampaignResponse: CampaignResponse

CampaignsImportVouchers

CampaignsImportVouchers: Pick<VouchersImport, "code" | "redemption" | "metadata" | "additional_info" | "active">

CampaignsUpdateCampaign

CampaignsUpdateCampaign: Pick<CampaignResponse, "start_date" | "expiration_date" | "type" | "description" | "metadata">

CampaignsUpdateCampaignResponse

CampaignsUpdateCampaignResponse: CampaignResponse

CampaignsVouchersImportResponse

CampaignsVouchersImportResponse: { async_action_id: string }

Type declaration

  • async_action_id: string

ClientSideConsentsListResponse

ClientSideConsentsListResponse: ConsentsListResponse

ClientSideCustomersCreateParams

ClientSideCustomersCreateParams: CustomersCreateBody

ClientSideCustomersCreateResponse

ClientSideCustomersCreateResponse: CustomersCreateResponse

ClientSideCustomersUpdateConsentsBody

ClientSideCustomersUpdateConsentsBody: CustomersUpdateConsentsBody

ClientSideListVouchersParams

ClientSideListVouchersParams: VouchersListParams

ClientSidePublishPreparedPayload

ClientSidePublishPreparedPayload: ClientSidePublishPayload

ClientSidePublishResponse

ClientSidePublishResponse: DistributionsPublicationsCreateResponse & { vouchers_id?: string[] }

ClientSideRedeemOrder

ClientSideRedeemOrder: Partial<Pick<OrdersCreateResponse, "id" | "source_id" | "metadata" | "amount">> & { items?: ClientSideItem[] }

ClientSideRedemptionsRedeemStackableParams

ClientSideRedemptionsRedeemStackableParams: RedemptionsRedeemStackableParams

ClientSideRedemptionsRedeemStackableResponse

ClientSideRedemptionsRedeemStackableResponse: RedemptionsRedeemStackableResponse

ClientSideTrackCustomer

ClientSideTrackCustomer: CustomerRequest

ClientSideValidationValidateStackableResponse

ClientSideValidationValidateStackableResponse: ValidationValidateStackableResponse

ClientSideValidationsValidateStackableParams

ClientSideValidationsValidateStackableParams: ValidationsValidateStackableParams

ClientSideVoucherListing

ClientSideVoucherListing: Pick<VouchersResponse, "active" | "code" | "metadata" | "assets" | "object" | "expiration_date" | "start_date" | "created_at">

CustomerUnconfirmed

CustomerUnconfirmed: Pick<CustomerObject, "summary" | "email" | "loyalty"> & { object: "unconfirmed_customer" }

CustomersCreateBody

CustomersCreateBody: CustomerRequest

CustomersCreateResponse

CustomersCreateResponse: CustomerObject | CustomerUnconfirmed

CustomersGetResponse

CustomersGetResponse: CustomerObject | CustomerUnconfirmed

CustomersListParams

CustomersListParams: CustomersCommonListRequest

CustomersListResponse

CustomersListResponse: CustomersCommonListResponse

CustomersScrollParams

CustomersScrollParams: CustomersCommonListRequest

CustomersScrollResponse

CustomersScrollResponse: CustomersCommonListResponse

CustomersScrollYield

CustomersScrollYield: CustomerObject

CustomersUpdateConsentsBody

CustomersUpdateConsentsBody: Record<string, boolean>

CustomersUpdateParams

CustomersUpdateParams: CustomerRequest & IdOrSourceId

CustomersUpdateResponse

CustomersUpdateResponse: CustomerObject | CustomerUnconfirmed

DiscountAmountVouchersEffectTypes

DiscountAmountVouchersEffectTypes: "APPLY_TO_ORDER" | "APPLY_TO_ITEMS" | "APPLY_TO_ITEMS_PROPORTIONALLY" | "APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY"

DiscountFixedVouchersEffectTypes

DiscountFixedVouchersEffectTypes: "APPLY_TO_ORDER" | "APPLY_TO_ITEMS"

DiscountPercentVouchersEffectTypes

DiscountPercentVouchersEffectTypes: "APPLY_TO_ORDER" | "APPLY_TO_ITEMS"

DiscountUnitVouchersEffectTypes

DiscountUnitVouchersEffectTypes: "ADD_MISSING_ITEMS" | "ADD_NEW_ITEMS" | "ADD_MANY_ITEMS"

DiscountVouchersEffectTypes

DiscountVouchersEffectTypes: "ADD_MISSING_ITEMS" | "ADD_NEW_ITEMS" | "ADD_MANY_ITEMS" | "APPLY_TO_ORDER" | "APPLY_TO_ITEMS" | "APPLY_TO_ITEMS_PROPORTIONALLY" | "APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY"

DiscountVouchersTypes

DiscountVouchersTypes: "AMOUNT" | "PERCENT" | "UNIT" | "FIXED"

ExportsGetResponse

ExportsGetResponse: ExportsCreateResponse

LoyaltiesCreateEarningRuleResponse

LoyaltiesCreateEarningRuleResponse: LoyaltiesEarningRulesResponse

LoyaltiesCreateMemberResponse

LoyaltiesCreateMemberResponse: LoyaltiesVoucherResponse

LoyaltiesGetCampaignResponse

LoyaltiesGetCampaignResponse: LoyaltiesCreateCampaignResponse

LoyaltiesGetMemberResponse

LoyaltiesGetMemberResponse: LoyaltiesCreateMemberResponse

LoyaltiesUpdateCampaignResponse

LoyaltiesUpdateCampaignResponse: LoyaltiesCreateCampaignResponse

LoyaltiesUpdateEarningRuleResponse

LoyaltiesUpdateEarningRuleResponse: LoyaltiesEarningRulesResponse

LoyaltiesUpdateRewardAssignmentResponse

LoyaltiesUpdateRewardAssignmentResponse: LoyaltiesCreateRewardAssignmentResponse

OrdersGetResponse

OrdersGetResponse: OrdersCreateResponse

OrdersUpdateResponse

OrdersUpdateResponse: OrdersGetResponse

ProductsBulkUpdate

ProductsBulkUpdate: ProductsCreate[]

ProductsBulkUpdateMetadataResponse

ProductsBulkUpdateMetadataResponse: { async_action_id: string }

Type declaration

  • async_action_id: string

ProductsBulkUpdateResponse

ProductsBulkUpdateResponse: { async_action_id: string }

Type declaration

  • async_action_id: string

ProductsGetResponse

ProductsGetResponse: ProductsCreateResponse & ProductsGetResponseSkus

ProductsGetSkuResponse

ProductsGetSkuResponse: ProductsCreateSkuResponse

ProductsUpdate

ProductsUpdate: { attributes?: string[]; id?: string; image_url?: string; metadata?: Record<string, any>; name?: string; price?: number; source_id?: string }

Type declaration

  • Optional attributes?: string[]
  • Optional id?: string
  • Optional image_url?: string
  • Optional metadata?: Record<string, any>
  • Optional name?: string
  • Optional price?: number
  • Optional source_id?: string

ProductsUpdateResponse

ProductsUpdateResponse: ProductsCreateResponse

ProductsUpdateSku

ProductsUpdateSku: ProductsCreateSku & { id?: string; source_id?: string }

ProductsUpdateSkuResponse

ProductsUpdateSkuResponse: ProductsGetSkuResponse

PromotionTierGetResponse

PromotionTierGetResponse: PromotionTier

PromotionTierRedeemDetails

PromotionTierRedeemDetails: PromotionTier & { summary: { orders: { total_amount: number; total_discount_amount: number }; redemptions: { total_redeemed: number } } }

PromotionTiersCreateResponse

PromotionTiersCreateResponse: PromotionTier

PromotionTiersListResponse

PromotionTiersListResponse: PromotionTiersListAllResponse

PromotionTiersUpdateParams

PromotionTiersUpdateParams: PromotionTiersCreateParams & { id: string }

PromotionTiersUpdateResponse

PromotionTiersUpdateResponse: PromotionTier

RedemptionsRedeemStackableOrderResponse

RedemptionsRedeemStackableOrderResponse: OrdersCreateResponse & { redemptions?: Record<string, { date: string; related_object_id: string; related_object_type: "redemption"; rollback_date?: string; rollback_id?: string; rollback_stacked?: string[]; stacked: string[] }> }

RedemptionsRedeemStackableRedemptionResult

RedemptionsRedeemStackableRedemptionResult: RedemptionsRedeemResponse & { redemption: string }

RewardsCreate

RewardsCreate: Rewards & RewardsType

RewardsCreateAssignmentResponse

RewardsCreateAssignmentResponse: RewardsAssignmentObject

RewardsCreateResponse

RewardsCreateResponse: RewardsResponse & RewardsTypeResponse

RewardsGetResponse

RewardsGetResponse: RewardsCreateResponse

RewardsType

RewardsType: RewardsTypeCampaign | RewardsTypeCoin | RewardsTypeMaterial

RewardsTypeResponse

RewardsTypeResponse: Required<RewardsTypeCampaignResponse> | Required<RewardsTypeCoin> | Required<RewardsTypeMaterial>

RewardsUpdate

RewardsUpdate: Omit<RewardsCreate, "type"> & { id: string }

RewardsUpdateAssignment

RewardsUpdateAssignment: RewardsCreateAssignment & { id: string }

RewardsUpdateAssignmentResponse

RewardsUpdateAssignmentResponse: RewardsAssignmentObject

RewardsUpdateResponse

RewardsUpdateResponse: RewardsCreateResponse

SegmentsGetResponse

SegmentsGetResponse: SegmentsCreateResponse

SimpleRollback

SimpleRollback: Pick<RedemptionsRollbackResponse, "id" | "object" | "date" | "customer_id" | "tracking_id" | "redemption" | "result" | "customer"> & { gift?: { amount: number }; loyalty_card?: { points: number }; related_object_type: "voucher"; voucher: { campaign?: string; campaign_id?: string; code: string; id: string; object: "voucher" } }

StackableRedeemableObject

StackableRedeemableObject: "promotion_stack" | "promotion_tier" | "voucher"

StackableRedeemableResponseStatus

StackableRedeemableResponseStatus: "APPLICABLE" | "INAPPLICABLE" | "SKIPPED"

ValidationRulesGetResponse

ValidationRulesGetResponse: ValidationRulesCreateResponse & { assignments_count?: string }

ValidationRulesUpdate

ValidationRulesUpdate: Partial<ValidationRulesCreate> & { id: string }

ValidationRulesUpdateResponse

ValidationRulesUpdateResponse: ValidationRulesCreateResponse

ValidationSessionTTLUnit

ValidationSessionTTLUnit: "DAYS" | "HOURS" | "MICROSECONDS" | "MILLISECONDS" | "MINUTES" | "NANOSECONDS" | "SECONDS"

ValidationSessionType

ValidationSessionType: "LOCK"

ValidationsValidateCode

ValidationsValidateCode: PromotionsValidateParams

ValidationsValidateContext

ValidationsValidateContext: ValidationsValidateVoucherParams

VoucherType

VoucherType: "GIFT_VOUCHER" | "DISCOUNT_VOUCHER" | "LOYALTY_CARD" | "LUCKY_DRAW"

VouchersBulkUpdate

VouchersBulkUpdate: VouchersBulkUpdateObject[]

VouchersBulkUpdateMetadataResponse

VouchersBulkUpdateMetadataResponse: { async_action_id: string }

Type declaration

  • async_action_id: string

VouchersBulkUpdateResponse

VouchersBulkUpdateResponse: { async_action_id: string }

Type declaration

  • async_action_id: string

VouchersCreate

VouchersCreate: VouchersCreateParameters & Pick<VouchersResponse, "type" | "discount" | "gift" | "category" | "additional_info" | "start_date" | "expiration_date" | "metadata">

VouchersCreateResponse

VouchersCreateResponse: Omit<VouchersResponse, "validation_rules_assignments">

VouchersDisableResponse

VouchersDisableResponse: VouchersResponse

VouchersEnableResponse

VouchersEnableResponse: VouchersResponse

VouchersGetResponse

VouchersGetResponse: VouchersResponse

VouchersImportResponse

VouchersImportResponse: { async_action_id: string }

Type declaration

  • async_action_id: string

VouchersUpdateResponse

VouchersUpdateResponse: VouchersResponse

Functions

VoucherifyClientSide

VoucherifyServerSide