Add new GraphQL Goal object and resolver on Account.goal

server/constants/goal-types.ts

@@ -0,0 +1,14 @@
+/**
+ * Constants for the goal type
+ *
+ */
+
+enum GoalTypes {
+  ALL_TIME = 'ALL_TIME',
+  MONTHLY_BUDGET = 'MONTHLY_BUDGET',
+  YEARLY_BUDGET = 'YEARLY_BUDGET',
+  CALENDAR_MONTH = 'CALENDAR_MONTH',
+  CALENDAR_YEAR = 'CALENDAR_YEAR',
+}
+
+export default GoalTypes;

server/graphql/schemaV2.graphql

@@ -990,6 +990,22 @@
   EXPERIMENTAL (this may change or be removed)
   """
   transactionReports(timeUnit: TimeUnit = MONTH, dateFrom: DateTime, dateTo: DateTime): TransactionReports
+  goal: Goal
+  activeContributors(
+    """
+    The number of results to fetch (default 10, max 1000)
+    """
+    limit: Int! = 10
+
+    """
+    The offset to use to fetch
+    """
+    offset: Int! = 0
+    forGoalType: GoalType
+    dateFrom: DateTime
+    dateTo: DateTime
+    includeActiveRecurringContributions: Boolean
+  ): AccountCollection
 }
 
 """
@@ -3430,6 +3446,22 @@
   EXPERIMENTAL (this may change or be removed)
   """
   transactionReports(timeUnit: TimeUnit = MONTH, dateFrom: DateTime, dateTo: DateTime): TransactionReports
+  goal: Goal
+  activeContributors(
+    """
+    The number of results to fetch (default 10, max 1000)
+    """
+    limit: Int! = 10
+
+    """
+    The offset to use to fetch
+    """
+    offset: Int! = 0
+    forGoalType: GoalType
+    dateFrom: DateTime
+    dateTo: DateTime
+    includeActiveRecurringContributions: Boolean
+  ): AccountCollection
   webhooks(
     """
     The number of results to fetch (default 10, max 1000)
@@ -3451,8 +3483,8 @@
     Type of account (COLLECTIVE/EVENT/ORGANIZATION/INDIVIDUAL)
     """
     accountType: AccountType
   ): Int!
   tiers(
     """
     The number of results to fetch
     """
@@ -6265,6 +6297,64 @@
   expenseType: ExpenseType
 }
 
+type Goal {
+  """
+  The type of the goal (per month, per year or all time)
+  """
+  type: GoalType
+
+  """
+  The amount of the goal
+  """
+  amount: Amount
+
+  """
+  The progress of the goal in percentage
+  """
+  progress: Int
+  contributors(
+    """
+    The number of results to fetch (default 10, max 1000)
+    """
+    limit: Int! = 10
+
+    """
+    The offset to use to fetch
+    """
+    offset: Int! = 0
+  ): AccountCollection
+}
+
+"""
+All supported goal types
+"""
+enum GoalType {
+  """
+  Total contributions
+  """
+  ALL_TIME
+
+  """
+  Active yearly contributions (divided by 12), active monthly contributions and one-time contributions in the past 30 days
+  """
+  MONTHLY_BUDGET
+
+  """
+  Active yearly contributions , active monthly contributions (times 12) and one-time contributions in the past 365 days
+  """
+  YEARLY_BUDGET
+
+  """
+  Contributions in the current calendar month
+  """
+  CALENDAR_MONTH
+
+  """
+  Contributions in the current calendar year
+  """
+  CALENDAR_YEAR
+}
+
 """
 A collection of webhooks
 """
@@ -8413,6 +8503,22 @@
   EXPERIMENTAL (this may change or be removed)
   """
   transactionReports(timeUnit: TimeUnit = MONTH, dateFrom: DateTime, dateTo: DateTime): TransactionReports
