From 309cdac5ba44d79c24a2b1db75c75a9b0a2b675e Mon Sep 17 00:00:00 2001 From: adi790uu Date: Tue, 19 Mar 2024 16:31:31 +0530 Subject: [PATCH 1/2] Added workflow for pulling docs from api repo --- .github/workflows/md_mdx_format_adjuster.py | 96 + .github/workflows/pull-docs.sh | 26 + .github/workflows/pull-latest-docs.yml | 24 + docs/talawa-api-docs/.nojekyll | 1 - ...s_authDirective.AuthenticationDirective.md | 523 ----- ...oleDirective.RoleAuthorizationDirective.md | 523 ----- .../enums/constants.EventVolunteerResponse.md | 4 +- ...models_FundraisingCampaign.CurrencyType.md | 1803 +++++++++++++++++ .../enums/models_RecurrenceRule.Frequency.md | 8 +- .../enums/models_RecurrenceRule.WeekDays.md | 14 +- ...gEventInstances.InterfaceRecurringEvent.md | 318 +++ ...errors_applicationError.Interface_Error.md | 54 - .../middleware_isAuth.Interface_AuthData.md | 43 - ..._AgendaCategory.InterfaceAgendaCategory.md | 12 +- .../models_Comment.Interface_Comment.md | 100 - .../models_DirectChat.Interface_DirectChat.md | 78 - ...ChatMessage.Interface_DirectChatMessage.md | 89 - .../models_Donation.Interface_Donation.md | 78 - ...els_EncodedImage.Interface_EncodedImage.md | 56 - .../models_Event.Interface_Event.md | 254 --- .../models_Event.Interface_UserAttende.md | 56 - ...els_EventProject.Interface_EventProject.md | 100 - ..._EventVolunteer.InterfaceEventVolunteer.md | 18 +- .../interfaces/models_File.Interface_File.md | 100 - .../interfaces/models_Fund.InterfaceFund.md | 122 ++ ...ngCampaign.InterfaceFundraisingCampaign.md | 154 ++ ...dge.InterfaceFundraisingCampaignPledges.md | 109 + .../models_Group.Interface_Group.md | 89 - .../models_GroupChat.Interface_GroupChat.md | 89 - ...pChatMessage.Interface_GroupChatMessage.md | 78 - .../models_ImageHash.Interface_ImageHash.md | 67 - .../models_Language.Interface_Language.md | 56 - ...models_Language.Interface_LanguageModel.md | 56 - ...shipRequest.Interface_MembershipRequest.md | 56 - .../models_Message.Interface_Message.md | 100 - ...odels_MessageChat.Interface_MessageChat.md | 78 - ...els_Organization.Interface_Organization.md | 210 -- ...onTagUser.Interface_OrganizationTagUser.md | 54 - .../models_Plugin.Interface_Plugin.md | 78 - ...odels_PluginField.Interface_PluginField.md | 67 - .../interfaces/models_Post.Interface_Post.md | 166 -- ..._RecurrenceRule.InterfaceRecurrenceRule.md | 20 +- .../models_TagUser.Interface_TagUser.md | 43 - .../interfaces/models_Task.Interface_Task.md | 100 - .../models_User.InterfaceUserToReturn.md | 354 ---- .../interfaces/models_User.Interface_User.md | 265 --- .../models_userFamily.InterfaceUserFamily.md | 10 +- ...tilities_auth.Interface_JwtTokenPayload.md | 65 - .../utilities_mailer.Interface_MailFields.md | 43 - .../modules/config_firebaseConfig.md | 52 - docs/talawa-api-docs/modules/directives.md | 22 - .../modules/directives_authDirective.md | 9 - .../modules/directives_roleDirective.md | 9 - .../helpers_event_createEventHelpers.md | 22 - ...createEventHelpers_createRecurringEvent.md | 2 +- ...reateRecurringEventInstancesDuringQuery.md | 42 + ...nt_createEventHelpers_createSingleEvent.md | 2 +- .../helpers_event_recurringEventHelpers.md | 36 - ...urringEventHelpers_createRecurrenceRule.md | 2 +- ...entHelpers_generateRecurrenceRuleString.md | 2 +- ...Helpers_generateRecurringEventInstances.md | 6 +- ...gEventHelpers_getRecurringInstanceDates.md | 2 +- ...s_event_updateEventHelpers_getEventData.md | 40 + ...t_updateEventHelpers_updateAllInstances.md | 43 + ...updateEventHelpers_updateRecurringEvent.md | 42 + ...nt_updateEventHelpers_updateSingleEvent.md | 45 + ...Helpers_updateThisAndFollowingInstances.md | 49 + ...t_updateEventHelpers_updateThisInstance.md | 40 + .../modules/models_AgendaCategory.md | 6 +- .../modules/models_EventProject.md | 23 - .../modules/models_EventVolunteer.md | 2 +- docs/talawa-api-docs/modules/models_Fund.md | 23 + .../modules/models_FundraisingCampaign.md | 27 + .../models_FundraisingCampaignPledge.md | 23 + .../modules/models_RecurrenceRule.md | 2 +- docs/talawa-api-docs/modules/models_Task.md | 23 - .../modules/models_userFamily.md | 2 +- .../modules/resolvers_AgendaCategory.md | 2 +- .../resolvers_AgendaCategory_createdBy.md | 2 +- .../resolvers_AgendaCategory_organization.md | 2 +- .../resolvers_AgendaCategory_updatedBy.md | 2 +- .../modules/resolvers_EventVolunteer.md | 2 +- .../resolvers_EventVolunteer_creator.md | 2 +- .../modules/resolvers_EventVolunteer_event.md | 2 +- .../modules/resolvers_EventVolunteer_user.md | 2 +- ...Mutation_addPledgeToFundraisingCampaign.md | 40 + .../resolvers_Mutation_addUserToUserFamily.md | 2 +- ...resolvers_Mutation_createAgendaCategory.md | 2 +- .../resolvers_Mutation_createEventProject.md | 42 - ...resolvers_Mutation_createEventVolunteer.md | 2 +- .../modules/resolvers_Mutation_createFund.md | 41 + ...vers_Mutation_createFundraisingCampaign.md | 42 + ...utation_createFundraisingCampaignPledge.md | 41 + .../modules/resolvers_Mutation_createTask.md | 39 - .../resolvers_Mutation_createUserFamily.md | 2 +- ...resolvers_Mutation_deleteAgendaCategory.md | 2 +- .../resolvers_Mutation_inviteEventAttendee.md | 49 + ...esolvers_Mutation_registerEventAttendee.md | 45 + .../resolvers_Mutation_removeEventProject.md | 42 - ...resolvers_Mutation_removeEventVolunteer.md | 2 +- .../modules/resolvers_Mutation_removeFund.md | 41 + ...vers_Mutation_removeFundraisingCampaign.md | 41 + ...utation_removeFundraisingCampaingPledge.md | 40 + .../modules/resolvers_Mutation_removeTask.md | 40 - .../resolvers_Mutation_removeUserFamily.md | 2 +- ...lvers_Mutation_removeUserFromUserFamily.md | 2 +- ...resolvers_Mutation_updateAgendaCategory.md | 2 +- .../resolvers_Mutation_updateEventProject.md | 41 - ...resolvers_Mutation_updateEventVolunteer.md | 2 +- .../modules/resolvers_Mutation_updateFund.md | 42 + ...lvers_Mutation_updateFundCampaignPledge.md | 42 + ...vers_Mutation_updateFundraisingCampaign.md | 43 + ...vers_Mutation_updatePluginInstalledOrgs.md | 33 - .../modules/resolvers_Mutation_updateTask.md | 39 - ...resolvers_Organization_agendaCategories.md | 2 +- .../modules/resolvers_Query_agendaCategory.md | 2 +- .../modules/resolvers_Query_comments.md | 21 - .../modules/resolvers_Query_commentsByPost.md | 34 - .../resolvers_Query_directChatMessages.md | 21 - .../modules/resolvers_Query_directChats.md | 21 - .../resolvers_Query_eventVolunteersByEvent.md | 2 +- .../modules/resolvers_Query_events.md | 32 - .../modules/resolvers_Query_getDonations.md | 21 - .../resolvers_Query_getEventAttendee.md | 19 + ...olvers_Query_getEventAttendeesByEventId.md | 19 + .../modules/resolvers_Query_getFundById.md | 27 + .../resolvers_Query_getFundraisingCampaign.md | 27 + ..._Query_getFundraisingCampaignPledgeById.md | 27 + .../resolvers_Query_groupChatMessages.md | 21 - .../modules/resolvers_Query_groupChats.md | 21 - .../modules/resolvers_Query_groups.md | 21 - .../modules/resolvers_Query_isUserRegister.md | 31 - .../modules/resolvers_Query_posts.md | 31 - .../resolvers_Query_registrantsByEvent.md | 27 - .../modules/resolvers_Query_tasksByEvent.md | 31 - .../modules/resolvers_Query_tasksByUser.md | 27 - .../modules/resolvers_UserFamily.md | 2 +- .../modules/resolvers_UserFamily_admins.md | 2 +- .../modules/resolvers_UserFamily_creator.md | 2 +- .../modules/resolvers_UserFamily_users.md | 2 +- .../modules/utilities_checkReplicaSet.md | 23 + .../modules/utilities_dateValidator.md | 32 + .../modules/utilities_graphQLConnection.md | 298 +++ ...ection_generateDefaultGraphQLConnection.md | 98 + ...ection_getCommonGraphQLConnectionFilter.md | 57 + ...nnection_getCommonGraphQLConnectionSort.md | 55 + ...nection_parseGraphQLConnectionArguments.md | 190 ++ ...eGraphQLConnectionArgumentsWithSortedBy.md | 129 ++ ...ConnectionArgumentsWithSortedByAndWhere.md | 115 ++ ...arseGraphQLConnectionArgumentsWithWhere.md | 129 ++ ...ion_transformToDefaultGraphQLConnection.md | 168 ++ .../utilities_loadDefaultOrganization.md | 42 - .../modules/utilities_recurrenceDatesUtil.md | 4 +- .../modules/utilities_userFamilyAdminCheck.md | 2 +- 154 files changed, 5033 insertions(+), 5126 deletions(-) create mode 100644 .github/workflows/md_mdx_format_adjuster.py create mode 100644 .github/workflows/pull-docs.sh create mode 100644 .github/workflows/pull-latest-docs.yml delete mode 100644 docs/talawa-api-docs/.nojekyll delete mode 100644 docs/talawa-api-docs/classes/directives_authDirective.AuthenticationDirective.md delete mode 100644 docs/talawa-api-docs/classes/directives_roleDirective.RoleAuthorizationDirective.md create mode 100644 docs/talawa-api-docs/enums/models_FundraisingCampaign.CurrencyType.md create mode 100644 docs/talawa-api-docs/interfaces/helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md delete mode 100644 docs/talawa-api-docs/interfaces/libraries_errors_applicationError.Interface_Error.md delete mode 100644 docs/talawa-api-docs/interfaces/middleware_isAuth.Interface_AuthData.md delete mode 100644 docs/talawa-api-docs/interfaces/models_Comment.Interface_Comment.md delete mode 100644 docs/talawa-api-docs/interfaces/models_DirectChat.Interface_DirectChat.md delete mode 100644 docs/talawa-api-docs/interfaces/models_DirectChatMessage.Interface_DirectChatMessage.md delete mode 100644 docs/talawa-api-docs/interfaces/models_Donation.Interface_Donation.md delete mode 100644 docs/talawa-api-docs/interfaces/models_EncodedImage.Interface_EncodedImage.md delete mode 100644 docs/talawa-api-docs/interfaces/models_Event.Interface_Event.md delete mode 100644 docs/talawa-api-docs/interfaces/models_Event.Interface_UserAttende.md delete mode 100644 docs/talawa-api-docs/interfaces/models_EventProject.Interface_EventProject.md delete mode 100644 docs/talawa-api-docs/interfaces/models_File.Interface_File.md create mode 100644 docs/talawa-api-docs/interfaces/models_Fund.InterfaceFund.md create mode 100644 docs/talawa-api-docs/interfaces/models_FundraisingCampaign.InterfaceFundraisingCampaign.md create mode 100644 docs/talawa-api-docs/interfaces/models_FundraisingCampaignPledge.InterfaceFundraisingCampaignPledges.md delete mode 100644 docs/talawa-api-docs/interfaces/models_Group.Interface_Group.md delete mode 100644 docs/talawa-api-docs/interfaces/models_GroupChat.Interface_GroupChat.md delete mode 100644 docs/talawa-api-docs/interfaces/models_GroupChatMessage.Interface_GroupChatMessage.md delete mode 100644 docs/talawa-api-docs/interfaces/models_ImageHash.Interface_ImageHash.md delete mode 100644 docs/talawa-api-docs/interfaces/models_Language.Interface_Language.md delete mode 100644 docs/talawa-api-docs/interfaces/models_Language.Interface_LanguageModel.md delete mode 100644 docs/talawa-api-docs/interfaces/models_MembershipRequest.Interface_MembershipRequest.md delete mode 100644 docs/talawa-api-docs/interfaces/models_Message.Interface_Message.md delete mode 100644 docs/talawa-api-docs/interfaces/models_MessageChat.Interface_MessageChat.md delete mode 100644 docs/talawa-api-docs/interfaces/models_Organization.Interface_Organization.md delete mode 100644 docs/talawa-api-docs/interfaces/models_OrganizationTagUser.Interface_OrganizationTagUser.md delete mode 100644 docs/talawa-api-docs/interfaces/models_Plugin.Interface_Plugin.md delete mode 100644 docs/talawa-api-docs/interfaces/models_PluginField.Interface_PluginField.md delete mode 100644 docs/talawa-api-docs/interfaces/models_Post.Interface_Post.md delete mode 100644 docs/talawa-api-docs/interfaces/models_TagUser.Interface_TagUser.md delete mode 100644 docs/talawa-api-docs/interfaces/models_Task.Interface_Task.md delete mode 100644 docs/talawa-api-docs/interfaces/models_User.InterfaceUserToReturn.md delete mode 100644 docs/talawa-api-docs/interfaces/models_User.Interface_User.md delete mode 100644 docs/talawa-api-docs/interfaces/utilities_auth.Interface_JwtTokenPayload.md delete mode 100644 docs/talawa-api-docs/interfaces/utilities_mailer.Interface_MailFields.md delete mode 100644 docs/talawa-api-docs/modules/config_firebaseConfig.md delete mode 100644 docs/talawa-api-docs/modules/directives.md delete mode 100644 docs/talawa-api-docs/modules/directives_authDirective.md delete mode 100644 docs/talawa-api-docs/modules/directives_roleDirective.md delete mode 100644 docs/talawa-api-docs/modules/helpers_event_createEventHelpers.md create mode 100644 docs/talawa-api-docs/modules/helpers_event_createEventHelpers_createRecurringEventInstancesDuringQuery.md delete mode 100644 docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers.md create mode 100644 docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_getEventData.md create mode 100644 docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateAllInstances.md create mode 100644 docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateRecurringEvent.md create mode 100644 docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateSingleEvent.md create mode 100644 docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateThisAndFollowingInstances.md create mode 100644 docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateThisInstance.md delete mode 100644 docs/talawa-api-docs/modules/models_EventProject.md create mode 100644 docs/talawa-api-docs/modules/models_Fund.md create mode 100644 docs/talawa-api-docs/modules/models_FundraisingCampaign.md create mode 100644 docs/talawa-api-docs/modules/models_FundraisingCampaignPledge.md delete mode 100644 docs/talawa-api-docs/modules/models_Task.md create mode 100644 docs/talawa-api-docs/modules/resolvers_Mutation_addPledgeToFundraisingCampaign.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Mutation_createEventProject.md create mode 100644 docs/talawa-api-docs/modules/resolvers_Mutation_createFund.md create mode 100644 docs/talawa-api-docs/modules/resolvers_Mutation_createFundraisingCampaign.md create mode 100644 docs/talawa-api-docs/modules/resolvers_Mutation_createFundraisingCampaignPledge.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Mutation_createTask.md create mode 100644 docs/talawa-api-docs/modules/resolvers_Mutation_inviteEventAttendee.md create mode 100644 docs/talawa-api-docs/modules/resolvers_Mutation_registerEventAttendee.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Mutation_removeEventProject.md create mode 100644 docs/talawa-api-docs/modules/resolvers_Mutation_removeFund.md create mode 100644 docs/talawa-api-docs/modules/resolvers_Mutation_removeFundraisingCampaign.md create mode 100644 docs/talawa-api-docs/modules/resolvers_Mutation_removeFundraisingCampaingPledge.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Mutation_removeTask.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Mutation_updateEventProject.md create mode 100644 docs/talawa-api-docs/modules/resolvers_Mutation_updateFund.md create mode 100644 docs/talawa-api-docs/modules/resolvers_Mutation_updateFundCampaignPledge.md create mode 100644 docs/talawa-api-docs/modules/resolvers_Mutation_updateFundraisingCampaign.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Mutation_updatePluginInstalledOrgs.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Mutation_updateTask.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Query_comments.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Query_commentsByPost.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Query_directChatMessages.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Query_directChats.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Query_events.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Query_getDonations.md create mode 100644 docs/talawa-api-docs/modules/resolvers_Query_getEventAttendee.md create mode 100644 docs/talawa-api-docs/modules/resolvers_Query_getEventAttendeesByEventId.md create mode 100644 docs/talawa-api-docs/modules/resolvers_Query_getFundById.md create mode 100644 docs/talawa-api-docs/modules/resolvers_Query_getFundraisingCampaign.md create mode 100644 docs/talawa-api-docs/modules/resolvers_Query_getFundraisingCampaignPledgeById.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Query_groupChatMessages.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Query_groupChats.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Query_groups.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Query_isUserRegister.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Query_posts.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Query_registrantsByEvent.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Query_tasksByEvent.md delete mode 100644 docs/talawa-api-docs/modules/resolvers_Query_tasksByUser.md create mode 100644 docs/talawa-api-docs/modules/utilities_checkReplicaSet.md create mode 100644 docs/talawa-api-docs/modules/utilities_dateValidator.md create mode 100644 docs/talawa-api-docs/modules/utilities_graphQLConnection.md create mode 100644 docs/talawa-api-docs/modules/utilities_graphQLConnection_generateDefaultGraphQLConnection.md create mode 100644 docs/talawa-api-docs/modules/utilities_graphQLConnection_getCommonGraphQLConnectionFilter.md create mode 100644 docs/talawa-api-docs/modules/utilities_graphQLConnection_getCommonGraphQLConnectionSort.md create mode 100644 docs/talawa-api-docs/modules/utilities_graphQLConnection_parseGraphQLConnectionArguments.md create mode 100644 docs/talawa-api-docs/modules/utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedBy.md create mode 100644 docs/talawa-api-docs/modules/utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedByAndWhere.md create mode 100644 docs/talawa-api-docs/modules/utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithWhere.md create mode 100644 docs/talawa-api-docs/modules/utilities_graphQLConnection_transformToDefaultGraphQLConnection.md delete mode 100644 docs/talawa-api-docs/modules/utilities_loadDefaultOrganization.md diff --git a/.github/workflows/md_mdx_format_adjuster.py b/.github/workflows/md_mdx_format_adjuster.py new file mode 100644 index 00000000000..cd76a30cf62 --- /dev/null +++ b/.github/workflows/md_mdx_format_adjuster.py @@ -0,0 +1,96 @@ +#!/usr/bin/env python3 +# -*- coding: UTF-8 -*- +""" +Script to make Markdown files MDX compatible. + +This script scans Markdown files and escapes special characters (<, >, {, }) +to make them compatible with the MDX standard used in Docusaurus v3. + +This script complies with: + 1) Pylint + 2) Pydocstyle + 3) Pycodestyle + 4) Flake8 +""" +import os +import argparse +import re + +def escape_mdx_characters(text): + """ + Escape special characters in a text string for MDX compatibility. + Avoids escaping already escaped characters. + + Args: + text: A string containing the text to be processed. + + Returns: + A string with special characters (<, >, {, }) escaped, avoiding + double escaping. + """ + # Regular expressions to find unescaped special characters + patterns = { + "<": r"(?": r"(?", + "{": r"(? | -| `details.objectType` | `GraphQLObjectType`\<`any`, `any`\> \| `GraphQLInterfaceType` | - -#### Returns - -``null`` \| `void` \| `GraphQLArgument` - -#### Inherited from - -SchemaDirectiveVisitor.visitArgumentDefinition - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:12 - -___ - -### visitEnum - -▸ **visitEnum**(`type`): ``null`` \| `void` \| `GraphQLEnumType` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `GraphQLEnumType` | - -#### Returns - -``null`` \| `void` \| `GraphQLEnumType` - -#### Inherited from - -SchemaDirectiveVisitor.visitEnum - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:18 - -___ - -### visitEnumValue - -▸ **visitEnumValue**(`value`, `details`): ``null`` \| `void` \| `GraphQLEnumValue` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `GraphQLEnumValue` | -| `details` | `Object` | -| `details.enumType` | `GraphQLEnumType` | - -#### Returns - -``null`` \| `void` \| `GraphQLEnumValue` - -#### Inherited from - -SchemaDirectiveVisitor.visitEnumValue - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:19 - -___ - -### visitFieldDefinition - -▸ **visitFieldDefinition**(`field`, `_details`): ``null`` \| `void` \| `GraphQLField`\<`any`, `any`, \{ `[key: string]`: `any`; }\> - -This function throws an Unauthenticated error if the context is expired or not authenticated. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `field` | `GraphQLField`\<`any`, `any`, \{ `[key: string]`: `any`; }\> | GraphQLField | -| `_details` | `Object` | Object | -| `_details.objectType` | `GraphQLObjectType`\<`any`, `any`\> \| `GraphQLInterfaceType` | - | - -#### Returns - -``null`` \| `void` \| `GraphQLField`\<`any`, `any`, \{ `[key: string]`: `any`; }\> - -resolver function - -#### Overrides - -SchemaDirectiveVisitor.visitFieldDefinition - -#### Defined in - -src/directives/authDirective.ts:17 - -___ - -### visitInputFieldDefinition - -▸ **visitInputFieldDefinition**(`field`, `details`): ``null`` \| `void` \| `GraphQLInputField` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `field` | `GraphQLInputField` | -| `details` | `Object` | -| `details.objectType` | `GraphQLInputObjectType` | - -#### Returns - -``null`` \| `void` \| `GraphQLInputField` - -#### Inherited from - -SchemaDirectiveVisitor.visitInputFieldDefinition - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:23 - -___ - -### visitInputObject - -▸ **visitInputObject**(`object`): ``null`` \| `void` \| `GraphQLInputObjectType` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `object` | `GraphQLInputObjectType` | - -#### Returns - -``null`` \| `void` \| `GraphQLInputObjectType` - -#### Inherited from - -SchemaDirectiveVisitor.visitInputObject - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:22 - -___ - -### visitInterface - -▸ **visitInterface**(`iface`): ``null`` \| `void` \| `GraphQLInterfaceType` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `iface` | `GraphQLInterfaceType` | - -#### Returns - -``null`` \| `void` \| `GraphQLInterfaceType` - -#### Inherited from - -SchemaDirectiveVisitor.visitInterface - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:16 - -___ - -### visitObject - -▸ **visitObject**(`object`): ``null`` \| `void` \| `GraphQLObjectType`\<`any`, `any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `object` | `GraphQLObjectType`\<`any`, `any`\> | - -#### Returns - -``null`` \| `void` \| `GraphQLObjectType`\<`any`, `any`\> - -#### Inherited from - -SchemaDirectiveVisitor.visitObject - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:8 - -___ - -### visitScalar - -▸ **visitScalar**(`scalar`): ``null`` \| `void` \| `GraphQLScalarType` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `scalar` | `GraphQLScalarType` | - -#### Returns - -``null`` \| `void` \| `GraphQLScalarType` - -#### Inherited from - -SchemaDirectiveVisitor.visitScalar - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:7 - -___ - -### visitSchema - -▸ **visitSchema**(`schema`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `GraphQLSchema` | - -#### Returns - -`void` - -#### Inherited from - -SchemaDirectiveVisitor.visitSchema - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:6 - -___ - -### visitUnion - -▸ **visitUnion**(`union`): ``null`` \| `void` \| `GraphQLUnionType` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `union` | `GraphQLUnionType` | - -#### Returns - -``null`` \| `void` \| `GraphQLUnionType` - -#### Inherited from - -SchemaDirectiveVisitor.visitUnion - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:17 - -___ - -### getDeclaredDirectives - -▸ `Static` `Protected` **getDeclaredDirectives**(`schema`, `directiveVisitors`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `GraphQLSchema` | -| `directiveVisitors` | `Object` | - -#### Returns - -`Object` - -#### Inherited from - -SchemaDirectiveVisitor.getDeclaredDirectives - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:46 - -___ - -### getDirectiveDeclaration - -▸ `Static` **getDirectiveDeclaration**(`directiveName`, `schema`): `GraphQLDirective` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `directiveName` | `string` | -| `schema` | `GraphQLSchema` | - -#### Returns - -`GraphQLDirective` - -#### Inherited from - -SchemaDirectiveVisitor.getDirectiveDeclaration - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:38 - -___ - -### implementsVisitorMethod - -▸ `Static` **implementsVisitorMethod**(`methodName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`boolean` - -#### Inherited from - -SchemaDirectiveVisitor.implementsVisitorMethod - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:5 - -___ - -### visitSchemaDirectives - -▸ `Static` **visitSchemaDirectives**(`schema`, `directiveVisitors`, `context?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `GraphQLSchema` | -| `directiveVisitors` | `Object` | -| `context?` | `Object` | - -#### Returns - -`Object` - -#### Inherited from - -SchemaDirectiveVisitor.visitSchemaDirectives - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:39 diff --git a/docs/talawa-api-docs/classes/directives_roleDirective.RoleAuthorizationDirective.md b/docs/talawa-api-docs/classes/directives_roleDirective.RoleAuthorizationDirective.md deleted file mode 100644 index db831c64a9f..00000000000 --- a/docs/talawa-api-docs/classes/directives_roleDirective.RoleAuthorizationDirective.md +++ /dev/null @@ -1,523 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [directives/roleDirective](../modules/directives_roleDirective.md) / RoleAuthorizationDirective - -# Class: RoleAuthorizationDirective - -[directives/roleDirective](../modules/directives_roleDirective.md).RoleAuthorizationDirective - -## Hierarchy - -- `SchemaDirectiveVisitor` - - ↳ **`RoleAuthorizationDirective`** - -## Table of contents - -### Constructors - -- [constructor](directives_roleDirective.RoleAuthorizationDirective.md#constructor) - -### Properties - -- [args](directives_roleDirective.RoleAuthorizationDirective.md#args) -- [context](directives_roleDirective.RoleAuthorizationDirective.md#context) -- [name](directives_roleDirective.RoleAuthorizationDirective.md#name) -- [schema](directives_roleDirective.RoleAuthorizationDirective.md#schema) -- [visitedType](directives_roleDirective.RoleAuthorizationDirective.md#visitedtype) - -### Methods - -- [visitArgumentDefinition](directives_roleDirective.RoleAuthorizationDirective.md#visitargumentdefinition) -- [visitEnum](directives_roleDirective.RoleAuthorizationDirective.md#visitenum) -- [visitEnumValue](directives_roleDirective.RoleAuthorizationDirective.md#visitenumvalue) -- [visitFieldDefinition](directives_roleDirective.RoleAuthorizationDirective.md#visitfielddefinition) -- [visitInputFieldDefinition](directives_roleDirective.RoleAuthorizationDirective.md#visitinputfielddefinition) -- [visitInputObject](directives_roleDirective.RoleAuthorizationDirective.md#visitinputobject) -- [visitInterface](directives_roleDirective.RoleAuthorizationDirective.md#visitinterface) -- [visitObject](directives_roleDirective.RoleAuthorizationDirective.md#visitobject) -- [visitScalar](directives_roleDirective.RoleAuthorizationDirective.md#visitscalar) -- [visitSchema](directives_roleDirective.RoleAuthorizationDirective.md#visitschema) -- [visitUnion](directives_roleDirective.RoleAuthorizationDirective.md#visitunion) -- [getDeclaredDirectives](directives_roleDirective.RoleAuthorizationDirective.md#getdeclareddirectives) -- [getDirectiveDeclaration](directives_roleDirective.RoleAuthorizationDirective.md#getdirectivedeclaration) -- [implementsVisitorMethod](directives_roleDirective.RoleAuthorizationDirective.md#implementsvisitormethod) -- [visitSchemaDirectives](directives_roleDirective.RoleAuthorizationDirective.md#visitschemadirectives) - -## Constructors - -### constructor - -• `Protected` **new RoleAuthorizationDirective**(`config`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `Object` | -| `config.args` | `Object` | -| `config.context` | `Object` | -| `config.name` | `string` | -| `config.schema` | `GraphQLSchema` | -| `config.visitedType` | `VisitableSchemaType` | - -#### Inherited from - -SchemaDirectiveVisitor.constructor - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:51 - -## Properties - -### args - -• **args**: `Object` - -#### Index signature - -▪ [name: `string`]: `any` - -#### Inherited from - -SchemaDirectiveVisitor.args - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:31 - -___ - -### context - -• **context**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Inherited from - -SchemaDirectiveVisitor.context - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:35 - -___ - -### name - -• **name**: `string` - -#### Inherited from - -SchemaDirectiveVisitor.name - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:30 - -___ - -### schema - -• **schema**: `GraphQLSchema` - -#### Inherited from - -SchemaDirectiveVisitor.schema - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:4 - -___ - -### visitedType - -• **visitedType**: `VisitableSchemaType` - -#### Inherited from - -SchemaDirectiveVisitor.visitedType - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:34 - -## Methods - -### visitArgumentDefinition - -▸ **visitArgumentDefinition**(`argument`, `details`): ``null`` \| `void` \| `GraphQLArgument` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `argument` | `GraphQLArgument` | -| `details` | `Object` | -| `details.field` | `GraphQLField`\<`any`, `any`, \{ `[key: string]`: `any`; }\> | -| `details.objectType` | `GraphQLObjectType`\<`any`, `any`\> \| `GraphQLInterfaceType` | - -#### Returns - -``null`` \| `void` \| `GraphQLArgument` - -#### Inherited from - -SchemaDirectiveVisitor.visitArgumentDefinition - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:12 - -___ - -### visitEnum - -▸ **visitEnum**(`type`): ``null`` \| `void` \| `GraphQLEnumType` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `GraphQLEnumType` | - -#### Returns - -``null`` \| `void` \| `GraphQLEnumType` - -#### Inherited from - -SchemaDirectiveVisitor.visitEnum - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:18 - -___ - -### visitEnumValue - -▸ **visitEnumValue**(`value`, `details`): ``null`` \| `void` \| `GraphQLEnumValue` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `GraphQLEnumValue` | -| `details` | `Object` | -| `details.enumType` | `GraphQLEnumType` | - -#### Returns - -``null`` \| `void` \| `GraphQLEnumValue` - -#### Inherited from - -SchemaDirectiveVisitor.visitEnumValue - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:19 - -___ - -### visitFieldDefinition - -▸ **visitFieldDefinition**(`field`, `_details`): ``null`` \| `void` \| `GraphQLField`\<`any`, `any`, \{ `[key: string]`: `any`; }\> - -This function authenticates the role of the user and if not validated, then throws an Unauthenticated Error. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `field` | `GraphQLField`\<`any`, `any`, \{ `[key: string]`: `any`; }\> | GraphQLField | -| `_details` | `Object` | Object | -| `_details.objectType` | `GraphQLObjectType`\<`any`, `any`\> \| `GraphQLInterfaceType` | - | - -#### Returns - -``null`` \| `void` \| `GraphQLField`\<`any`, `any`, \{ `[key: string]`: `any`; }\> - -resolver function - -#### Overrides - -SchemaDirectiveVisitor.visitFieldDefinition - -#### Defined in - -src/directives/roleDirective.ts:19 - -___ - -### visitInputFieldDefinition - -▸ **visitInputFieldDefinition**(`field`, `details`): ``null`` \| `void` \| `GraphQLInputField` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `field` | `GraphQLInputField` | -| `details` | `Object` | -| `details.objectType` | `GraphQLInputObjectType` | - -#### Returns - -``null`` \| `void` \| `GraphQLInputField` - -#### Inherited from - -SchemaDirectiveVisitor.visitInputFieldDefinition - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:23 - -___ - -### visitInputObject - -▸ **visitInputObject**(`object`): ``null`` \| `void` \| `GraphQLInputObjectType` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `object` | `GraphQLInputObjectType` | - -#### Returns - -``null`` \| `void` \| `GraphQLInputObjectType` - -#### Inherited from - -SchemaDirectiveVisitor.visitInputObject - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:22 - -___ - -### visitInterface - -▸ **visitInterface**(`iface`): ``null`` \| `void` \| `GraphQLInterfaceType` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `iface` | `GraphQLInterfaceType` | - -#### Returns - -``null`` \| `void` \| `GraphQLInterfaceType` - -#### Inherited from - -SchemaDirectiveVisitor.visitInterface - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:16 - -___ - -### visitObject - -▸ **visitObject**(`object`): ``null`` \| `void` \| `GraphQLObjectType`\<`any`, `any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `object` | `GraphQLObjectType`\<`any`, `any`\> | - -#### Returns - -``null`` \| `void` \| `GraphQLObjectType`\<`any`, `any`\> - -#### Inherited from - -SchemaDirectiveVisitor.visitObject - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:8 - -___ - -### visitScalar - -▸ **visitScalar**(`scalar`): ``null`` \| `void` \| `GraphQLScalarType` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `scalar` | `GraphQLScalarType` | - -#### Returns - -``null`` \| `void` \| `GraphQLScalarType` - -#### Inherited from - -SchemaDirectiveVisitor.visitScalar - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:7 - -___ - -### visitSchema - -▸ **visitSchema**(`schema`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `GraphQLSchema` | - -#### Returns - -`void` - -#### Inherited from - -SchemaDirectiveVisitor.visitSchema - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:6 - -___ - -### visitUnion - -▸ **visitUnion**(`union`): ``null`` \| `void` \| `GraphQLUnionType` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `union` | `GraphQLUnionType` | - -#### Returns - -``null`` \| `void` \| `GraphQLUnionType` - -#### Inherited from - -SchemaDirectiveVisitor.visitUnion - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:17 - -___ - -### getDeclaredDirectives - -▸ `Static` `Protected` **getDeclaredDirectives**(`schema`, `directiveVisitors`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `GraphQLSchema` | -| `directiveVisitors` | `Object` | - -#### Returns - -`Object` - -#### Inherited from - -SchemaDirectiveVisitor.getDeclaredDirectives - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:46 - -___ - -### getDirectiveDeclaration - -▸ `Static` **getDirectiveDeclaration**(`directiveName`, `schema`): `GraphQLDirective` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `directiveName` | `string` | -| `schema` | `GraphQLSchema` | - -#### Returns - -`GraphQLDirective` - -#### Inherited from - -SchemaDirectiveVisitor.getDirectiveDeclaration - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:38 - -___ - -### implementsVisitorMethod - -▸ `Static` **implementsVisitorMethod**(`methodName`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodName` | `string` | - -#### Returns - -`boolean` - -#### Inherited from - -SchemaDirectiveVisitor.implementsVisitorMethod - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:5 - -___ - -### visitSchemaDirectives - -▸ `Static` **visitSchemaDirectives**(`schema`, `directiveVisitors`, `context?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `GraphQLSchema` | -| `directiveVisitors` | `Object` | -| `context?` | `Object` | - -#### Returns - -`Object` - -#### Inherited from - -SchemaDirectiveVisitor.visitSchemaDirectives - -#### Defined in - -node_modules/graphql-tools/dist/schemaVisitor.d.ts:39 diff --git a/docs/talawa-api-docs/enums/constants.EventVolunteerResponse.md b/docs/talawa-api-docs/enums/constants.EventVolunteerResponse.md index 068b4457b93..3240b3fce0e 100644 --- a/docs/talawa-api-docs/enums/constants.EventVolunteerResponse.md +++ b/docs/talawa-api-docs/enums/constants.EventVolunteerResponse.md @@ -19,7 +19,7 @@ #### Defined in -[src/constants.ts:574](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/constants.ts#L574) +[src/constants.ts:632](https://github.com/adi790uu/talawa-api/blob/5146430/src/constants.ts#L632) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -[src/constants.ts:573](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/constants.ts#L573) +[src/constants.ts:631](https://github.com/adi790uu/talawa-api/blob/5146430/src/constants.ts#L631) diff --git a/docs/talawa-api-docs/enums/models_FundraisingCampaign.CurrencyType.md b/docs/talawa-api-docs/enums/models_FundraisingCampaign.CurrencyType.md new file mode 100644 index 00000000000..56f09edbeb7 --- /dev/null +++ b/docs/talawa-api-docs/enums/models_FundraisingCampaign.CurrencyType.md @@ -0,0 +1,1803 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / [models/FundraisingCampaign](../modules/models_FundraisingCampaign.md) / CurrencyType + +# Enumeration: CurrencyType + +[models/FundraisingCampaign](../modules/models_FundraisingCampaign.md).CurrencyType + +## Table of contents + +### Enumeration Members + +- [AED](models_FundraisingCampaign.CurrencyType.md#aed) +- [AFN](models_FundraisingCampaign.CurrencyType.md#afn) +- [ALL](models_FundraisingCampaign.CurrencyType.md#all) +- [AMD](models_FundraisingCampaign.CurrencyType.md#amd) +- [ANG](models_FundraisingCampaign.CurrencyType.md#ang) +- [AOA](models_FundraisingCampaign.CurrencyType.md#aoa) +- [ARS](models_FundraisingCampaign.CurrencyType.md#ars) +- [AUD](models_FundraisingCampaign.CurrencyType.md#aud) +- [AWG](models_FundraisingCampaign.CurrencyType.md#awg) +- [AZN](models_FundraisingCampaign.CurrencyType.md#azn) +- [BAM](models_FundraisingCampaign.CurrencyType.md#bam) +- [BBD](models_FundraisingCampaign.CurrencyType.md#bbd) +- [BDT](models_FundraisingCampaign.CurrencyType.md#bdt) +- [BGN](models_FundraisingCampaign.CurrencyType.md#bgn) +- [BHD](models_FundraisingCampaign.CurrencyType.md#bhd) +- [BIF](models_FundraisingCampaign.CurrencyType.md#bif) +- [BMD](models_FundraisingCampaign.CurrencyType.md#bmd) +- [BND](models_FundraisingCampaign.CurrencyType.md#bnd) +- [BOB](models_FundraisingCampaign.CurrencyType.md#bob) +- [BRL](models_FundraisingCampaign.CurrencyType.md#brl) +- [BSD](models_FundraisingCampaign.CurrencyType.md#bsd) +- [BTN](models_FundraisingCampaign.CurrencyType.md#btn) +- [BWP](models_FundraisingCampaign.CurrencyType.md#bwp) +- [BYN](models_FundraisingCampaign.CurrencyType.md#byn) +- [BZD](models_FundraisingCampaign.CurrencyType.md#bzd) +- [CAD](models_FundraisingCampaign.CurrencyType.md#cad) +- [CDF](models_FundraisingCampaign.CurrencyType.md#cdf) +- [CHF](models_FundraisingCampaign.CurrencyType.md#chf) +- [CLP](models_FundraisingCampaign.CurrencyType.md#clp) +- [CNY](models_FundraisingCampaign.CurrencyType.md#cny) +- [COP](models_FundraisingCampaign.CurrencyType.md#cop) +- [CRC](models_FundraisingCampaign.CurrencyType.md#crc) +- [CUP](models_FundraisingCampaign.CurrencyType.md#cup) +- [CVE](models_FundraisingCampaign.CurrencyType.md#cve) +- [CZK](models_FundraisingCampaign.CurrencyType.md#czk) +- [DJF](models_FundraisingCampaign.CurrencyType.md#djf) +- [DKK](models_FundraisingCampaign.CurrencyType.md#dkk) +- [DOP](models_FundraisingCampaign.CurrencyType.md#dop) +- [DZD](models_FundraisingCampaign.CurrencyType.md#dzd) +- [EGP](models_FundraisingCampaign.CurrencyType.md#egp) +- [ERN](models_FundraisingCampaign.CurrencyType.md#ern) +- [ETB](models_FundraisingCampaign.CurrencyType.md#etb) +- [EUR](models_FundraisingCampaign.CurrencyType.md#eur) +- [FJD](models_FundraisingCampaign.CurrencyType.md#fjd) +- [FKP](models_FundraisingCampaign.CurrencyType.md#fkp) +- [FOK](models_FundraisingCampaign.CurrencyType.md#fok) +- [FRO](models_FundraisingCampaign.CurrencyType.md#fro) +- [GBP](models_FundraisingCampaign.CurrencyType.md#gbp) +- [GEL](models_FundraisingCampaign.CurrencyType.md#gel) +- [GGP](models_FundraisingCampaign.CurrencyType.md#ggp) +- [GHS](models_FundraisingCampaign.CurrencyType.md#ghs) +- [GIP](models_FundraisingCampaign.CurrencyType.md#gip) +- [GMD](models_FundraisingCampaign.CurrencyType.md#gmd) +- [GNF](models_FundraisingCampaign.CurrencyType.md#gnf) +- [GTQ](models_FundraisingCampaign.CurrencyType.md#gtq) +- [GYD](models_FundraisingCampaign.CurrencyType.md#gyd) +- [HKD](models_FundraisingCampaign.CurrencyType.md#hkd) +- [HNL](models_FundraisingCampaign.CurrencyType.md#hnl) +- [HRK](models_FundraisingCampaign.CurrencyType.md#hrk) +- [HTG](models_FundraisingCampaign.CurrencyType.md#htg) +- [HUF](models_FundraisingCampaign.CurrencyType.md#huf) +- [IDR](models_FundraisingCampaign.CurrencyType.md#idr) +- [ILS](models_FundraisingCampaign.CurrencyType.md#ils) +- [IMP](models_FundraisingCampaign.CurrencyType.md#imp) +- [INR](models_FundraisingCampaign.CurrencyType.md#inr) +- [IQD](models_FundraisingCampaign.CurrencyType.md#iqd) +- [IRR](models_FundraisingCampaign.CurrencyType.md#irr) +- [ISK](models_FundraisingCampaign.CurrencyType.md#isk) +- [JEP](models_FundraisingCampaign.CurrencyType.md#jep) +- [JMD](models_FundraisingCampaign.CurrencyType.md#jmd) +- [JOD](models_FundraisingCampaign.CurrencyType.md#jod) +- [JPY](models_FundraisingCampaign.CurrencyType.md#jpy) +- [KES](models_FundraisingCampaign.CurrencyType.md#kes) +- [KGS](models_FundraisingCampaign.CurrencyType.md#kgs) +- [KHR](models_FundraisingCampaign.CurrencyType.md#khr) +- [KID](models_FundraisingCampaign.CurrencyType.md#kid) +- [KMF](models_FundraisingCampaign.CurrencyType.md#kmf) +- [KRW](models_FundraisingCampaign.CurrencyType.md#krw) +- [KWD](models_FundraisingCampaign.CurrencyType.md#kwd) +- [KYD](models_FundraisingCampaign.CurrencyType.md#kyd) +- [KZT](models_FundraisingCampaign.CurrencyType.md#kzt) +- [LAK](models_FundraisingCampaign.CurrencyType.md#lak) +- [LBP](models_FundraisingCampaign.CurrencyType.md#lbp) +- [LKR](models_FundraisingCampaign.CurrencyType.md#lkr) +- [LRD](models_FundraisingCampaign.CurrencyType.md#lrd) +- [LSL](models_FundraisingCampaign.CurrencyType.md#lsl) +- [LYD](models_FundraisingCampaign.CurrencyType.md#lyd) +- [MAD](models_FundraisingCampaign.CurrencyType.md#mad) +- [MDL](models_FundraisingCampaign.CurrencyType.md#mdl) +- [MGA](models_FundraisingCampaign.CurrencyType.md#mga) +- [MKD](models_FundraisingCampaign.CurrencyType.md#mkd) +- [MMK](models_FundraisingCampaign.CurrencyType.md#mmk) +- [MNT](models_FundraisingCampaign.CurrencyType.md#mnt) +- [MOP](models_FundraisingCampaign.CurrencyType.md#mop) +- [MRU](models_FundraisingCampaign.CurrencyType.md#mru) +- [MUR](models_FundraisingCampaign.CurrencyType.md#mur) +- [MVR](models_FundraisingCampaign.CurrencyType.md#mvr) +- [MWK](models_FundraisingCampaign.CurrencyType.md#mwk) +- [MXN](models_FundraisingCampaign.CurrencyType.md#mxn) +- [MYR](models_FundraisingCampaign.CurrencyType.md#myr) +- [MZN](models_FundraisingCampaign.CurrencyType.md#mzn) +- [NAD](models_FundraisingCampaign.CurrencyType.md#nad) +- [NGN](models_FundraisingCampaign.CurrencyType.md#ngn) +- [NIO](models_FundraisingCampaign.CurrencyType.md#nio) +- [NOK](models_FundraisingCampaign.CurrencyType.md#nok) +- [NPR](models_FundraisingCampaign.CurrencyType.md#npr) +- [NZD](models_FundraisingCampaign.CurrencyType.md#nzd) +- [OMR](models_FundraisingCampaign.CurrencyType.md#omr) +- [PAB](models_FundraisingCampaign.CurrencyType.md#pab) +- [PEN](models_FundraisingCampaign.CurrencyType.md#pen) +- [PGK](models_FundraisingCampaign.CurrencyType.md#pgk) +- [PHP](models_FundraisingCampaign.CurrencyType.md#php) +- [PKR](models_FundraisingCampaign.CurrencyType.md#pkr) +- [PLN](models_FundraisingCampaign.CurrencyType.md#pln) +- [PYG](models_FundraisingCampaign.CurrencyType.md#pyg) +- [QAR](models_FundraisingCampaign.CurrencyType.md#qar) +- [RON](models_FundraisingCampaign.CurrencyType.md#ron) +- [RSD](models_FundraisingCampaign.CurrencyType.md#rsd) +- [RUB](models_FundraisingCampaign.CurrencyType.md#rub) +- [RWF](models_FundraisingCampaign.CurrencyType.md#rwf) +- [SAR](models_FundraisingCampaign.CurrencyType.md#sar) +- [SBD](models_FundraisingCampaign.CurrencyType.md#sbd) +- [SCR](models_FundraisingCampaign.CurrencyType.md#scr) +- [SDG](models_FundraisingCampaign.CurrencyType.md#sdg) +- [SEK](models_FundraisingCampaign.CurrencyType.md#sek) +- [SGD](models_FundraisingCampaign.CurrencyType.md#sgd) +- [SHP](models_FundraisingCampaign.CurrencyType.md#shp) +- [SLL](models_FundraisingCampaign.CurrencyType.md#sll) +- [SOS](models_FundraisingCampaign.CurrencyType.md#sos) +- [SPL](models_FundraisingCampaign.CurrencyType.md#spl) +- [SRD](models_FundraisingCampaign.CurrencyType.md#srd) +- [STN](models_FundraisingCampaign.CurrencyType.md#stn) +- [SVC](models_FundraisingCampaign.CurrencyType.md#svc) +- [SYP](models_FundraisingCampaign.CurrencyType.md#syp) +- [SZL](models_FundraisingCampaign.CurrencyType.md#szl) +- [THB](models_FundraisingCampaign.CurrencyType.md#thb) +- [TJS](models_FundraisingCampaign.CurrencyType.md#tjs) +- [TMT](models_FundraisingCampaign.CurrencyType.md#tmt) +- [TND](models_FundraisingCampaign.CurrencyType.md#tnd) +- [TOP](models_FundraisingCampaign.CurrencyType.md#top) +- [TRY](models_FundraisingCampaign.CurrencyType.md#try) +- [TTD](models_FundraisingCampaign.CurrencyType.md#ttd) +- [TVD](models_FundraisingCampaign.CurrencyType.md#tvd) +- [TWD](models_FundraisingCampaign.CurrencyType.md#twd) +- [TZS](models_FundraisingCampaign.CurrencyType.md#tzs) +- [UAH](models_FundraisingCampaign.CurrencyType.md#uah) +- [UGX](models_FundraisingCampaign.CurrencyType.md#ugx) +- [USD](models_FundraisingCampaign.CurrencyType.md#usd) +- [UYU](models_FundraisingCampaign.CurrencyType.md#uyu) +- [UZS](models_FundraisingCampaign.CurrencyType.md#uzs) +- [VEF](models_FundraisingCampaign.CurrencyType.md#vef) +- [VND](models_FundraisingCampaign.CurrencyType.md#vnd) +- [VUV](models_FundraisingCampaign.CurrencyType.md#vuv) +- [WST](models_FundraisingCampaign.CurrencyType.md#wst) +- [XAF](models_FundraisingCampaign.CurrencyType.md#xaf) +- [XCD](models_FundraisingCampaign.CurrencyType.md#xcd) +- [XDR](models_FundraisingCampaign.CurrencyType.md#xdr) +- [XOF](models_FundraisingCampaign.CurrencyType.md#xof) +- [XPF](models_FundraisingCampaign.CurrencyType.md#xpf) +- [YER](models_FundraisingCampaign.CurrencyType.md#yer) +- [ZAR](models_FundraisingCampaign.CurrencyType.md#zar) +- [ZMW](models_FundraisingCampaign.CurrencyType.md#zmw) +- [ZWD](models_FundraisingCampaign.CurrencyType.md#zwd) + +## Enumeration Members + +### AED + +• **AED** = ``"AED"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:7](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L7) + +___ + +### AFN + +• **AFN** = ``"AFN"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:8](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L8) + +___ + +### ALL + +• **ALL** = ``"ALL"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:9](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L9) + +___ + +### AMD + +• **AMD** = ``"AMD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:10](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L10) + +___ + +### ANG + +• **ANG** = ``"ANG"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:11](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L11) + +___ + +### AOA + +• **AOA** = ``"AOA"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:12](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L12) + +___ + +### ARS + +• **ARS** = ``"ARS"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:13](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L13) + +___ + +### AUD + +• **AUD** = ``"AUD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:14](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L14) + +___ + +### AWG + +• **AWG** = ``"AWG"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:15](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L15) + +___ + +### AZN + +• **AZN** = ``"AZN"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:16](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L16) + +___ + +### BAM + +• **BAM** = ``"BAM"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:17](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L17) + +___ + +### BBD + +• **BBD** = ``"BBD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:18](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L18) + +___ + +### BDT + +• **BDT** = ``"BDT"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:19](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L19) + +___ + +### BGN + +• **BGN** = ``"BGN"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:20](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L20) + +___ + +### BHD + +• **BHD** = ``"BHD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:21](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L21) + +___ + +### BIF + +• **BIF** = ``"BIF"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:22](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L22) + +___ + +### BMD + +• **BMD** = ``"BMD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:23](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L23) + +___ + +### BND + +• **BND** = ``"BND"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:24](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L24) + +___ + +### BOB + +• **BOB** = ``"BOB"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:25](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L25) + +___ + +### BRL + +• **BRL** = ``"BRL"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:26](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L26) + +___ + +### BSD + +• **BSD** = ``"BSD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:27](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L27) + +___ + +### BTN + +• **BTN** = ``"BTN"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:28](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L28) + +___ + +### BWP + +• **BWP** = ``"BWP"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:29](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L29) + +___ + +### BYN + +• **BYN** = ``"BYN"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:30](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L30) + +___ + +### BZD + +• **BZD** = ``"BZD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:31](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L31) + +___ + +### CAD + +• **CAD** = ``"CAD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:32](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L32) + +___ + +### CDF + +• **CDF** = ``"CDF"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:33](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L33) + +___ + +### CHF + +• **CHF** = ``"CHF"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:34](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L34) + +___ + +### CLP + +• **CLP** = ``"CLP"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:35](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L35) + +___ + +### CNY + +• **CNY** = ``"CNY"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:36](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L36) + +___ + +### COP + +• **COP** = ``"COP"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:37](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L37) + +___ + +### CRC + +• **CRC** = ``"CRC"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:38](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L38) + +___ + +### CUP + +• **CUP** = ``"CUP"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:39](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L39) + +___ + +### CVE + +• **CVE** = ``"CVE"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:40](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L40) + +___ + +### CZK + +• **CZK** = ``"CZK"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:41](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L41) + +___ + +### DJF + +• **DJF** = ``"DJF"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:42](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L42) + +___ + +### DKK + +• **DKK** = ``"DKK"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:43](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L43) + +___ + +### DOP + +• **DOP** = ``"DOP"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:44](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L44) + +___ + +### DZD + +• **DZD** = ``"DZD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:45](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L45) + +___ + +### EGP + +• **EGP** = ``"EGP"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:46](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L46) + +___ + +### ERN + +• **ERN** = ``"ERN"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:47](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L47) + +___ + +### ETB + +• **ETB** = ``"ETB"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:48](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L48) + +___ + +### EUR + +• **EUR** = ``"EUR"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:49](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L49) + +___ + +### FJD + +• **FJD** = ``"FJD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:50](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L50) + +___ + +### FKP + +• **FKP** = ``"FKP"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:51](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L51) + +___ + +### FOK + +• **FOK** = ``"FOK"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:52](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L52) + +___ + +### FRO + +• **FRO** = ``"FRO"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:53](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L53) + +___ + +### GBP + +• **GBP** = ``"GBP"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:54](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L54) + +___ + +### GEL + +• **GEL** = ``"GEL"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:55](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L55) + +___ + +### GGP + +• **GGP** = ``"GGP"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:56](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L56) + +___ + +### GHS + +• **GHS** = ``"GHS"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:57](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L57) + +___ + +### GIP + +• **GIP** = ``"GIP"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:58](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L58) + +___ + +### GMD + +• **GMD** = ``"GMD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:59](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L59) + +___ + +### GNF + +• **GNF** = ``"GNF"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:60](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L60) + +___ + +### GTQ + +• **GTQ** = ``"GTQ"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:61](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L61) + +___ + +### GYD + +• **GYD** = ``"GYD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:62](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L62) + +___ + +### HKD + +• **HKD** = ``"HKD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:63](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L63) + +___ + +### HNL + +• **HNL** = ``"HNL"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:64](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L64) + +___ + +### HRK + +• **HRK** = ``"HRK"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:65](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L65) + +___ + +### HTG + +• **HTG** = ``"HTG"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:66](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L66) + +___ + +### HUF + +• **HUF** = ``"HUF"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:67](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L67) + +___ + +### IDR + +• **IDR** = ``"IDR"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:68](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L68) + +___ + +### ILS + +• **ILS** = ``"ILS"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:69](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L69) + +___ + +### IMP + +• **IMP** = ``"IMP"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:70](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L70) + +___ + +### INR + +• **INR** = ``"INR"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:71](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L71) + +___ + +### IQD + +• **IQD** = ``"IQD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:72](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L72) + +___ + +### IRR + +• **IRR** = ``"IRR"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:73](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L73) + +___ + +### ISK + +• **ISK** = ``"ISK"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:74](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L74) + +___ + +### JEP + +• **JEP** = ``"JEP"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:75](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L75) + +___ + +### JMD + +• **JMD** = ``"JMD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:76](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L76) + +___ + +### JOD + +• **JOD** = ``"JOD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:77](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L77) + +___ + +### JPY + +• **JPY** = ``"JPY"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:78](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L78) + +___ + +### KES + +• **KES** = ``"KES"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:79](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L79) + +___ + +### KGS + +• **KGS** = ``"KGS"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:80](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L80) + +___ + +### KHR + +• **KHR** = ``"KHR"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:81](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L81) + +___ + +### KID + +• **KID** = ``"KID"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:82](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L82) + +___ + +### KMF + +• **KMF** = ``"KMF"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:83](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L83) + +___ + +### KRW + +• **KRW** = ``"KRW"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:84](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L84) + +___ + +### KWD + +• **KWD** = ``"KWD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:85](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L85) + +___ + +### KYD + +• **KYD** = ``"KYD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:86](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L86) + +___ + +### KZT + +• **KZT** = ``"KZT"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:87](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L87) + +___ + +### LAK + +• **LAK** = ``"LAK"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:88](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L88) + +___ + +### LBP + +• **LBP** = ``"LBP"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:89](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L89) + +___ + +### LKR + +• **LKR** = ``"LKR"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:90](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L90) + +___ + +### LRD + +• **LRD** = ``"LRD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:91](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L91) + +___ + +### LSL + +• **LSL** = ``"LSL"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:92](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L92) + +___ + +### LYD + +• **LYD** = ``"LYD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:93](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L93) + +___ + +### MAD + +• **MAD** = ``"MAD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:94](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L94) + +___ + +### MDL + +• **MDL** = ``"MDL"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:95](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L95) + +___ + +### MGA + +• **MGA** = ``"MGA"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:96](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L96) + +___ + +### MKD + +• **MKD** = ``"MKD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:97](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L97) + +___ + +### MMK + +• **MMK** = ``"MMK"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:98](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L98) + +___ + +### MNT + +• **MNT** = ``"MNT"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:99](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L99) + +___ + +### MOP + +• **MOP** = ``"MOP"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:100](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L100) + +___ + +### MRU + +• **MRU** = ``"MRU"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:101](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L101) + +___ + +### MUR + +• **MUR** = ``"MUR"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:102](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L102) + +___ + +### MVR + +• **MVR** = ``"MVR"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:103](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L103) + +___ + +### MWK + +• **MWK** = ``"MWK"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:104](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L104) + +___ + +### MXN + +• **MXN** = ``"MXN"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:105](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L105) + +___ + +### MYR + +• **MYR** = ``"MYR"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:106](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L106) + +___ + +### MZN + +• **MZN** = ``"MZN"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:107](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L107) + +___ + +### NAD + +• **NAD** = ``"NAD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:108](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L108) + +___ + +### NGN + +• **NGN** = ``"NGN"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:109](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L109) + +___ + +### NIO + +• **NIO** = ``"NIO"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:110](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L110) + +___ + +### NOK + +• **NOK** = ``"NOK"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:111](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L111) + +___ + +### NPR + +• **NPR** = ``"NPR"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:112](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L112) + +___ + +### NZD + +• **NZD** = ``"NZD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:113](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L113) + +___ + +### OMR + +• **OMR** = ``"OMR"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:114](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L114) + +___ + +### PAB + +• **PAB** = ``"PAB"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:115](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L115) + +___ + +### PEN + +• **PEN** = ``"PEN"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:116](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L116) + +___ + +### PGK + +• **PGK** = ``"PGK"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:117](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L117) + +___ + +### PHP + +• **PHP** = ``"PHP"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:118](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L118) + +___ + +### PKR + +• **PKR** = ``"PKR"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:119](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L119) + +___ + +### PLN + +• **PLN** = ``"PLN"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:120](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L120) + +___ + +### PYG + +• **PYG** = ``"PYG"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:121](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L121) + +___ + +### QAR + +• **QAR** = ``"QAR"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:122](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L122) + +___ + +### RON + +• **RON** = ``"RON"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:123](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L123) + +___ + +### RSD + +• **RSD** = ``"RSD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:124](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L124) + +___ + +### RUB + +• **RUB** = ``"RUB"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:125](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L125) + +___ + +### RWF + +• **RWF** = ``"RWF"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:126](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L126) + +___ + +### SAR + +• **SAR** = ``"SAR"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:127](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L127) + +___ + +### SBD + +• **SBD** = ``"SBD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:128](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L128) + +___ + +### SCR + +• **SCR** = ``"SCR"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:129](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L129) + +___ + +### SDG + +• **SDG** = ``"SDG"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:130](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L130) + +___ + +### SEK + +• **SEK** = ``"SEK"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:131](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L131) + +___ + +### SGD + +• **SGD** = ``"SGD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:132](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L132) + +___ + +### SHP + +• **SHP** = ``"SHP"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:133](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L133) + +___ + +### SLL + +• **SLL** = ``"SLL"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:134](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L134) + +___ + +### SOS + +• **SOS** = ``"SOS"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:135](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L135) + +___ + +### SPL + +• **SPL** = ``"SPL"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:136](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L136) + +___ + +### SRD + +• **SRD** = ``"SRD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:137](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L137) + +___ + +### STN + +• **STN** = ``"STN"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:138](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L138) + +___ + +### SVC + +• **SVC** = ``"SVC"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:139](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L139) + +___ + +### SYP + +• **SYP** = ``"SYP"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:140](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L140) + +___ + +### SZL + +• **SZL** = ``"SZL"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:141](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L141) + +___ + +### THB + +• **THB** = ``"THB"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:142](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L142) + +___ + +### TJS + +• **TJS** = ``"TJS"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:143](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L143) + +___ + +### TMT + +• **TMT** = ``"TMT"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:144](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L144) + +___ + +### TND + +• **TND** = ``"TND"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:145](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L145) + +___ + +### TOP + +• **TOP** = ``"TOP"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:146](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L146) + +___ + +### TRY + +• **TRY** = ``"TRY"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:147](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L147) + +___ + +### TTD + +• **TTD** = ``"TTD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:148](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L148) + +___ + +### TVD + +• **TVD** = ``"TVD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:149](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L149) + +___ + +### TWD + +• **TWD** = ``"TWD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:150](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L150) + +___ + +### TZS + +• **TZS** = ``"TZS"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:151](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L151) + +___ + +### UAH + +• **UAH** = ``"UAH"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:152](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L152) + +___ + +### UGX + +• **UGX** = ``"UGX"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:153](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L153) + +___ + +### USD + +• **USD** = ``"USD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:154](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L154) + +___ + +### UYU + +• **UYU** = ``"UYU"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:155](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L155) + +___ + +### UZS + +• **UZS** = ``"UZS"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:156](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L156) + +___ + +### VEF + +• **VEF** = ``"VEF"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:157](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L157) + +___ + +### VND + +• **VND** = ``"VND"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:158](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L158) + +___ + +### VUV + +• **VUV** = ``"VUV"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:159](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L159) + +___ + +### WST + +• **WST** = ``"WST"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:160](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L160) + +___ + +### XAF + +• **XAF** = ``"XAF"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:161](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L161) + +___ + +### XCD + +• **XCD** = ``"XCD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:162](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L162) + +___ + +### XDR + +• **XDR** = ``"XDR"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:163](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L163) + +___ + +### XOF + +• **XOF** = ``"XOF"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:164](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L164) + +___ + +### XPF + +• **XPF** = ``"XPF"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:165](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L165) + +___ + +### YER + +• **YER** = ``"YER"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:166](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L166) + +___ + +### ZAR + +• **ZAR** = ``"ZAR"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:167](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L167) + +___ + +### ZMW + +• **ZMW** = ``"ZMW"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:168](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L168) + +___ + +### ZWD + +• **ZWD** = ``"ZWD"`` + +#### Defined in + +[src/models/FundraisingCampaign.ts:169](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L169) diff --git a/docs/talawa-api-docs/enums/models_RecurrenceRule.Frequency.md b/docs/talawa-api-docs/enums/models_RecurrenceRule.Frequency.md index 24cd130c774..f7f5e1fab68 100644 --- a/docs/talawa-api-docs/enums/models_RecurrenceRule.Frequency.md +++ b/docs/talawa-api-docs/enums/models_RecurrenceRule.Frequency.md @@ -23,7 +23,7 @@ This is an interface representing a document for a recurrence rule in the databa #### Defined in -[src/models/RecurrenceRule.ts:13](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L13) +[src/models/RecurrenceRule.ts:13](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L13) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -[src/models/RecurrenceRule.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L11) +[src/models/RecurrenceRule.ts:11](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L11) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[src/models/RecurrenceRule.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L12) +[src/models/RecurrenceRule.ts:12](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L12) ___ @@ -53,4 +53,4 @@ ___ #### Defined in -[src/models/RecurrenceRule.ts:10](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L10) +[src/models/RecurrenceRule.ts:10](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L10) diff --git a/docs/talawa-api-docs/enums/models_RecurrenceRule.WeekDays.md b/docs/talawa-api-docs/enums/models_RecurrenceRule.WeekDays.md index 30fb5951783..1427d23464e 100644 --- a/docs/talawa-api-docs/enums/models_RecurrenceRule.WeekDays.md +++ b/docs/talawa-api-docs/enums/models_RecurrenceRule.WeekDays.md @@ -24,7 +24,7 @@ #### Defined in -[src/models/RecurrenceRule.ts:22](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L22) +[src/models/RecurrenceRule.ts:22](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L22) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[src/models/RecurrenceRule.ts:18](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L18) +[src/models/RecurrenceRule.ts:18](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L18) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[src/models/RecurrenceRule.ts:23](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L23) +[src/models/RecurrenceRule.ts:23](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L23) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[src/models/RecurrenceRule.ts:17](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L17) +[src/models/RecurrenceRule.ts:17](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L17) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[src/models/RecurrenceRule.ts:21](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L21) +[src/models/RecurrenceRule.ts:21](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L21) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[src/models/RecurrenceRule.ts:19](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L19) +[src/models/RecurrenceRule.ts:19](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L19) ___ @@ -84,4 +84,4 @@ ___ #### Defined in -[src/models/RecurrenceRule.ts:20](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L20) +[src/models/RecurrenceRule.ts:20](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L20) diff --git a/docs/talawa-api-docs/interfaces/helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md b/docs/talawa-api-docs/interfaces/helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md new file mode 100644 index 00000000000..035e28b0d07 --- /dev/null +++ b/docs/talawa-api-docs/interfaces/helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md @@ -0,0 +1,318 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / [helpers/event/recurringEventHelpers/generateRecurringEventInstances](../modules/helpers_event_recurringEventHelpers_generateRecurringEventInstances.md) / InterfaceRecurringEvent + +# Interface: InterfaceRecurringEvent + +[helpers/event/recurringEventHelpers/generateRecurringEventInstances](../modules/helpers_event_recurringEventHelpers_generateRecurringEventInstances.md).InterfaceRecurringEvent + +## Hierarchy + +- [`EventInput`](../modules/types_generatedGraphQLTypes.md#eventinput) + + ↳ **`InterfaceRecurringEvent`** + +## Table of contents + +### Properties + +- [admins](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#admins) +- [allDay](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#allday) +- [baseRecurringEventId](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#baserecurringeventid) +- [creatorId](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#creatorid) +- [description](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#description) +- [endDate](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#enddate) +- [endTime](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#endtime) +- [isBaseRecurringEvent](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#isbaserecurringevent) +- [isPublic](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#ispublic) +- [isRegisterable](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#isregisterable) +- [latitude](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#latitude) +- [location](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#location) +- [longitude](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#longitude) +- [organization](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#organization) +- [organizationId](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#organizationid) +- [recurrance](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#recurrance) +- [recurrenceRuleId](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#recurrenceruleid) +- [recurring](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#recurring) +- [startDate](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#startdate) +- [startTime](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#starttime) +- [status](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#status) +- [title](helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md#title) + +## Properties + +### admins + +• `Optional` **admins**: `string`[] + +#### Defined in + +[src/helpers/event/recurringEventHelpers/generateRecurringEventInstances.ts:39](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/recurringEventHelpers/generateRecurringEventInstances.ts#L39) + +___ + +### allDay + +• **allDay**: `boolean` + +#### Inherited from + +EventInput.allDay + +#### Defined in + +[src/types/generatedGraphQLTypes.ts:581](https://github.com/adi790uu/talawa-api/blob/5146430/src/types/generatedGraphQLTypes.ts#L581) + +___ + +### baseRecurringEventId + +• `Optional` **baseRecurringEventId**: `string` + +#### Defined in + +[src/helpers/event/recurringEventHelpers/generateRecurringEventInstances.ts:37](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/recurringEventHelpers/generateRecurringEventInstances.ts#L37) + +___ + +### creatorId + +• `Optional` **creatorId**: `string` + +#### Defined in + +[src/helpers/event/recurringEventHelpers/generateRecurringEventInstances.ts:38](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/recurringEventHelpers/generateRecurringEventInstances.ts#L38) + +___ + +### description + +• **description**: `string` + +#### Inherited from + +EventInput.description + +#### Defined in + +[src/types/generatedGraphQLTypes.ts:582](https://github.com/adi790uu/talawa-api/blob/5146430/src/types/generatedGraphQLTypes.ts#L582) + +___ + +### endDate + +• `Optional` **endDate**: `any` + +#### Inherited from + +EventInput.endDate + +#### Defined in + +[src/types/generatedGraphQLTypes.ts:583](https://github.com/adi790uu/talawa-api/blob/5146430/src/types/generatedGraphQLTypes.ts#L583) + +___ + +### endTime + +• `Optional` **endTime**: `any` + +#### Inherited from + +EventInput.endTime + +#### Defined in + +[src/types/generatedGraphQLTypes.ts:584](https://github.com/adi790uu/talawa-api/blob/5146430/src/types/generatedGraphQLTypes.ts#L584) + +___ + +### isBaseRecurringEvent + +• `Optional` **isBaseRecurringEvent**: `boolean` + +#### Defined in + +[src/helpers/event/recurringEventHelpers/generateRecurringEventInstances.ts:35](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/recurringEventHelpers/generateRecurringEventInstances.ts#L35) + +___ + +### isPublic + +• **isPublic**: `boolean` + +#### Inherited from + +EventInput.isPublic + +#### Defined in + +[src/types/generatedGraphQLTypes.ts:585](https://github.com/adi790uu/talawa-api/blob/5146430/src/types/generatedGraphQLTypes.ts#L585) + +___ + +### isRegisterable + +• **isRegisterable**: `boolean` + +#### Inherited from + +EventInput.isRegisterable + +#### Defined in + +[src/types/generatedGraphQLTypes.ts:586](https://github.com/adi790uu/talawa-api/blob/5146430/src/types/generatedGraphQLTypes.ts#L586) + +___ + +### latitude + +• `Optional` **latitude**: `any` + +#### Inherited from + +EventInput.latitude + +#### Defined in + +[src/types/generatedGraphQLTypes.ts:587](https://github.com/adi790uu/talawa-api/blob/5146430/src/types/generatedGraphQLTypes.ts#L587) + +___ + +### location + +• `Optional` **location**: [`InputMaybe`](../modules/types_generatedGraphQLTypes.md#inputmaybe)\<`string`\> + +#### Inherited from + +EventInput.location + +#### Defined in + +[src/types/generatedGraphQLTypes.ts:588](https://github.com/adi790uu/talawa-api/blob/5146430/src/types/generatedGraphQLTypes.ts#L588) + +___ + +### longitude + +• `Optional` **longitude**: `any` + +#### Inherited from + +EventInput.longitude + +#### Defined in + +[src/types/generatedGraphQLTypes.ts:589](https://github.com/adi790uu/talawa-api/blob/5146430/src/types/generatedGraphQLTypes.ts#L589) + +___ + +### organization + +• `Optional` **organization**: `string` + +#### Defined in + +[src/helpers/event/recurringEventHelpers/generateRecurringEventInstances.ts:40](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/recurringEventHelpers/generateRecurringEventInstances.ts#L40) + +___ + +### organizationId + +• **organizationId**: `string` + +#### Inherited from + +EventInput.organizationId + +#### Defined in + +[src/types/generatedGraphQLTypes.ts:590](https://github.com/adi790uu/talawa-api/blob/5146430/src/types/generatedGraphQLTypes.ts#L590) + +___ + +### recurrance + +• `Optional` **recurrance**: [`InputMaybe`](../modules/types_generatedGraphQLTypes.md#inputmaybe)\<[`Recurrance`](../modules/types_generatedGraphQLTypes.md#recurrance)\> + +#### Inherited from + +EventInput.recurrance + +#### Defined in + +[src/types/generatedGraphQLTypes.ts:591](https://github.com/adi790uu/talawa-api/blob/5146430/src/types/generatedGraphQLTypes.ts#L591) + +___ + +### recurrenceRuleId + +• `Optional` **recurrenceRuleId**: `string` + +#### Defined in + +[src/helpers/event/recurringEventHelpers/generateRecurringEventInstances.ts:36](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/recurringEventHelpers/generateRecurringEventInstances.ts#L36) + +___ + +### recurring + +• **recurring**: `boolean` + +#### Inherited from + +EventInput.recurring + +#### Defined in + +[src/types/generatedGraphQLTypes.ts:592](https://github.com/adi790uu/talawa-api/blob/5146430/src/types/generatedGraphQLTypes.ts#L592) + +___ + +### startDate + +• **startDate**: `any` + +#### Inherited from + +EventInput.startDate + +#### Defined in + +[src/types/generatedGraphQLTypes.ts:593](https://github.com/adi790uu/talawa-api/blob/5146430/src/types/generatedGraphQLTypes.ts#L593) + +___ + +### startTime + +• `Optional` **startTime**: `any` + +#### Inherited from + +EventInput.startTime + +#### Defined in + +[src/types/generatedGraphQLTypes.ts:594](https://github.com/adi790uu/talawa-api/blob/5146430/src/types/generatedGraphQLTypes.ts#L594) + +___ + +### status + +• `Optional` **status**: `string` + +#### Defined in + +[src/helpers/event/recurringEventHelpers/generateRecurringEventInstances.ts:41](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/recurringEventHelpers/generateRecurringEventInstances.ts#L41) + +___ + +### title + +• **title**: `string` + +#### Inherited from + +EventInput.title + +#### Defined in + +[src/types/generatedGraphQLTypes.ts:595](https://github.com/adi790uu/talawa-api/blob/5146430/src/types/generatedGraphQLTypes.ts#L595) diff --git a/docs/talawa-api-docs/interfaces/libraries_errors_applicationError.Interface_Error.md b/docs/talawa-api-docs/interfaces/libraries_errors_applicationError.Interface_Error.md deleted file mode 100644 index ebc00d08f0e..00000000000 --- a/docs/talawa-api-docs/interfaces/libraries_errors_applicationError.Interface_Error.md +++ /dev/null @@ -1,54 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [libraries/errors/applicationError](../modules/libraries_errors_applicationError.md) / Interface\_Error - -# Interface: Interface\_Error - -[libraries/errors/applicationError](../modules/libraries_errors_applicationError.md).Interface_Error - -## Table of contents - -### Properties - -- [code](libraries_errors_applicationError.Interface_Error.md#code) -- [message](libraries_errors_applicationError.Interface_Error.md#message) -- [metadata](libraries_errors_applicationError.Interface_Error.md#metadata) -- [param](libraries_errors_applicationError.Interface_Error.md#param) - -## Properties - -### code - -• **code**: ``null`` \| `string` - -#### Defined in - -src/libraries/errors/applicationError.ts:3 - -___ - -### message - -• **message**: `string` - -#### Defined in - -src/libraries/errors/applicationError.ts:2 - -___ - -### metadata - -• `Optional` **metadata**: `Record`\<`any`, `any`\> - -#### Defined in - -src/libraries/errors/applicationError.ts:5 - -___ - -### param - -• **param**: ``null`` \| `string` - -#### Defined in - -src/libraries/errors/applicationError.ts:4 diff --git a/docs/talawa-api-docs/interfaces/middleware_isAuth.Interface_AuthData.md b/docs/talawa-api-docs/interfaces/middleware_isAuth.Interface_AuthData.md deleted file mode 100644 index 43cff38934e..00000000000 --- a/docs/talawa-api-docs/interfaces/middleware_isAuth.Interface_AuthData.md +++ /dev/null @@ -1,43 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [middleware/isAuth](../modules/middleware_isAuth.md) / Interface\_AuthData - -# Interface: Interface\_AuthData - -[middleware/isAuth](../modules/middleware_isAuth.md).Interface_AuthData - -## Table of contents - -### Properties - -- [expired](middleware_isAuth.Interface_AuthData.md#expired) -- [isAuth](middleware_isAuth.Interface_AuthData.md#isauth) -- [userId](middleware_isAuth.Interface_AuthData.md#userid) - -## Properties - -### expired - -• **expired**: `undefined` \| `boolean` - -#### Defined in - -src/middleware/isAuth.ts:9 - -___ - -### isAuth - -• **isAuth**: `boolean` - -#### Defined in - -src/middleware/isAuth.ts:8 - -___ - -### userId - -• **userId**: `undefined` \| `string` - -#### Defined in - -src/middleware/isAuth.ts:10 diff --git a/docs/talawa-api-docs/interfaces/models_AgendaCategory.InterfaceAgendaCategory.md b/docs/talawa-api-docs/interfaces/models_AgendaCategory.InterfaceAgendaCategory.md index 44dde073f66..a23422a8560 100644 --- a/docs/talawa-api-docs/interfaces/models_AgendaCategory.InterfaceAgendaCategory.md +++ b/docs/talawa-api-docs/interfaces/models_AgendaCategory.InterfaceAgendaCategory.md @@ -25,7 +25,7 @@ This is an interface representing a document for an agenda category in the datab #### Defined in -[src/models/AgendaCategory.ts:9](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/AgendaCategory.ts#L9) +[src/models/AgendaCategory.ts:9](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/AgendaCategory.ts#L9) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[src/models/AgendaCategory.ts:13](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/AgendaCategory.ts#L13) +[src/models/AgendaCategory.ts:13](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/AgendaCategory.ts#L13) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[src/models/AgendaCategory.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/AgendaCategory.ts#L11) +[src/models/AgendaCategory.ts:11](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/AgendaCategory.ts#L11) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[src/models/AgendaCategory.ts:10](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/AgendaCategory.ts#L10) +[src/models/AgendaCategory.ts:10](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/AgendaCategory.ts#L10) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[src/models/AgendaCategory.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/AgendaCategory.ts#L12) +[src/models/AgendaCategory.ts:12](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/AgendaCategory.ts#L12) ___ @@ -75,4 +75,4 @@ ___ #### Defined in -[src/models/AgendaCategory.ts:14](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/AgendaCategory.ts#L14) +[src/models/AgendaCategory.ts:14](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/AgendaCategory.ts#L14) diff --git a/docs/talawa-api-docs/interfaces/models_Comment.Interface_Comment.md b/docs/talawa-api-docs/interfaces/models_Comment.Interface_Comment.md deleted file mode 100644 index 5fad8b92e28..00000000000 --- a/docs/talawa-api-docs/interfaces/models_Comment.Interface_Comment.md +++ /dev/null @@ -1,100 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/Comment](../modules/models_Comment.md) / Interface\_Comment - -# Interface: Interface\_Comment - -[models/Comment](../modules/models_Comment.md).Interface_Comment - -This is an interface representing a document for a comment in the database(MongoDB). - -## Table of contents - -### Properties - -- [\_id](models_Comment.Interface_Comment.md#_id) -- [createdAt](models_Comment.Interface_Comment.md#createdat) -- [creator](models_Comment.Interface_Comment.md#creator) -- [likeCount](models_Comment.Interface_Comment.md#likecount) -- [likedBy](models_Comment.Interface_Comment.md#likedby) -- [post](models_Comment.Interface_Comment.md#post) -- [status](models_Comment.Interface_Comment.md#status) -- [text](models_Comment.Interface_Comment.md#text) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/Comment.ts:8 - -___ - -### createdAt - -• **createdAt**: `Date` - -#### Defined in - -src/models/Comment.ts:10 - -___ - -### creator - -• **creator**: `any` - -#### Defined in - -src/models/Comment.ts:11 - -___ - -### likeCount - -• **likeCount**: `number` - -#### Defined in - -src/models/Comment.ts:14 - -___ - -### likedBy - -• **likedBy**: `any`[] - -#### Defined in - -src/models/Comment.ts:13 - -___ - -### post - -• **post**: `any` - -#### Defined in - -src/models/Comment.ts:12 - -___ - -### status - -• **status**: `string` - -#### Defined in - -src/models/Comment.ts:15 - -___ - -### text - -• **text**: `string` - -#### Defined in - -src/models/Comment.ts:9 diff --git a/docs/talawa-api-docs/interfaces/models_DirectChat.Interface_DirectChat.md b/docs/talawa-api-docs/interfaces/models_DirectChat.Interface_DirectChat.md deleted file mode 100644 index 5a8906f1f0d..00000000000 --- a/docs/talawa-api-docs/interfaces/models_DirectChat.Interface_DirectChat.md +++ /dev/null @@ -1,78 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/DirectChat](../modules/models_DirectChat.md) / Interface\_DirectChat - -# Interface: Interface\_DirectChat - -[models/DirectChat](../modules/models_DirectChat.md).Interface_DirectChat - -This is an interface representing a document for direct chat in the database(MongoDB). - -## Table of contents - -### Properties - -- [\_id](models_DirectChat.Interface_DirectChat.md#_id) -- [creator](models_DirectChat.Interface_DirectChat.md#creator) -- [messages](models_DirectChat.Interface_DirectChat.md#messages) -- [organization](models_DirectChat.Interface_DirectChat.md#organization) -- [status](models_DirectChat.Interface_DirectChat.md#status) -- [users](models_DirectChat.Interface_DirectChat.md#users) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/DirectChat.ts:9 - -___ - -### creator - -• **creator**: `any` - -#### Defined in - -src/models/DirectChat.ts:12 - -___ - -### messages - -• **messages**: `any`[] - -#### Defined in - -src/models/DirectChat.ts:11 - -___ - -### organization - -• **organization**: `any` - -#### Defined in - -src/models/DirectChat.ts:13 - -___ - -### status - -• **status**: `string` - -#### Defined in - -src/models/DirectChat.ts:14 - -___ - -### users - -• **users**: `any`[] - -#### Defined in - -src/models/DirectChat.ts:10 diff --git a/docs/talawa-api-docs/interfaces/models_DirectChatMessage.Interface_DirectChatMessage.md b/docs/talawa-api-docs/interfaces/models_DirectChatMessage.Interface_DirectChatMessage.md deleted file mode 100644 index c2061eed597..00000000000 --- a/docs/talawa-api-docs/interfaces/models_DirectChatMessage.Interface_DirectChatMessage.md +++ /dev/null @@ -1,89 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/DirectChatMessage](../modules/models_DirectChatMessage.md) / Interface\_DirectChatMessage - -# Interface: Interface\_DirectChatMessage - -[models/DirectChatMessage](../modules/models_DirectChatMessage.md).Interface_DirectChatMessage - -This is an interface representing a document for a direct chat message in the database(MongoDB). - -## Table of contents - -### Properties - -- [\_id](models_DirectChatMessage.Interface_DirectChatMessage.md#_id) -- [createdAt](models_DirectChatMessage.Interface_DirectChatMessage.md#createdat) -- [directChatMessageBelongsTo](models_DirectChatMessage.Interface_DirectChatMessage.md#directchatmessagebelongsto) -- [messageContent](models_DirectChatMessage.Interface_DirectChatMessage.md#messagecontent) -- [receiver](models_DirectChatMessage.Interface_DirectChatMessage.md#receiver) -- [sender](models_DirectChatMessage.Interface_DirectChatMessage.md#sender) -- [status](models_DirectChatMessage.Interface_DirectChatMessage.md#status) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/DirectChatMessage.ts:8 - -___ - -### createdAt - -• **createdAt**: `Date` - -#### Defined in - -src/models/DirectChatMessage.ts:12 - -___ - -### directChatMessageBelongsTo - -• **directChatMessageBelongsTo**: `any` - -#### Defined in - -src/models/DirectChatMessage.ts:9 - -___ - -### messageContent - -• **messageContent**: `string` - -#### Defined in - -src/models/DirectChatMessage.ts:13 - -___ - -### receiver - -• **receiver**: `any` - -#### Defined in - -src/models/DirectChatMessage.ts:11 - -___ - -### sender - -• **sender**: `any` - -#### Defined in - -src/models/DirectChatMessage.ts:10 - -___ - -### status - -• **status**: `string` - -#### Defined in - -src/models/DirectChatMessage.ts:14 diff --git a/docs/talawa-api-docs/interfaces/models_Donation.Interface_Donation.md b/docs/talawa-api-docs/interfaces/models_Donation.Interface_Donation.md deleted file mode 100644 index dceaa23d503..00000000000 --- a/docs/talawa-api-docs/interfaces/models_Donation.Interface_Donation.md +++ /dev/null @@ -1,78 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/Donation](../modules/models_Donation.md) / Interface\_Donation - -# Interface: Interface\_Donation - -[models/Donation](../modules/models_Donation.md).Interface_Donation - -This is an interface representing a document for a donation in the database(MongoDB). - -## Table of contents - -### Properties - -- [amount](models_Donation.Interface_Donation.md#amount) -- [nameOfOrg](models_Donation.Interface_Donation.md#nameoforg) -- [nameOfUser](models_Donation.Interface_Donation.md#nameofuser) -- [orgId](models_Donation.Interface_Donation.md#orgid) -- [payPalId](models_Donation.Interface_Donation.md#paypalid) -- [userId](models_Donation.Interface_Donation.md#userid) - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -src/models/Donation.ts:11 - -___ - -### nameOfOrg - -• **nameOfOrg**: `string` - -#### Defined in - -src/models/Donation.ts:8 - -___ - -### nameOfUser - -• **nameOfUser**: `string` - -#### Defined in - -src/models/Donation.ts:10 - -___ - -### orgId - -• **orgId**: `string` \| `ObjectId` - -#### Defined in - -src/models/Donation.ts:7 - -___ - -### payPalId - -• **payPalId**: `string` - -#### Defined in - -src/models/Donation.ts:9 - -___ - -### userId - -• **userId**: `string` \| `ObjectId` - -#### Defined in - -src/models/Donation.ts:6 diff --git a/docs/talawa-api-docs/interfaces/models_EncodedImage.Interface_EncodedImage.md b/docs/talawa-api-docs/interfaces/models_EncodedImage.Interface_EncodedImage.md deleted file mode 100644 index 83509676f03..00000000000 --- a/docs/talawa-api-docs/interfaces/models_EncodedImage.Interface_EncodedImage.md +++ /dev/null @@ -1,56 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/EncodedImage](../modules/models_EncodedImage.md) / Interface\_EncodedImage - -# Interface: Interface\_EncodedImage - -[models/EncodedImage](../modules/models_EncodedImage.md).Interface_EncodedImage - -This is an interface that represents a database(MongoDB) document for Encoded Image. - -## Table of contents - -### Properties - -- [\_id](models_EncodedImage.Interface_EncodedImage.md#_id) -- [content](models_EncodedImage.Interface_EncodedImage.md#content) -- [fileName](models_EncodedImage.Interface_EncodedImage.md#filename) -- [numberOfUses](models_EncodedImage.Interface_EncodedImage.md#numberofuses) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/EncodedImage.ts:6 - -___ - -### content - -• **content**: `string` - -#### Defined in - -src/models/EncodedImage.ts:8 - -___ - -### fileName - -• **fileName**: `string` - -#### Defined in - -src/models/EncodedImage.ts:7 - -___ - -### numberOfUses - -• **numberOfUses**: `number` - -#### Defined in - -src/models/EncodedImage.ts:9 diff --git a/docs/talawa-api-docs/interfaces/models_Event.Interface_Event.md b/docs/talawa-api-docs/interfaces/models_Event.Interface_Event.md deleted file mode 100644 index e9d054e73c7..00000000000 --- a/docs/talawa-api-docs/interfaces/models_Event.Interface_Event.md +++ /dev/null @@ -1,254 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/Event](../modules/models_Event.md) / Interface\_Event - -# Interface: Interface\_Event - -[models/Event](../modules/models_Event.md).Interface_Event - -This is an interface representing a document for an event in the database(MongoDB). - -## Table of contents - -### Properties - -- [\_id](models_Event.Interface_Event.md#_id) -- [admins](models_Event.Interface_Event.md#admins) -- [allDay](models_Event.Interface_Event.md#allday) -- [attendees](models_Event.Interface_Event.md#attendees) -- [creator](models_Event.Interface_Event.md#creator) -- [description](models_Event.Interface_Event.md#description) -- [endDate](models_Event.Interface_Event.md#enddate) -- [endTime](models_Event.Interface_Event.md#endtime) -- [isPublic](models_Event.Interface_Event.md#ispublic) -- [isRegisterable](models_Event.Interface_Event.md#isregisterable) -- [latitude](models_Event.Interface_Event.md#latitude) -- [location](models_Event.Interface_Event.md#location) -- [longitude](models_Event.Interface_Event.md#longitude) -- [organization](models_Event.Interface_Event.md#organization) -- [recurrance](models_Event.Interface_Event.md#recurrance) -- [recurring](models_Event.Interface_Event.md#recurring) -- [registrants](models_Event.Interface_Event.md#registrants) -- [startDate](models_Event.Interface_Event.md#startdate) -- [startTime](models_Event.Interface_Event.md#starttime) -- [status](models_Event.Interface_Event.md#status) -- [tasks](models_Event.Interface_Event.md#tasks) -- [title](models_Event.Interface_Event.md#title) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/Event.ts:46 - -___ - -### admins - -• **admins**: `any`[] - -#### Defined in - -src/models/Event.ts:64 - -___ - -### allDay - -• **allDay**: `boolean` - -#### Defined in - -src/models/Event.ts:54 - -___ - -### attendees - -• **attendees**: `undefined` \| `string` - -#### Defined in - -src/models/Event.ts:49 - -___ - -### creator - -• **creator**: `any` - -#### Defined in - -src/models/Event.ts:62 - -___ - -### description - -• **description**: `string` - -#### Defined in - -src/models/Event.ts:48 - -___ - -### endDate - -• **endDate**: `undefined` \| `string` - -#### Defined in - -src/models/Event.ts:56 - -___ - -### endTime - -• **endTime**: `undefined` \| `string` - -#### Defined in - -src/models/Event.ts:58 - -___ - -### isPublic - -• **isPublic**: `boolean` - -#### Defined in - -src/models/Event.ts:60 - -___ - -### isRegisterable - -• **isRegisterable**: `boolean` - -#### Defined in - -src/models/Event.ts:61 - -___ - -### latitude - -• **latitude**: `undefined` \| `number` - -#### Defined in - -src/models/Event.ts:51 - -___ - -### location - -• **location**: `undefined` \| `string` - -#### Defined in - -src/models/Event.ts:50 - -___ - -### longitude - -• **longitude**: `number` - -#### Defined in - -src/models/Event.ts:52 - -___ - -### organization - -• **organization**: `any` - -#### Defined in - -src/models/Event.ts:65 - -___ - -### recurrance - -• **recurrance**: `string` - -#### Defined in - -src/models/Event.ts:59 - -___ - -### recurring - -• **recurring**: `boolean` - -#### Defined in - -src/models/Event.ts:53 - -___ - -### registrants - -• **registrants**: `any`[] - -#### Defined in - -src/models/Event.ts:63 - -___ - -### startDate - -• **startDate**: `string` - -#### Defined in - -src/models/Event.ts:55 - -___ - -### startTime - -• **startTime**: `undefined` \| `string` - -#### Defined in - -src/models/Event.ts:57 - -___ - -### status - -• **status**: `string` - -#### Defined in - -src/models/Event.ts:67 - -___ - -### tasks - -• **tasks**: `any`[] - -#### Defined in - -src/models/Event.ts:66 - -___ - -### title - -• **title**: `string` - -#### Defined in - -src/models/Event.ts:47 diff --git a/docs/talawa-api-docs/interfaces/models_Event.Interface_UserAttende.md b/docs/talawa-api-docs/interfaces/models_Event.Interface_UserAttende.md deleted file mode 100644 index a4d6affa369..00000000000 --- a/docs/talawa-api-docs/interfaces/models_Event.Interface_UserAttende.md +++ /dev/null @@ -1,56 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/Event](../modules/models_Event.md) / Interface\_UserAttende - -# Interface: Interface\_UserAttende - -[models/Event](../modules/models_Event.md).Interface_UserAttende - -This is an interface representing a document for a user attendee in the database(MongoDB). - -## Table of contents - -### Properties - -- [createdAt](models_Event.Interface_UserAttende.md#createdat) -- [status](models_Event.Interface_UserAttende.md#status) -- [user](models_Event.Interface_UserAttende.md#user) -- [userId](models_Event.Interface_UserAttende.md#userid) - -## Properties - -### createdAt - -• **createdAt**: `Date` - -#### Defined in - -src/models/Event.ts:12 - -___ - -### status - -• **status**: `string` - -#### Defined in - -src/models/Event.ts:11 - -___ - -### user - -• **user**: `any` - -#### Defined in - -src/models/Event.ts:10 - -___ - -### userId - -• **userId**: `string` - -#### Defined in - -src/models/Event.ts:9 diff --git a/docs/talawa-api-docs/interfaces/models_EventProject.Interface_EventProject.md b/docs/talawa-api-docs/interfaces/models_EventProject.Interface_EventProject.md deleted file mode 100644 index a2a55d2dba7..00000000000 --- a/docs/talawa-api-docs/interfaces/models_EventProject.Interface_EventProject.md +++ /dev/null @@ -1,100 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/EventProject](../modules/models_EventProject.md) / Interface\_EventProject - -# Interface: Interface\_EventProject - -[models/EventProject](../modules/models_EventProject.md).Interface_EventProject - -This is an interface representing a document for an event project in the database(MongoDB). - -## Table of contents - -### Properties - -- [\_id](models_EventProject.Interface_EventProject.md#_id) -- [createdAt](models_EventProject.Interface_EventProject.md#createdat) -- [creator](models_EventProject.Interface_EventProject.md#creator) -- [description](models_EventProject.Interface_EventProject.md#description) -- [event](models_EventProject.Interface_EventProject.md#event) -- [status](models_EventProject.Interface_EventProject.md#status) -- [tasks](models_EventProject.Interface_EventProject.md#tasks) -- [title](models_EventProject.Interface_EventProject.md#title) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/EventProject.ts:9 - -___ - -### createdAt - -• **createdAt**: `Date` - -#### Defined in - -src/models/EventProject.ts:12 - -___ - -### creator - -• **creator**: `any` - -#### Defined in - -src/models/EventProject.ts:14 - -___ - -### description - -• **description**: `string` - -#### Defined in - -src/models/EventProject.ts:11 - -___ - -### event - -• **event**: `any` - -#### Defined in - -src/models/EventProject.ts:13 - -___ - -### status - -• **status**: `string` - -#### Defined in - -src/models/EventProject.ts:16 - -___ - -### tasks - -• **tasks**: `any`[] - -#### Defined in - -src/models/EventProject.ts:15 - -___ - -### title - -• **title**: `string` - -#### Defined in - -src/models/EventProject.ts:10 diff --git a/docs/talawa-api-docs/interfaces/models_EventVolunteer.InterfaceEventVolunteer.md b/docs/talawa-api-docs/interfaces/models_EventVolunteer.InterfaceEventVolunteer.md index e25a5aebce2..9821269eda9 100644 --- a/docs/talawa-api-docs/interfaces/models_EventVolunteer.InterfaceEventVolunteer.md +++ b/docs/talawa-api-docs/interfaces/models_EventVolunteer.InterfaceEventVolunteer.md @@ -26,7 +26,7 @@ #### Defined in -[src/models/EventVolunteer.ts:8](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/EventVolunteer.ts#L8) +[src/models/EventVolunteer.ts:8](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/EventVolunteer.ts#L8) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -[src/models/EventVolunteer.ts:9](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/EventVolunteer.ts#L9) +[src/models/EventVolunteer.ts:9](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/EventVolunteer.ts#L9) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[src/models/EventVolunteer.ts:10](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/EventVolunteer.ts#L10) +[src/models/EventVolunteer.ts:10](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/EventVolunteer.ts#L10) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[src/models/EventVolunteer.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/EventVolunteer.ts#L11) +[src/models/EventVolunteer.ts:11](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/EventVolunteer.ts#L11) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[src/models/EventVolunteer.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/EventVolunteer.ts#L12) +[src/models/EventVolunteer.ts:12](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/EventVolunteer.ts#L12) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[src/models/EventVolunteer.ts:13](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/EventVolunteer.ts#L13) +[src/models/EventVolunteer.ts:13](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/EventVolunteer.ts#L13) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[src/models/EventVolunteer.ts:14](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/EventVolunteer.ts#L14) +[src/models/EventVolunteer.ts:14](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/EventVolunteer.ts#L14) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[src/models/EventVolunteer.ts:15](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/EventVolunteer.ts#L15) +[src/models/EventVolunteer.ts:15](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/EventVolunteer.ts#L15) ___ @@ -106,4 +106,4 @@ ___ #### Defined in -[src/models/EventVolunteer.ts:16](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/EventVolunteer.ts#L16) +[src/models/EventVolunteer.ts:16](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/EventVolunteer.ts#L16) diff --git a/docs/talawa-api-docs/interfaces/models_File.Interface_File.md b/docs/talawa-api-docs/interfaces/models_File.Interface_File.md deleted file mode 100644 index ac7fda8a0ba..00000000000 --- a/docs/talawa-api-docs/interfaces/models_File.Interface_File.md +++ /dev/null @@ -1,100 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/File](../modules/models_File.md) / Interface\_File - -# Interface: Interface\_File - -[models/File](../modules/models_File.md).Interface_File - -This is an interface representing a document for a file in the database(MongoDB). - -## Table of contents - -### Properties - -- [\_id](models_File.Interface_File.md#_id) -- [contentType](models_File.Interface_File.md#contenttype) -- [createdAt](models_File.Interface_File.md#createdat) -- [name](models_File.Interface_File.md#name) -- [secret](models_File.Interface_File.md#secret) -- [size](models_File.Interface_File.md#size) -- [status](models_File.Interface_File.md#status) -- [url](models_File.Interface_File.md#url) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/File.ts:7 - -___ - -### contentType - -• **contentType**: `undefined` \| `string` - -#### Defined in - -src/models/File.ts:13 - -___ - -### createdAt - -• **createdAt**: `Date` - -#### Defined in - -src/models/File.ts:12 - -___ - -### name - -• **name**: `string` - -#### Defined in - -src/models/File.ts:8 - -___ - -### secret - -• **secret**: `string` - -#### Defined in - -src/models/File.ts:11 - -___ - -### size - -• **size**: `undefined` \| `number` - -#### Defined in - -src/models/File.ts:10 - -___ - -### status - -• **status**: `string` - -#### Defined in - -src/models/File.ts:14 - -___ - -### url - -• **url**: `undefined` \| `string` - -#### Defined in - -src/models/File.ts:9 diff --git a/docs/talawa-api-docs/interfaces/models_Fund.InterfaceFund.md b/docs/talawa-api-docs/interfaces/models_Fund.InterfaceFund.md new file mode 100644 index 00000000000..ca8b632b98e --- /dev/null +++ b/docs/talawa-api-docs/interfaces/models_Fund.InterfaceFund.md @@ -0,0 +1,122 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / [models/Fund](../modules/models_Fund.md) / InterfaceFund + +# Interface: InterfaceFund + +[models/Fund](../modules/models_Fund.md).InterfaceFund + +This is an interface representing a document for fund in the database(MongoDB). + +## Table of contents + +### Properties + +- [\_id](models_Fund.InterfaceFund.md#_id) +- [campaigns](models_Fund.InterfaceFund.md#campaigns) +- [createdAt](models_Fund.InterfaceFund.md#createdat) +- [isArchived](models_Fund.InterfaceFund.md#isarchived) +- [isDefault](models_Fund.InterfaceFund.md#isdefault) +- [name](models_Fund.InterfaceFund.md#name) +- [organizationId](models_Fund.InterfaceFund.md#organizationid) +- [refrenceNumber](models_Fund.InterfaceFund.md#refrencenumber) +- [taxDeductible](models_Fund.InterfaceFund.md#taxdeductible) +- [updatedAt](models_Fund.InterfaceFund.md#updatedat) + +## Properties + +### \_id + +• **\_id**: `ObjectId` + +#### Defined in + +[src/models/Fund.ts:9](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/Fund.ts#L9) + +___ + +### campaigns + +• **campaigns**: `PopulatedDoc`\<[`InterfaceFundraisingCampaign`](models_FundraisingCampaign.InterfaceFundraisingCampaign.md) & `Document`\>[] + +#### Defined in + +[src/models/Fund.ts:16](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/Fund.ts#L16) + +___ + +### createdAt + +• **createdAt**: `Date` + +#### Defined in + +[src/models/Fund.ts:17](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/Fund.ts#L17) + +___ + +### isArchived + +• **isArchived**: `boolean` + +#### Defined in + +[src/models/Fund.ts:15](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/Fund.ts#L15) + +___ + +### isDefault + +• **isDefault**: `boolean` + +#### Defined in + +[src/models/Fund.ts:14](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/Fund.ts#L14) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[src/models/Fund.ts:11](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/Fund.ts#L11) + +___ + +### organizationId + +• **organizationId**: `ObjectId` + +#### Defined in + +[src/models/Fund.ts:10](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/Fund.ts#L10) + +___ + +### refrenceNumber + +• **refrenceNumber**: `string` + +#### Defined in + +[src/models/Fund.ts:12](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/Fund.ts#L12) + +___ + +### taxDeductible + +• **taxDeductible**: `boolean` + +#### Defined in + +[src/models/Fund.ts:13](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/Fund.ts#L13) + +___ + +### updatedAt + +• **updatedAt**: `Date` + +#### Defined in + +[src/models/Fund.ts:18](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/Fund.ts#L18) diff --git a/docs/talawa-api-docs/interfaces/models_FundraisingCampaign.InterfaceFundraisingCampaign.md b/docs/talawa-api-docs/interfaces/models_FundraisingCampaign.InterfaceFundraisingCampaign.md new file mode 100644 index 00000000000..fbec84f2dfe --- /dev/null +++ b/docs/talawa-api-docs/interfaces/models_FundraisingCampaign.InterfaceFundraisingCampaign.md @@ -0,0 +1,154 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / [models/FundraisingCampaign](../modules/models_FundraisingCampaign.md) / InterfaceFundraisingCampaign + +# Interface: InterfaceFundraisingCampaign + +[models/FundraisingCampaign](../modules/models_FundraisingCampaign.md).InterfaceFundraisingCampaign + +This is the structure of a file + +**`Param`** + +parent fund to which campaign belongs + +**`Param`** + +Name of the campaign + +**`Param`** + +Start date of the campaign + +**`Param`** + +End date of the campaign + +**`Param`** + +Goal of the campaign + +**`Param`** + +Currency of the campaign + +**`Param`** + +Timestamp of creation + +**`Param`** + +Timestamp of updation + +## Table of contents + +### Properties + +- [\_id](models_FundraisingCampaign.InterfaceFundraisingCampaign.md#_id) +- [createdAt](models_FundraisingCampaign.InterfaceFundraisingCampaign.md#createdat) +- [currency](models_FundraisingCampaign.InterfaceFundraisingCampaign.md#currency) +- [endDate](models_FundraisingCampaign.InterfaceFundraisingCampaign.md#enddate) +- [fundId](models_FundraisingCampaign.InterfaceFundraisingCampaign.md#fundid) +- [fundingGoal](models_FundraisingCampaign.InterfaceFundraisingCampaign.md#fundinggoal) +- [name](models_FundraisingCampaign.InterfaceFundraisingCampaign.md#name) +- [pledges](models_FundraisingCampaign.InterfaceFundraisingCampaign.md#pledges) +- [startDate](models_FundraisingCampaign.InterfaceFundraisingCampaign.md#startdate) +- [updatedAt](models_FundraisingCampaign.InterfaceFundraisingCampaign.md#updatedat) + +## Properties + +### \_id + +• **\_id**: `ObjectId` + +#### Defined in + +[src/models/FundraisingCampaign.ts:185](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L185) + +___ + +### createdAt + +• **createdAt**: `Date` + +#### Defined in + +[src/models/FundraisingCampaign.ts:193](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L193) + +___ + +### currency + +• **currency**: [`CurrencyType`](../enums/models_FundraisingCampaign.CurrencyType.md) + +#### Defined in + +[src/models/FundraisingCampaign.ts:191](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L191) + +___ + +### endDate + +• **endDate**: `Date` + +#### Defined in + +[src/models/FundraisingCampaign.ts:189](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L189) + +___ + +### fundId + +• **fundId**: `PopulatedDoc`\<[`InterfaceFund`](models_Fund.InterfaceFund.md) & `Document`\> + +#### Defined in + +[src/models/FundraisingCampaign.ts:186](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L186) + +___ + +### fundingGoal + +• **fundingGoal**: `number` + +#### Defined in + +[src/models/FundraisingCampaign.ts:190](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L190) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[src/models/FundraisingCampaign.ts:187](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L187) + +___ + +### pledges + +• **pledges**: `PopulatedDoc`\<[`InterfaceFundraisingCampaignPledges`](models_FundraisingCampaignPledge.InterfaceFundraisingCampaignPledges.md) & `Document`\>[] + +#### Defined in + +[src/models/FundraisingCampaign.ts:192](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L192) + +___ + +### startDate + +• **startDate**: `Date` + +#### Defined in + +[src/models/FundraisingCampaign.ts:188](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L188) + +___ + +### updatedAt + +• **updatedAt**: `Date` + +#### Defined in + +[src/models/FundraisingCampaign.ts:194](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L194) diff --git a/docs/talawa-api-docs/interfaces/models_FundraisingCampaignPledge.InterfaceFundraisingCampaignPledges.md b/docs/talawa-api-docs/interfaces/models_FundraisingCampaignPledge.InterfaceFundraisingCampaignPledges.md new file mode 100644 index 00000000000..43806028aa4 --- /dev/null +++ b/docs/talawa-api-docs/interfaces/models_FundraisingCampaignPledge.InterfaceFundraisingCampaignPledges.md @@ -0,0 +1,109 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / [models/FundraisingCampaignPledge](../modules/models_FundraisingCampaignPledge.md) / InterfaceFundraisingCampaignPledges + +# Interface: InterfaceFundraisingCampaignPledges + +[models/FundraisingCampaignPledge](../modules/models_FundraisingCampaignPledge.md).InterfaceFundraisingCampaignPledges + +## Table of contents + +### Properties + +- [\_id](models_FundraisingCampaignPledge.InterfaceFundraisingCampaignPledges.md#_id) +- [amount](models_FundraisingCampaignPledge.InterfaceFundraisingCampaignPledges.md#amount) +- [campaigns](models_FundraisingCampaignPledge.InterfaceFundraisingCampaignPledges.md#campaigns) +- [createdAt](models_FundraisingCampaignPledge.InterfaceFundraisingCampaignPledges.md#createdat) +- [currency](models_FundraisingCampaignPledge.InterfaceFundraisingCampaignPledges.md#currency) +- [endDate](models_FundraisingCampaignPledge.InterfaceFundraisingCampaignPledges.md#enddate) +- [startDate](models_FundraisingCampaignPledge.InterfaceFundraisingCampaignPledges.md#startdate) +- [updatedAt](models_FundraisingCampaignPledge.InterfaceFundraisingCampaignPledges.md#updatedat) +- [users](models_FundraisingCampaignPledge.InterfaceFundraisingCampaignPledges.md#users) + +## Properties + +### \_id + +• **\_id**: `ObjectId` + +#### Defined in + +[src/models/FundraisingCampaignPledge.ts:10](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaignPledge.ts#L10) + +___ + +### amount + +• **amount**: `number` + +#### Defined in + +[src/models/FundraisingCampaignPledge.ts:15](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaignPledge.ts#L15) + +___ + +### campaigns + +• **campaigns**: `PopulatedDoc`\<[`InterfaceFundraisingCampaign`](models_FundraisingCampaign.InterfaceFundraisingCampaign.md) & `Document`\>[] + +#### Defined in + +[src/models/FundraisingCampaignPledge.ts:11](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaignPledge.ts#L11) + +___ + +### createdAt + +• **createdAt**: `Date` + +#### Defined in + +[src/models/FundraisingCampaignPledge.ts:17](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaignPledge.ts#L17) + +___ + +### currency + +• **currency**: [`CurrencyType`](../enums/models_FundraisingCampaign.CurrencyType.md) + +#### Defined in + +[src/models/FundraisingCampaignPledge.ts:16](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaignPledge.ts#L16) + +___ + +### endDate + +• **endDate**: `Date` + +#### Defined in + +[src/models/FundraisingCampaignPledge.ts:14](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaignPledge.ts#L14) + +___ + +### startDate + +• **startDate**: `Date` + +#### Defined in + +[src/models/FundraisingCampaignPledge.ts:13](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaignPledge.ts#L13) + +___ + +### updatedAt + +• **updatedAt**: `Date` + +#### Defined in + +[src/models/FundraisingCampaignPledge.ts:18](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaignPledge.ts#L18) + +___ + +### users + +• **users**: `PopulatedDoc`\<[`InterfaceUser`](models_User.InterfaceUser.md) & `Document`\>[] + +#### Defined in + +[src/models/FundraisingCampaignPledge.ts:12](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaignPledge.ts#L12) diff --git a/docs/talawa-api-docs/interfaces/models_Group.Interface_Group.md b/docs/talawa-api-docs/interfaces/models_Group.Interface_Group.md deleted file mode 100644 index 072a5ac853d..00000000000 --- a/docs/talawa-api-docs/interfaces/models_Group.Interface_Group.md +++ /dev/null @@ -1,89 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/Group](../modules/models_Group.md) / Interface\_Group - -# Interface: Interface\_Group - -[models/Group](../modules/models_Group.md).Interface_Group - -This is an interface representing a document for a group in the database(MongoDB). - -## Table of contents - -### Properties - -- [\_id](models_Group.Interface_Group.md#_id) -- [admins](models_Group.Interface_Group.md#admins) -- [createdAt](models_Group.Interface_Group.md#createdat) -- [description](models_Group.Interface_Group.md#description) -- [organization](models_Group.Interface_Group.md#organization) -- [status](models_Group.Interface_Group.md#status) -- [title](models_Group.Interface_Group.md#title) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/Group.ts:8 - -___ - -### admins - -• **admins**: `any`[] - -#### Defined in - -src/models/Group.ts:14 - -___ - -### createdAt - -• **createdAt**: `Date` - -#### Defined in - -src/models/Group.ts:11 - -___ - -### description - -• **description**: `undefined` \| `string` - -#### Defined in - -src/models/Group.ts:10 - -___ - -### organization - -• **organization**: `any` - -#### Defined in - -src/models/Group.ts:12 - -___ - -### status - -• **status**: `string` - -#### Defined in - -src/models/Group.ts:13 - -___ - -### title - -• **title**: `string` - -#### Defined in - -src/models/Group.ts:9 diff --git a/docs/talawa-api-docs/interfaces/models_GroupChat.Interface_GroupChat.md b/docs/talawa-api-docs/interfaces/models_GroupChat.Interface_GroupChat.md deleted file mode 100644 index c28de1299c0..00000000000 --- a/docs/talawa-api-docs/interfaces/models_GroupChat.Interface_GroupChat.md +++ /dev/null @@ -1,89 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/GroupChat](../modules/models_GroupChat.md) / Interface\_GroupChat - -# Interface: Interface\_GroupChat - -[models/GroupChat](../modules/models_GroupChat.md).Interface_GroupChat - -This is an interface representing a document for a group chat in the database(MongoDB). - -## Table of contents - -### Properties - -- [\_id](models_GroupChat.Interface_GroupChat.md#_id) -- [creator](models_GroupChat.Interface_GroupChat.md#creator) -- [messages](models_GroupChat.Interface_GroupChat.md#messages) -- [organization](models_GroupChat.Interface_GroupChat.md#organization) -- [status](models_GroupChat.Interface_GroupChat.md#status) -- [title](models_GroupChat.Interface_GroupChat.md#title) -- [users](models_GroupChat.Interface_GroupChat.md#users) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/GroupChat.ts:9 - -___ - -### creator - -• **creator**: `any` - -#### Defined in - -src/models/GroupChat.ts:13 - -___ - -### messages - -• **messages**: `any`[] - -#### Defined in - -src/models/GroupChat.ts:12 - -___ - -### organization - -• **organization**: `any` - -#### Defined in - -src/models/GroupChat.ts:14 - -___ - -### status - -• **status**: `string` - -#### Defined in - -src/models/GroupChat.ts:15 - -___ - -### title - -• **title**: `string` - -#### Defined in - -src/models/GroupChat.ts:10 - -___ - -### users - -• **users**: `any`[] - -#### Defined in - -src/models/GroupChat.ts:11 diff --git a/docs/talawa-api-docs/interfaces/models_GroupChatMessage.Interface_GroupChatMessage.md b/docs/talawa-api-docs/interfaces/models_GroupChatMessage.Interface_GroupChatMessage.md deleted file mode 100644 index 6613b7cd50f..00000000000 --- a/docs/talawa-api-docs/interfaces/models_GroupChatMessage.Interface_GroupChatMessage.md +++ /dev/null @@ -1,78 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/GroupChatMessage](../modules/models_GroupChatMessage.md) / Interface\_GroupChatMessage - -# Interface: Interface\_GroupChatMessage - -[models/GroupChatMessage](../modules/models_GroupChatMessage.md).Interface_GroupChatMessage - -This is an interface that represents a database(MongoDB) document for Group Chat Message. - -## Table of contents - -### Properties - -- [\_id](models_GroupChatMessage.Interface_GroupChatMessage.md#_id) -- [createdAt](models_GroupChatMessage.Interface_GroupChatMessage.md#createdat) -- [groupChatMessageBelongsTo](models_GroupChatMessage.Interface_GroupChatMessage.md#groupchatmessagebelongsto) -- [messageContent](models_GroupChatMessage.Interface_GroupChatMessage.md#messagecontent) -- [sender](models_GroupChatMessage.Interface_GroupChatMessage.md#sender) -- [status](models_GroupChatMessage.Interface_GroupChatMessage.md#status) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/GroupChatMessage.ts:8 - -___ - -### createdAt - -• **createdAt**: `Date` - -#### Defined in - -src/models/GroupChatMessage.ts:11 - -___ - -### groupChatMessageBelongsTo - -• **groupChatMessageBelongsTo**: `any` - -#### Defined in - -src/models/GroupChatMessage.ts:9 - -___ - -### messageContent - -• **messageContent**: `string` - -#### Defined in - -src/models/GroupChatMessage.ts:12 - -___ - -### sender - -• **sender**: `any` - -#### Defined in - -src/models/GroupChatMessage.ts:10 - -___ - -### status - -• **status**: `string` - -#### Defined in - -src/models/GroupChatMessage.ts:13 diff --git a/docs/talawa-api-docs/interfaces/models_ImageHash.Interface_ImageHash.md b/docs/talawa-api-docs/interfaces/models_ImageHash.Interface_ImageHash.md deleted file mode 100644 index 01f866a3c34..00000000000 --- a/docs/talawa-api-docs/interfaces/models_ImageHash.Interface_ImageHash.md +++ /dev/null @@ -1,67 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/ImageHash](../modules/models_ImageHash.md) / Interface\_ImageHash - -# Interface: Interface\_ImageHash - -[models/ImageHash](../modules/models_ImageHash.md).Interface_ImageHash - -This is an interface that represents a database(MongoDB) document for Image Hash. - -## Table of contents - -### Properties - -- [\_id](models_ImageHash.Interface_ImageHash.md#_id) -- [fileName](models_ImageHash.Interface_ImageHash.md#filename) -- [hashValue](models_ImageHash.Interface_ImageHash.md#hashvalue) -- [numberOfUses](models_ImageHash.Interface_ImageHash.md#numberofuses) -- [status](models_ImageHash.Interface_ImageHash.md#status) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/ImageHash.ts:6 - -___ - -### fileName - -• **fileName**: `string` - -#### Defined in - -src/models/ImageHash.ts:8 - -___ - -### hashValue - -• **hashValue**: `string` - -#### Defined in - -src/models/ImageHash.ts:7 - -___ - -### numberOfUses - -• **numberOfUses**: `number` - -#### Defined in - -src/models/ImageHash.ts:9 - -___ - -### status - -• **status**: `string` - -#### Defined in - -src/models/ImageHash.ts:10 diff --git a/docs/talawa-api-docs/interfaces/models_Language.Interface_Language.md b/docs/talawa-api-docs/interfaces/models_Language.Interface_Language.md deleted file mode 100644 index 163553eb612..00000000000 --- a/docs/talawa-api-docs/interfaces/models_Language.Interface_Language.md +++ /dev/null @@ -1,56 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/Language](../modules/models_Language.md) / Interface\_Language - -# Interface: Interface\_Language - -[models/Language](../modules/models_Language.md).Interface_Language - -This is an interface that represents a database(MongoDB) document for Language. - -## Table of contents - -### Properties - -- [\_id](models_Language.Interface_Language.md#_id) -- [createdAt](models_Language.Interface_Language.md#createdat) -- [en](models_Language.Interface_Language.md#en) -- [translation](models_Language.Interface_Language.md#translation) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/Language.ts:46 - -___ - -### createdAt - -• **createdAt**: `Date` - -#### Defined in - -src/models/Language.ts:49 - -___ - -### en - -• **en**: `string` - -#### Defined in - -src/models/Language.ts:47 - -___ - -### translation - -• **translation**: `any`[] - -#### Defined in - -src/models/Language.ts:48 diff --git a/docs/talawa-api-docs/interfaces/models_Language.Interface_LanguageModel.md b/docs/talawa-api-docs/interfaces/models_Language.Interface_LanguageModel.md deleted file mode 100644 index 7ca08ab8a5d..00000000000 --- a/docs/talawa-api-docs/interfaces/models_Language.Interface_LanguageModel.md +++ /dev/null @@ -1,56 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/Language](../modules/models_Language.md) / Interface\_LanguageModel - -# Interface: Interface\_LanguageModel - -[models/Language](../modules/models_Language.md).Interface_LanguageModel - -This is an interface that represents a database document. - -## Table of contents - -### Properties - -- [createdAt](models_Language.Interface_LanguageModel.md#createdat) -- [lang\_code](models_Language.Interface_LanguageModel.md#lang_code) -- [value](models_Language.Interface_LanguageModel.md#value) -- [verified](models_Language.Interface_LanguageModel.md#verified) - -## Properties - -### createdAt - -• **createdAt**: `Date` - -#### Defined in - -src/models/Language.ts:9 - -___ - -### lang\_code - -• **lang\_code**: `string` - -#### Defined in - -src/models/Language.ts:6 - -___ - -### value - -• **value**: `string` - -#### Defined in - -src/models/Language.ts:7 - -___ - -### verified - -• **verified**: `boolean` - -#### Defined in - -src/models/Language.ts:8 diff --git a/docs/talawa-api-docs/interfaces/models_MembershipRequest.Interface_MembershipRequest.md b/docs/talawa-api-docs/interfaces/models_MembershipRequest.Interface_MembershipRequest.md deleted file mode 100644 index ce5aabd0b3e..00000000000 --- a/docs/talawa-api-docs/interfaces/models_MembershipRequest.Interface_MembershipRequest.md +++ /dev/null @@ -1,56 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/MembershipRequest](../modules/models_MembershipRequest.md) / Interface\_MembershipRequest - -# Interface: Interface\_MembershipRequest - -[models/MembershipRequest](../modules/models_MembershipRequest.md).Interface_MembershipRequest - -This is an interface that represents a database(MongoDB) document for Membership Request. - -## Table of contents - -### Properties - -- [\_id](models_MembershipRequest.Interface_MembershipRequest.md#_id) -- [organization](models_MembershipRequest.Interface_MembershipRequest.md#organization) -- [status](models_MembershipRequest.Interface_MembershipRequest.md#status) -- [user](models_MembershipRequest.Interface_MembershipRequest.md#user) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/MembershipRequest.ts:8 - -___ - -### organization - -• **organization**: `any` - -#### Defined in - -src/models/MembershipRequest.ts:9 - -___ - -### status - -• **status**: `string` - -#### Defined in - -src/models/MembershipRequest.ts:11 - -___ - -### user - -• **user**: `any` - -#### Defined in - -src/models/MembershipRequest.ts:10 diff --git a/docs/talawa-api-docs/interfaces/models_Message.Interface_Message.md b/docs/talawa-api-docs/interfaces/models_Message.Interface_Message.md deleted file mode 100644 index 481e0fe3784..00000000000 --- a/docs/talawa-api-docs/interfaces/models_Message.Interface_Message.md +++ /dev/null @@ -1,100 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/Message](../modules/models_Message.md) / Interface\_Message - -# Interface: Interface\_Message - -[models/Message](../modules/models_Message.md).Interface_Message - -This is an interface that represents a database(MongoDB) document for Message. - -## Table of contents - -### Properties - -- [\_id](models_Message.Interface_Message.md#_id) -- [createdAt](models_Message.Interface_Message.md#createdat) -- [creator](models_Message.Interface_Message.md#creator) -- [group](models_Message.Interface_Message.md#group) -- [imageUrl](models_Message.Interface_Message.md#imageurl) -- [status](models_Message.Interface_Message.md#status) -- [text](models_Message.Interface_Message.md#text) -- [videoUrl](models_Message.Interface_Message.md#videourl) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/Message.ts:8 - -___ - -### createdAt - -• **createdAt**: `Date` - -#### Defined in - -src/models/Message.ts:12 - -___ - -### creator - -• **creator**: `any` - -#### Defined in - -src/models/Message.ts:13 - -___ - -### group - -• **group**: `any` - -#### Defined in - -src/models/Message.ts:14 - -___ - -### imageUrl - -• **imageUrl**: `undefined` \| `string` - -#### Defined in - -src/models/Message.ts:10 - -___ - -### status - -• **status**: `string` - -#### Defined in - -src/models/Message.ts:15 - -___ - -### text - -• **text**: `string` - -#### Defined in - -src/models/Message.ts:9 - -___ - -### videoUrl - -• **videoUrl**: `undefined` \| `string` - -#### Defined in - -src/models/Message.ts:11 diff --git a/docs/talawa-api-docs/interfaces/models_MessageChat.Interface_MessageChat.md b/docs/talawa-api-docs/interfaces/models_MessageChat.Interface_MessageChat.md deleted file mode 100644 index 8cea4845bc7..00000000000 --- a/docs/talawa-api-docs/interfaces/models_MessageChat.Interface_MessageChat.md +++ /dev/null @@ -1,78 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/MessageChat](../modules/models_MessageChat.md) / Interface\_MessageChat - -# Interface: Interface\_MessageChat - -[models/MessageChat](../modules/models_MessageChat.md).Interface_MessageChat - -This is an interface representing a document for a chat in the database(MongoDB). - -## Table of contents - -### Properties - -- [\_id](models_MessageChat.Interface_MessageChat.md#_id) -- [createdAt](models_MessageChat.Interface_MessageChat.md#createdat) -- [languageBarrier](models_MessageChat.Interface_MessageChat.md#languagebarrier) -- [message](models_MessageChat.Interface_MessageChat.md#message) -- [receiver](models_MessageChat.Interface_MessageChat.md#receiver) -- [sender](models_MessageChat.Interface_MessageChat.md#sender) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/MessageChat.ts:7 - -___ - -### createdAt - -• **createdAt**: `Date` - -#### Defined in - -src/models/MessageChat.ts:12 - -___ - -### languageBarrier - -• **languageBarrier**: `boolean` - -#### Defined in - -src/models/MessageChat.ts:9 - -___ - -### message - -• **message**: `string` - -#### Defined in - -src/models/MessageChat.ts:8 - -___ - -### receiver - -• **receiver**: `any` - -#### Defined in - -src/models/MessageChat.ts:11 - -___ - -### sender - -• **sender**: `any` - -#### Defined in - -src/models/MessageChat.ts:10 diff --git a/docs/talawa-api-docs/interfaces/models_Organization.Interface_Organization.md b/docs/talawa-api-docs/interfaces/models_Organization.Interface_Organization.md deleted file mode 100644 index fb5845d75d8..00000000000 --- a/docs/talawa-api-docs/interfaces/models_Organization.Interface_Organization.md +++ /dev/null @@ -1,210 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/Organization](../modules/models_Organization.md) / Interface\_Organization - -# Interface: Interface\_Organization - -[models/Organization](../modules/models_Organization.md).Interface_Organization - -This is an interface that represents a database(MongoDB) document for Organization. - -## Table of contents - -### Properties - -- [\_id](models_Organization.Interface_Organization.md#_id) -- [admins](models_Organization.Interface_Organization.md#admins) -- [apiUrl](models_Organization.Interface_Organization.md#apiurl) -- [blockedUsers](models_Organization.Interface_Organization.md#blockedusers) -- [createdAt](models_Organization.Interface_Organization.md#createdat) -- [creator](models_Organization.Interface_Organization.md#creator) -- [description](models_Organization.Interface_Organization.md#description) -- [groupChats](models_Organization.Interface_Organization.md#groupchats) -- [image](models_Organization.Interface_Organization.md#image) -- [isPublic](models_Organization.Interface_Organization.md#ispublic) -- [location](models_Organization.Interface_Organization.md#location) -- [members](models_Organization.Interface_Organization.md#members) -- [membershipRequests](models_Organization.Interface_Organization.md#membershiprequests) -- [name](models_Organization.Interface_Organization.md#name) -- [pinnedPosts](models_Organization.Interface_Organization.md#pinnedposts) -- [posts](models_Organization.Interface_Organization.md#posts) -- [status](models_Organization.Interface_Organization.md#status) -- [visibleInSearch](models_Organization.Interface_Organization.md#visibleinsearch) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/Organization.ts:10 - -___ - -### admins - -• **admins**: `any`[] - -#### Defined in - -src/models/Organization.ts:20 - -___ - -### apiUrl - -• **apiUrl**: `undefined` \| `string` - -#### Defined in - -src/models/Organization.ts:11 - -___ - -### blockedUsers - -• **blockedUsers**: `any`[] - -#### Defined in - -src/models/Organization.ts:27 - -___ - -### createdAt - -• **createdAt**: `Date` - -#### Defined in - -src/models/Organization.ts:29 - -___ - -### creator - -• **creator**: `any` - -#### Defined in - -src/models/Organization.ts:17 - -___ - -### description - -• **description**: `string` - -#### Defined in - -src/models/Organization.ts:14 - -___ - -### groupChats - -• **groupChats**: `any`[] - -#### Defined in - -src/models/Organization.ts:21 - -___ - -### image - -• **image**: `undefined` \| `string` - -#### Defined in - -src/models/Organization.ts:12 - -___ - -### isPublic - -• **isPublic**: `boolean` - -#### Defined in - -src/models/Organization.ts:16 - -___ - -### location - -• **location**: `undefined` \| `string` - -#### Defined in - -src/models/Organization.ts:15 - -___ - -### members - -• **members**: `any`[] - -#### Defined in - -src/models/Organization.ts:19 - -___ - -### membershipRequests - -• **membershipRequests**: `any`[] - -#### Defined in - -src/models/Organization.ts:24 - -___ - -### name - -• **name**: `string` - -#### Defined in - -src/models/Organization.ts:13 - -___ - -### pinnedPosts - -• **pinnedPosts**: `any`[] - -#### Defined in - -src/models/Organization.ts:23 - -___ - -### posts - -• **posts**: `any`[] - -#### Defined in - -src/models/Organization.ts:22 - -___ - -### status - -• **status**: `string` - -#### Defined in - -src/models/Organization.ts:18 - -___ - -### visibleInSearch - -• **visibleInSearch**: `undefined` \| `boolean` - -#### Defined in - -src/models/Organization.ts:28 diff --git a/docs/talawa-api-docs/interfaces/models_OrganizationTagUser.Interface_OrganizationTagUser.md b/docs/talawa-api-docs/interfaces/models_OrganizationTagUser.Interface_OrganizationTagUser.md deleted file mode 100644 index 62b67a72ffb..00000000000 --- a/docs/talawa-api-docs/interfaces/models_OrganizationTagUser.Interface_OrganizationTagUser.md +++ /dev/null @@ -1,54 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/OrganizationTagUser](../modules/models_OrganizationTagUser.md) / Interface\_OrganizationTagUser - -# Interface: Interface\_OrganizationTagUser - -[models/OrganizationTagUser](../modules/models_OrganizationTagUser.md).Interface_OrganizationTagUser - -## Table of contents - -### Properties - -- [\_id](models_OrganizationTagUser.Interface_OrganizationTagUser.md#_id) -- [name](models_OrganizationTagUser.Interface_OrganizationTagUser.md#name) -- [organizationId](models_OrganizationTagUser.Interface_OrganizationTagUser.md#organizationid) -- [parentTagId](models_OrganizationTagUser.Interface_OrganizationTagUser.md#parenttagid) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/OrganizationTagUser.ts:5 - -___ - -### name - -• **name**: `string` - -#### Defined in - -src/models/OrganizationTagUser.ts:8 - -___ - -### organizationId - -• **organizationId**: `any` - -#### Defined in - -src/models/OrganizationTagUser.ts:6 - -___ - -### parentTagId - -• **parentTagId**: `any` - -#### Defined in - -src/models/OrganizationTagUser.ts:7 diff --git a/docs/talawa-api-docs/interfaces/models_Plugin.Interface_Plugin.md b/docs/talawa-api-docs/interfaces/models_Plugin.Interface_Plugin.md deleted file mode 100644 index 915465a0f8f..00000000000 --- a/docs/talawa-api-docs/interfaces/models_Plugin.Interface_Plugin.md +++ /dev/null @@ -1,78 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/Plugin](../modules/models_Plugin.md) / Interface\_Plugin - -# Interface: Interface\_Plugin - -[models/Plugin](../modules/models_Plugin.md).Interface_Plugin - -This is an interface that represents a database(MongoDB) document for Plugin. - -## Table of contents - -### Properties - -- [\_id](models_Plugin.Interface_Plugin.md#_id) -- [installedOrgs](models_Plugin.Interface_Plugin.md#installedorgs) -- [pluginCreatedBy](models_Plugin.Interface_Plugin.md#plugincreatedby) -- [pluginDesc](models_Plugin.Interface_Plugin.md#plugindesc) -- [pluginInstallStatus](models_Plugin.Interface_Plugin.md#plugininstallstatus) -- [pluginName](models_Plugin.Interface_Plugin.md#pluginname) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/Plugin.ts:6 - -___ - -### installedOrgs - -• **installedOrgs**: `ObjectId`[] - -#### Defined in - -src/models/Plugin.ts:11 - -___ - -### pluginCreatedBy - -• **pluginCreatedBy**: `string` - -#### Defined in - -src/models/Plugin.ts:8 - -___ - -### pluginDesc - -• **pluginDesc**: `string` - -#### Defined in - -src/models/Plugin.ts:9 - -___ - -### pluginInstallStatus - -• **pluginInstallStatus**: `boolean` - -#### Defined in - -src/models/Plugin.ts:10 - -___ - -### pluginName - -• **pluginName**: `string` - -#### Defined in - -src/models/Plugin.ts:7 diff --git a/docs/talawa-api-docs/interfaces/models_PluginField.Interface_PluginField.md b/docs/talawa-api-docs/interfaces/models_PluginField.Interface_PluginField.md deleted file mode 100644 index 75c7da8a054..00000000000 --- a/docs/talawa-api-docs/interfaces/models_PluginField.Interface_PluginField.md +++ /dev/null @@ -1,67 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/PluginField](../modules/models_PluginField.md) / Interface\_PluginField - -# Interface: Interface\_PluginField - -[models/PluginField](../modules/models_PluginField.md).Interface_PluginField - -This is an interface that represents a database(MongoDB) document for Plugin Field. - -## Table of contents - -### Properties - -- [\_id](models_PluginField.Interface_PluginField.md#_id) -- [createdAt](models_PluginField.Interface_PluginField.md#createdat) -- [key](models_PluginField.Interface_PluginField.md#key) -- [status](models_PluginField.Interface_PluginField.md#status) -- [value](models_PluginField.Interface_PluginField.md#value) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/PluginField.ts:6 - -___ - -### createdAt - -• **createdAt**: `Date` - -#### Defined in - -src/models/PluginField.ts:10 - -___ - -### key - -• **key**: `string` - -#### Defined in - -src/models/PluginField.ts:7 - -___ - -### status - -• **status**: `string` - -#### Defined in - -src/models/PluginField.ts:9 - -___ - -### value - -• **value**: `string` - -#### Defined in - -src/models/PluginField.ts:8 diff --git a/docs/talawa-api-docs/interfaces/models_Post.Interface_Post.md b/docs/talawa-api-docs/interfaces/models_Post.Interface_Post.md deleted file mode 100644 index 29da241d6d4..00000000000 --- a/docs/talawa-api-docs/interfaces/models_Post.Interface_Post.md +++ /dev/null @@ -1,166 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/Post](../modules/models_Post.md) / Interface\_Post - -# Interface: Interface\_Post - -[models/Post](../modules/models_Post.md).Interface_Post - -This is an interface that represents a database(MongoDB) document for Post. - -## Table of contents - -### Properties - -- [\_id](models_Post.Interface_Post.md#_id) -- [commentCount](models_Post.Interface_Post.md#commentcount) -- [comments](models_Post.Interface_Post.md#comments) -- [createdAt](models_Post.Interface_Post.md#createdat) -- [creator](models_Post.Interface_Post.md#creator) -- [imageUrl](models_Post.Interface_Post.md#imageurl) -- [likeCount](models_Post.Interface_Post.md#likecount) -- [likedBy](models_Post.Interface_Post.md#likedby) -- [organization](models_Post.Interface_Post.md#organization) -- [pinned](models_Post.Interface_Post.md#pinned) -- [status](models_Post.Interface_Post.md#status) -- [text](models_Post.Interface_Post.md#text) -- [title](models_Post.Interface_Post.md#title) -- [videoUrl](models_Post.Interface_Post.md#videourl) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/Post.ts:18 - -___ - -### commentCount - -• **commentCount**: `number` - -#### Defined in - -src/models/Post.ts:30 - -___ - -### comments - -• **comments**: `any`[] - -#### Defined in - -src/models/Post.ts:28 - -___ - -### createdAt - -• **createdAt**: `Date` - -#### Defined in - -src/models/Post.ts:22 - -___ - -### creator - -• **creator**: `any` - -#### Defined in - -src/models/Post.ts:25 - -___ - -### imageUrl - -• **imageUrl**: `undefined` \| ``null`` \| `string` - -#### Defined in - -src/models/Post.ts:23 - -___ - -### likeCount - -• **likeCount**: `number` - -#### Defined in - -src/models/Post.ts:29 - -___ - -### likedBy - -• **likedBy**: `any`[] - -#### Defined in - -src/models/Post.ts:27 - -___ - -### organization - -• **organization**: `any` - -#### Defined in - -src/models/Post.ts:26 - -___ - -### pinned - -• **pinned**: `boolean` - -#### Defined in - -src/models/Post.ts:31 - -___ - -### status - -• **status**: `string` - -#### Defined in - -src/models/Post.ts:21 - -___ - -### text - -• **text**: `string` - -#### Defined in - -src/models/Post.ts:19 - -___ - -### title - -• **title**: `undefined` \| `string` - -#### Defined in - -src/models/Post.ts:20 - -___ - -### videoUrl - -• **videoUrl**: `undefined` \| `string` - -#### Defined in - -src/models/Post.ts:24 diff --git a/docs/talawa-api-docs/interfaces/models_RecurrenceRule.InterfaceRecurrenceRule.md b/docs/talawa-api-docs/interfaces/models_RecurrenceRule.InterfaceRecurrenceRule.md index a399be03af4..f0098241a35 100644 --- a/docs/talawa-api-docs/interfaces/models_RecurrenceRule.InterfaceRecurrenceRule.md +++ b/docs/talawa-api-docs/interfaces/models_RecurrenceRule.InterfaceRecurrenceRule.md @@ -27,7 +27,7 @@ #### Defined in -[src/models/RecurrenceRule.ts:27](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L27) +[src/models/RecurrenceRule.ts:27](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L27) ___ @@ -37,7 +37,7 @@ ___ #### Defined in -[src/models/RecurrenceRule.ts:29](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L29) +[src/models/RecurrenceRule.ts:29](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L29) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[src/models/RecurrenceRule.ts:34](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L34) +[src/models/RecurrenceRule.ts:34](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L34) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[src/models/RecurrenceRule.ts:32](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L32) +[src/models/RecurrenceRule.ts:32](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L32) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[src/models/RecurrenceRule.ts:33](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L33) +[src/models/RecurrenceRule.ts:33](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L33) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[src/models/RecurrenceRule.ts:36](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L36) +[src/models/RecurrenceRule.ts:36](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L36) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -[src/models/RecurrenceRule.ts:28](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L28) +[src/models/RecurrenceRule.ts:28](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L28) ___ @@ -97,7 +97,7 @@ ___ #### Defined in -[src/models/RecurrenceRule.ts:30](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L30) +[src/models/RecurrenceRule.ts:30](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L30) ___ @@ -107,7 +107,7 @@ ___ #### Defined in -[src/models/RecurrenceRule.ts:31](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L31) +[src/models/RecurrenceRule.ts:31](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L31) ___ @@ -117,4 +117,4 @@ ___ #### Defined in -[src/models/RecurrenceRule.ts:35](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L35) +[src/models/RecurrenceRule.ts:35](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L35) diff --git a/docs/talawa-api-docs/interfaces/models_TagUser.Interface_TagUser.md b/docs/talawa-api-docs/interfaces/models_TagUser.Interface_TagUser.md deleted file mode 100644 index d0380699196..00000000000 --- a/docs/talawa-api-docs/interfaces/models_TagUser.Interface_TagUser.md +++ /dev/null @@ -1,43 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/TagUser](../modules/models_TagUser.md) / Interface\_TagUser - -# Interface: Interface\_TagUser - -[models/TagUser](../modules/models_TagUser.md).Interface_TagUser - -## Table of contents - -### Properties - -- [\_id](models_TagUser.Interface_TagUser.md#_id) -- [tagId](models_TagUser.Interface_TagUser.md#tagid) -- [userId](models_TagUser.Interface_TagUser.md#userid) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/TagUser.ts:6 - -___ - -### tagId - -• **tagId**: `any` - -#### Defined in - -src/models/TagUser.ts:8 - -___ - -### userId - -• **userId**: `any` - -#### Defined in - -src/models/TagUser.ts:7 diff --git a/docs/talawa-api-docs/interfaces/models_Task.Interface_Task.md b/docs/talawa-api-docs/interfaces/models_Task.Interface_Task.md deleted file mode 100644 index 12d68f647e3..00000000000 --- a/docs/talawa-api-docs/interfaces/models_Task.Interface_Task.md +++ /dev/null @@ -1,100 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/Task](../modules/models_Task.md) / Interface\_Task - -# Interface: Interface\_Task - -[models/Task](../modules/models_Task.md).Interface_Task - -This is an interface that represents a database(MongoDB) document for Task. - -## Table of contents - -### Properties - -- [\_id](models_Task.Interface_Task.md#_id) -- [createdAt](models_Task.Interface_Task.md#createdat) -- [creator](models_Task.Interface_Task.md#creator) -- [deadline](models_Task.Interface_Task.md#deadline) -- [description](models_Task.Interface_Task.md#description) -- [event](models_Task.Interface_Task.md#event) -- [status](models_Task.Interface_Task.md#status) -- [title](models_Task.Interface_Task.md#title) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/Task.ts:8 - -___ - -### createdAt - -• **createdAt**: `Date` - -#### Defined in - -src/models/Task.ts:12 - -___ - -### creator - -• **creator**: `any` - -#### Defined in - -src/models/Task.ts:15 - -___ - -### deadline - -• **deadline**: `undefined` \| `Date` - -#### Defined in - -src/models/Task.ts:13 - -___ - -### description - -• **description**: `undefined` \| `string` - -#### Defined in - -src/models/Task.ts:10 - -___ - -### event - -• **event**: `any` - -#### Defined in - -src/models/Task.ts:14 - -___ - -### status - -• **status**: `string` - -#### Defined in - -src/models/Task.ts:11 - -___ - -### title - -• **title**: `string` - -#### Defined in - -src/models/Task.ts:9 diff --git a/docs/talawa-api-docs/interfaces/models_User.InterfaceUserToReturn.md b/docs/talawa-api-docs/interfaces/models_User.InterfaceUserToReturn.md deleted file mode 100644 index a3473444688..00000000000 --- a/docs/talawa-api-docs/interfaces/models_User.InterfaceUserToReturn.md +++ /dev/null @@ -1,354 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/User](../modules/models_User.md) / InterfaceUserToReturn - -# Interface: InterfaceUserToReturn - -[models/User](../modules/models_User.md).InterfaceUserToReturn - -This is an interface of the user that will be returned to the client side. -The differrence between this interface and the real User Interface is that it doesn't contains password field -Although this is a poor way, a better way will include implementing this Model with inclusion of password field and then using that model everywhere. - -## Table of contents - -### Properties - -- [\_id](models_User.InterfaceUserToReturn.md#_id) -- [address](models_User.InterfaceUserToReturn.md#address) -- [adminApproved](models_User.InterfaceUserToReturn.md#adminapproved) -- [adminFor](models_User.InterfaceUserToReturn.md#adminfor) -- [appLanguageCode](models_User.InterfaceUserToReturn.md#applanguagecode) -- [birthDate](models_User.InterfaceUserToReturn.md#birthdate) -- [createdAt](models_User.InterfaceUserToReturn.md#createdat) -- [createdEvents](models_User.InterfaceUserToReturn.md#createdevents) -- [createdOrganizations](models_User.InterfaceUserToReturn.md#createdorganizations) -- [educationGrade](models_User.InterfaceUserToReturn.md#educationgrade) -- [email](models_User.InterfaceUserToReturn.md#email) -- [employmentStatus](models_User.InterfaceUserToReturn.md#employmentstatus) -- [eventAdmin](models_User.InterfaceUserToReturn.md#eventadmin) -- [firstName](models_User.InterfaceUserToReturn.md#firstname) -- [gender](models_User.InterfaceUserToReturn.md#gender) -- [image](models_User.InterfaceUserToReturn.md#image) -- [joinedOrganizations](models_User.InterfaceUserToReturn.md#joinedorganizations) -- [lastName](models_User.InterfaceUserToReturn.md#lastname) -- [maritalStatus](models_User.InterfaceUserToReturn.md#maritalstatus) -- [membershipRequests](models_User.InterfaceUserToReturn.md#membershiprequests) -- [organizationsBlockedBy](models_User.InterfaceUserToReturn.md#organizationsblockedby) -- [phone](models_User.InterfaceUserToReturn.md#phone) -- [pluginCreationAllowed](models_User.InterfaceUserToReturn.md#plugincreationallowed) -- [registeredEvents](models_User.InterfaceUserToReturn.md#registeredevents) -- [status](models_User.InterfaceUserToReturn.md#status) -- [token](models_User.InterfaceUserToReturn.md#token) -- [tokenVersion](models_User.InterfaceUserToReturn.md#tokenversion) -- [updatedAt](models_User.InterfaceUserToReturn.md#updatedat) -- [userType](models_User.InterfaceUserToReturn.md#usertype) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -[src/models/User.ts:292](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L292) - -___ - -### address - -• **address**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `city` | `string` | -| `countryCode` | `string` | -| `dependentLocality` | `string` | -| `line1` | `string` | -| `line2` | `string` | -| `postalCode` | `string` | -| `sortingCode` | `string` | -| `state` | `string` | - -#### Defined in - -[src/models/User.ts:293](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L293) - -___ - -### adminApproved - -• **adminApproved**: `boolean` - -#### Defined in - -[src/models/User.ts:303](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L303) - -___ - -### adminFor - -• **adminFor**: `any`[] - -#### Defined in - -[src/models/User.ts:304](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L304) - -___ - -### appLanguageCode - -• **appLanguageCode**: `string` - -#### Defined in - -[src/models/User.ts:305](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L305) - -___ - -### birthDate - -• **birthDate**: `Date` - -#### Defined in - -[src/models/User.ts:306](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L306) - -___ - -### createdAt - -• **createdAt**: `Date` - -#### Defined in - -[src/models/User.ts:307](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L307) - -___ - -### createdEvents - -• **createdEvents**: `any`[] - -#### Defined in - -[src/models/User.ts:308](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L308) - -___ - -### createdOrganizations - -• **createdOrganizations**: `any`[] - -#### Defined in - -[src/models/User.ts:309](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L309) - -___ - -### educationGrade - -• **educationGrade**: `string` - -#### Defined in - -[src/models/User.ts:310](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L310) - -___ - -### email - -• **email**: `string` - -#### Defined in - -[src/models/User.ts:311](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L311) - -___ - -### employmentStatus - -• **employmentStatus**: `string` - -#### Defined in - -[src/models/User.ts:312](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L312) - -___ - -### eventAdmin - -• **eventAdmin**: `any`[] - -#### Defined in - -[src/models/User.ts:313](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L313) - -___ - -### firstName - -• **firstName**: `string` - -#### Defined in - -[src/models/User.ts:314](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L314) - -___ - -### gender - -• **gender**: `string` - -#### Defined in - -[src/models/User.ts:315](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L315) - -___ - -### image - -• **image**: `undefined` \| ``null`` \| `string` - -#### Defined in - -[src/models/User.ts:316](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L316) - -___ - -### joinedOrganizations - -• **joinedOrganizations**: `any`[] - -#### Defined in - -[src/models/User.ts:317](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L317) - -___ - -### lastName - -• **lastName**: `string` - -#### Defined in - -[src/models/User.ts:318](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L318) - -___ - -### maritalStatus - -• **maritalStatus**: `string` - -#### Defined in - -[src/models/User.ts:319](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L319) - -___ - -### membershipRequests - -• **membershipRequests**: `any`[] - -#### Defined in - -[src/models/User.ts:320](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L320) - -___ - -### organizationsBlockedBy - -• **organizationsBlockedBy**: `any`[] - -#### Defined in - -[src/models/User.ts:321](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L321) - -___ - -### phone - -• **phone**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `home` | `string` | -| `mobile` | `string` | -| `work` | `string` | - -#### Defined in - -[src/models/User.ts:322](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L322) - -___ - -### pluginCreationAllowed - -• **pluginCreationAllowed**: `boolean` - -#### Defined in - -[src/models/User.ts:327](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L327) - -___ - -### registeredEvents - -• **registeredEvents**: `any`[] - -#### Defined in - -[src/models/User.ts:328](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L328) - -___ - -### status - -• **status**: `string` - -#### Defined in - -[src/models/User.ts:329](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L329) - -___ - -### token - -• **token**: `undefined` \| `string` - -#### Defined in - -[src/models/User.ts:330](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L330) - -___ - -### tokenVersion - -• **tokenVersion**: `number` - -#### Defined in - -[src/models/User.ts:331](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L331) - -___ - -### updatedAt - -• **updatedAt**: `Date` - -#### Defined in - -[src/models/User.ts:332](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L332) - -___ - -### userType - -• **userType**: `string` - -#### Defined in - -[src/models/User.ts:333](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/models/User.ts#L333) diff --git a/docs/talawa-api-docs/interfaces/models_User.Interface_User.md b/docs/talawa-api-docs/interfaces/models_User.Interface_User.md deleted file mode 100644 index 659d4d507b6..00000000000 --- a/docs/talawa-api-docs/interfaces/models_User.Interface_User.md +++ /dev/null @@ -1,265 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [models/User](../modules/models_User.md) / Interface\_User - -# Interface: Interface\_User - -[models/User](../modules/models_User.md).Interface_User - -This is an interface that represents a database(MongoDB) document for User. - -## Table of contents - -### Properties - -- [\_id](models_User.Interface_User.md#_id) -- [adminApproved](models_User.Interface_User.md#adminapproved) -- [adminFor](models_User.Interface_User.md#adminfor) -- [appLanguageCode](models_User.Interface_User.md#applanguagecode) -- [createdAt](models_User.Interface_User.md#createdat) -- [createdEvents](models_User.Interface_User.md#createdevents) -- [createdOrganizations](models_User.Interface_User.md#createdorganizations) -- [email](models_User.Interface_User.md#email) -- [eventAdmin](models_User.Interface_User.md#eventadmin) -- [firstName](models_User.Interface_User.md#firstname) -- [image](models_User.Interface_User.md#image) -- [joinedOrganizations](models_User.Interface_User.md#joinedorganizations) -- [lastName](models_User.Interface_User.md#lastname) -- [membershipRequests](models_User.Interface_User.md#membershiprequests) -- [organizationUserBelongsTo](models_User.Interface_User.md#organizationuserbelongsto) -- [organizationsBlockedBy](models_User.Interface_User.md#organizationsblockedby) -- [password](models_User.Interface_User.md#password) -- [pluginCreationAllowed](models_User.Interface_User.md#plugincreationallowed) -- [registeredEvents](models_User.Interface_User.md#registeredevents) -- [status](models_User.Interface_User.md#status) -- [token](models_User.Interface_User.md#token) -- [tokenVersion](models_User.Interface_User.md#tokenversion) -- [userType](models_User.Interface_User.md#usertype) - -## Properties - -### \_id - -• **\_id**: `ObjectId` - -#### Defined in - -src/models/User.ts:19 - -___ - -### adminApproved - -• **adminApproved**: `boolean` - -#### Defined in - -src/models/User.ts:46 - -___ - -### adminFor - -• **adminFor**: `any`[] - -#### Defined in - -src/models/User.ts:34 - -___ - -### appLanguageCode - -• **appLanguageCode**: `string` - -#### Defined in - -src/models/User.ts:27 - -___ - -### createdAt - -• **createdAt**: `Date` - -#### Defined in - -src/models/User.ts:47 - -___ - -### createdEvents - -• **createdEvents**: `any`[] - -#### Defined in - -src/models/User.ts:29 - -___ - -### createdOrganizations - -• **createdOrganizations**: `any`[] - -#### Defined in - -src/models/User.ts:28 - -___ - -### email - -• **email**: `string` - -#### Defined in - -src/models/User.ts:25 - -___ - -### eventAdmin - -• **eventAdmin**: `any`[] - -#### Defined in - -src/models/User.ts:33 - -___ - -### firstName - -• **firstName**: `string` - -#### Defined in - -src/models/User.ts:23 - -___ - -### image - -• **image**: `undefined` \| ``null`` \| `string` - -#### Defined in - -src/models/User.ts:20 - -___ - -### joinedOrganizations - -• **joinedOrganizations**: `any`[] - -#### Defined in - -src/models/User.ts:31 - -___ - -### lastName - -• **lastName**: `string` - -#### Defined in - -src/models/User.ts:24 - -___ - -### membershipRequests - -• **membershipRequests**: `any`[] - -#### Defined in - -src/models/User.ts:35 - -___ - -### organizationUserBelongsTo - -• **organizationUserBelongsTo**: `any` - -#### Defined in - -src/models/User.ts:42 - -___ - -### organizationsBlockedBy - -• **organizationsBlockedBy**: `any`[] - -#### Defined in - -src/models/User.ts:38 - -___ - -### password - -• **password**: `string` - -#### Defined in - -src/models/User.ts:26 - -___ - -### pluginCreationAllowed - -• **pluginCreationAllowed**: `boolean` - -#### Defined in - -src/models/User.ts:45 - -___ - -### registeredEvents - -• **registeredEvents**: `any`[] - -#### Defined in - -src/models/User.ts:32 - -___ - -### status - -• **status**: `string` - -#### Defined in - -src/models/User.ts:41 - -___ - -### token - -• **token**: `undefined` \| `string` - -#### Defined in - -src/models/User.ts:21 - -___ - -### tokenVersion - -• **tokenVersion**: `number` - -#### Defined in - -src/models/User.ts:22 - -___ - -### userType - -• **userType**: `string` - -#### Defined in - -src/models/User.ts:30 diff --git a/docs/talawa-api-docs/interfaces/models_userFamily.InterfaceUserFamily.md b/docs/talawa-api-docs/interfaces/models_userFamily.InterfaceUserFamily.md index 85642a16c0d..27e00b13a16 100644 --- a/docs/talawa-api-docs/interfaces/models_userFamily.InterfaceUserFamily.md +++ b/docs/talawa-api-docs/interfaces/models_userFamily.InterfaceUserFamily.md @@ -24,7 +24,7 @@ This is an interface that represents a database(MongoDB) document for Family. #### Defined in -[src/models/userFamily.ts:9](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/userFamily.ts#L9) +[src/models/userFamily.ts:9](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/userFamily.ts#L9) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[src/models/userFamily.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/userFamily.ts#L12) +[src/models/userFamily.ts:12](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/userFamily.ts#L12) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[src/models/userFamily.ts:13](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/userFamily.ts#L13) +[src/models/userFamily.ts:13](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/userFamily.ts#L13) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[src/models/userFamily.ts:10](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/userFamily.ts#L10) +[src/models/userFamily.ts:10](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/userFamily.ts#L10) ___ @@ -64,4 +64,4 @@ ___ #### Defined in -[src/models/userFamily.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/userFamily.ts#L11) +[src/models/userFamily.ts:11](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/userFamily.ts#L11) diff --git a/docs/talawa-api-docs/interfaces/utilities_auth.Interface_JwtTokenPayload.md b/docs/talawa-api-docs/interfaces/utilities_auth.Interface_JwtTokenPayload.md deleted file mode 100644 index 45fc83aa6f7..00000000000 --- a/docs/talawa-api-docs/interfaces/utilities_auth.Interface_JwtTokenPayload.md +++ /dev/null @@ -1,65 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [utilities/auth](../modules/utilities_auth.md) / Interface\_JwtTokenPayload - -# Interface: Interface\_JwtTokenPayload - -[utilities/auth](../modules/utilities_auth.md).Interface_JwtTokenPayload - -## Table of contents - -### Properties - -- [email](utilities_auth.Interface_JwtTokenPayload.md#email) -- [firstName](utilities_auth.Interface_JwtTokenPayload.md#firstname) -- [lastName](utilities_auth.Interface_JwtTokenPayload.md#lastname) -- [tokenVersion](utilities_auth.Interface_JwtTokenPayload.md#tokenversion) -- [userId](utilities_auth.Interface_JwtTokenPayload.md#userid) - -## Properties - -### email - -• **email**: `string` - -#### Defined in - -src/utilities/auth.ts:10 - -___ - -### firstName - -• **firstName**: `string` - -#### Defined in - -src/utilities/auth.ts:8 - -___ - -### lastName - -• **lastName**: `string` - -#### Defined in - -src/utilities/auth.ts:9 - -___ - -### tokenVersion - -• **tokenVersion**: `number` - -#### Defined in - -src/utilities/auth.ts:6 - -___ - -### userId - -• **userId**: `string` - -#### Defined in - -src/utilities/auth.ts:7 diff --git a/docs/talawa-api-docs/interfaces/utilities_mailer.Interface_MailFields.md b/docs/talawa-api-docs/interfaces/utilities_mailer.Interface_MailFields.md deleted file mode 100644 index 579fcbf647b..00000000000 --- a/docs/talawa-api-docs/interfaces/utilities_mailer.Interface_MailFields.md +++ /dev/null @@ -1,43 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / [utilities/mailer](../modules/utilities_mailer.md) / Interface\_MailFields - -# Interface: Interface\_MailFields - -[utilities/mailer](../modules/utilities_mailer.md).Interface_MailFields - -## Table of contents - -### Properties - -- [body](utilities_mailer.Interface_MailFields.md#body) -- [emailTo](utilities_mailer.Interface_MailFields.md#emailto) -- [subject](utilities_mailer.Interface_MailFields.md#subject) - -## Properties - -### body - -• **body**: `string` - -#### Defined in - -src/utilities/mailer.ts:13 - -___ - -### emailTo - -• **emailTo**: `string` - -#### Defined in - -src/utilities/mailer.ts:11 - -___ - -### subject - -• **subject**: `string` - -#### Defined in - -src/utilities/mailer.ts:12 diff --git a/docs/talawa-api-docs/modules/config_firebaseConfig.md b/docs/talawa-api-docs/modules/config_firebaseConfig.md deleted file mode 100644 index 9e7c33d4725..00000000000 --- a/docs/talawa-api-docs/modules/config_firebaseConfig.md +++ /dev/null @@ -1,52 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / config/firebaseConfig - -# Module: config/firebaseConfig - -## Table of contents - -### Variables - -- [androidFirebaseOptions](config_firebaseConfig.md#androidfirebaseoptions) -- [iosFirebaseOptions](config_firebaseConfig.md#iosfirebaseoptions) - -## Variables - -### androidFirebaseOptions - -• `Const` **androidFirebaseOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `apiKey` | `undefined` \| `string` | -| `appId` | `undefined` \| `string` | -| `messagingSenderId` | `undefined` \| `string` | -| `projectId` | `undefined` \| `string` | -| `storageBucket` | `undefined` \| `string` | - -#### Defined in - -src/config/firebaseConfig.ts:16 - -___ - -### iosFirebaseOptions - -• `Const` **iosFirebaseOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `apiKey` | `undefined` \| `string` | -| `appId` | `undefined` \| `string` | -| `iosBundleId` | `undefined` \| `string` | -| `iosClientId` | `undefined` \| `string` | -| `messagingSenderId` | `undefined` \| `string` | -| `projectId` | `undefined` \| `string` | -| `storageBucket` | `undefined` \| `string` | - -#### Defined in - -src/config/firebaseConfig.ts:24 diff --git a/docs/talawa-api-docs/modules/directives.md b/docs/talawa-api-docs/modules/directives.md deleted file mode 100644 index 348221539a9..00000000000 --- a/docs/talawa-api-docs/modules/directives.md +++ /dev/null @@ -1,22 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / directives - -# Module: directives - -## Table of contents - -### References - -- [AuthenticationDirective](directives.md#authenticationdirective) -- [RoleAuthorizationDirective](directives.md#roleauthorizationdirective) - -## References - -### AuthenticationDirective - -Re-exports [AuthenticationDirective](../classes/directives_authDirective.AuthenticationDirective.md) - -___ - -### RoleAuthorizationDirective - -Re-exports [RoleAuthorizationDirective](../classes/directives_roleDirective.RoleAuthorizationDirective.md) diff --git a/docs/talawa-api-docs/modules/directives_authDirective.md b/docs/talawa-api-docs/modules/directives_authDirective.md deleted file mode 100644 index 7ba045fadbf..00000000000 --- a/docs/talawa-api-docs/modules/directives_authDirective.md +++ /dev/null @@ -1,9 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / directives/authDirective - -# Module: directives/authDirective - -## Table of contents - -### Classes - -- [AuthenticationDirective](../classes/directives_authDirective.AuthenticationDirective.md) diff --git a/docs/talawa-api-docs/modules/directives_roleDirective.md b/docs/talawa-api-docs/modules/directives_roleDirective.md deleted file mode 100644 index 4e244cf01b3..00000000000 --- a/docs/talawa-api-docs/modules/directives_roleDirective.md +++ /dev/null @@ -1,9 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / directives/roleDirective - -# Module: directives/roleDirective - -## Table of contents - -### Classes - -- [RoleAuthorizationDirective](../classes/directives_roleDirective.RoleAuthorizationDirective.md) diff --git a/docs/talawa-api-docs/modules/helpers_event_createEventHelpers.md b/docs/talawa-api-docs/modules/helpers_event_createEventHelpers.md deleted file mode 100644 index e21c342413a..00000000000 --- a/docs/talawa-api-docs/modules/helpers_event_createEventHelpers.md +++ /dev/null @@ -1,22 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / helpers/event/createEventHelpers - -# Module: helpers/event/createEventHelpers - -## Table of contents - -### References - -- [createRecurringEvent](helpers_event_createEventHelpers.md#createrecurringevent) -- [createSingleEvent](helpers_event_createEventHelpers.md#createsingleevent) - -## References - -### createRecurringEvent - -Re-exports [createRecurringEvent](helpers_event_createEventHelpers_createRecurringEvent.md#createrecurringevent) - -___ - -### createSingleEvent - -Re-exports [createSingleEvent](helpers_event_createEventHelpers_createSingleEvent.md#createsingleevent) diff --git a/docs/talawa-api-docs/modules/helpers_event_createEventHelpers_createRecurringEvent.md b/docs/talawa-api-docs/modules/helpers_event_createEventHelpers_createRecurringEvent.md index 11c36d3f0a4..aa64ee53daf 100644 --- a/docs/talawa-api-docs/modules/helpers_event_createEventHelpers_createRecurringEvent.md +++ b/docs/talawa-api-docs/modules/helpers_event_createEventHelpers_createRecurringEvent.md @@ -43,4 +43,4 @@ The following steps are followed: #### Defined in -[src/helpers/event/createEventHelpers/createRecurringEvent.ts:27](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/helpers/event/createEventHelpers/createRecurringEvent.ts#L27) +[src/helpers/event/createEventHelpers/createRecurringEvent.ts:27](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/createEventHelpers/createRecurringEvent.ts#L27) diff --git a/docs/talawa-api-docs/modules/helpers_event_createEventHelpers_createRecurringEventInstancesDuringQuery.md b/docs/talawa-api-docs/modules/helpers_event_createEventHelpers_createRecurringEventInstancesDuringQuery.md new file mode 100644 index 00000000000..b11a869df23 --- /dev/null +++ b/docs/talawa-api-docs/modules/helpers_event_createEventHelpers_createRecurringEventInstancesDuringQuery.md @@ -0,0 +1,42 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / helpers/event/createEventHelpers/createRecurringEventInstancesDuringQuery + +# Module: helpers/event/createEventHelpers/createRecurringEventInstancesDuringQuery + +## Table of contents + +### Functions + +- [createRecurringEventInstancesDuringQuery](helpers_event_createEventHelpers_createRecurringEventInstancesDuringQuery.md#createrecurringeventinstancesduringquery) + +## Functions + +### createRecurringEventInstancesDuringQuery + +▸ **createRecurringEventInstancesDuringQuery**(`organizationId`): `Promise`\<`void`\> + +This function creates the instances of a recurring event upto a certain date during queries. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `organizationId` | `undefined` \| ``null`` \| `string` | _id of the organization the events belong to | + +#### Returns + +`Promise`\<`void`\> + +**`Remarks`** + +The following steps are followed: +1. Get the limit date upto which we would want to query the recurrenceRules and generate new instances. +2. Get the recurrence rules to be used for instance generation during this query. +3. For every recurrence rule found: + - find the base recurring event to get the data to be used for new instance generation. + - get the number of existing instances and how many more to generate based on the recurrenceRule's count (if specified). + - generate new instances after their latestInstanceDates. + - update the latestInstanceDate. + +#### Defined in + +[src/helpers/event/createEventHelpers/createRecurringEventInstancesDuringQuery.ts:27](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/createEventHelpers/createRecurringEventInstancesDuringQuery.ts#L27) diff --git a/docs/talawa-api-docs/modules/helpers_event_createEventHelpers_createSingleEvent.md b/docs/talawa-api-docs/modules/helpers_event_createEventHelpers_createSingleEvent.md index 842825dbbd6..d54ea4a1fe7 100644 --- a/docs/talawa-api-docs/modules/helpers_event_createEventHelpers_createSingleEvent.md +++ b/docs/talawa-api-docs/modules/helpers_event_createEventHelpers_createSingleEvent.md @@ -40,4 +40,4 @@ The following steps are followed: #### Defined in -[src/helpers/event/createEventHelpers/createSingleEvent.ts:19](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/helpers/event/createEventHelpers/createSingleEvent.ts#L19) +[src/helpers/event/createEventHelpers/createSingleEvent.ts:19](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/createEventHelpers/createSingleEvent.ts#L19) diff --git a/docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers.md b/docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers.md deleted file mode 100644 index bf0f1e9c472..00000000000 --- a/docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers.md +++ /dev/null @@ -1,36 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / helpers/event/recurringEventHelpers - -# Module: helpers/event/recurringEventHelpers - -## Table of contents - -### References - -- [createRecurrenceRule](helpers_event_recurringEventHelpers.md#createrecurrencerule) -- [generateRecurrenceRuleString](helpers_event_recurringEventHelpers.md#generaterecurrencerulestring) -- [generateRecurringEventInstances](helpers_event_recurringEventHelpers.md#generaterecurringeventinstances) -- [getRecurringInstanceDates](helpers_event_recurringEventHelpers.md#getrecurringinstancedates) - -## References - -### createRecurrenceRule - -Re-exports [createRecurrenceRule](helpers_event_recurringEventHelpers_createRecurrenceRule.md#createrecurrencerule) - -___ - -### generateRecurrenceRuleString - -Re-exports [generateRecurrenceRuleString](helpers_event_recurringEventHelpers_generateRecurrenceRuleString.md#generaterecurrencerulestring) - -___ - -### generateRecurringEventInstances - -Re-exports [generateRecurringEventInstances](helpers_event_recurringEventHelpers_generateRecurringEventInstances.md#generaterecurringeventinstances) - -___ - -### getRecurringInstanceDates - -Re-exports [getRecurringInstanceDates](helpers_event_recurringEventHelpers_getRecurringInstanceDates.md#getrecurringinstancedates) diff --git a/docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers_createRecurrenceRule.md b/docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers_createRecurrenceRule.md index d42d2dfb519..234d6a08004 100644 --- a/docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers_createRecurrenceRule.md +++ b/docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers_createRecurrenceRule.md @@ -43,4 +43,4 @@ The following steps are followed: #### Defined in -[src/helpers/event/recurringEventHelpers/createRecurrenceRule.ts:25](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/helpers/event/recurringEventHelpers/createRecurrenceRule.ts#L25) +[src/helpers/event/recurringEventHelpers/createRecurrenceRule.ts:25](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/recurringEventHelpers/createRecurrenceRule.ts#L25) diff --git a/docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers_generateRecurrenceRuleString.md b/docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers_generateRecurrenceRuleString.md index bb7e8a633fe..68840fa0816 100644 --- a/docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers_generateRecurrenceRuleString.md +++ b/docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers_generateRecurrenceRuleString.md @@ -38,4 +38,4 @@ The following steps are followed: #### Defined in -[src/helpers/event/recurringEventHelpers/generateRecurrenceRuleString.ts:15](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/helpers/event/recurringEventHelpers/generateRecurrenceRuleString.ts#L15) +[src/helpers/event/recurringEventHelpers/generateRecurrenceRuleString.ts:15](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/recurringEventHelpers/generateRecurrenceRuleString.ts#L15) diff --git a/docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers_generateRecurringEventInstances.md b/docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers_generateRecurringEventInstances.md index 8f9975d02d5..a3d0701d7aa 100644 --- a/docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers_generateRecurringEventInstances.md +++ b/docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers_generateRecurringEventInstances.md @@ -4,6 +4,10 @@ ## Table of contents +### Interfaces + +- [InterfaceRecurringEvent](../interfaces/helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md) + ### Functions - [generateRecurringEventInstances](helpers_event_recurringEventHelpers_generateRecurringEventInstances.md#generaterecurringeventinstances) @@ -26,4 +30,4 @@ #### Defined in -[src/helpers/event/recurringEventHelpers/generateRecurringEventInstances.ts:42](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/helpers/event/recurringEventHelpers/generateRecurringEventInstances.ts#L42) +[src/helpers/event/recurringEventHelpers/generateRecurringEventInstances.ts:44](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/recurringEventHelpers/generateRecurringEventInstances.ts#L44) diff --git a/docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers_getRecurringInstanceDates.md b/docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers_getRecurringInstanceDates.md index 1be90dbad5f..b26c4aab389 100644 --- a/docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers_getRecurringInstanceDates.md +++ b/docs/talawa-api-docs/modules/helpers_event_recurringEventHelpers_getRecurringInstanceDates.md @@ -39,4 +39,4 @@ The following steps are followed: #### Defined in -[src/helpers/event/recurringEventHelpers/getRecurringInstanceDates.ts:23](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/helpers/event/recurringEventHelpers/getRecurringInstanceDates.ts#L23) +[src/helpers/event/recurringEventHelpers/getRecurringInstanceDates.ts:23](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/recurringEventHelpers/getRecurringInstanceDates.ts#L23) diff --git a/docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_getEventData.md b/docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_getEventData.md new file mode 100644 index 00000000000..98d223c3a63 --- /dev/null +++ b/docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_getEventData.md @@ -0,0 +1,40 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / helpers/event/updateEventHelpers/getEventData + +# Module: helpers/event/updateEventHelpers/getEventData + +## Table of contents + +### Functions + +- [getEventData](helpers_event_updateEventHelpers_getEventData.md#geteventdata) + +## Functions + +### getEventData + +▸ **getEventData**(`updateEventInputData`, `event`): [`InterfaceRecurringEvent`](../interfaces/helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md) + +This function get the data to be used for generating the recurring event instances. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `updateEventInputData` | `undefined` \| ``null`` \| [`UpdateEventInput`](types_generatedGraphQLTypes.md#updateeventinput) | the update event input data. | +| `event` | [`InterfaceEvent`](../interfaces/models_Event.InterfaceEvent.md) | the event to be updated. | + +#### Returns + +[`InterfaceRecurringEvent`](../interfaces/helpers_event_recurringEventHelpers_generateRecurringEventInstances.InterfaceRecurringEvent.md) + +The updated event data. + +**`Remarks`** + +The following steps are followed: +1. get the current event data. +2. update the data provided in the input. + +#### Defined in + +[src/helpers/event/updateEventHelpers/getEventData.ts:18](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/updateEventHelpers/getEventData.ts#L18) diff --git a/docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateAllInstances.md b/docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateAllInstances.md new file mode 100644 index 00000000000..87d5826c72d --- /dev/null +++ b/docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateAllInstances.md @@ -0,0 +1,43 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / helpers/event/updateEventHelpers/updateAllInstances + +# Module: helpers/event/updateEventHelpers/updateAllInstances + +## Table of contents + +### Functions + +- [updateAllInstances](helpers_event_updateEventHelpers_updateAllInstances.md#updateallinstances) + +## Functions + +### updateAllInstances + +▸ **updateAllInstances**(`args`, `event`, `recurrenceRule`, `baseRecurringEvent`, `session`): `Promise`\<[`InterfaceEvent`](../interfaces/models_Event.InterfaceEvent.md)\> + +This function updates all instances of the recurring event following the given recurrenceRule. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `args` | [`MutationUpdateEventArgs`](types_generatedGraphQLTypes.md#mutationupdateeventargs) | update event args. | +| `event` | [`InterfaceEvent`](../interfaces/models_Event.InterfaceEvent.md) | the event to be updated. | +| `recurrenceRule` | [`InterfaceRecurrenceRule`](../interfaces/models_RecurrenceRule.InterfaceRecurrenceRule.md) | the recurrence rule followed by the instances. | +| `baseRecurringEvent` | [`InterfaceEvent`](../interfaces/models_Event.InterfaceEvent.md) | the base recurring event. | +| `session` | `ClientSession` | - | + +#### Returns + +`Promise`\<[`InterfaceEvent`](../interfaces/models_Event.InterfaceEvent.md)\> + +The updated event. + +**`Remarks`** + +The following steps are followed: +1. get the current event data. +2. update the data provided in the input. + +#### Defined in + +[src/helpers/event/updateEventHelpers/updateAllInstances.ts:19](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/updateEventHelpers/updateAllInstances.ts#L19) diff --git a/docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateRecurringEvent.md b/docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateRecurringEvent.md new file mode 100644 index 00000000000..95383d7e411 --- /dev/null +++ b/docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateRecurringEvent.md @@ -0,0 +1,42 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / helpers/event/updateEventHelpers/updateRecurringEvent + +# Module: helpers/event/updateEventHelpers/updateRecurringEvent + +## Table of contents + +### Functions + +- [updateRecurringEvent](helpers_event_updateEventHelpers_updateRecurringEvent.md#updaterecurringevent) + +## Functions + +### updateRecurringEvent + +▸ **updateRecurringEvent**(`args`, `event`, `session`): `Promise`\<[`InterfaceEvent`](../interfaces/models_Event.InterfaceEvent.md)\> + +This function updates the recurring event. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `args` | [`MutationUpdateEventArgs`](types_generatedGraphQLTypes.md#mutationupdateeventargs) | update event args. | +| `event` | [`InterfaceEvent`](../interfaces/models_Event.InterfaceEvent.md) | the event to be updated. | +| `session` | `ClientSession` | - | + +#### Returns + +`Promise`\<[`InterfaceEvent`](../interfaces/models_Event.InterfaceEvent.md)\> + +The updated event. + +**`Remarks`** + +The following steps are followed: +1. get the recurrence rule. +2. get the base recurring event. +3. based on the type of update, call the function required. + +#### Defined in + +[src/helpers/event/updateEventHelpers/updateRecurringEvent.ts:21](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/updateEventHelpers/updateRecurringEvent.ts#L21) diff --git a/docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateSingleEvent.md b/docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateSingleEvent.md new file mode 100644 index 00000000000..a71f13527bb --- /dev/null +++ b/docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateSingleEvent.md @@ -0,0 +1,45 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / helpers/event/updateEventHelpers/updateSingleEvent + +# Module: helpers/event/updateEventHelpers/updateSingleEvent + +## Table of contents + +### Functions + +- [updateSingleEvent](helpers_event_updateEventHelpers_updateSingleEvent.md#updatesingleevent) + +## Functions + +### updateSingleEvent + +▸ **updateSingleEvent**(`args`, `event`, `session`): `Promise`\<[`InterfaceEvent`](../interfaces/models_Event.InterfaceEvent.md)\> + +This function updates a single non-recurring event. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `args` | [`MutationUpdateEventArgs`](types_generatedGraphQLTypes.md#mutationupdateeventargs) | the arguments provided for the updateEvent mutation. | +| `event` | [`InterfaceEvent`](../interfaces/models_Event.InterfaceEvent.md) | the single event to be updated. | +| `session` | `ClientSession` | - | + +#### Returns + +`Promise`\<[`InterfaceEvent`](../interfaces/models_Event.InterfaceEvent.md)\> + +The updated event. + +**`Remarks`** + +The following steps are followed: +1. If the single event is made recurring with this update: + - get the appropriate data to create the baseRecurringEvent and recurring event instances. + - generate the instances with createRecurringEvent function. + - remove the current event and its associations as a new series has been created. +2. If it's still a non-recurring event: + - just perform a regular update. + +#### Defined in + +[src/helpers/event/updateEventHelpers/updateSingleEvent.ts:28](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/updateEventHelpers/updateSingleEvent.ts#L28) diff --git a/docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateThisAndFollowingInstances.md b/docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateThisAndFollowingInstances.md new file mode 100644 index 00000000000..4b3b5459eab --- /dev/null +++ b/docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateThisAndFollowingInstances.md @@ -0,0 +1,49 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / helpers/event/updateEventHelpers/updateThisAndFollowingInstances + +# Module: helpers/event/updateEventHelpers/updateThisAndFollowingInstances + +## Table of contents + +### Functions + +- [updateThisAndFollowingInstances](helpers_event_updateEventHelpers_updateThisAndFollowingInstances.md#updatethisandfollowinginstances) + +## Functions + +### updateThisAndFollowingInstances + +▸ **updateThisAndFollowingInstances**(`args`, `event`, `recurrenceRule`, `baseRecurringEvent`, `session`): `Promise`\<[`InterfaceEvent`](../interfaces/models_Event.InterfaceEvent.md)\> + +This function updates this and the following instances of a recurring event. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `args` | [`MutationUpdateEventArgs`](types_generatedGraphQLTypes.md#mutationupdateeventargs) | update event args. | +| `event` | [`InterfaceEvent`](../interfaces/models_Event.InterfaceEvent.md) | the event to be updated. | +| `recurrenceRule` | [`InterfaceRecurrenceRule`](../interfaces/models_RecurrenceRule.InterfaceRecurrenceRule.md) | the recurrence rule followed by the instances. | +| `baseRecurringEvent` | [`InterfaceEvent`](../interfaces/models_Event.InterfaceEvent.md) | the base recurring event. | +| `session` | `ClientSession` | - | + +#### Returns + +`Promise`\<[`InterfaceEvent`](../interfaces/models_Event.InterfaceEvent.md)\> + +The updated first instance of the recurrence rule. + +**`Remarks`** + +The following steps are followed: +1. Check if the recurrence rule has been changed. +2. If the recurrence rule has been changed. + - get the appropriate data to create the baseRecurringEvent and recurring event instances. + - generate the instances with createRecurringEvent function. + - remove the current event and its associations as a new series has been created. +3. If the recurrence rule hasn't changed: + - just perform a bulk regular update. +4. Update the base recurring event if required. + +#### Defined in + +[src/helpers/event/updateEventHelpers/updateThisAndFollowingInstances.ts:33](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/updateEventHelpers/updateThisAndFollowingInstances.ts#L33) diff --git a/docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateThisInstance.md b/docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateThisInstance.md new file mode 100644 index 00000000000..d04583ed504 --- /dev/null +++ b/docs/talawa-api-docs/modules/helpers_event_updateEventHelpers_updateThisInstance.md @@ -0,0 +1,40 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / helpers/event/updateEventHelpers/updateThisInstance + +# Module: helpers/event/updateEventHelpers/updateThisInstance + +## Table of contents + +### Functions + +- [updateThisInstance](helpers_event_updateEventHelpers_updateThisInstance.md#updatethisinstance) + +## Functions + +### updateThisInstance + +▸ **updateThisInstance**(`args`, `event`, `session`): `Promise`\<[`InterfaceEvent`](../interfaces/models_Event.InterfaceEvent.md)\> + +This function updates only this instance of a recurrence pattern. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `args` | [`MutationUpdateEventArgs`](types_generatedGraphQLTypes.md#mutationupdateeventargs) | update event args. | +| `event` | [`InterfaceEvent`](../interfaces/models_Event.InterfaceEvent.md) | the event to be updated. | +| `session` | `ClientSession` | - | + +#### Returns + +`Promise`\<[`InterfaceEvent`](../interfaces/models_Event.InterfaceEvent.md)\> + +The updated recurring event instance. + +**`Remarks`** + +The following steps are followed: +1. Update this instance. + +#### Defined in + +[src/helpers/event/updateEventHelpers/updateThisInstance.ts:16](https://github.com/adi790uu/talawa-api/blob/5146430/src/helpers/event/updateEventHelpers/updateThisInstance.ts#L16) diff --git a/docs/talawa-api-docs/modules/models_AgendaCategory.md b/docs/talawa-api-docs/modules/models_AgendaCategory.md index 4d0ad6b340e..8a941426afc 100644 --- a/docs/talawa-api-docs/modules/models_AgendaCategory.md +++ b/docs/talawa-api-docs/modules/models_AgendaCategory.md @@ -21,7 +21,7 @@ #### Defined in -[src/models/AgendaCategory.ts:65](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/AgendaCategory.ts#L65) +[src/models/AgendaCategory.ts:65](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/AgendaCategory.ts#L65) ___ @@ -29,7 +29,7 @@ ___ • `Const` **AgendaCategorySchema**: `Schema`\<`Document`\<`any`, `any`, `any`\>, `Model`\<`Document`\<`any`, `any`, `any`\>, `any`, `any`\>, `undefined`, \{\}\> -This is the Mongoose schema for an agenda category. +This is the Mongoose schema for an agenda category (test-change). **`Param`** @@ -61,4 +61,4 @@ Date when the agenda category was last updated. #### Defined in -[src/models/AgendaCategory.ts:27](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/AgendaCategory.ts#L27) +[src/models/AgendaCategory.ts:27](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/AgendaCategory.ts#L27) diff --git a/docs/talawa-api-docs/modules/models_EventProject.md b/docs/talawa-api-docs/modules/models_EventProject.md deleted file mode 100644 index 989297a024c..00000000000 --- a/docs/talawa-api-docs/modules/models_EventProject.md +++ /dev/null @@ -1,23 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / models/EventProject - -# Module: models/EventProject - -## Table of contents - -### Interfaces - -- [Interface\_EventProject](../interfaces/models_EventProject.Interface_EventProject.md) - -### Variables - -- [EventProject](models_EventProject.md#eventproject) - -## Variables - -### EventProject - -• `Const` **EventProject**: `Model`\<[`Interface_EventProject`](../interfaces/models_EventProject.Interface_EventProject.md), \{}, \{}\> - -#### Defined in - -src/models/EventProject.ts:69 diff --git a/docs/talawa-api-docs/modules/models_EventVolunteer.md b/docs/talawa-api-docs/modules/models_EventVolunteer.md index b2ec2af2edf..12da9ad0a0e 100644 --- a/docs/talawa-api-docs/modules/models_EventVolunteer.md +++ b/docs/talawa-api-docs/modules/models_EventVolunteer.md @@ -20,4 +20,4 @@ #### Defined in -[src/models/EventVolunteer.ts:58](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/EventVolunteer.ts#L58) +[src/models/EventVolunteer.ts:58](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/EventVolunteer.ts#L58) diff --git a/docs/talawa-api-docs/modules/models_Fund.md b/docs/talawa-api-docs/modules/models_Fund.md new file mode 100644 index 00000000000..57e061fd3be --- /dev/null +++ b/docs/talawa-api-docs/modules/models_Fund.md @@ -0,0 +1,23 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / models/Fund + +# Module: models/Fund + +## Table of contents + +### Interfaces + +- [InterfaceFund](../interfaces/models_Fund.InterfaceFund.md) + +### Variables + +- [Fund](models_Fund.md#fund) + +## Variables + +### Fund + +• `Const` **Fund**: `Model`\<[`InterfaceFund`](../interfaces/models_Fund.InterfaceFund.md), \{\}, \{\}\> + +#### Defined in + +[src/models/Fund.ts:74](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/Fund.ts#L74) diff --git a/docs/talawa-api-docs/modules/models_FundraisingCampaign.md b/docs/talawa-api-docs/modules/models_FundraisingCampaign.md new file mode 100644 index 00000000000..bafdc2a940a --- /dev/null +++ b/docs/talawa-api-docs/modules/models_FundraisingCampaign.md @@ -0,0 +1,27 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / models/FundraisingCampaign + +# Module: models/FundraisingCampaign + +## Table of contents + +### Enumerations + +- [CurrencyType](../enums/models_FundraisingCampaign.CurrencyType.md) + +### Interfaces + +- [InterfaceFundraisingCampaign](../interfaces/models_FundraisingCampaign.InterfaceFundraisingCampaign.md) + +### Variables + +- [FundraisingCampaign](models_FundraisingCampaign.md#fundraisingcampaign) + +## Variables + +### FundraisingCampaign + +• `Const` **FundraisingCampaign**: `Model`\<[`InterfaceFundraisingCampaign`](../interfaces/models_FundraisingCampaign.InterfaceFundraisingCampaign.md), \{\}, \{\}\> + +#### Defined in + +[src/models/FundraisingCampaign.ts:241](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaign.ts#L241) diff --git a/docs/talawa-api-docs/modules/models_FundraisingCampaignPledge.md b/docs/talawa-api-docs/modules/models_FundraisingCampaignPledge.md new file mode 100644 index 00000000000..cc0ba803be4 --- /dev/null +++ b/docs/talawa-api-docs/modules/models_FundraisingCampaignPledge.md @@ -0,0 +1,23 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / models/FundraisingCampaignPledge + +# Module: models/FundraisingCampaignPledge + +## Table of contents + +### Interfaces + +- [InterfaceFundraisingCampaignPledges](../interfaces/models_FundraisingCampaignPledge.InterfaceFundraisingCampaignPledges.md) + +### Variables + +- [FundraisingCampaignPledge](models_FundraisingCampaignPledge.md#fundraisingcampaignpledge) + +## Variables + +### FundraisingCampaignPledge + +• `Const` **FundraisingCampaignPledge**: `Model`\<[`InterfaceFundraisingCampaignPledges`](../interfaces/models_FundraisingCampaignPledge.InterfaceFundraisingCampaignPledges.md), \{\}, \{\}\> + +#### Defined in + +[src/models/FundraisingCampaignPledge.ts:64](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/FundraisingCampaignPledge.ts#L64) diff --git a/docs/talawa-api-docs/modules/models_RecurrenceRule.md b/docs/talawa-api-docs/modules/models_RecurrenceRule.md index 4bfb8753603..d634e88cd8b 100644 --- a/docs/talawa-api-docs/modules/models_RecurrenceRule.md +++ b/docs/talawa-api-docs/modules/models_RecurrenceRule.md @@ -25,4 +25,4 @@ #### Defined in -[src/models/RecurrenceRule.ts:100](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/RecurrenceRule.ts#L100) +[src/models/RecurrenceRule.ts:100](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/RecurrenceRule.ts#L100) diff --git a/docs/talawa-api-docs/modules/models_Task.md b/docs/talawa-api-docs/modules/models_Task.md deleted file mode 100644 index 75f599927c1..00000000000 --- a/docs/talawa-api-docs/modules/models_Task.md +++ /dev/null @@ -1,23 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / models/Task - -# Module: models/Task - -## Table of contents - -### Interfaces - -- [Interface\_Task](../interfaces/models_Task.Interface_Task.md) - -### Variables - -- [Task](models_Task.md#task) - -## Variables - -### Task - -• `Const` **Task**: `Model`\<[`Interface_Task`](../interfaces/models_Task.Interface_Task.md), \{}, \{}\> - -#### Defined in - -src/models/Task.ts:63 diff --git a/docs/talawa-api-docs/modules/models_userFamily.md b/docs/talawa-api-docs/modules/models_userFamily.md index 10b74a33d15..a5bc213728c 100644 --- a/docs/talawa-api-docs/modules/models_userFamily.md +++ b/docs/talawa-api-docs/modules/models_userFamily.md @@ -20,4 +20,4 @@ #### Defined in -[src/models/userFamily.ts:55](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/models/userFamily.ts#L55) +[src/models/userFamily.ts:55](https://github.com/adi790uu/talawa-api/blob/5146430/src/models/userFamily.ts#L55) diff --git a/docs/talawa-api-docs/modules/resolvers_AgendaCategory.md b/docs/talawa-api-docs/modules/resolvers_AgendaCategory.md index 8d753b153df..508c3d08a34 100644 --- a/docs/talawa-api-docs/modules/resolvers_AgendaCategory.md +++ b/docs/talawa-api-docs/modules/resolvers_AgendaCategory.md @@ -16,4 +16,4 @@ #### Defined in -[src/resolvers/AgendaCategory/index.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/AgendaCategory/index.ts#L6) +[src/resolvers/AgendaCategory/index.ts:6](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/AgendaCategory/index.ts#L6) diff --git a/docs/talawa-api-docs/modules/resolvers_AgendaCategory_createdBy.md b/docs/talawa-api-docs/modules/resolvers_AgendaCategory_createdBy.md index 8b6c5ffbd28..620bfa815e8 100644 --- a/docs/talawa-api-docs/modules/resolvers_AgendaCategory_createdBy.md +++ b/docs/talawa-api-docs/modules/resolvers_AgendaCategory_createdBy.md @@ -16,4 +16,4 @@ #### Defined in -[src/resolvers/AgendaCategory/createdBy.ts:4](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/AgendaCategory/createdBy.ts#L4) +[src/resolvers/AgendaCategory/createdBy.ts:4](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/AgendaCategory/createdBy.ts#L4) diff --git a/docs/talawa-api-docs/modules/resolvers_AgendaCategory_organization.md b/docs/talawa-api-docs/modules/resolvers_AgendaCategory_organization.md index ff660d9ae6a..6a1c90660aa 100644 --- a/docs/talawa-api-docs/modules/resolvers_AgendaCategory_organization.md +++ b/docs/talawa-api-docs/modules/resolvers_AgendaCategory_organization.md @@ -16,4 +16,4 @@ #### Defined in -[src/resolvers/AgendaCategory/organization.ts:4](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/AgendaCategory/organization.ts#L4) +[src/resolvers/AgendaCategory/organization.ts:4](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/AgendaCategory/organization.ts#L4) diff --git a/docs/talawa-api-docs/modules/resolvers_AgendaCategory_updatedBy.md b/docs/talawa-api-docs/modules/resolvers_AgendaCategory_updatedBy.md index ba93d20faac..faf626572e4 100644 --- a/docs/talawa-api-docs/modules/resolvers_AgendaCategory_updatedBy.md +++ b/docs/talawa-api-docs/modules/resolvers_AgendaCategory_updatedBy.md @@ -16,4 +16,4 @@ #### Defined in -[src/resolvers/AgendaCategory/updatedBy.ts:4](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/AgendaCategory/updatedBy.ts#L4) +[src/resolvers/AgendaCategory/updatedBy.ts:4](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/AgendaCategory/updatedBy.ts#L4) diff --git a/docs/talawa-api-docs/modules/resolvers_EventVolunteer.md b/docs/talawa-api-docs/modules/resolvers_EventVolunteer.md index 0f144cb206e..84d82e443a4 100644 --- a/docs/talawa-api-docs/modules/resolvers_EventVolunteer.md +++ b/docs/talawa-api-docs/modules/resolvers_EventVolunteer.md @@ -16,4 +16,4 @@ #### Defined in -[src/resolvers/EventVolunteer/index.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/EventVolunteer/index.ts#L6) +[src/resolvers/EventVolunteer/index.ts:6](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/EventVolunteer/index.ts#L6) diff --git a/docs/talawa-api-docs/modules/resolvers_EventVolunteer_creator.md b/docs/talawa-api-docs/modules/resolvers_EventVolunteer_creator.md index 92b42ec6e1b..0f6dcaa63ab 100644 --- a/docs/talawa-api-docs/modules/resolvers_EventVolunteer_creator.md +++ b/docs/talawa-api-docs/modules/resolvers_EventVolunteer_creator.md @@ -16,4 +16,4 @@ #### Defined in -[src/resolvers/EventVolunteer/creator.ts:4](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/EventVolunteer/creator.ts#L4) +[src/resolvers/EventVolunteer/creator.ts:4](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/EventVolunteer/creator.ts#L4) diff --git a/docs/talawa-api-docs/modules/resolvers_EventVolunteer_event.md b/docs/talawa-api-docs/modules/resolvers_EventVolunteer_event.md index b2b1d6165d3..70a21039588 100644 --- a/docs/talawa-api-docs/modules/resolvers_EventVolunteer_event.md +++ b/docs/talawa-api-docs/modules/resolvers_EventVolunteer_event.md @@ -16,4 +16,4 @@ #### Defined in -[src/resolvers/EventVolunteer/event.ts:4](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/EventVolunteer/event.ts#L4) +[src/resolvers/EventVolunteer/event.ts:4](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/EventVolunteer/event.ts#L4) diff --git a/docs/talawa-api-docs/modules/resolvers_EventVolunteer_user.md b/docs/talawa-api-docs/modules/resolvers_EventVolunteer_user.md index 1973e7b1f86..a8d512caaa5 100644 --- a/docs/talawa-api-docs/modules/resolvers_EventVolunteer_user.md +++ b/docs/talawa-api-docs/modules/resolvers_EventVolunteer_user.md @@ -16,4 +16,4 @@ #### Defined in -[src/resolvers/EventVolunteer/user.ts:4](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/EventVolunteer/user.ts#L4) +[src/resolvers/EventVolunteer/user.ts:4](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/EventVolunteer/user.ts#L4) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_addPledgeToFundraisingCampaign.md b/docs/talawa-api-docs/modules/resolvers_Mutation_addPledgeToFundraisingCampaign.md new file mode 100644 index 00000000000..c15a015fe25 --- /dev/null +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_addPledgeToFundraisingCampaign.md @@ -0,0 +1,40 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Mutation/addPledgeToFundraisingCampaign + +# Module: resolvers/Mutation/addPledgeToFundraisingCampaign + +## Table of contents + +### Variables + +- [addPledgeToFundraisingCampaign](resolvers_Mutation_addPledgeToFundraisingCampaign.md#addpledgetofundraisingcampaign) + +## Variables + +### addPledgeToFundraisingCampaign + +• `Const` **addPledgeToFundraisingCampaign**: [`MutationResolvers`](types_generatedGraphQLTypes.md#mutationresolvers)[``"addPledgeToFundraisingCampaign"``] + +This function adds campaign pledge to campaign. + +**`Param`** + +parent of current request + +**`Param`** + +payload provided with the request + +**`Param`** + +context of entire application + +**`Remarks`** + +The following checks are done: +1. If the current user exists +2. If the pledge exists +3. If the campaign exists + +#### Defined in + +[src/resolvers/Mutation/addPledgeToFundraisingCampaign.ts:28](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/addPledgeToFundraisingCampaign.ts#L28) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_addUserToUserFamily.md b/docs/talawa-api-docs/modules/resolvers_Mutation_addUserToUserFamily.md index 6a967904187..878cdabb562 100644 --- a/docs/talawa-api-docs/modules/resolvers_Mutation_addUserToUserFamily.md +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_addUserToUserFamily.md @@ -38,4 +38,4 @@ The following checks are done: #### Defined in -[src/resolvers/Mutation/addUserToUserFamily.ts:24](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/Mutation/addUserToUserFamily.ts#L24) +[src/resolvers/Mutation/addUserToUserFamily.ts:24](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/addUserToUserFamily.ts#L24) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_createAgendaCategory.md b/docs/talawa-api-docs/modules/resolvers_Mutation_createAgendaCategory.md index dee4abe285b..a12b2d56846 100644 --- a/docs/talawa-api-docs/modules/resolvers_Mutation_createAgendaCategory.md +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_createAgendaCategory.md @@ -33,4 +33,4 @@ and updates the organization with the new agenda category. #### Defined in -[src/resolvers/Mutation/createAgendaCategory.ts:23](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/Mutation/createAgendaCategory.ts#L23) +[src/resolvers/Mutation/createAgendaCategory.ts:23](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/createAgendaCategory.ts#L23) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_createEventProject.md b/docs/talawa-api-docs/modules/resolvers_Mutation_createEventProject.md deleted file mode 100644 index 77628bd6a74..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Mutation_createEventProject.md +++ /dev/null @@ -1,42 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Mutation/createEventProject - -# Module: resolvers/Mutation/createEventProject - -## Table of contents - -### Functions - -- [createEventProject](resolvers_Mutation_createEventProject.md#createeventproject) - -## Functions - -### createEventProject - -▸ **createEventProject**(`_parent`, `args`, `context`): `Promise`\<`LeanDocument`\<[`Interface_EventProject`](../interfaces/models_EventProject.Interface_EventProject.md) & `Document`\<`any`, `any`, [`Interface_EventProject`](../interfaces/models_EventProject.Interface_EventProject.md)\>\>\> - -This function enables to create an event project. - -**`Remarks`** - -The following checks are done: -1. If the user exists -2. If the event exists -3. If the user is an admin of the event. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_parent` | `any` | parent of current request | -| `args` | `any` | payload provided with the request | -| `context` | `any` | context of entire application | - -#### Returns - -`Promise`\<`LeanDocument`\<[`Interface_EventProject`](../interfaces/models_EventProject.Interface_EventProject.md) & `Document`\<`any`, `any`, [`Interface_EventProject`](../interfaces/models_EventProject.Interface_EventProject.md)\>\>\> - -Created event project - -#### Defined in - -src/resolvers/Mutation/createEventProject.ts:19 diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_createEventVolunteer.md b/docs/talawa-api-docs/modules/resolvers_Mutation_createEventVolunteer.md index 3247ebb0e79..d4df3f6c0d7 100644 --- a/docs/talawa-api-docs/modules/resolvers_Mutation_createEventVolunteer.md +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_createEventVolunteer.md @@ -37,4 +37,4 @@ The following checks are done: #### Defined in -[src/resolvers/Mutation/createEventVolunteer.ts:23](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/Mutation/createEventVolunteer.ts#L23) +[src/resolvers/Mutation/createEventVolunteer.ts:23](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/createEventVolunteer.ts#L23) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_createFund.md b/docs/talawa-api-docs/modules/resolvers_Mutation_createFund.md new file mode 100644 index 00000000000..14220c46c6f --- /dev/null +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_createFund.md @@ -0,0 +1,41 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Mutation/createFund + +# Module: resolvers/Mutation/createFund + +## Table of contents + +### Variables + +- [createFund](resolvers_Mutation_createFund.md#createfund) + +## Variables + +### createFund + +• `Const` **createFund**: [`MutationResolvers`](types_generatedGraphQLTypes.md#mutationresolvers)[``"createFund"``] + +This function enables to create an organization specific fundraising funds. + +**`Param`** + +parent of current request + +**`Param`** + +payload provided with the request + +**`Param`** + +context of entire application + +**`Remarks`** + +The following checks are done: +1. If the user exists +2. If the organization exists +3. If the user is authorized. +4. If the fund already exists + +#### Defined in + +[src/resolvers/Mutation/createFund.ts:24](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/createFund.ts#L24) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_createFundraisingCampaign.md b/docs/talawa-api-docs/modules/resolvers_Mutation_createFundraisingCampaign.md new file mode 100644 index 00000000000..8b1e8e23186 --- /dev/null +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_createFundraisingCampaign.md @@ -0,0 +1,42 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Mutation/createFundraisingCampaign + +# Module: resolvers/Mutation/createFundraisingCampaign + +## Table of contents + +### Variables + +- [createFundraisingCampaign](resolvers_Mutation_createFundraisingCampaign.md#createfundraisingcampaign) + +## Variables + +### createFundraisingCampaign + +• `Const` **createFundraisingCampaign**: [`MutationResolvers`](types_generatedGraphQLTypes.md#mutationresolvers)[``"createFundraisingCampaign"``] + +This function enables to create a fundraisingCampaigin . + +**`Param`** + +parent of current request + +**`Param`** + +payload provided with the request + +**`Param`** + +context of entire application + +**`Remarks`** + +The following checks are done: +1. If the current user exists +2 .If the startDate is valid +3. If the endDate is valid +4. if the parent fund exists +5. If the user is authorized. + +#### Defined in + +[src/resolvers/Mutation/createFundraisingCampaign.ts:26](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/createFundraisingCampaign.ts#L26) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_createFundraisingCampaignPledge.md b/docs/talawa-api-docs/modules/resolvers_Mutation_createFundraisingCampaignPledge.md new file mode 100644 index 00000000000..c4d57a684d6 --- /dev/null +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_createFundraisingCampaignPledge.md @@ -0,0 +1,41 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Mutation/createFundraisingCampaignPledge + +# Module: resolvers/Mutation/createFundraisingCampaignPledge + +## Table of contents + +### Variables + +- [createFundraisingCampaignPledge](resolvers_Mutation_createFundraisingCampaignPledge.md#createfundraisingcampaignpledge) + +## Variables + +### createFundraisingCampaignPledge + +• `Const` **createFundraisingCampaignPledge**: [`MutationResolvers`](types_generatedGraphQLTypes.md#mutationresolvers)[``"createFundraisingCampaignPledge"``] + +This function enables to create a fundraisingCampaiginPledge . + +**`Param`** + +parent of current request + +**`Param`** + +payload provided with the request + +**`Param`** + +context of entire application + +**`Remarks`** + +The following checks are done: +1. If the current user exists +2 .If the startDate is valid +3. If the endDate is valid +4. if the fund campaign exists + +#### Defined in + +[src/resolvers/Mutation/createFundraisingCampaignPledge.ts:25](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/createFundraisingCampaignPledge.ts#L25) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_createTask.md b/docs/talawa-api-docs/modules/resolvers_Mutation_createTask.md deleted file mode 100644 index 656194beeaa..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Mutation_createTask.md +++ /dev/null @@ -1,39 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Mutation/createTask - -# Module: resolvers/Mutation/createTask - -## Table of contents - -### Variables - -- [createTask](resolvers_Mutation_createTask.md#createtask) - -## Variables - -### createTask - -• `Const` **createTask**: [`MutationResolvers`](types_generatedGraphQLTypes.md#mutationresolvers)[``"createTask"``] - -This function enables to create a task. - -**`Param`** - -parent of current request - -**`Param`** - -payload provided with the request - -**`Param`** - -context of entire application - -**`Remarks`** - -The following checks are done: -1. If the user exists -2. If the event exists - -#### Defined in - -src/resolvers/Mutation/createTask.ts:15 diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_createUserFamily.md b/docs/talawa-api-docs/modules/resolvers_Mutation_createUserFamily.md index 3280e9b350a..613c33865a6 100644 --- a/docs/talawa-api-docs/modules/resolvers_Mutation_createUserFamily.md +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_createUserFamily.md @@ -37,4 +37,4 @@ context of entire application #### Defined in -[src/resolvers/Mutation/createUserFamily.ts:23](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/Mutation/createUserFamily.ts#L23) +[src/resolvers/Mutation/createUserFamily.ts:23](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/createUserFamily.ts#L23) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_deleteAgendaCategory.md b/docs/talawa-api-docs/modules/resolvers_Mutation_deleteAgendaCategory.md index 2ca5033aa17..b1aa36d9d80 100644 --- a/docs/talawa-api-docs/modules/resolvers_Mutation_deleteAgendaCategory.md +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_deleteAgendaCategory.md @@ -40,4 +40,4 @@ The input arguments for the mutation. #### Defined in -[src/resolvers/Mutation/deleteAgendaCategory.ts:23](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/Mutation/deleteAgendaCategory.ts#L23) +[src/resolvers/Mutation/deleteAgendaCategory.ts:23](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/deleteAgendaCategory.ts#L23) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_inviteEventAttendee.md b/docs/talawa-api-docs/modules/resolvers_Mutation_inviteEventAttendee.md new file mode 100644 index 00000000000..d6e68f90e8a --- /dev/null +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_inviteEventAttendee.md @@ -0,0 +1,49 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Mutation/inviteEventAttendee + +# Module: resolvers/Mutation/inviteEventAttendee + +## Table of contents + +### Variables + +- [inviteEventAttendee](resolvers_Mutation_inviteEventAttendee.md#inviteeventattendee) + +## Variables + +### inviteEventAttendee + +• `Const` **inviteEventAttendee**: [`MutationResolvers`](types_generatedGraphQLTypes.md#mutationresolvers)[``"inviteEventAttendee"``] + +Invites an attendee to an event. + +This resolver function facilitates the invitation process for an attendee to participate in an event. +It ensures the current user's authorization, validates the existence of the event, and manages the invitation status +to prevent duplicate invitations. + +**`Param`** + +The parent resolver. + +**`Param`** + +Arguments containing data for the invitation, including the eventId and userId. + +**`Param`** + +Context object providing information about the current user. + +**`Throws`** + +NotFoundError if the user or event is not found. + +**`Throws`** + +UnauthorizedError if the current user lacks authorization to invite attendees. + +**`Throws`** + +ConflictError if the user is already invited to the event. + +#### Defined in + +[src/resolvers/Mutation/inviteEventAttendee.ts:32](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/inviteEventAttendee.ts#L32) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_registerEventAttendee.md b/docs/talawa-api-docs/modules/resolvers_Mutation_registerEventAttendee.md new file mode 100644 index 00000000000..441fa6c5530 --- /dev/null +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_registerEventAttendee.md @@ -0,0 +1,45 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Mutation/registerEventAttendee + +# Module: resolvers/Mutation/registerEventAttendee + +## Table of contents + +### Variables + +- [registerEventAttendee](resolvers_Mutation_registerEventAttendee.md#registereventattendee) + +## Variables + +### registerEventAttendee + +• `Const` **registerEventAttendee**: [`MutationResolvers`](types_generatedGraphQLTypes.md#mutationresolvers)[``"registerEventAttendee"``] + +Registers an attendee for an event. + +This function handles the registration process for an attendee to participate in an event. +It checks the user's authorization, verifies the event's existence, and manages the registration status +based on whether the user was invited or directly registered. + +**`Param`** + +The parent resolver. + +**`Param`** + +Arguments passed to the resolver containing registration data. + +**`Param`** + +Context object containing user authentication and request information. + +**`Throws`** + +NotFoundError Throws a NotFoundError if the user or event is not found. + +**`Throws`** + +UnauthorizedError Throws an UnauthorizedError if the current user is not authorized to register attendees. + +#### Defined in + +[src/resolvers/Mutation/registerEventAttendee.ts:30](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/registerEventAttendee.ts#L30) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_removeEventProject.md b/docs/talawa-api-docs/modules/resolvers_Mutation_removeEventProject.md deleted file mode 100644 index 7a641ebdb94..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Mutation_removeEventProject.md +++ /dev/null @@ -1,42 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Mutation/removeEventProject - -# Module: resolvers/Mutation/removeEventProject - -## Table of contents - -### Functions - -- [removeEventProject](resolvers_Mutation_removeEventProject.md#removeeventproject) - -## Functions - -### removeEventProject - -▸ **removeEventProject**(`_parent`, `args`, `context`): `Promise`\<[`Interface_EventProject`](../interfaces/models_EventProject.Interface_EventProject.md)\> - -This function enables to remove an event project. - -**`Remarks`** - -The following checks are done: -1. If the user exists -2. If the event project exists -3. If the user is the creator of the event project. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_parent` | `any` | parent of current request | -| `args` | `any` | payload provided with the request | -| `context` | `any` | context of entire application | - -#### Returns - -`Promise`\<[`Interface_EventProject`](../interfaces/models_EventProject.Interface_EventProject.md)\> - -Deleted event project. - -#### Defined in - -src/resolvers/Mutation/removeEventProject.ts:19 diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_removeEventVolunteer.md b/docs/talawa-api-docs/modules/resolvers_Mutation_removeEventVolunteer.md index 3fdf9838fe1..305246f1f6a 100644 --- a/docs/talawa-api-docs/modules/resolvers_Mutation_removeEventVolunteer.md +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_removeEventVolunteer.md @@ -36,4 +36,4 @@ The following checks are done: #### Defined in -[src/resolvers/Mutation/removeEventVolunteer.ts:20](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/Mutation/removeEventVolunteer.ts#L20) +[src/resolvers/Mutation/removeEventVolunteer.ts:20](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/removeEventVolunteer.ts#L20) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_removeFund.md b/docs/talawa-api-docs/modules/resolvers_Mutation_removeFund.md new file mode 100644 index 00000000000..637f2c63aeb --- /dev/null +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_removeFund.md @@ -0,0 +1,41 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Mutation/removeFund + +# Module: resolvers/Mutation/removeFund + +## Table of contents + +### Variables + +- [removeFund](resolvers_Mutation_removeFund.md#removefund) + +## Variables + +### removeFund + +• `Const` **removeFund**: [`MutationResolvers`](types_generatedGraphQLTypes.md#mutationresolvers)[``"removeFund"``] + +This function enables to remove fund . + +**`Param`** + +parent of current request + +**`Param`** + +payload provided with the request + +**`Param`** + +context of entire application + +**`Remarks`** + +The following checks are done: +1. If the user exists +2. If the fund exists. +3. If the user is authorized. +4. If the user is admin of the organization. + +#### Defined in + +[src/resolvers/Mutation/removeFund.ts:24](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/removeFund.ts#L24) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_removeFundraisingCampaign.md b/docs/talawa-api-docs/modules/resolvers_Mutation_removeFundraisingCampaign.md new file mode 100644 index 00000000000..b3d96102ac1 --- /dev/null +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_removeFundraisingCampaign.md @@ -0,0 +1,41 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Mutation/removeFundraisingCampaign + +# Module: resolvers/Mutation/removeFundraisingCampaign + +## Table of contents + +### Variables + +- [removeFundraisingCampaign](resolvers_Mutation_removeFundraisingCampaign.md#removefundraisingcampaign) + +## Variables + +### removeFundraisingCampaign + +• `Const` **removeFundraisingCampaign**: [`MutationResolvers`](types_generatedGraphQLTypes.md#mutationresolvers)[``"removeFundraisingCampaign"``] + +This function enables to remove fundraising campaign . + +**`Param`** + +parent of current request + +**`Param`** + +payload provided with the request + +**`Param`** + +context of entire application + +**`Remarks`** + +The following checks are done: +1. If the user exists +2. If the fundraising campaign exists. +3. If the user is authorized. +4. If the user is admin of the organization. + +#### Defined in + +[src/resolvers/Mutation/removeFundraisingCampaign.ts:29](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/removeFundraisingCampaign.ts#L29) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_removeFundraisingCampaingPledge.md b/docs/talawa-api-docs/modules/resolvers_Mutation_removeFundraisingCampaingPledge.md new file mode 100644 index 00000000000..c1874abbdb6 --- /dev/null +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_removeFundraisingCampaingPledge.md @@ -0,0 +1,40 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Mutation/removeFundraisingCampaingPledge + +# Module: resolvers/Mutation/removeFundraisingCampaingPledge + +## Table of contents + +### Variables + +- [removeFundraisingCampaingPledge](resolvers_Mutation_removeFundraisingCampaingPledge.md#removefundraisingcampaingpledge) + +## Variables + +### removeFundraisingCampaingPledge + +• `Const` **removeFundraisingCampaingPledge**: [`MutationResolvers`](types_generatedGraphQLTypes.md#mutationresolvers)[``"removeFundraisingCampaignPledge"``] + +This function enables to remove fundraising campaign pledge . + +**`Param`** + +parent of current request + +**`Param`** + +payload provided with the request + +**`Param`** + +context of entire application + +**`Remarks`** + +The following checks are done: +1. If the user exists +2. If the fundraising campaign pledge exists. +3. If the user has made the pledge. + +#### Defined in + +[src/resolvers/Mutation/removeFundraisingCampaingPledge.ts:26](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/removeFundraisingCampaingPledge.ts#L26) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_removeTask.md b/docs/talawa-api-docs/modules/resolvers_Mutation_removeTask.md deleted file mode 100644 index 50fb166116b..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Mutation_removeTask.md +++ /dev/null @@ -1,40 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Mutation/removeTask - -# Module: resolvers/Mutation/removeTask - -## Table of contents - -### Variables - -- [removeTask](resolvers_Mutation_removeTask.md#removetask) - -## Variables - -### removeTask - -• `Const` **removeTask**: [`MutationResolvers`](types_generatedGraphQLTypes.md#mutationresolvers)[``"removeTask"``] - -This function enables to remove a task. - -**`Param`** - -parent of current request - -**`Param`** - -payload provided with the request - -**`Param`** - -context of entire application - -**`Remarks`** - -The following checks are done: -1. If the user exists. -2. If the task exists -3. If the user is the creator of the task. - -#### Defined in - -src/resolvers/Mutation/removeTask.ts:20 diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_removeUserFamily.md b/docs/talawa-api-docs/modules/resolvers_Mutation_removeUserFamily.md index e2bc176d5f3..3d71b974919 100644 --- a/docs/talawa-api-docs/modules/resolvers_Mutation_removeUserFamily.md +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_removeUserFamily.md @@ -36,4 +36,4 @@ context of entire application. #### Defined in -[src/resolvers/Mutation/removeUserFamily.ts:20](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/Mutation/removeUserFamily.ts#L20) +[src/resolvers/Mutation/removeUserFamily.ts:20](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/removeUserFamily.ts#L20) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_removeUserFromUserFamily.md b/docs/talawa-api-docs/modules/resolvers_Mutation_removeUserFromUserFamily.md index 5c63f983c44..4d2243030e5 100644 --- a/docs/talawa-api-docs/modules/resolvers_Mutation_removeUserFromUserFamily.md +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_removeUserFromUserFamily.md @@ -37,4 +37,4 @@ The following checks are done: #### Defined in -[src/resolvers/Mutation/removeUserFromUserFamily.ts:25](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/Mutation/removeUserFromUserFamily.ts#L25) +[src/resolvers/Mutation/removeUserFromUserFamily.ts:25](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/removeUserFromUserFamily.ts#L25) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_updateAgendaCategory.md b/docs/talawa-api-docs/modules/resolvers_Mutation_updateAgendaCategory.md index e5d4a1eca9f..de0accefcf5 100644 --- a/docs/talawa-api-docs/modules/resolvers_Mutation_updateAgendaCategory.md +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_updateAgendaCategory.md @@ -45,4 +45,4 @@ The context object containing user information. #### Defined in -[src/resolvers/Mutation/updateAgendaCategory.ts:28](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/Mutation/updateAgendaCategory.ts#L28) +[src/resolvers/Mutation/updateAgendaCategory.ts:28](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/updateAgendaCategory.ts#L28) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_updateEventProject.md b/docs/talawa-api-docs/modules/resolvers_Mutation_updateEventProject.md deleted file mode 100644 index 7473e335893..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Mutation_updateEventProject.md +++ /dev/null @@ -1,41 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Mutation/updateEventProject - -# Module: resolvers/Mutation/updateEventProject - -## Table of contents - -### Functions - -- [updateEventProject](resolvers_Mutation_updateEventProject.md#updateeventproject) - -## Functions - -### updateEventProject - -▸ **updateEventProject**(`_parent`, `args`, `context`): `Promise`\<``null`` \| [`Interface_EventProject`](../interfaces/models_EventProject.Interface_EventProject.md)\> - -This function enables to update an event project. - -**`Remarks`** - -The following checks are done: -1. If the user exists. -2. If the event project exists. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `_parent` | `any` | parent of current request | -| `args` | `any` | payload provided with the request | -| `context` | `any` | context of entire application | - -#### Returns - -`Promise`\<``null`` \| [`Interface_EventProject`](../interfaces/models_EventProject.Interface_EventProject.md)\> - -Updated event project. - -#### Defined in - -src/resolvers/Mutation/updateEventProject.ts:19 diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_updateEventVolunteer.md b/docs/talawa-api-docs/modules/resolvers_Mutation_updateEventVolunteer.md index 402bb65928c..dec36ec9e5a 100644 --- a/docs/talawa-api-docs/modules/resolvers_Mutation_updateEventVolunteer.md +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_updateEventVolunteer.md @@ -38,4 +38,4 @@ The following checks are done: #### Defined in -[src/resolvers/Mutation/updateEventVolunteer.ts:22](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/Mutation/updateEventVolunteer.ts#L22) +[src/resolvers/Mutation/updateEventVolunteer.ts:22](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/updateEventVolunteer.ts#L22) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_updateFund.md b/docs/talawa-api-docs/modules/resolvers_Mutation_updateFund.md new file mode 100644 index 00000000000..de1a9743ab7 --- /dev/null +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_updateFund.md @@ -0,0 +1,42 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Mutation/updateFund + +# Module: resolvers/Mutation/updateFund + +## Table of contents + +### Variables + +- [updateFund](resolvers_Mutation_updateFund.md#updatefund) + +## Variables + +### updateFund + +• `Const` **updateFund**: [`MutationResolvers`](types_generatedGraphQLTypes.md#mutationresolvers)[``"updateFund"``] + +This function enables to update an organization specific fund. + +**`Param`** + +parent of current request + +**`Param`** + +payload provided with the request + +**`Param`** + +context of entire application + +**`Remarks`** + +The following checks are done: +1. If the user exists. +2. If the Fund of the organization exists. +3. If the organization exists. +4.If the user is authorized to update the fund. +5. If the fund already exists with the same name. + +#### Defined in + +[src/resolvers/Mutation/updateFund.ts:27](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/updateFund.ts#L27) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_updateFundCampaignPledge.md b/docs/talawa-api-docs/modules/resolvers_Mutation_updateFundCampaignPledge.md new file mode 100644 index 00000000000..e487ec42712 --- /dev/null +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_updateFundCampaignPledge.md @@ -0,0 +1,42 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Mutation/updateFundCampaignPledge + +# Module: resolvers/Mutation/updateFundCampaignPledge + +## Table of contents + +### Variables + +- [updateFundraisingCampaignPledge](resolvers_Mutation_updateFundCampaignPledge.md#updatefundraisingcampaignpledge) + +## Variables + +### updateFundraisingCampaignPledge + +• `Const` **updateFundraisingCampaignPledge**: [`MutationResolvers`](types_generatedGraphQLTypes.md#mutationresolvers)[``"updateFundraisingCampaignPledge"``] + +This function enables to update a fundraising campaign pledge. + +**`Param`** + +parent of current request + +**`Param`** + +payload provided with the request + +**`Param`** + +context of entire application + +**`Remarks`** + +The following checks are done: +1. If the user exists. +2. If the FundraisingCampaignPledge exists. +3. If the user has made the pledge. +4. If the start date is valid. +5. If the end date is valid. + +#### Defined in + +[src/resolvers/Mutation/updateFundCampaignPledge.ts:29](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/updateFundCampaignPledge.ts#L29) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_updateFundraisingCampaign.md b/docs/talawa-api-docs/modules/resolvers_Mutation_updateFundraisingCampaign.md new file mode 100644 index 00000000000..7dee45a3d4a --- /dev/null +++ b/docs/talawa-api-docs/modules/resolvers_Mutation_updateFundraisingCampaign.md @@ -0,0 +1,43 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Mutation/updateFundraisingCampaign + +# Module: resolvers/Mutation/updateFundraisingCampaign + +## Table of contents + +### Variables + +- [updateFundraisingCampaign](resolvers_Mutation_updateFundraisingCampaign.md#updatefundraisingcampaign) + +## Variables + +### updateFundraisingCampaign + +• `Const` **updateFundraisingCampaign**: [`MutationResolvers`](types_generatedGraphQLTypes.md#mutationresolvers)[``"updateFundraisingCampaign"``] + +This function enables to update a fundraising campaign. + +**`Param`** + +parent of current request + +**`Param`** + +payload provided with the request + +**`Param`** + +context of entire application + +**`Remarks`** + +The following checks are done: +1. If the user exists. +2. If the FundraisingCampaign exists. +3. If the user is authorized to update the fundraising campaign. +4. If the fundraising campaign already exists with the same name. +5. If the start date is valid. +6. If the end date is valid. + +#### Defined in + +[src/resolvers/Mutation/updateFundraisingCampaign.ts:33](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Mutation/updateFundraisingCampaign.ts#L33) diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_updatePluginInstalledOrgs.md b/docs/talawa-api-docs/modules/resolvers_Mutation_updatePluginInstalledOrgs.md deleted file mode 100644 index 3cfb2cd1c0b..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Mutation_updatePluginInstalledOrgs.md +++ /dev/null @@ -1,33 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Mutation/updatePluginInstalledOrgs - -# Module: resolvers/Mutation/updatePluginInstalledOrgs - -## Table of contents - -### Variables - -- [updatePluginInstalledOrgs](resolvers_Mutation_updatePluginInstalledOrgs.md#updateplugininstalledorgs) - -## Variables - -### updatePluginInstalledOrgs - -• `Const` **updatePluginInstalledOrgs**: [`MutationResolvers`](types_generatedGraphQLTypes.md#mutationresolvers)[``"updatePluginInstalledOrgs"``] - -This function enables to update plugin installed organizations. - -**`Param`** - -parent of current request - -**`Param`** - -payload provided with the request - -**`Param`** - -context of entire application - -#### Defined in - -src/resolvers/Mutation/updatePluginInstalledOrgs.ts:12 diff --git a/docs/talawa-api-docs/modules/resolvers_Mutation_updateTask.md b/docs/talawa-api-docs/modules/resolvers_Mutation_updateTask.md deleted file mode 100644 index 1fc0c077c03..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Mutation_updateTask.md +++ /dev/null @@ -1,39 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Mutation/updateTask - -# Module: resolvers/Mutation/updateTask - -## Table of contents - -### Variables - -- [updateTask](resolvers_Mutation_updateTask.md#updatetask) - -## Variables - -### updateTask - -• `Const` **updateTask**: [`MutationResolvers`](types_generatedGraphQLTypes.md#mutationresolvers)[``"updateTask"``] - -This function enables to update a task. - -**`Param`** - -parent of current request - -**`Param`** - -payload provided with the request - -**`Param`** - -context of entire application - -**`Remarks`** - -The following checks are done: -1. If the user exists. -2. If the task exists. - -#### Defined in - -src/resolvers/Mutation/updateTask.ts:19 diff --git a/docs/talawa-api-docs/modules/resolvers_Organization_agendaCategories.md b/docs/talawa-api-docs/modules/resolvers_Organization_agendaCategories.md index fcef19eb0f2..161b5cd5635 100644 --- a/docs/talawa-api-docs/modules/resolvers_Organization_agendaCategories.md +++ b/docs/talawa-api-docs/modules/resolvers_Organization_agendaCategories.md @@ -22,4 +22,4 @@ An object that is the return value of the resolver for this field's parent. #### Defined in -[src/resolvers/Organization/agendaCategories.ts:8](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/Organization/agendaCategories.ts#L8) +[src/resolvers/Organization/agendaCategories.ts:8](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Organization/agendaCategories.ts#L8) diff --git a/docs/talawa-api-docs/modules/resolvers_Query_agendaCategory.md b/docs/talawa-api-docs/modules/resolvers_Query_agendaCategory.md index aeb6d4fc042..9134b8b5007 100644 --- a/docs/talawa-api-docs/modules/resolvers_Query_agendaCategory.md +++ b/docs/talawa-api-docs/modules/resolvers_Query_agendaCategory.md @@ -36,4 +36,4 @@ The input arguments for the query. #### Defined in -[src/resolvers/Query/agendaCategory.ts:19](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/Query/agendaCategory.ts#L19) +[src/resolvers/Query/agendaCategory.ts:19](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Query/agendaCategory.ts#L19) diff --git a/docs/talawa-api-docs/modules/resolvers_Query_comments.md b/docs/talawa-api-docs/modules/resolvers_Query_comments.md deleted file mode 100644 index 27ed9abc6d5..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Query_comments.md +++ /dev/null @@ -1,21 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Query/comments - -# Module: resolvers/Query/comments - -## Table of contents - -### Variables - -- [comments](resolvers_Query_comments.md#comments) - -## Variables - -### comments - -• `Const` **comments**: [`QueryResolvers`](types_generatedGraphQLTypes.md#queryresolvers)[``"comments"``] - -This query fetch the all existing comments from database. - -#### Defined in - -src/resolvers/Query/comments.ts:7 diff --git a/docs/talawa-api-docs/modules/resolvers_Query_commentsByPost.md b/docs/talawa-api-docs/modules/resolvers_Query_commentsByPost.md deleted file mode 100644 index 0b8c26ecdb0..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Query_commentsByPost.md +++ /dev/null @@ -1,34 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Query/commentsByPost - -# Module: resolvers/Query/commentsByPost - -## Table of contents - -### Variables - -- [commentsByPost](resolvers_Query_commentsByPost.md#commentsbypost) - -## Variables - -### commentsByPost - -• `Const` **commentsByPost**: [`QueryResolvers`](types_generatedGraphQLTypes.md#queryresolvers)[``"commentsByPost"``] - -This query will fetch all the comments for a Post from database. - -**`Param`** - -**`Param`** - -An object that contains `id` of the post. - -**`Param`** - -**`Remarks`** - -You can learn about GraphQL `Resolvers` -[here](https://www.apollographql.com/docs/apollo-server/data/resolvers/). - -#### Defined in - -src/resolvers/Query/commentsByPost.ts:19 diff --git a/docs/talawa-api-docs/modules/resolvers_Query_directChatMessages.md b/docs/talawa-api-docs/modules/resolvers_Query_directChatMessages.md deleted file mode 100644 index f35572606c5..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Query_directChatMessages.md +++ /dev/null @@ -1,21 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Query/directChatMessages - -# Module: resolvers/Query/directChatMessages - -## Table of contents - -### Variables - -- [directChatMessages](resolvers_Query_directChatMessages.md#directchatmessages) - -## Variables - -### directChatMessages - -• `Const` **directChatMessages**: [`QueryResolvers`](types_generatedGraphQLTypes.md#queryresolvers)[``"directChatMessages"``] - -This query will fetch all existing Direct chat messages from the database. - -#### Defined in - -src/resolvers/Query/directChatMessages.ts:8 diff --git a/docs/talawa-api-docs/modules/resolvers_Query_directChats.md b/docs/talawa-api-docs/modules/resolvers_Query_directChats.md deleted file mode 100644 index d819dd8df31..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Query_directChats.md +++ /dev/null @@ -1,21 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Query/directChats - -# Module: resolvers/Query/directChats - -## Table of contents - -### Variables - -- [directChats](resolvers_Query_directChats.md#directchats) - -## Variables - -### directChats - -• `Const` **directChats**: [`QueryResolvers`](types_generatedGraphQLTypes.md#queryresolvers)[``"directChats"``] - -This query will fetch all existing Direct chats from the database. - -#### Defined in - -src/resolvers/Query/directChats.ts:7 diff --git a/docs/talawa-api-docs/modules/resolvers_Query_eventVolunteersByEvent.md b/docs/talawa-api-docs/modules/resolvers_Query_eventVolunteersByEvent.md index 00d28d392aa..dbd03e22af9 100644 --- a/docs/talawa-api-docs/modules/resolvers_Query_eventVolunteersByEvent.md +++ b/docs/talawa-api-docs/modules/resolvers_Query_eventVolunteersByEvent.md @@ -24,4 +24,4 @@ An object that contains `id` of the Event. #### Defined in -[src/resolvers/Query/eventVolunteersByEvent.ts:9](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/Query/eventVolunteersByEvent.ts#L9) +[src/resolvers/Query/eventVolunteersByEvent.ts:9](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Query/eventVolunteersByEvent.ts#L9) diff --git a/docs/talawa-api-docs/modules/resolvers_Query_events.md b/docs/talawa-api-docs/modules/resolvers_Query_events.md deleted file mode 100644 index 5102250f851..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Query_events.md +++ /dev/null @@ -1,32 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Query/events - -# Module: resolvers/Query/events - -## Table of contents - -### Variables - -- [events](resolvers_Query_events.md#events) - -## Variables - -### events - -• `Const` **events**: [`QueryResolvers`](types_generatedGraphQLTypes.md#queryresolvers)[``"events"``] - -This query will fetch all events with `ACTIVE` status and sorts them as specified from database. - -**`Param`** - -**`Param`** - -An object that contains `orderBy` that helps to sort the object as specified. - -**`Remarks`** - -You can learn about GraphQL `Resolvers` -[here](https://www.apollographql.com/docs/apollo-server/data/resolvers/). - -#### Defined in - -src/resolvers/Query/events.ts:12 diff --git a/docs/talawa-api-docs/modules/resolvers_Query_getDonations.md b/docs/talawa-api-docs/modules/resolvers_Query_getDonations.md deleted file mode 100644 index a9e7d336c07..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Query_getDonations.md +++ /dev/null @@ -1,21 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Query/getDonations - -# Module: resolvers/Query/getDonations - -## Table of contents - -### Variables - -- [getDonations](resolvers_Query_getDonations.md#getdonations) - -## Variables - -### getDonations - -• `Const` **getDonations**: [`QueryResolvers`](types_generatedGraphQLTypes.md#queryresolvers)[``"getDonations"``] - -This query will fetch the list of donations as a transactions from the database. - -#### Defined in - -src/resolvers/Query/getDonations.ts:8 diff --git a/docs/talawa-api-docs/modules/resolvers_Query_getEventAttendee.md b/docs/talawa-api-docs/modules/resolvers_Query_getEventAttendee.md new file mode 100644 index 00000000000..0ff1dd4c98c --- /dev/null +++ b/docs/talawa-api-docs/modules/resolvers_Query_getEventAttendee.md @@ -0,0 +1,19 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Query/getEventAttendee + +# Module: resolvers/Query/getEventAttendee + +## Table of contents + +### Variables + +- [getEventAttendee](resolvers_Query_getEventAttendee.md#geteventattendee) + +## Variables + +### getEventAttendee + +• `Const` **getEventAttendee**: [`QueryResolvers`](types_generatedGraphQLTypes.md#queryresolvers)[``"getEventAttendee"``] + +#### Defined in + +[src/resolvers/Query/getEventAttendee.ts:4](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Query/getEventAttendee.ts#L4) diff --git a/docs/talawa-api-docs/modules/resolvers_Query_getEventAttendeesByEventId.md b/docs/talawa-api-docs/modules/resolvers_Query_getEventAttendeesByEventId.md new file mode 100644 index 00000000000..0a3ca20acf3 --- /dev/null +++ b/docs/talawa-api-docs/modules/resolvers_Query_getEventAttendeesByEventId.md @@ -0,0 +1,19 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Query/getEventAttendeesByEventId + +# Module: resolvers/Query/getEventAttendeesByEventId + +## Table of contents + +### Variables + +- [getEventAttendeesByEventId](resolvers_Query_getEventAttendeesByEventId.md#geteventattendeesbyeventid) + +## Variables + +### getEventAttendeesByEventId + +• `Const` **getEventAttendeesByEventId**: [`QueryResolvers`](types_generatedGraphQLTypes.md#queryresolvers)[``"getEventAttendeesByEventId"``] + +#### Defined in + +[src/resolvers/Query/getEventAttendeesByEventId.ts:4](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Query/getEventAttendeesByEventId.ts#L4) diff --git a/docs/talawa-api-docs/modules/resolvers_Query_getFundById.md b/docs/talawa-api-docs/modules/resolvers_Query_getFundById.md new file mode 100644 index 00000000000..b770f15424e --- /dev/null +++ b/docs/talawa-api-docs/modules/resolvers_Query_getFundById.md @@ -0,0 +1,27 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Query/getFundById + +# Module: resolvers/Query/getFundById + +## Table of contents + +### Variables + +- [getFundById](resolvers_Query_getFundById.md#getfundbyid) + +## Variables + +### getFundById + +• `Const` **getFundById**: [`QueryResolvers`](types_generatedGraphQLTypes.md#queryresolvers)[``"getFundById"``] + +This query will fetch the fund as a transaction from database. + +**`Param`** + +**`Param`** + +An object that contains `id` of the fund. + +#### Defined in + +[src/resolvers/Query/getFundById.ts:11](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Query/getFundById.ts#L11) diff --git a/docs/talawa-api-docs/modules/resolvers_Query_getFundraisingCampaign.md b/docs/talawa-api-docs/modules/resolvers_Query_getFundraisingCampaign.md new file mode 100644 index 00000000000..5c04e57c908 --- /dev/null +++ b/docs/talawa-api-docs/modules/resolvers_Query_getFundraisingCampaign.md @@ -0,0 +1,27 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Query/getFundraisingCampaign + +# Module: resolvers/Query/getFundraisingCampaign + +## Table of contents + +### Variables + +- [getFundraisingCampaignById](resolvers_Query_getFundraisingCampaign.md#getfundraisingcampaignbyid) + +## Variables + +### getFundraisingCampaignById + +• `Const` **getFundraisingCampaignById**: [`QueryResolvers`](types_generatedGraphQLTypes.md#queryresolvers)[``"getFundraisingCampaignById"``] + +This query will fetch the fundraisingCampaign as a transaction from database. + +**`Param`** + +**`Param`** + +An object that contains `id` of the campaign. + +#### Defined in + +[src/resolvers/Query/getFundraisingCampaign.ts:12](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Query/getFundraisingCampaign.ts#L12) diff --git a/docs/talawa-api-docs/modules/resolvers_Query_getFundraisingCampaignPledgeById.md b/docs/talawa-api-docs/modules/resolvers_Query_getFundraisingCampaignPledgeById.md new file mode 100644 index 00000000000..da7b5780a4b --- /dev/null +++ b/docs/talawa-api-docs/modules/resolvers_Query_getFundraisingCampaignPledgeById.md @@ -0,0 +1,27 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Query/getFundraisingCampaignPledgeById + +# Module: resolvers/Query/getFundraisingCampaignPledgeById + +## Table of contents + +### Variables + +- [getFundraisingCampaignPledgeById](resolvers_Query_getFundraisingCampaignPledgeById.md#getfundraisingcampaignpledgebyid) + +## Variables + +### getFundraisingCampaignPledgeById + +• `Const` **getFundraisingCampaignPledgeById**: [`QueryResolvers`](types_generatedGraphQLTypes.md#queryresolvers)[``"getFundraisingCampaignPledgeById"``] + +This query will fetch the fundraisingCampaignPledge as a transaction from database. + +**`Param`** + +**`Param`** + +An object that contains `id` of the fund. + +#### Defined in + +[src/resolvers/Query/getFundraisingCampaignPledgeById.ts:12](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/Query/getFundraisingCampaignPledgeById.ts#L12) diff --git a/docs/talawa-api-docs/modules/resolvers_Query_groupChatMessages.md b/docs/talawa-api-docs/modules/resolvers_Query_groupChatMessages.md deleted file mode 100644 index 7f518500c53..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Query_groupChatMessages.md +++ /dev/null @@ -1,21 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Query/groupChatMessages - -# Module: resolvers/Query/groupChatMessages - -## Table of contents - -### Variables - -- [groupChatMessages](resolvers_Query_groupChatMessages.md#groupchatmessages) - -## Variables - -### groupChatMessages - -• `Const` **groupChatMessages**: [`QueryResolvers`](types_generatedGraphQLTypes.md#queryresolvers)[``"groupChatMessages"``] - -This query fetch all the group chat messages from the database. - -#### Defined in - -src/resolvers/Query/groupChatMessages.ts:7 diff --git a/docs/talawa-api-docs/modules/resolvers_Query_groupChats.md b/docs/talawa-api-docs/modules/resolvers_Query_groupChats.md deleted file mode 100644 index eddc4437f9e..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Query_groupChats.md +++ /dev/null @@ -1,21 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Query/groupChats - -# Module: resolvers/Query/groupChats - -## Table of contents - -### Variables - -- [groupChats](resolvers_Query_groupChats.md#groupchats) - -## Variables - -### groupChats - -• `Const` **groupChats**: [`QueryResolvers`](types_generatedGraphQLTypes.md#queryresolvers)[``"groupChats"``] - -This query fetch all the group chat from the database. - -#### Defined in - -src/resolvers/Query/groupChats.ts:7 diff --git a/docs/talawa-api-docs/modules/resolvers_Query_groups.md b/docs/talawa-api-docs/modules/resolvers_Query_groups.md deleted file mode 100644 index b5093374934..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Query_groups.md +++ /dev/null @@ -1,21 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Query/groups - -# Module: resolvers/Query/groups - -## Table of contents - -### Variables - -- [groups](resolvers_Query_groups.md#groups) - -## Variables - -### groups - -• `Const` **groups**: [`QueryResolvers`](types_generatedGraphQLTypes.md#queryresolvers)[``"groups"``] - -This query fetch all the groups from the database. - -#### Defined in - -src/resolvers/Query/groups.ts:7 diff --git a/docs/talawa-api-docs/modules/resolvers_Query_isUserRegister.md b/docs/talawa-api-docs/modules/resolvers_Query_isUserRegister.md deleted file mode 100644 index 4b220865caa..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Query_isUserRegister.md +++ /dev/null @@ -1,31 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Query/isUserRegister - -# Module: resolvers/Query/isUserRegister - -## Table of contents - -### Variables - -- [isUserRegister](resolvers_Query_isUserRegister.md#isuserregister) - -## Variables - -### isUserRegister - -• `Const` **isUserRegister**: [`QueryResolvers`](types_generatedGraphQLTypes.md#queryresolvers)[``"isUserRegister"``] - -This query determines whether or not the user is registered for an event. - -**`Param`** - -**`Param`** - -An object that contains `eventId` of an event. - -**`Param`** - -An object that contains `userId` of the User. - -#### Defined in - -src/resolvers/Query/isUserRegister.ts:13 diff --git a/docs/talawa-api-docs/modules/resolvers_Query_posts.md b/docs/talawa-api-docs/modules/resolvers_Query_posts.md deleted file mode 100644 index 32b42f712df..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Query_posts.md +++ /dev/null @@ -1,31 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Query/posts - -# Module: resolvers/Query/posts - -## Table of contents - -### Variables - -- [posts](resolvers_Query_posts.md#posts) - -## Variables - -### posts - -• `Const` **posts**: [`QueryResolvers`](types_generatedGraphQLTypes.md#queryresolvers)[``"posts"``] - -The query will fetch all the Posts in specified order from the database. - -**`Param`** - -**`Param`** - -An object that contains `orderBy` field to get the data in specified order. - -**`Remarks`** - -The query function uses `getSort()` function to sort the data in specified order. - -#### Defined in - -src/resolvers/Query/posts.ts:11 diff --git a/docs/talawa-api-docs/modules/resolvers_Query_registrantsByEvent.md b/docs/talawa-api-docs/modules/resolvers_Query_registrantsByEvent.md deleted file mode 100644 index 8b78bff3e5a..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Query_registrantsByEvent.md +++ /dev/null @@ -1,27 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Query/registrantsByEvent - -# Module: resolvers/Query/registrantsByEvent - -## Table of contents - -### Variables - -- [registrantsByEvent](resolvers_Query_registrantsByEvent.md#registrantsbyevent) - -## Variables - -### registrantsByEvent - -• `Const` **registrantsByEvent**: [`QueryResolvers`](types_generatedGraphQLTypes.md#queryresolvers)[``"registrantsByEvent"``] - -This query will fetch all the registrants of the Event from the database. - -**`Param`** - -**`Param`** - -An object that contains `id` of the event. - -#### Defined in - -src/resolvers/Query/registrantsByEvent.ts:12 diff --git a/docs/talawa-api-docs/modules/resolvers_Query_tasksByEvent.md b/docs/talawa-api-docs/modules/resolvers_Query_tasksByEvent.md deleted file mode 100644 index e9eb95617c9..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Query_tasksByEvent.md +++ /dev/null @@ -1,31 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Query/tasksByEvent - -# Module: resolvers/Query/tasksByEvent - -## Table of contents - -### Variables - -- [tasksByEvent](resolvers_Query_tasksByEvent.md#tasksbyevent) - -## Variables - -### tasksByEvent - -• `Const` **tasksByEvent**: [`QueryResolvers`](types_generatedGraphQLTypes.md#queryresolvers)[``"tasksByEvent"``] - -This query will fetch the list of tasks for an Event in specified order from database. - -**`Param`** - -**`Param`** - -An object that contains `id` of an Event and `orderBy`. - -**`Remarks`** - -The query function uses `getSort()` function to sort the data in specified. - -#### Defined in - -src/resolvers/Query/tasksByEvent.ts:11 diff --git a/docs/talawa-api-docs/modules/resolvers_Query_tasksByUser.md b/docs/talawa-api-docs/modules/resolvers_Query_tasksByUser.md deleted file mode 100644 index b516e8d2047..00000000000 --- a/docs/talawa-api-docs/modules/resolvers_Query_tasksByUser.md +++ /dev/null @@ -1,27 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / resolvers/Query/tasksByUser - -# Module: resolvers/Query/tasksByUser - -## Table of contents - -### Variables - -- [tasksByUser](resolvers_Query_tasksByUser.md#tasksbyuser) - -## Variables - -### tasksByUser - -• `Const` **tasksByUser**: [`QueryResolvers`](types_generatedGraphQLTypes.md#queryresolvers)[``"tasksByUser"``] - -This query will fetch the list of tasks created by the user in an specified order from the database. - -**`Param`** - -**`Param`** - -An object that contains `id` of the user and `orderBy`. - -#### Defined in - -src/resolvers/Query/tasksByUser.ts:10 diff --git a/docs/talawa-api-docs/modules/resolvers_UserFamily.md b/docs/talawa-api-docs/modules/resolvers_UserFamily.md index d1fc18e4a9d..a52dfba0bf7 100644 --- a/docs/talawa-api-docs/modules/resolvers_UserFamily.md +++ b/docs/talawa-api-docs/modules/resolvers_UserFamily.md @@ -16,4 +16,4 @@ #### Defined in -[src/resolvers/UserFamily/index.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/UserFamily/index.ts#L6) +[src/resolvers/UserFamily/index.ts:6](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/UserFamily/index.ts#L6) diff --git a/docs/talawa-api-docs/modules/resolvers_UserFamily_admins.md b/docs/talawa-api-docs/modules/resolvers_UserFamily_admins.md index e3b8bb0757a..ecc7e92b3c1 100644 --- a/docs/talawa-api-docs/modules/resolvers_UserFamily_admins.md +++ b/docs/talawa-api-docs/modules/resolvers_UserFamily_admins.md @@ -22,4 +22,4 @@ An object that is the return value of the resolver for this field's parent. #### Defined in -[src/resolvers/UserFamily/admins.ts:8](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/UserFamily/admins.ts#L8) +[src/resolvers/UserFamily/admins.ts:8](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/UserFamily/admins.ts#L8) diff --git a/docs/talawa-api-docs/modules/resolvers_UserFamily_creator.md b/docs/talawa-api-docs/modules/resolvers_UserFamily_creator.md index 625d93eb09e..a11bdc35156 100644 --- a/docs/talawa-api-docs/modules/resolvers_UserFamily_creator.md +++ b/docs/talawa-api-docs/modules/resolvers_UserFamily_creator.md @@ -22,4 +22,4 @@ An object that is the return value of the resolver for this field's parent. #### Defined in -[src/resolvers/UserFamily/creator.ts:10](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/UserFamily/creator.ts#L10) +[src/resolvers/UserFamily/creator.ts:10](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/UserFamily/creator.ts#L10) diff --git a/docs/talawa-api-docs/modules/resolvers_UserFamily_users.md b/docs/talawa-api-docs/modules/resolvers_UserFamily_users.md index d059ebcd595..6649ecbbcb8 100644 --- a/docs/talawa-api-docs/modules/resolvers_UserFamily_users.md +++ b/docs/talawa-api-docs/modules/resolvers_UserFamily_users.md @@ -22,4 +22,4 @@ An object that is the return value of the resolver for this field's parent. #### Defined in -[src/resolvers/UserFamily/users.ts:8](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/resolvers/UserFamily/users.ts#L8) +[src/resolvers/UserFamily/users.ts:8](https://github.com/adi790uu/talawa-api/blob/5146430/src/resolvers/UserFamily/users.ts#L8) diff --git a/docs/talawa-api-docs/modules/utilities_checkReplicaSet.md b/docs/talawa-api-docs/modules/utilities_checkReplicaSet.md new file mode 100644 index 00000000000..2ad050f01cb --- /dev/null +++ b/docs/talawa-api-docs/modules/utilities_checkReplicaSet.md @@ -0,0 +1,23 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / utilities/checkReplicaSet + +# Module: utilities/checkReplicaSet + +## Table of contents + +### Functions + +- [checkReplicaSet](utilities_checkReplicaSet.md#checkreplicaset) + +## Functions + +### checkReplicaSet + +▸ **checkReplicaSet**(): `Promise`\<`boolean`\> + +#### Returns + +`Promise`\<`boolean`\> + +#### Defined in + +[src/utilities/checkReplicaSet.ts:4](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/checkReplicaSet.ts#L4) diff --git a/docs/talawa-api-docs/modules/utilities_dateValidator.md b/docs/talawa-api-docs/modules/utilities_dateValidator.md new file mode 100644 index 00000000000..b3cdc11cec3 --- /dev/null +++ b/docs/talawa-api-docs/modules/utilities_dateValidator.md @@ -0,0 +1,32 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / utilities/dateValidator + +# Module: utilities/dateValidator + +## Table of contents + +### Functions + +- [validateDate](utilities_dateValidator.md#validatedate) + +## Functions + +### validateDate + +▸ **validateDate**(`startDate`, `endDate`): `void` + +This function validates the date. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `startDate` | `Date` | starting Date | +| `endDate` | `Date` | Ending Date | + +#### Returns + +`void` + +#### Defined in + +[src/utilities/dateValidator.ts:11](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/dateValidator.ts#L11) diff --git a/docs/talawa-api-docs/modules/utilities_graphQLConnection.md b/docs/talawa-api-docs/modules/utilities_graphQLConnection.md new file mode 100644 index 00000000000..0bdbdd1b478 --- /dev/null +++ b/docs/talawa-api-docs/modules/utilities_graphQLConnection.md @@ -0,0 +1,298 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / utilities/graphQLConnection + +# Module: utilities/graphQLConnection + +## Table of contents + +### References + +- [CreateCursor](utilities_graphQLConnection.md#createcursor) +- [CreateNode](utilities_graphQLConnection.md#createnode) +- [DefaultGraphQLConnection](utilities_graphQLConnection.md#defaultgraphqlconnection) +- [DefaultGraphQLConnectionEdge](utilities_graphQLConnection.md#defaultgraphqlconnectionedge) +- [ParseGraphQLConnectionArgumentsResult](utilities_graphQLConnection.md#parsegraphqlconnectionargumentsresult) +- [ParseGraphQLConnectionArgumentsWithSortedByAndWhereResult](utilities_graphQLConnection.md#parsegraphqlconnectionargumentswithsortedbyandwhereresult) +- [ParseGraphQLConnectionArgumentsWithSortedByResult](utilities_graphQLConnection.md#parsegraphqlconnectionargumentswithsortedbyresult) +- [ParseGraphQLConnectionArgumentsWithWhereResult](utilities_graphQLConnection.md#parsegraphqlconnectionargumentswithwhereresult) +- [ParseGraphQLConnectionCursor](utilities_graphQLConnection.md#parsegraphqlconnectioncursor) +- [ParseGraphQLConnectionCursorArguments](utilities_graphQLConnection.md#parsegraphqlconnectioncursorarguments) +- [ParseGraphQLConnectionCursorResult](utilities_graphQLConnection.md#parsegraphqlconnectioncursorresult) +- [ParseGraphQLConnectionSortedByResult](utilities_graphQLConnection.md#parsegraphqlconnectionsortedbyresult) +- [ParseGraphQLConnectionWhereResult](utilities_graphQLConnection.md#parsegraphqlconnectionwhereresult) +- [ParsedGraphQLConnectionArguments](utilities_graphQLConnection.md#parsedgraphqlconnectionarguments) +- [ParsedGraphQLConnectionArgumentsWithSortedBy](utilities_graphQLConnection.md#parsedgraphqlconnectionargumentswithsortedby) +- [ParsedGraphQLConnectionArgumentsWithSortedByAndWhere](utilities_graphQLConnection.md#parsedgraphqlconnectionargumentswithsortedbyandwhere) +- [ParsedGraphQLConnectionArgumentsWithWhere](utilities_graphQLConnection.md#parsedgraphqlconnectionargumentswithwhere) +- [TransformToDefaultGraphQLConnectionArguments](utilities_graphQLConnection.md#transformtodefaultgraphqlconnectionarguments) +- [generateDefaultGraphQLConnection](utilities_graphQLConnection.md#generatedefaultgraphqlconnection) +- [getCommonGraphQLConnectionFilter](utilities_graphQLConnection.md#getcommongraphqlconnectionfilter) +- [getCommonGraphQLConnectionSort](utilities_graphQLConnection.md#getcommongraphqlconnectionsort) +- [parseGraphQLConnectionArguments](utilities_graphQLConnection.md#parsegraphqlconnectionarguments) +- [parseGraphQLConnectionArgumentsWithSortedBy](utilities_graphQLConnection.md#parsegraphqlconnectionargumentswithsortedby) +- [parseGraphQLConnectionArgumentsWithSortedByAndWhere](utilities_graphQLConnection.md#parsegraphqlconnectionargumentswithsortedbyandwhere) +- [parseGraphQLConnectionArgumentsWithWhere](utilities_graphQLConnection.md#parsegraphqlconnectionargumentswithwhere) +- [transformToDefaultGraphQLConnection](utilities_graphQLConnection.md#transformtodefaultgraphqlconnection) + +### Type Aliases + +- [DefaultGraphQLArgumentError](utilities_graphQLConnection.md#defaultgraphqlargumenterror) +- [DefaultGraphQLConnectionArguments](utilities_graphQLConnection.md#defaultgraphqlconnectionarguments) +- [GraphQLConnectionTraversalDirection](utilities_graphQLConnection.md#graphqlconnectiontraversaldirection) + +### Functions + +- [isNotNullish](utilities_graphQLConnection.md#isnotnullish) + +## References + +### CreateCursor + +Re-exports [CreateCursor](utilities_graphQLConnection_transformToDefaultGraphQLConnection.md#createcursor) + +___ + +### CreateNode + +Re-exports [CreateNode](utilities_graphQLConnection_transformToDefaultGraphQLConnection.md#createnode) + +___ + +### DefaultGraphQLConnection + +Re-exports [DefaultGraphQLConnection](utilities_graphQLConnection_generateDefaultGraphQLConnection.md#defaultgraphqlconnection) + +___ + +### DefaultGraphQLConnectionEdge + +Re-exports [DefaultGraphQLConnectionEdge](utilities_graphQLConnection_generateDefaultGraphQLConnection.md#defaultgraphqlconnectionedge) + +___ + +### ParseGraphQLConnectionArgumentsResult + +Re-exports [ParseGraphQLConnectionArgumentsResult](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectionargumentsresult) + +___ + +### ParseGraphQLConnectionArgumentsWithSortedByAndWhereResult + +Re-exports [ParseGraphQLConnectionArgumentsWithSortedByAndWhereResult](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedByAndWhere.md#parsegraphqlconnectionargumentswithsortedbyandwhereresult) + +___ + +### ParseGraphQLConnectionArgumentsWithSortedByResult + +Re-exports [ParseGraphQLConnectionArgumentsWithSortedByResult](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedBy.md#parsegraphqlconnectionargumentswithsortedbyresult) + +___ + +### ParseGraphQLConnectionArgumentsWithWhereResult + +Re-exports [ParseGraphQLConnectionArgumentsWithWhereResult](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithWhere.md#parsegraphqlconnectionargumentswithwhereresult) + +___ + +### ParseGraphQLConnectionCursor + +Re-exports [ParseGraphQLConnectionCursor](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectioncursor) + +___ + +### ParseGraphQLConnectionCursorArguments + +Re-exports [ParseGraphQLConnectionCursorArguments](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectioncursorarguments) + +___ + +### ParseGraphQLConnectionCursorResult + +Re-exports [ParseGraphQLConnectionCursorResult](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectioncursorresult) + +___ + +### ParseGraphQLConnectionSortedByResult + +Re-exports [ParseGraphQLConnectionSortedByResult](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedBy.md#parsegraphqlconnectionsortedbyresult) + +___ + +### ParseGraphQLConnectionWhereResult + +Re-exports [ParseGraphQLConnectionWhereResult](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithWhere.md#parsegraphqlconnectionwhereresult) + +___ + +### ParsedGraphQLConnectionArguments + +Re-exports [ParsedGraphQLConnectionArguments](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsedgraphqlconnectionarguments) + +___ + +### ParsedGraphQLConnectionArgumentsWithSortedBy + +Re-exports [ParsedGraphQLConnectionArgumentsWithSortedBy](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedBy.md#parsedgraphqlconnectionargumentswithsortedby) + +___ + +### ParsedGraphQLConnectionArgumentsWithSortedByAndWhere + +Re-exports [ParsedGraphQLConnectionArgumentsWithSortedByAndWhere](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedByAndWhere.md#parsedgraphqlconnectionargumentswithsortedbyandwhere) + +___ + +### ParsedGraphQLConnectionArgumentsWithWhere + +Re-exports [ParsedGraphQLConnectionArgumentsWithWhere](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithWhere.md#parsedgraphqlconnectionargumentswithwhere) + +___ + +### TransformToDefaultGraphQLConnectionArguments + +Re-exports [TransformToDefaultGraphQLConnectionArguments](utilities_graphQLConnection_transformToDefaultGraphQLConnection.md#transformtodefaultgraphqlconnectionarguments) + +___ + +### generateDefaultGraphQLConnection + +Re-exports [generateDefaultGraphQLConnection](utilities_graphQLConnection_generateDefaultGraphQLConnection.md#generatedefaultgraphqlconnection) + +___ + +### getCommonGraphQLConnectionFilter + +Re-exports [getCommonGraphQLConnectionFilter](utilities_graphQLConnection_getCommonGraphQLConnectionFilter.md#getcommongraphqlconnectionfilter) + +___ + +### getCommonGraphQLConnectionSort + +Re-exports [getCommonGraphQLConnectionSort](utilities_graphQLConnection_getCommonGraphQLConnectionSort.md#getcommongraphqlconnectionsort) + +___ + +### parseGraphQLConnectionArguments + +Re-exports [parseGraphQLConnectionArguments](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectionarguments) + +___ + +### parseGraphQLConnectionArgumentsWithSortedBy + +Re-exports [parseGraphQLConnectionArgumentsWithSortedBy](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedBy.md#parsegraphqlconnectionargumentswithsortedby) + +___ + +### parseGraphQLConnectionArgumentsWithSortedByAndWhere + +Re-exports [parseGraphQLConnectionArgumentsWithSortedByAndWhere](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedByAndWhere.md#parsegraphqlconnectionargumentswithsortedbyandwhere) + +___ + +### parseGraphQLConnectionArgumentsWithWhere + +Re-exports [parseGraphQLConnectionArgumentsWithWhere](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithWhere.md#parsegraphqlconnectionargumentswithwhere) + +___ + +### transformToDefaultGraphQLConnection + +Re-exports [transformToDefaultGraphQLConnection](utilities_graphQLConnection_transformToDefaultGraphQLConnection.md#transformtodefaultgraphqlconnection) + +## Type Aliases + +### DefaultGraphQLArgumentError + +Ƭ **DefaultGraphQLArgumentError**: `Object` + +This is typescript type of a base graphQL argument error. This argument error type can be +extended to create custom argument error types as long as they adhere to the default type of +this base graphQL argument error. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `path` | `string`[] | + +#### Defined in + +[src/utilities/graphQLConnection/index.ts:24](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/index.ts#L24) + +___ + +### DefaultGraphQLConnectionArguments + +Ƭ **DefaultGraphQLConnectionArguments**: `Object` + +This is typescript type of the standard arguments object received by a graphQL connection +following the relay cursor connection specification, more info here:- [https://relay.dev/graphql/connections.htm](https://relay.dev/graphql/connections.htm) + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `after?` | `string` \| ``null`` | +| `before?` | `string` \| ``null`` | +| `first?` | `number` \| ``null`` | +| `last?` | `number` \| ``null`` | + +#### Defined in + +[src/utilities/graphQLConnection/index.ts:33](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/index.ts#L33) + +___ + +### GraphQLConnectionTraversalDirection + +Ƭ **GraphQLConnectionTraversalDirection**: ``"FORWARD"`` \| ``"BACKWARD"`` + +This is typescript type of the direction the graphQL connection is to be traversed in. + +#### Defined in + +[src/utilities/graphQLConnection/index.ts:43](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/index.ts#L43) + +## Functions + +### isNotNullish + +▸ **isNotNullish**\<`T0`\>(`value`): value is T0 + +This function is used to check nullish state of a value passed to it. Nullish means the +value being either `null` or `undefined`. If the value is found to be nullish, the function +returns the boolean `false`, else it returns the boolean `true`. + +#### Type parameters + +| Name | +| :------ | +| `T0` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `undefined` \| ``null`` \| `T0` | + +#### Returns + +value is T0 + +**`Example`** + +```ts +Here's an example:- +function print(str: string | null) \{ + if(isNotNullish(str)) \{ + console.log(`the string is $\{str\}`) + \} else \{ + console.log(`the string is null`) + \} +\} +``` + +#### Defined in + +[src/utilities/graphQLConnection/index.ts:15](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/index.ts#L15) diff --git a/docs/talawa-api-docs/modules/utilities_graphQLConnection_generateDefaultGraphQLConnection.md b/docs/talawa-api-docs/modules/utilities_graphQLConnection_generateDefaultGraphQLConnection.md new file mode 100644 index 00000000000..a90e7d9e32c --- /dev/null +++ b/docs/talawa-api-docs/modules/utilities_graphQLConnection_generateDefaultGraphQLConnection.md @@ -0,0 +1,98 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / utilities/graphQLConnection/generateDefaultGraphQLConnection + +# Module: utilities/graphQLConnection/generateDefaultGraphQLConnection + +## Table of contents + +### Type Aliases + +- [DefaultGraphQLConnection](utilities_graphQLConnection_generateDefaultGraphQLConnection.md#defaultgraphqlconnection) +- [DefaultGraphQLConnectionEdge](utilities_graphQLConnection_generateDefaultGraphQLConnection.md#defaultgraphqlconnectionedge) + +### Functions + +- [generateDefaultGraphQLConnection](utilities_graphQLConnection_generateDefaultGraphQLConnection.md#generatedefaultgraphqlconnection) + +## Type Aliases + +### DefaultGraphQLConnection + +Ƭ **DefaultGraphQLConnection**\<`T0`\>: `Object` + +This is typescript type of a base graphQL connection object. This connection object can be +extended to create a custom connnection object as long as the new connection object adheres +to the default type of this base connection object. + +#### Type parameters + +| Name | +| :------ | +| `T0` | + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `edges` | [`DefaultGraphQLConnectionEdge`](utilities_graphQLConnection_generateDefaultGraphQLConnection.md#defaultgraphqlconnectionedge)\<`T0`\>[] | +| `pageInfo` | [`ConnectionPageInfo`](types_generatedGraphQLTypes.md#connectionpageinfo) | +| `totalCount` | `number` | + +#### Defined in + +[src/utilities/graphQLConnection/generateDefaultGraphQLConnection.ts:18](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/generateDefaultGraphQLConnection.ts#L18) + +___ + +### DefaultGraphQLConnectionEdge + +Ƭ **DefaultGraphQLConnectionEdge**\<`T0`\>: `Object` + +This is typescript type of a base graphQL connection edge object. This connection edge object +can be extended to create a custom connection edge object as long as the new connection edge +object adheres to the default type of this base connection edge object. + +#### Type parameters + +| Name | +| :------ | +| `T0` | + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `cursor` | `string` | +| `node` | `T0` | + +#### Defined in + +[src/utilities/graphQLConnection/generateDefaultGraphQLConnection.ts:8](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/generateDefaultGraphQLConnection.ts#L8) + +## Functions + +### generateDefaultGraphQLConnection + +▸ **generateDefaultGraphQLConnection**\<`T0`\>(): [`DefaultGraphQLConnection`](utilities_graphQLConnection_generateDefaultGraphQLConnection.md#defaultgraphqlconnection)\<`T0`\> + +This is a factory function to create a base graphql connection object with default fields +that correspond to a connection with no data and no traversal properties in any direction. + +#### Type parameters + +| Name | +| :------ | +| `T0` | + +#### Returns + +[`DefaultGraphQLConnection`](utilities_graphQLConnection_generateDefaultGraphQLConnection.md#defaultgraphqlconnection)\<`T0`\> + +**`Example`** + +```ts +const connection = generateDefaultGraphQLConnection(); +``` + +#### Defined in + +[src/utilities/graphQLConnection/generateDefaultGraphQLConnection.ts:30](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/generateDefaultGraphQLConnection.ts#L30) diff --git a/docs/talawa-api-docs/modules/utilities_graphQLConnection_getCommonGraphQLConnectionFilter.md b/docs/talawa-api-docs/modules/utilities_graphQLConnection_getCommonGraphQLConnectionFilter.md new file mode 100644 index 00000000000..c5b5e6a2075 --- /dev/null +++ b/docs/talawa-api-docs/modules/utilities_graphQLConnection_getCommonGraphQLConnectionFilter.md @@ -0,0 +1,57 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / utilities/graphQLConnection/getCommonGraphQLConnectionFilter + +# Module: utilities/graphQLConnection/getCommonGraphQLConnectionFilter + +## Table of contents + +### Functions + +- [getCommonGraphQLConnectionFilter](utilities_graphQLConnection_getCommonGraphQLConnectionFilter.md#getcommongraphqlconnectionfilter) + +## Functions + +### getCommonGraphQLConnectionFilter + +▸ **getCommonGraphQLConnectionFilter**(`«destructured»`): `CommonGraphQLConnectionFilter` + +This function is used to get an object containing common mongoose filtering logic. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `«destructured»` | `Object` | +| › `cursor` | ``null`` \| `string` | +| › `direction` | [`GraphQLConnectionTraversalDirection`](utilities_graphQLConnection.md#graphqlconnectiontraversaldirection) | + +#### Returns + +`CommonGraphQLConnectionFilter` + +**`Remarks`** + +Here are a few assumptions this function makes which are common to most of the +graphQL connections. + +The entity that has the latest creation datetime must appear at the top of the connection. This +means the default filtering logic would be to filter in descending order by the time of creation of +an entity, and if two or more entities have the same time of creation filtering in descending order +by the primary key of the entity. MongoDB object ids are lexographically sortable all on their own +because they contain information about both the creation time and primary key for the document. + +Therefore, this function only returns filtering logic for filtering by the object id of a mongoDB +document. + +**`Example`** + +```ts +const filter = getCommonGraphQLConnectionFilter(\{ + cursor: "65da3f8df35eb5bfd52c5368", + direction: "BACKWARD" +\}); +const objectList = await User.find(filter).limit(10); +``` + +#### Defined in + +[src/utilities/graphQLConnection/getCommonGraphQLConnectionFilter.ts:44](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/getCommonGraphQLConnectionFilter.ts#L44) diff --git a/docs/talawa-api-docs/modules/utilities_graphQLConnection_getCommonGraphQLConnectionSort.md b/docs/talawa-api-docs/modules/utilities_graphQLConnection_getCommonGraphQLConnectionSort.md new file mode 100644 index 00000000000..4112195f0b0 --- /dev/null +++ b/docs/talawa-api-docs/modules/utilities_graphQLConnection_getCommonGraphQLConnectionSort.md @@ -0,0 +1,55 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / utilities/graphQLConnection/getCommonGraphQLConnectionSort + +# Module: utilities/graphQLConnection/getCommonGraphQLConnectionSort + +## Table of contents + +### Functions + +- [getCommonGraphQLConnectionSort](utilities_graphQLConnection_getCommonGraphQLConnectionSort.md#getcommongraphqlconnectionsort) + +## Functions + +### getCommonGraphQLConnectionSort + +▸ **getCommonGraphQLConnectionSort**(`«destructured»`): `CommmonGraphQLConnectionSort` + +This function is used to get an object containing common mongoose sorting logic. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `«destructured»` | `Object` | +| › `direction` | [`GraphQLConnectionTraversalDirection`](utilities_graphQLConnection.md#graphqlconnectiontraversaldirection) | + +#### Returns + +`CommmonGraphQLConnectionSort` + +**`Remarks`** + +Here are a few assumptions this function makes which are common to most of the +graphQL connections. + +The entity that has the latest creation datetime must appear at the top of the connection. This +means the default sorting logic would be sorting in descending order by the time of creation of +an entity, and if two or more entities have the same time of creation sorting in descending order +by the primary key of the entity. MongoDB object ids are lexographically sortable all on their own +because they contain information about both the creation time and primary key for the document. + +Therefore, this function only returns sorting logic for sorting by the object id of a mongoDB +document. + +**`Example`** + +```ts +const sort = getCommonGraphQLConnectionSort(\{ + direction: "BACKWARD" + \}); +const objectList = await User.find().sort(sort).limit(10); +``` + +#### Defined in + +[src/utilities/graphQLConnection/getCommonGraphQLConnectionSort.ts:34](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/getCommonGraphQLConnectionSort.ts#L34) diff --git a/docs/talawa-api-docs/modules/utilities_graphQLConnection_parseGraphQLConnectionArguments.md b/docs/talawa-api-docs/modules/utilities_graphQLConnection_parseGraphQLConnectionArguments.md new file mode 100644 index 00000000000..700f352c47d --- /dev/null +++ b/docs/talawa-api-docs/modules/utilities_graphQLConnection_parseGraphQLConnectionArguments.md @@ -0,0 +1,190 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / utilities/graphQLConnection/parseGraphQLConnectionArguments + +# Module: utilities/graphQLConnection/parseGraphQLConnectionArguments + +## Table of contents + +### Type Aliases + +- [ParseGraphQLConnectionArgumentsResult](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectionargumentsresult) +- [ParseGraphQLConnectionCursor](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectioncursor) +- [ParseGraphQLConnectionCursorArguments](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectioncursorarguments) +- [ParseGraphQLConnectionCursorResult](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectioncursorresult) +- [ParsedGraphQLConnectionArguments](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsedgraphqlconnectionarguments) + +### Functions + +- [parseGraphQLConnectionArguments](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectionarguments) + +## Type Aliases + +### ParseGraphQLConnectionArgumentsResult + +Ƭ **ParseGraphQLConnectionArgumentsResult**\<`T0`\>: \{ `errors`: [`DefaultGraphQLArgumentError`](utilities_graphQLConnection.md#defaultgraphqlargumenterror)[] ; `isSuccessful`: ``false`` \} \| \{ `isSuccessful`: ``true`` ; `parsedArgs`: [`ParsedGraphQLConnectionArguments`](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsedgraphqlconnectionarguments)\<`T0`\> \} + +This is typescript type of the object returned from `parseGraphQLConnectionArguments` +function. + +#### Type parameters + +| Name | +| :------ | +| `T0` | + +#### Defined in + +[src/utilities/graphQLConnection/parseGraphQLConnectionArguments.ts:57](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/parseGraphQLConnectionArguments.ts#L57) + +___ + +### ParseGraphQLConnectionCursor + +Ƭ **ParseGraphQLConnectionCursor**\<`T0`\>: (`args`: [`ParseGraphQLConnectionCursorArguments`](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectioncursorarguments)) =\> [`ParseGraphQLConnectionCursorResult`](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectioncursorresult)\<`T0`\> + +This is typescript type of the callback function `parseCursor`. + +#### Type parameters + +| Name | +| :------ | +| `T0` | + +#### Type declaration + +▸ (`args`): [`ParseGraphQLConnectionCursorResult`](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectioncursorresult)\<`T0`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `args` | [`ParseGraphQLConnectionCursorArguments`](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectioncursorarguments) | + +##### Returns + +[`ParseGraphQLConnectionCursorResult`](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectioncursorresult)\<`T0`\> + +#### Defined in + +[src/utilities/graphQLConnection/parseGraphQLConnectionArguments.ts:39](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/parseGraphQLConnectionArguments.ts#L39) + +___ + +### ParseGraphQLConnectionCursorArguments + +Ƭ **ParseGraphQLConnectionCursorArguments**: `Object` + +This is typescript type of the single object callback function `parseCursor` takes in as +an argument. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `cursorName` | ``"after"`` \| ``"before"`` | +| `cursorPath` | `string`[] | +| `cursorValue` | `string` | + +#### Defined in + +[src/utilities/graphQLConnection/parseGraphQLConnectionArguments.ts:13](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/parseGraphQLConnectionArguments.ts#L13) + +___ + +### ParseGraphQLConnectionCursorResult + +Ƭ **ParseGraphQLConnectionCursorResult**\<`T0`\>: `Promise`\<\{ `errors`: [`DefaultGraphQLArgumentError`](utilities_graphQLConnection.md#defaultgraphqlargumenterror)[] ; `isSuccessful`: ``false`` \} \| \{ `isSuccessful`: ``true`` ; `parsedCursor`: `T0` \}\> + +This is typescript type of object returned from the callback function `parseCursor` passed +as an argument to `parseGraphQLConnectionArguments`, `parseGraphQLConnectionArgumentsWithSortedBy`, +`parseGraphQLConnectionArgumentsWithWhere` and `parseGraphQLConnectionArgumentsWithSortedByAndWhere` +functions. + +#### Type parameters + +| Name | +| :------ | +| `T0` | + +#### Defined in + +[src/utilities/graphQLConnection/parseGraphQLConnectionArguments.ts:25](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/parseGraphQLConnectionArguments.ts#L25) + +___ + +### ParsedGraphQLConnectionArguments + +Ƭ **ParsedGraphQLConnectionArguments**\<`T0`\>: `Object` + +This is typescript type of the object containing the validated and transformed connection +arguments passed to `parseGraphQLConnectionArguments` function. + +#### Type parameters + +| Name | +| :------ | +| `T0` | + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `cursor` | `T0` \| ``null`` | +| `direction` | [`GraphQLConnectionTraversalDirection`](utilities_graphQLConnection.md#graphqlconnectiontraversaldirection) | +| `limit` | `number` | + +#### Defined in + +[src/utilities/graphQLConnection/parseGraphQLConnectionArguments.ts:47](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/parseGraphQLConnectionArguments.ts#L47) + +## Functions + +### parseGraphQLConnectionArguments + +▸ **parseGraphQLConnectionArguments**\<`T0`\>(`«destructured»`): `Promise`\<[`ParseGraphQLConnectionArgumentsResult`](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectionargumentsresult)\<`T0`\>\> + +This function handles validating and transforming arguments of a base graphQL connection. + +#### Type parameters + +| Name | +| :------ | +| `T0` | + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `«destructured»` | `Object` | `undefined` | +| › `args` | [`DefaultGraphQLConnectionArguments`](utilities_graphQLConnection.md#defaultgraphqlconnectionarguments) | `undefined` | +| › `maximumLimit?` | `number` | `MAXIMUM_FETCH_LIMIT` | +| › `parseCursor` | [`ParseGraphQLConnectionCursor`](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectioncursor)\<`T0`\> | `undefined` | + +#### Returns + +`Promise`\<[`ParseGraphQLConnectionArgumentsResult`](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectionargumentsresult)\<`T0`\>\> + +**`Example`** + +```ts +const result = await parseGraphQLConnectionArguments(\{ + args: \{ + after, + first, + \}, + maximumLimit: 20, + parseCursor +\}) +if (result.isSuccessful === false) \{ + throw new GraphQLError("Invalid arguments provided.", \{ + extensions: \{ + code: "INVALID_ARGUMENTS", + errors: result.errors + \} + \}) +\} +const \{ parsedArgs: \{ cursor, direction, limit \} \} = result; +``` + +#### Defined in + +[src/utilities/graphQLConnection/parseGraphQLConnectionArguments.ts:88](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/parseGraphQLConnectionArguments.ts#L88) diff --git a/docs/talawa-api-docs/modules/utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedBy.md b/docs/talawa-api-docs/modules/utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedBy.md new file mode 100644 index 00000000000..cc05b4bc0f2 --- /dev/null +++ b/docs/talawa-api-docs/modules/utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedBy.md @@ -0,0 +1,129 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithSortedBy + +# Module: utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithSortedBy + +## Table of contents + +### Type Aliases + +- [ParseGraphQLConnectionArgumentsWithSortedByResult](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedBy.md#parsegraphqlconnectionargumentswithsortedbyresult) +- [ParseGraphQLConnectionSortedByResult](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedBy.md#parsegraphqlconnectionsortedbyresult) +- [ParsedGraphQLConnectionArgumentsWithSortedBy](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedBy.md#parsedgraphqlconnectionargumentswithsortedby) + +### Functions + +- [parseGraphQLConnectionArgumentsWithSortedBy](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedBy.md#parsegraphqlconnectionargumentswithsortedby) + +## Type Aliases + +### ParseGraphQLConnectionArgumentsWithSortedByResult + +Ƭ **ParseGraphQLConnectionArgumentsWithSortedByResult**\<`T0`, `T1`\>: `Promise`\<\{ `errors`: [`DefaultGraphQLArgumentError`](utilities_graphQLConnection.md#defaultgraphqlargumenterror)[] ; `isSuccessful`: ``false`` \} \| \{ `isSuccessful`: ``true`` ; `parsedArgs`: [`ParsedGraphQLConnectionArgumentsWithSortedBy`](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedBy.md#parsedgraphqlconnectionargumentswithsortedby)\<`T0`, `T1`\> \}\> + +This is typescript type of the object returned from `parseGraphQLConnectionArgumentsWithSortedBy` function. + +#### Type parameters + +| Name | +| :------ | +| `T0` | +| `T1` | + +#### Defined in + +[src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithSortedBy.ts:36](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithSortedBy.ts#L36) + +___ + +### ParseGraphQLConnectionSortedByResult + +Ƭ **ParseGraphQLConnectionSortedByResult**\<`T0`\>: \{ `errors`: [`DefaultGraphQLArgumentError`](utilities_graphQLConnection.md#defaultgraphqlargumenterror)[] ; `isSuccessful`: ``false`` \} \| \{ `isSuccessful`: ``true`` ; `parsedSortedBy`: `T0` \} + +This is typescript type of the object returned from callback function `parseSortedBy`. + +#### Type parameters + +| Name | +| :------ | +| `T0` | + +#### Defined in + +[src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithSortedBy.ts:15](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithSortedBy.ts#L15) + +___ + +### ParsedGraphQLConnectionArgumentsWithSortedBy + +Ƭ **ParsedGraphQLConnectionArgumentsWithSortedBy**\<`T0`, `T1`\>: \{ `sort`: `T1` \} & [`ParsedGraphQLConnectionArguments`](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsedgraphqlconnectionarguments)\<`T0`\> + +This is typescript type of the object containing validated and transformed connection +arguments passed to `parseGraphQLConnectionArgumentsWithSortedBy` function. + +#### Type parameters + +| Name | +| :------ | +| `T0` | +| `T1` | + +#### Defined in + +[src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithSortedBy.ts:29](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithSortedBy.ts#L29) + +## Functions + +### parseGraphQLConnectionArgumentsWithSortedBy + +▸ **parseGraphQLConnectionArgumentsWithSortedBy**\<`T0`, `T1`\>(`«destructured»`): [`ParseGraphQLConnectionArgumentsWithSortedByResult`](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedBy.md#parsegraphqlconnectionargumentswithsortedbyresult)\<`T0`, `T1`\> + +This function is used for validating and transforming arguments for a graphQL connection that +also provides sorting capabilities. + +#### Type parameters + +| Name | +| :------ | +| `T0` | +| `T1` | + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `«destructured»` | `Object` | `undefined` | +| › `args` | [`DefaultGraphQLConnectionArguments`](utilities_graphQLConnection.md#defaultgraphqlconnectionarguments) | `undefined` | +| › `maximumLimit?` | `number` | `MAXIMUM_FETCH_LIMIT` | +| › `parseCursor` | [`ParseGraphQLConnectionCursor`](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectioncursor)\<`T0`\> | `undefined` | +| › `parseSortedByResult` | [`ParseGraphQLConnectionSortedByResult`](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedBy.md#parsegraphqlconnectionsortedbyresult)\<`T1`\> | `undefined` | + +#### Returns + +[`ParseGraphQLConnectionArgumentsWithSortedByResult`](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedBy.md#parsegraphqlconnectionargumentswithsortedbyresult)\<`T0`, `T1`\> + +**`Example`** + +```ts +const result = await parseGraphQLConnectionArgumentsWithSortedBy(\{ + args: \{ + after, + first, + \}, + maximumLimit: 20, + parseCursor, + parseSortedBy, +\}) +if (result.isSuccessful === false) \{ + throw new GraphQLError("Invalid arguments provided.", \{ + extensions: \{ + code: "INVALID_ARGUMENTS", + errors: result.errors + \} + \}) +\} +const \{ parsedArgs: \{ cursor, direction, limit, sort \} \} = result; +``` + +#### Defined in + +[src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithSortedBy.ts:70](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithSortedBy.ts#L70) diff --git a/docs/talawa-api-docs/modules/utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedByAndWhere.md b/docs/talawa-api-docs/modules/utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedByAndWhere.md new file mode 100644 index 00000000000..b473665f388 --- /dev/null +++ b/docs/talawa-api-docs/modules/utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedByAndWhere.md @@ -0,0 +1,115 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithSortedByAndWhere + +# Module: utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithSortedByAndWhere + +## Table of contents + +### Type Aliases + +- [ParseGraphQLConnectionArgumentsWithSortedByAndWhereResult](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedByAndWhere.md#parsegraphqlconnectionargumentswithsortedbyandwhereresult) +- [ParsedGraphQLConnectionArgumentsWithSortedByAndWhere](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedByAndWhere.md#parsedgraphqlconnectionargumentswithsortedbyandwhere) + +### Functions + +- [parseGraphQLConnectionArgumentsWithSortedByAndWhere](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedByAndWhere.md#parsegraphqlconnectionargumentswithsortedbyandwhere) + +## Type Aliases + +### ParseGraphQLConnectionArgumentsWithSortedByAndWhereResult + +Ƭ **ParseGraphQLConnectionArgumentsWithSortedByAndWhereResult**\<`T0`, `T1`, `T2`\>: `Promise`\<\{ `errors`: [`DefaultGraphQLArgumentError`](utilities_graphQLConnection.md#defaultgraphqlargumenterror)[] ; `isSuccessful`: ``false`` \} \| \{ `isSuccessful`: ``true`` ; `parsedArgs`: [`ParsedGraphQLConnectionArgumentsWithSortedByAndWhere`](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedByAndWhere.md#parsedgraphqlconnectionargumentswithsortedbyandwhere)\<`T0`, `T1`, `T2`\> \}\> + +This is typescript type of the object returned from `parseGraphQLConnectionArgumentsWithSortedByAndWhere` function. + +#### Type parameters + +| Name | +| :------ | +| `T0` | +| `T1` | +| `T2` | + +#### Defined in + +[src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithSortedByAndWhere.ts:25](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithSortedByAndWhere.ts#L25) + +___ + +### ParsedGraphQLConnectionArgumentsWithSortedByAndWhere + +Ƭ **ParsedGraphQLConnectionArgumentsWithSortedByAndWhere**\<`T0`, `T1`, `T2`\>: \{ `filter`: `T1` ; `sort`: `T2` \} & [`ParsedGraphQLConnectionArguments`](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsedgraphqlconnectionarguments)\<`T0`\> + +This is typescript type of the object containing validated and transformed connection +arguments passed to `parseGraphQLConnectionArgumentsWithSortedByAndWhere` function. + +#### Type parameters + +| Name | +| :------ | +| `T0` | +| `T1` | +| `T2` | + +#### Defined in + +[src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithSortedByAndWhere.ts:17](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithSortedByAndWhere.ts#L17) + +## Functions + +### parseGraphQLConnectionArgumentsWithSortedByAndWhere + +▸ **parseGraphQLConnectionArgumentsWithSortedByAndWhere**\<`T0`, `T1`, `T2`\>(`«destructured»`): [`ParseGraphQLConnectionArgumentsWithSortedByAndWhereResult`](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedByAndWhere.md#parsegraphqlconnectionargumentswithsortedbyandwhereresult)\<`T0`, `T1`, `T2`\> + +This function is used for validating and transforming arguments for a custom graphQL +connection that also provides filtering and sorting capabilities. + +#### Type parameters + +| Name | +| :------ | +| `T0` | +| `T1` | +| `T2` | + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `«destructured»` | `Object` | `undefined` | +| › `args` | [`DefaultGraphQLConnectionArguments`](utilities_graphQLConnection.md#defaultgraphqlconnectionarguments) | `undefined` | +| › `maximumLimit?` | `number` | `MAXIMUM_FETCH_LIMIT` | +| › `parseCursor` | [`ParseGraphQLConnectionCursor`](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectioncursor)\<`T0`\> | `undefined` | +| › `parseSortedByResult` | [`ParseGraphQLConnectionSortedByResult`](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedBy.md#parsegraphqlconnectionsortedbyresult)\<`T2`\> | `undefined` | +| › `parseWhereResult` | [`ParseGraphQLConnectionWhereResult`](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithWhere.md#parsegraphqlconnectionwhereresult)\<`T1`\> | `undefined` | + +#### Returns + +[`ParseGraphQLConnectionArgumentsWithSortedByAndWhereResult`](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithSortedByAndWhere.md#parsegraphqlconnectionargumentswithsortedbyandwhereresult)\<`T0`, `T1`, `T2`\> + +**`Example`** + +```ts +const result = await parseGraphQLConnectionArgumentsWithSortedBy(\{ + args: \{ + after, + first, + \}, + maximumLimit: 20, + parseCursor, + parseSortedBy, + parseWhere, +\}) +if (result.isSuccessful === false) \{ + throw new GraphQLError("Invalid arguments provided.", \{ + extensions: \{ + code: "INVALID_ARGUMENTS", + errors: result.errors + \} + \}) +\} +const \{ parsedArgs: \{ cursor, direction, filter, limit, sort \} \} = result; +``` + +#### Defined in + +[src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithSortedByAndWhere.ts:68](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithSortedByAndWhere.ts#L68) diff --git a/docs/talawa-api-docs/modules/utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithWhere.md b/docs/talawa-api-docs/modules/utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithWhere.md new file mode 100644 index 00000000000..c6c035681d5 --- /dev/null +++ b/docs/talawa-api-docs/modules/utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithWhere.md @@ -0,0 +1,129 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithWhere + +# Module: utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithWhere + +## Table of contents + +### Type Aliases + +- [ParseGraphQLConnectionArgumentsWithWhereResult](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithWhere.md#parsegraphqlconnectionargumentswithwhereresult) +- [ParseGraphQLConnectionWhereResult](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithWhere.md#parsegraphqlconnectionwhereresult) +- [ParsedGraphQLConnectionArgumentsWithWhere](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithWhere.md#parsedgraphqlconnectionargumentswithwhere) + +### Functions + +- [parseGraphQLConnectionArgumentsWithWhere](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithWhere.md#parsegraphqlconnectionargumentswithwhere) + +## Type Aliases + +### ParseGraphQLConnectionArgumentsWithWhereResult + +Ƭ **ParseGraphQLConnectionArgumentsWithWhereResult**\<`T0`, `T1`\>: `Promise`\<\{ `errors`: [`DefaultGraphQLArgumentError`](utilities_graphQLConnection.md#defaultgraphqlargumenterror)[] ; `isSuccessful`: ``false`` \} \| \{ `isSuccessful`: ``true`` ; `parsedArgs`: [`ParsedGraphQLConnectionArgumentsWithWhere`](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithWhere.md#parsedgraphqlconnectionargumentswithwhere)\<`T0`, `T1`\> \}\> + +This is typescript type of the object returned from `parseGraphQLConnectionArgumentsWithWhere` function. + +#### Type parameters + +| Name | +| :------ | +| `T0` | +| `T1` | + +#### Defined in + +[src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithWhere.ts:36](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithWhere.ts#L36) + +___ + +### ParseGraphQLConnectionWhereResult + +Ƭ **ParseGraphQLConnectionWhereResult**\<`T0`\>: \{ `errors`: [`DefaultGraphQLArgumentError`](utilities_graphQLConnection.md#defaultgraphqlargumenterror)[] ; `isSuccessful`: ``false`` \} \| \{ `isSuccessful`: ``true`` ; `parsedWhere`: `T0` \} + +This is typescript type of the object returned from callback function `parseWhere`. + +#### Type parameters + +| Name | +| :------ | +| `T0` | + +#### Defined in + +[src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithWhere.ts:15](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithWhere.ts#L15) + +___ + +### ParsedGraphQLConnectionArgumentsWithWhere + +Ƭ **ParsedGraphQLConnectionArgumentsWithWhere**\<`T0`, `T1`\>: \{ `where`: `T1` \} & [`ParsedGraphQLConnectionArguments`](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsedgraphqlconnectionarguments)\<`T0`\> + +This is typescript type of the object containing the validated and transformed connection +arguments passed to `parseGraphQLConnectionArgumentsWithWhere` function. + +#### Type parameters + +| Name | +| :------ | +| `T0` | +| `T1` | + +#### Defined in + +[src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithWhere.ts:29](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithWhere.ts#L29) + +## Functions + +### parseGraphQLConnectionArgumentsWithWhere + +▸ **parseGraphQLConnectionArgumentsWithWhere**\<`T0`, `T1`\>(`«destructured»`): [`ParseGraphQLConnectionArgumentsWithWhereResult`](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithWhere.md#parsegraphqlconnectionargumentswithwhereresult)\<`T0`, `T1`\> + +This function handles validating and transforming arguments for a custom graphQL connection +that also provides filtering capabilities. + +#### Type parameters + +| Name | +| :------ | +| `T0` | +| `T1` | + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `«destructured»` | `Object` | `undefined` | +| › `args` | [`DefaultGraphQLConnectionArguments`](utilities_graphQLConnection.md#defaultgraphqlconnectionarguments) | `undefined` | +| › `maximumLimit?` | `number` | `MAXIMUM_FETCH_LIMIT` | +| › `parseCursor` | [`ParseGraphQLConnectionCursor`](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsegraphqlconnectioncursor)\<`T0`\> | `undefined` | +| › `parseWhereResult` | [`ParseGraphQLConnectionWhereResult`](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithWhere.md#parsegraphqlconnectionwhereresult)\<`T1`\> | `undefined` | + +#### Returns + +[`ParseGraphQLConnectionArgumentsWithWhereResult`](utilities_graphQLConnection_parseGraphQLConnectionArgumentsWithWhere.md#parsegraphqlconnectionargumentswithwhereresult)\<`T0`, `T1`\> + +**`Example`** + +```ts +const result = await parseGraphQLConnectionArgumentsWithSortedBy(\{ + args: \{ + after, + first, + \}, + maximumLimit: 20, + parseCursor, + parseSortedBy, +\}) +if (result.isSuccessful === false) \{ + throw new GraphQLError("Invalid arguments provided.", \{ + extensions: \{ + code: "INVALID_ARGUMENTS", + errors: result.errors + \} + \}) +\} +const \{ parsedArgs: \{ cursor, direction, filter, limit \} \} = result; +``` + +#### Defined in + +[src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithWhere.ts:70](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/parseGraphQLConnectionArgumentsWithWhere.ts#L70) diff --git a/docs/talawa-api-docs/modules/utilities_graphQLConnection_transformToDefaultGraphQLConnection.md b/docs/talawa-api-docs/modules/utilities_graphQLConnection_transformToDefaultGraphQLConnection.md new file mode 100644 index 00000000000..68abde6c3d3 --- /dev/null +++ b/docs/talawa-api-docs/modules/utilities_graphQLConnection_transformToDefaultGraphQLConnection.md @@ -0,0 +1,168 @@ +[talawa-api](../README.md) / [Exports](../modules.md) / utilities/graphQLConnection/transformToDefaultGraphQLConnection + +# Module: utilities/graphQLConnection/transformToDefaultGraphQLConnection + +## Table of contents + +### Type Aliases + +- [CreateCursor](utilities_graphQLConnection_transformToDefaultGraphQLConnection.md#createcursor) +- [CreateNode](utilities_graphQLConnection_transformToDefaultGraphQLConnection.md#createnode) +- [TransformToDefaultGraphQLConnectionArguments](utilities_graphQLConnection_transformToDefaultGraphQLConnection.md#transformtodefaultgraphqlconnectionarguments) + +### Functions + +- [transformToDefaultGraphQLConnection](utilities_graphQLConnection_transformToDefaultGraphQLConnection.md#transformtodefaultgraphqlconnection) + +## Type Aliases + +### CreateCursor + +Ƭ **CreateCursor**\<`T0`\>: (`object`: `T0`) =\> `string` + +This is typescript type of the callback function `createCursor`. + +#### Type parameters + +| Name | +| :------ | +| `T0` | + +#### Type declaration + +▸ (`object`): `string` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `object` | `T0` | + +##### Returns + +`string` + +#### Defined in + +[src/utilities/graphQLConnection/transformToDefaultGraphQLConnection.ts:11](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/transformToDefaultGraphQLConnection.ts#L11) + +___ + +### CreateNode + +Ƭ **CreateNode**\<`T0`, `T1`\>: (`object`: `T0`) =\> `T1` + +This is typescript type of the callback function `createNode`. + +#### Type parameters + +| Name | +| :------ | +| `T0` | +| `T1` | + +#### Type declaration + +▸ (`object`): `T1` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `object` | `T0` | + +##### Returns + +`T1` + +#### Defined in + +[src/utilities/graphQLConnection/transformToDefaultGraphQLConnection.ts:16](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/transformToDefaultGraphQLConnection.ts#L16) + +___ + +### TransformToDefaultGraphQLConnectionArguments + +Ƭ **TransformToDefaultGraphQLConnectionArguments**\<`T0`, `T1`, `T2`\>: `Object` + +#### Type parameters + +| Name | +| :------ | +| `T0` | +| `T1` | +| `T2` | + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `createCursor?` | [`CreateCursor`](utilities_graphQLConnection_transformToDefaultGraphQLConnection.md#createcursor)\<`T1`\> | +| `createNode?` | [`CreateNode`](utilities_graphQLConnection_transformToDefaultGraphQLConnection.md#createnode)\<`T1`, `T2`\> | +| `objectList` | `T1`[] | +| `parsedArgs` | [`ParsedGraphQLConnectionArguments`](utilities_graphQLConnection_parseGraphQLConnectionArguments.md#parsedgraphqlconnectionarguments)\<`T0`\> | +| `totalCount` | `number` | + +#### Defined in + +[src/utilities/graphQLConnection/transformToDefaultGraphQLConnection.ts:18](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/transformToDefaultGraphQLConnection.ts#L18) + +## Functions + +### transformToDefaultGraphQLConnection + +▸ **transformToDefaultGraphQLConnection**\<`T0`, `T1`, `T2`\>(`«destructured»`): [`DefaultGraphQLConnection`](utilities_graphQLConnection_generateDefaultGraphQLConnection.md#defaultgraphqlconnection)\<`T2`\> + +This function is used to transform a list of objects to a standard graphQL connection object. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T0` | `T0` | +| `T1` | extends `Object` | +| `T2` | `T2` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `«destructured»` | [`TransformToDefaultGraphQLConnectionArguments`](utilities_graphQLConnection_transformToDefaultGraphQLConnection.md#transformtodefaultgraphqlconnectionarguments)\<`T0`, `T1`, `T2`\> | + +#### Returns + +[`DefaultGraphQLConnection`](utilities_graphQLConnection_generateDefaultGraphQLConnection.md#defaultgraphqlconnection)\<`T2`\> + +**`Remarks`** + +The logic used in this function is common to almost all graphQL connection creation flows, +abstracting that away into this function lets developers use a declarative way to create the +graphQL connection object they want and prevents code duplication. + +**`Example`** + +```ts +const [objectList, totalCount] = await Promise.all([ + User.find(filter) + .sort(sort) + .limit(limit) + .exec(), + User.find(filter) + .countDocuments() + .exec(), +]); + +return transformToDefaultGraphQLConnection\< + String, + DatabaseUser, + DatabaseUser +\>(\{ + objectList, + parsedArgs, + totalCount, +\}); +``` + +#### Defined in + +[src/utilities/graphQLConnection/transformToDefaultGraphQLConnection.ts:53](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/graphQLConnection/transformToDefaultGraphQLConnection.ts#L53) diff --git a/docs/talawa-api-docs/modules/utilities_loadDefaultOrganization.md b/docs/talawa-api-docs/modules/utilities_loadDefaultOrganization.md deleted file mode 100644 index d239a754d8f..00000000000 --- a/docs/talawa-api-docs/modules/utilities_loadDefaultOrganization.md +++ /dev/null @@ -1,42 +0,0 @@ -[talawa-api](../README.md) / [Exports](../modules.md) / utilities/loadDefaultOrganization - -# Module: utilities/loadDefaultOrganization - -## Table of contents - -### Functions - -- [formatDatabase](utilities_loadDefaultOrganization.md#formatdatabase) -- [loadDefaultOrganization](utilities_loadDefaultOrganization.md#loaddefaultorganization) - -## Functions - -### formatDatabase - -▸ **formatDatabase**(): `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/utilities/loadDefaultOrganization.ts:14](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/utilities/loadDefaultOrganization.ts#L14) - -___ - -### loadDefaultOrganization - -▸ **loadDefaultOrganization**(): `Promise`\<`void`\> - -The function which loads the default organization, so that there is always altleast 1 organization in the DB - -#### Returns - -`Promise`\<`void`\> - -a Promise that resolves to void - -#### Defined in - -[src/utilities/loadDefaultOrganization.ts:30](https://github.com/PalisadoesFoundation/talawa-api/blob/fe9d65c/src/utilities/loadDefaultOrganization.ts#L30) diff --git a/docs/talawa-api-docs/modules/utilities_recurrenceDatesUtil.md b/docs/talawa-api-docs/modules/utilities_recurrenceDatesUtil.md index 8a35af4f983..15ed1f7d7c4 100644 --- a/docs/talawa-api-docs/modules/utilities_recurrenceDatesUtil.md +++ b/docs/talawa-api-docs/modules/utilities_recurrenceDatesUtil.md @@ -31,7 +31,7 @@ converted date string. #### Defined in -[src/utilities/recurrenceDatesUtil.ts:24](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/utilities/recurrenceDatesUtil.ts#L24) +[src/utilities/recurrenceDatesUtil.ts:24](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/recurrenceDatesUtil.ts#L24) ___ @@ -55,4 +55,4 @@ converted date. #### Defined in -[src/utilities/recurrenceDatesUtil.ts:7](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/utilities/recurrenceDatesUtil.ts#L7) +[src/utilities/recurrenceDatesUtil.ts:7](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/recurrenceDatesUtil.ts#L7) diff --git a/docs/talawa-api-docs/modules/utilities_userFamilyAdminCheck.md b/docs/talawa-api-docs/modules/utilities_userFamilyAdminCheck.md index 028e2d32183..ed0709c3be3 100644 --- a/docs/talawa-api-docs/modules/utilities_userFamilyAdminCheck.md +++ b/docs/talawa-api-docs/modules/utilities_userFamilyAdminCheck.md @@ -35,4 +35,4 @@ This is a utility method. #### Defined in -[src/utilities/userFamilyAdminCheck.ts:14](https://github.com/PalisadoesFoundation/talawa-api/blob/9cb91bb/src/utilities/userFamilyAdminCheck.ts#L14) +[src/utilities/userFamilyAdminCheck.ts:14](https://github.com/adi790uu/talawa-api/blob/5146430/src/utilities/userFamilyAdminCheck.ts#L14) From 207b693dea1c00c3f1691f2b4d20540ba411f7c3 Mon Sep 17 00:00:00 2001 From: adi790uu Date: Thu, 21 Mar 2024 00:14:51 +0530 Subject: [PATCH 2/2] Updated the cron schedule --- .github/workflows/pull-latest-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pull-latest-docs.yml b/.github/workflows/pull-latest-docs.yml index 4da2d391a45..89c696d44db 100644 --- a/.github/workflows/pull-latest-docs.yml +++ b/.github/workflows/pull-latest-docs.yml @@ -2,7 +2,7 @@ name: Pull Talawa API Changes on: schedule: - - cron: '*/5 * * * *' + - cron: '0 0 * * 0' jobs: pull: