All files / src/types/products fundraiser.types.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
type RecurringInterval =
  | "once"
  | "daily"
  | "weekly"
  | "monthly"
  | "quarterly"
  | "yearly";
 
export type DonationType = {
  id: number;
  typeID: number;
  typeName: "fundraiser" | "standard" | "sweepstake";
  name: string;
  description: string;
  accID: number;
  merchantName: string;
  merchTypeName: string;
  needsTax: boolean;
  allowFeeChoice: boolean;
  needsShipping: boolean;
  imageURL?: string;
  usesBackgroundImage: boolean;
  canBrowseCampaigns: boolean;
  maxPurchaseQuantity: number | null;
  startsAt: number | null;
  endsAt: number | null;
  showMap: boolean | null;
  includeTime: boolean | null;
  allowMultipleWinners: boolean | null;
  locationURL: string | null;
  locationShortAddress: string | null;
  locationAddress: null;
  variants: null;
  recurringIntervals: RecurringInterval[];
  defaultRecurringIntervalName: RecurringInterval;
  publishedStatus: string;
  totalTransactions: number;
  sumTransactions: number;
  averageTransactions: number;
  averageApprovedPurchases: number;
  visitors: number;
  conversionRate: number;
  createdAt: number;
  updatedAt: number;
  deletedAt: number | null;
  totalValidPurchases: number;
  totalValidNonReversedPurchases: number;
  totalItemsSold: number;
  totalApprovedPurchases: number;
  sumApprovedPurchases: number;
  /**
   * Events only — the merchant offers printed tickets ("Do you want to offer
   * physical tickets?" in the builder's Checkout step). Served by
   * `product.ProductMinimalView`; gates the Tickets tab's "Ticket Picked Up"
   * column. Optional because non-event products never carry it.
   */
  printedMaterialsEnabled?: boolean;
  /**
   * The form's background colour, served by the same
   * `merchants/{mid}/products/{id}` endpoint the campaign panel reads (where
   * it is declared on `CampaignData`). Optional because it is unset until the
   * merchant picks one in the builder's Style step.
   */
  backgroundColor?: string;
};