+  goal: Goal
+  activeContributors(
+    """
+    The number of results to fetch (default 10, max 1000)
+    """
+    limit: Int! = 10
+
+    """
+    The offset to use to fetch
+    """
+    offset: Int! = 0
+    forGoalType: GoalType
+    dateFrom: DateTime
+    dateTo: DateTime
+    includeActiveRecurringContributions: Boolean
+  ): AccountCollection
   webhooks(
     """
     The number of results to fetch (default 10, max 1000)
@@ -8437,8 +8543,8 @@
   """
   The slug identifying the account (ie: babel)
   """
   slug: String!
   type: AccountType!
 
   """
   Public name
@@ -9260,6 +9366,22 @@
   EXPERIMENTAL (this may change or be removed)
   """
   transactionReports(timeUnit: TimeUnit = MONTH, dateFrom: DateTime, dateTo: DateTime): TransactionReports
+  goal: Goal
+  activeContributors(
+    """
+    The number of results to fetch (default 10, max 1000)
+    """
+    limit: Int! = 10
+
+    """
+    The offset to use to fetch
+    """
+    offset: Int! = 0
+    forGoalType: GoalType
+    dateFrom: DateTime
+    dateTo: DateTime
+    includeActiveRecurringContributions: Boolean
+  ): AccountCollection
   webhooks(
     """
     The number of results to fetch (default 10, max 1000)
@@ -9294,8 +9416,8 @@
   hostApplication: HostApplication
 
   """
   How much platform fees are charged for this account
   """
   platformFeePercent: Float!
 
   """
@@ -10560,6 +10682,22 @@
   EXPERIMENTAL (this may change or be removed)
   """
   transactionReports(timeUnit: TimeUnit = MONTH, dateFrom: DateTime, dateTo: DateTime): TransactionReports
+  goal: Goal
+  activeContributors(
+    """
+    The number of results to fetch (default 10, max 1000)
+    """
+    limit: Int! = 10
+
+    """
+    The offset to use to fetch
+    """
+    offset: Int! = 0
+    forGoalType: GoalType
+    dateFrom: DateTime
+    dateTo: DateTime
+    includeActiveRecurringContributions: Boolean
+  ): AccountCollection
   webhooks(
     """
     The number of results to fetch (default 10, max 1000)
@@ -10650,8 +10788,8 @@
   contributors(
     """
     The number of results to fetch (default 10, max 1000)
     """
     limit: Int! = 10
 
     """
     The offset to use to fetch
@@ -11640,6 +11778,22 @@
   EXPERIMENTAL (this may change or be removed)
   """
   transactionReports(timeUnit: TimeUnit = MONTH, dateFrom: DateTime, dateTo: DateTime): TransactionReports
+  goal: Goal
+  activeContributors(
+    """
+    The number of results to fetch (default 10, max 1000)
+    """
+    limit: Int! = 10
+
+    """
+    The offset to use to fetch
+    """
+    offset: Int! = 0
+    forGoalType: GoalType
+    dateFrom: DateTime
+    dateTo: DateTime
+    includeActiveRecurringContributions: Boolean
+  ): AccountCollection
   webhooks(
     """
     The number of results to fetch (default 10, max 1000)
@@ -11756,8 +11910,8 @@
 
   """
   The account that owns this personal token
   """
   account: Individual!
 
   """
   The date on which the personal token was created
@@ -12693,6 +12847,22 @@
   EXPERIMENTAL (this may change or be removed)
   """
   transactionReports(timeUnit: TimeUnit = MONTH, dateFrom: DateTime, dateTo: DateTime): TransactionReports
+  goal: Goal
+  activeContributors(
+    """
+    The number of results to fetch (default 10, max 1000)
+    """
+    limit: Int! = 10
+
+    """
+    The offset to use to fetch
+    """
+    offset: Int! = 0
+    forGoalType: GoalType
+    dateFrom: DateTime
+    dateTo: DateTime
+    includeActiveRecurringContributions: Boolean
+  ): AccountCollection
   webhooks(
     """
     The number of results to fetch (default 10, max 1000)
@@ -12819,8 +12989,8 @@
 
   """
   Public name
   """
   name: String
 
   """
   Private, legal name. Used for expense receipts, taxes, etc. Scope: "account".
@@ -13637,6 +13807,22 @@
   EXPERIMENTAL (this may change or be removed)
   """
   transactionReports(timeUnit: TimeUnit = MONTH, dateFrom: DateTime, dateTo: DateTime): TransactionReports
+  goal: Goal
+  activeContributors(
+    """
+    The number of results to fetch (default 10, max 1000)
+    """
+    limit: Int! = 10
+
+    """
+    The offset to use to fetch
+    """
+    offset: Int! = 0
+    forGoalType: GoalType
+    dateFrom: DateTime
+    dateTo: DateTime
+    includeActiveRecurringContributions: Boolean
+  ): AccountCollection
   webhooks(
     """
     The number of results to fetch (default 10, max 1000)
@@ -13773,8 +13959,8 @@
   ALL_TIME
 }
 
 """
 A Virtual Card request
 """
 type VirtualCardRequest {
   id: String!
@@ -17213,6 +17399,22 @@
   EXPERIMENTAL (this may change or be removed)
   """
   transactionReports(timeUnit: TimeUnit = MONTH, dateFrom: DateTime, dateTo: DateTime): TransactionReports
+  goal: Goal
+  activeContributors(
+    """
+    The number of results to fetch (default 10, max 1000)
+    """
+    limit: Int! = 10
+
+    """
+    The offset to use to fetch
+    """
+    offset: Int! = 0
+    forGoalType: GoalType
+    dateFrom: DateTime
+    dateTo: DateTime
+    includeActiveRecurringContributions: Boolean
+  ): AccountCollection
   webhooks(
     """
     The number of results to fetch (default 10, max 1000)
@@ -17359,8 +17561,8 @@
   name: String
 
   """
   Private, legal name. Used for expense receipts, taxes, etc. Scope: "account".
   """
   legalName: String
   description: String
   longDescription: String
@@ -18173,6 +18375,22 @@
   EXPERIMENTAL (this may change or be removed)
   """
   transactionReports(timeUnit: TimeUnit = MONTH, dateFrom: DateTime, dateTo: DateTime): TransactionReports
+  goal: Goal
+  activeContributors(
+    """
+    The number of results to fetch (default 10, max 1000)
+    """
+    limit: Int! = 10
+
+    """
+    The offset to use to fetch
+    """
+    offset: Int! = 0
+    forGoalType: GoalType
+    dateFrom: DateTime
+    dateTo: DateTime
+    includeActiveRecurringContributions: Boolean
+  ): AccountCollection
   webhooks(
     """
     The number of results to fetch (default 10, max 1000)
@@ -18345,8 +18563,8 @@
   Search results for Updates
   """
   updates: SearchResultsUpdates
 }
 
 type SearchResultsAccounts {
   collection: AccountCollection!
   highlights: JSONObject
@@ -19210,6 +19428,18 @@
     emailConfirmationToken: String!
   ): ConfirmGuestAccountResponse!
 
+  """
+  Set a goal for your account.
+  """
+  setGoal(
+    account: AccountReferenceInput!
+
+    """
+    The goal to set for the account. Setting goal to undefined or null will remove any current goal.
+    """
+    goal: GoalInput
+  ): Goal
+
   """
   Apply to an host with a collective. Scope: "account".
   """
@@ -19405,7 +19635,7 @@
   """
   Edit an existing member invitation of the Collective. Scope: "account".
   """
   editMemberInvitation(
     """
     Reference to an account for the member to edit.
     """
@@ -21479,6 +21709,14 @@
   accessToken: String!
 }
 
+"""
+Input type for Goals
+"""
+input GoalInput {
+  type: GoalType!
+  amount: Int!
+}
+
 type ProcessHostApplicationResponse {
   """
   The account that applied to the host
@@ -21688,7 +21926,7 @@
 }
 
 """
 Input type for guest contributions
 """
 input GuestInfoInput {
   """

server/graphql/v2/enum/GoalType.ts

@@ -0,0 +1,27 @@
+import { GraphQLEnumType } from 'graphql';
+
+import goalType from '../../../constants/goal-types';
+
+export const GraphQLGoalType = new GraphQLEnumType({
+  name: 'GoalType',
+  description: 'All supported goal types',
+  values: {
+    [goalType.ALL_TIME]: {
+      description: 'Total contributions',
+    },
+    [goalType.MONTHLY_BUDGET]: {
+      description:
+        'Active yearly contributions (divided by 12), active monthly contributions and one-time contributions in the past 30 days',
+    },
+    [goalType.YEARLY_BUDGET]: {
+      description:
+        'Active yearly contributions , active monthly contributions (times 12) and one-time contributions in the past 365 days',
+    },
+    [goalType.CALENDAR_MONTH]: {
+      description: 'Contributions in the current calendar month',
+    },
+    [goalType.CALENDAR_YEAR]: {
+      description: 'Contributions in the current calendar year',
+    },
+  },
+});

server/graphql/v2/input/GoalInput.ts

@@ -0,0 +1,12 @@
+import { GraphQLInputObjectType, GraphQLInt, GraphQLNonNull } from 'graphql';
+
+import { GraphQLGoalType } from '../enum/GoalType';
+
+export const GraphQLGoalInput = new GraphQLInputObjectType({
+  name: 'GoalInput',
+  description: 'Input type for Goals',
+  fields: () => ({
+    type: { type: new GraphQLNonNull(GraphQLGoalType) },
+    amount: { type: new GraphQLNonNull(GraphQLInt) },
+  }),
+});