Event documentation v2 - DO NOT MERGE YET

docs/event_definitions/Nonprofit/Campaign/CampaignMetrics.ts

@@ -0,0 +1,13 @@
+/* eslint-disable */
+import { IdType, HoudiniObject, HoudiniEvent } from './common';
+import { Campaign } from '.';
+import { Nonprofit } from '../../Nonprofit';
+
+export interface nCampaigMetrics extends HoudiniObject {
+	id: IdType;
+	campaign: IdType | Campaign;
+	object: "campaign_metrics";
+}
+
+
+export type CampaignMetricsUpdated = HoudiniEvent<'campaign_metrics.updated', CampaignMetrics>;

docs/event_definitions/Nonprofit/Campaign/GiftLevel.ts

@@ -0,0 +1,16 @@
+/* eslint-disable */
+
+import { IdType, HoudiniObject, Recurrence, Amount, HoudiniEvent } from '../../common';
+import { Nonprofit } from '../../Nonprofit';
+
+export interface GiftLevel extends HoudiniObject {
+	id: IdType;
+	name: string;
+	nonprofit: IdType | Nonprofit;
+	value: {amount:Amount, recurrence:Recurrence}
+	object: "campaign_gift_level";
+}
+
+export type GiftLevelCreated = HoudiniEvent<'campaign_gift_level.created', GiftLevel>
+export type GiftLevelUpdated = HoudiniEvent<'campaign_gift_level.updated', GiftLevel>
+export type GiftLevelDeleted = HoudiniEvent<'campaign_gift_level.deleted', GiftLevel>

docs/event_definitions/Nonprofit/Campaign/Page.ts

@@ -0,0 +1,16 @@
+import { Campaign } from './nonprofit/Campaign';
+/* eslint-disable */
+
+import { IdType, HoudiniObject, Logo, HoudiniEvent } from '../../common';
+
+
+export interface Page extends HoudiniObject {
+	id: IdType;
+	name: string;
+	campaign: IdType | Campaign;
+	logo: Logo;
+	object: "campaign_page";
+	public: boolean
+}
+
+export type PageUpdated = HoudiniEvent<'campaign_page.updated', Page>;

docs/event_definitions/Nonprofit/Campaign/index.ts

@@ -0,0 +1,20 @@
+/* eslint-disable */
+
+import { IdType, HoudiniObject, Logo, HoudiniEvent } from '../../common';
+import Nonprofit  from '../../Nonprofit';
+
+export interface Campaign extends HoudiniObject {
+	id: IdType;
+	name: string;
+	nonprofit: IdType | Nonprofit;
+	start_date: Date;
+	end_date: Date;
+	logo: Logo;
+	parent_campaign?: IdType|Campaign;
+	child_campaigns?: IdType[]|Campaign[];
+	object: "campaign";
+}
+
+export type CampaignCreated = HoudiniEvent<'campaign.created', Campaign>
+export type CampaignUpdated = HoudiniEvent<'campaign.updated', Campaign>
+export type CampaignDeleted = HoudiniEvent<'campaign.deleted', Campaign>

docs/event_definitions/Nonprofit/EmailTemplate.ts

@@ -0,0 +1,16 @@
+/* eslint-disable @typescript-eslint/member-ordering */
+
+/* eslint-disable */
+
+import type {IdType, FlexibleAmount, HoudiniObject, Logo} from '../common';
+import Nonprofit from './'
+
+export default interface EmailTemplate extends HoudiniObject {
+	id: IdType;
+	nonprofit: IdType | Nonprofit;
+
+	object: "email_template";
+}
+
+
+

docs/event_definitions/Nonprofit/Event/DiscountCode.ts

@@ -0,0 +1,21 @@
+import { HoudiniObject, FlexibleAmount, IdType, HoudiniEvent } from "../../common";
+import Nonprofit from '..';
+
+
+
+export interface DiscountCode extends HoudiniObject, CreateDiscountCode {
+	event: IdType | Event;
+	id: IdType;
+	nonprofit: IdType | Nonprofit;
+	object: 'discount_code';
+}
+
+type DiscountDetails =  { percent: number|string } | {flatAmount: FlexibleAmount}
+
+export interface CreateDiscountCode {
+	code: string;
+	description: string;
+	discount: DiscountDetails;
+}
+
+export type DiscountCodeCreated = HoudiniEvent<'discount_code.created', DiscountCode>

docs/event_definitions/Nonprofit/Event/Metrics.ts

@@ -0,0 +1,16 @@
+/* eslint-disable */
+
+import { IdType, HoudiniObject, HoudiniEvent } from '../../common';
+
+export interface Metrics extends HoudiniObject {
+	id: IdType;
+	name: string;
+	event: IdType | Event;
+	ticket_levels: [{
+
+	}]
+	object: "event_metrics";
+}
+
+
+export type EventMetricsUpdated = HoudiniEvent<'event_metrics.updated', Metrics>;

docs/event_definitions/Nonprofit/Event/TicketLevel.ts

@@ -0,0 +1,24 @@
+/* eslint-disable */
+
+import { IdType, HoudiniObject, HoudiniEvent, Amount, FlexibleAmount} from '../../common';
+import Event from './'
+
+export interface TicketLevel extends HoudiniObject {
+	id: IdType;
+	name: string;
+	event: IdType | Event;
+	amount: Amount
+	limit?: number;
+	object: "ticket_level";
+}
+
+
+export interface CreateTicketLevel {
+	name: string;
+	amount: FlexibleAmount;
+	limit?:number;
+	adminOnly: boolean;
+}
+
+
+export type TicketLevelCreated = HoudiniEvent<'ticket_level.created', TicketLevel>;

docs/event_definitions/Nonprofit/Event/index.ts

@@ -0,0 +1,14 @@
+/* eslint-disable */
+
+import { IdType, HoudiniObject, Logo } from '../../common';
+import Nonprofit from '../';
+
+export default interface Event extends HoudiniObject {
+	id: IdType;
+	name: string;
+	nonprofit: IdType | Nonprofit;
+	start_date: Date;
+	end_date: Date;
+	logo: Logo;
+	object: "event";
+}

docs/event_definitions/Nonprofit/Page.ts

@@ -0,0 +1,30 @@
+/* eslint-disable @typescript-eslint/member-ordering */
+
+/* eslint-disable */
+
+import type {IdType, FlexibleAmount, HoudiniObject, Logo, HoudiniEvent} from '../common';
+import Nonprofit  from './';
+
+export interface Page extends HoudiniObject {
+	id: IdType;
+	nonprofit: string|Nonprofit;
+	slug: string;
+	categories: string;
+	full_description: string;
+	facebook: string; 
+	twitter: string;
+	youtube: string;
+	instagram: string;
+	blog: string
+
+	background_image: string;
+	main_image:string;
+	second_image:string;
+	third_image:string
+}
+
+
+
+export type NonprofitPageUpdated = HoudiniEvent<'nonprofit_page.updated', Page>;
+
+

docs/event_definitions/Nonprofit/Supporter/Address.ts

@@ -0,0 +1,29 @@
+/* eslint-disable */
+import { IdType, HoudiniObject, HoudiniEvent } from '../../common';
+import  Supporter  from '.';
+
+
+export default interface Address extends HoudiniObject {
+	city: string;
+	country: string;
+	address: string;
+	postalCode: string;
+	stateCode: string;
+	supporter: IdType | Supporter;
+	object: 'supporter_address';
+}
+
+export interface CreateSupporterAddress {
+	address: string;
+	city: string;
+	country: string;
+	postalCode: string;
+	stateCode: string;
+}
+
+
+export type SupporterAddressCreated = HoudiniEvent<'supporter_address.created', Address>
+
+export type SupporterAddressUpdated = HoudiniEvent<'supporter_address.updated', Address>
+
+export type SupporterAddressDeleted = HoudiniEvent<'supporter_address.deleted', Address>

docs/event_definitions/Nonprofit/Supporter/Tag.ts

@@ -0,0 +1,19 @@
+/* eslint-disable @typescript-eslint/member-ordering */
+import { HoudiniEvent, HoudiniObject, IdType } from "../../common";
+import Nonprofit from '..';
+
+
+
+export interface TagMaster extends HoudiniObject {
+	object: 'tag_master';
+	nonprofit: IdType | Nonprofit;
+	value: string;
+}
+
+
+export interface CreateTagMaster {
+	value: string;
+}
+
+
+export type TagMasterCreated = HoudiniEvent<'tag_master.created', TagMaster>;

docs/event_definitions/Nonprofit/Supporter/index.ts

@@ -0,0 +1,52 @@
+/* eslint-disable */
+import { IdType, HoudiniObject, HoudiniEvent } from '../../common';
+import  Nonprofit  from '../';
+import Address, { CreateSupporterAddress} from "./Address";
+import { TagMaster } from './Tag';
+
+/**
+ * @description An individuals
+ * @date 2020-11-16
+ * @export
+ * @interface Supporter
+ */
+export default interface Supporter extends HoudiniObject {
+	id: IdType;
+	name?: string;
+	primary_address?: IdType | Address;
+	title: string;
+	organization: string;
+	object: 'supporter';
+	email?: string;
+	nonprofit: IdType | Nonprofit;
+	deleted?: boolean;
+	merged_into?: IdType | Supporter
+	merged_on?: Date
+
+	tags?: IdType[]|TagMaster[]
+}
+
+/**
+ * @description POST /api/nonprofits/{nonprofitId}/supporters
+ * @date 2020-11-16
+ * @export
+ * @interface CreateSupporter
+ */
+export interface CreateSupporter {
+	name: string;
+	email: string,
+	title: string;
+	organization?: string;
+	primary_address?: CreateSupporterAddress;
+	tags?: IdType[]
+}
+
+
+
+export type SupporterCreated = HoudiniEvent<'supporter.created', Supporter>
+
+export type SupporterUpdated = HoudiniEvent<'supporter.updated', Supporter>
+
+export type SupporterDeleted = HoudiniEvent<'supporter.deleted', Supporter>
+
+

docs/event_definitions/Nonprofit/Transaction/CampaignGiftPurchase.ts

@@ -0,0 +1,19 @@
+/* eslint-disable */
+import { IdType, HoudiniObject } from '../../common';
+import  Transaction  from '.';
+
+
+export interface CampaignGiftPurchase extends HoudiniObject {
+	id: IdType;
+	object: "campaign_gift_purchase";
+
+	gifts: []
+
+	dedication?: Dedication
+	designation?: string
+}
+
+
+interface Dedication {
+
+}

docs/event_definitions/Nonprofit/Transaction/Donation.ts

@@ -0,0 +1,26 @@
+/* eslint-disable */
+import { IdType, HoudiniObject, FlexibleAmount } from '../../common';
+import  Transaction  from './';
+
+
+export interface Donation extends HoudiniObject {
+	id: IdType;
+	object: "donation";
+
+	transaction: IdType | Transaction;
+
+	dedication?: Dedication
+	designation?: string
+}
+
+interface CreateDonation {
+	type: 'donation',
+	amount: FlexibleAmount,
+
+
+}
+
+
+interface Dedication {
+
+}