مرجع الواجهة
كل دالة تشحنها الحزمة، بتوقيعها الكامل.
هذه الصفحة مُولّدة من الحزمة المنشورة
التواقيع أدناه مقروءة من ملفات الأنواع الخاصة بـ @gurb/server عبر مدقّق أنواع TypeScript نفسه — لا مكتوبة بيد. فما تراه هنا هو ما ثبّته فعلاً، لا ما كان صحيحاً يوم كُتبت الصفحة.
@gurb/server 1.7.0 — 89 دالة · 22 قسماً
GurbClient
عميل المجتمع. مفتاحه مثبّت على مجتمع واحد، ولا يوجد وسيط communityId في أي دالة.
gurb.community
المجتمع الذي يخص مفتاحك: قراءته، إعداداته، هويته ووثائقه القانونية.
community.get(): Promise<Community>
community.requestCreation(input: CreateCommunityInput): Promise<CommunityRequest>
community.getSettings(): Promise<CommunitySettings>
community.updateSettings(patch: UpdateCommunitySettingsInput): Promise<CommunitySettings>
community.updateBranding(fields: UpdateCommunityBrandingInput): Promise<CommunityRecord>
community.getLegal(): Promise<CommunityLegal>
community.updateLegal(input: UpdateCommunityLegalInput): Promise<CommunityLegal>
gurb.communityRequests
طلبات إنشاء المجتمعات التي رفعها مفتاحك، وحالتها.
communityRequests.list(params?: (PaginationParams & { status?: CommunityRequestStatus | undefined; }) | undefined): Promise<Paginated<CommunityRequest>>
communityRequests.get(requestId: string): Promise<CommunityRequest>
gurb.tweets
منشورات الصفحة الرئيسية، أو داخل مجموعة.
tweets.list(params?: PaginationParams | undefined): Promise<Paginated<Tweet>>
tweets.create(input: CreateTweetInput): Promise<Tweet>
tweets.update(tweetId: string, input: UpdateTweetInput): Promise<Tweet>
tweets.delete(tweetId: string): Promise<{ id: string; deleted: true; }>
gurb.events
الفعاليات. محجوبة بميزة التقويم في الخطة.
events.list(params?: (PaginationParams & { upcoming?: boolean | undefined; }) | undefined): Promise<Paginated<Event>>
events.create(input: CreateEventInput): Promise<Event>
events.update(eventId: string, input: Partial<CreateEventInput>): Promise<Event>
events.delete(eventId: string): Promise<{ id: string; deleted: true; }>
gurb.blogs
المدونات. الحذف هنا ناعم (soft delete).
blogs.list(params?: PaginationParams | undefined): Promise<Paginated<Blog>>
blogs.create(input: CreateBlogInput): Promise<Blog>
blogs.update(blogId: string, input: Partial<CreateBlogInput>): Promise<Blog>
blogs.delete(blogId: string): Promise<{ id: string; deleted: true; }>
gurb.albums
الألبومات. تُنشأ فارغة — لا رفع صور على هذا السطح.
albums.list(params?: PaginationParams | undefined): Promise<Paginated<Album>>
albums.create(input: CreateAlbumInput): Promise<Album>
albums.update(albumId: string, input: UpdateAlbumInput): Promise<Album>
albums.delete(albumId: string): Promise<{ id: string; deleted: true; }>
gurb.groups
المجموعات. الحذف يحتاج manage أو moderate بلا استثناء للمؤلف.
groups.list(params?: PaginationParams | undefined): Promise<Paginated<Group>>
groups.create(input: CreateGroupInput): Promise<GroupWriteResult>
groups.update(groupId: string, fields: UpdateGroupInput): Promise<GroupWriteResult>
groups.delete(groupId: string): Promise<DeletedResult>
gurb.consultants
قوائم الاستشارات. صلاحية واحدة لكل الأفعال: consultants:manage.
consultants.list(params?: PaginationParams | undefined): Promise<Paginated<Consultant>>
consultants.create(input: CreateConsultantInput): Promise<ConsultantWriteResult>
consultants.update(consultantId: string, fields: UpdateConsultantInput): Promise<ConsultantWriteResult>
consultants.delete(consultantId: string): Promise<DeletedResult>
gurb.projects
وحدة المشاريع الأولى.
projects.list(params?: PaginationParams | undefined): Promise<Paginated<Project>>
projects.create(input: CreateProjectInput): Promise<Project>
projects.update(projectId: string, fields: UpdateProjectInput): Promise<Project>
projects.delete(projectId: string): Promise<DeletedResult>
gurb.projects2
وحدة المشاريع الثانية — موازية لا أحدث. بعض المجتمعات تشغّل الاثنتين.
projects2.list(params?: PaginationParams | undefined): Promise<Paginated<Project>>
projects2.create(input: CreateProjectInput): Promise<Project>
projects2.update(projectId: string, fields: UpdateProjectInput): Promise<Project>
projects2.delete(projectId: string): Promise<DeletedResult>
gurb.awards
تعريف الأوسمة. لا يمنحها لأحد — المنح ليس على هذا السطح.
awards.list(params?: PaginationParams | undefined): Promise<Paginated<Award>>
awards.create(input: CreateAwardInput): Promise<Award>
awards.update(awardId: string, fields: UpdateAwardInput): Promise<Award>
awards.delete(awardId: string): Promise<DeletedResult>
gurb.tasks
لوحة المهام. القراءة بلا صلاحية، والكتابة tasks:manage.
tasks.list(params?: TaskListParams | undefined): Promise<Paginated<Task>>
tasks.get(taskId: string): Promise<TaskDetail>
tasks.create(input: CreateTaskInput): Promise<Task>
tasks.update(taskId: string, fields: UpdateTaskInput): Promise<Task>
tasks.delete(taskId: string): Promise<DeletedResult>
gurb.comments
التعليقات على المنشورات والمدونات والألبومات والفعاليات، والإعجابات عليها.
comments.list(parent: "tweets" | "blogs" | "albums" | "events", parentId: string, params?: PaginationParams | undefined): Promise<Paginated<Comment>>
comments.create(parent: "tweets" | "blogs" | "albums" | "events", parentId: string, input: CreateCommentInput): Promise<Comment>
comments.update(parent: "tweets" | "blogs" | "albums" | "events", parentId: string, commentId: string, input: UpdateCommentInput): Promise<Comment>
comments.delete(parent: "tweets" | "blogs" | "albums" | "events", parentId: string, commentId: string): Promise<DeletedResult>
comments.likeState(parent: "tweets" | "blogs" | "albums" | "events", parentId: string, commentId: string): Promise<LikeState>
comments.like(parent: "tweets" | "blogs" | "albums" | "events", parentId: string, commentId: string): Promise<LikeState>
comments.unlike(parent: "tweets" | "blogs" | "albums" | "events", parentId: string, commentId: string): Promise<LikeState>
gurb.likes
الإعجابات على المنشورات والمدونات والألبومات. لا يوجد إعجاب للفعاليات.
likes.state(parent: "tweets" | "blogs" | "albums", parentId: string): Promise<LikeState>
likes.like(parent: "tweets" | "blogs" | "albums", parentId: string): Promise<LikeState>
likes.unlike(parent: "tweets" | "blogs" | "albums", parentId: string): Promise<LikeState>
gurb.sidebar
قائمة التنقّل. التحديث PUT ويستبدل القائمة كاملة.
sidebar.get(): Promise<SidebarConfig>
sidebar.update(input: UpdateSidebarInput): Promise<SidebarConfig>
sidebar.reset(): Promise<SidebarConfig>
sidebar.default(): Promise<SidebarConfig>
sidebar.icons(): Promise<string[]>
gurb.advertisements
الإعلانات. لا يوجد إنشاء — الإعلان صورته، والرفع غير مدعوم.
advertisements.listActive(params?: { position?: "RIGHT_SIDEBAR" | "LEFT_SIDEBAR" | "ABOVE_TWEET_CREATOR" | undefined; } | undefined): Promise<Advertisement[]>
advertisements.list(params?: PaginationParams | undefined): Promise<Paginated<Advertisement>>
advertisements.update(adId: string, fields: UpdateAdvertisementInput): Promise<Advertisement>
advertisements.delete(adId: string): Promise<DeletedResult>
gurb.members
الأعضاء والأدوار والصلاحيات، والمزامنة بالجملة.
members.list(params?: (PaginationParams & { role?: CommunityRole | undefined; }) | undefined): Promise<Paginated<Member>>
members.get(memberId: string): Promise<Member>
members.setRole(memberId: string, role: CommunityRole): Promise<Member>
members.getPermissions(memberId: string): Promise<MemberPermissions>
members.updatePermissions(memberId: string, changes: { grant?: Permission[] | undefined; revoke?: Permission[] | undefined; }): Promise<MemberPermissions>
members.remove(memberId: string): Promise<void>
members.bulkUpsert(members: BulkMemberInput[]): Promise<BulkMemberResult>
gurb.embed
إصدار رموز الجلسات وبناء الإطار.
embed.createSession(input: CreateEmbedSessionInput): Promise<EmbedSession>
embed.buildUrl(args: { slug?: string | undefined; section: "tweets" | "blogs" | "albums" | "events" | "community"; token: string; }): string
embed.iframe(args: { section: "tweets" | "blogs" | "albums" | "events" | "community"; token: string; height?: number | undefined; style?: string | undefined; }): string
GurbAdminClient
عميل المنصة. مفتاح مختلف وصلاحية أوسع بمراتب — أنشئه عمداً لا بالإكمال التلقائي.
admin.communities
كل مجتمعات المنصة. مشرف عام فقط.
communities.list(params?: (PaginationParams & { search?: string | undefined; }) | undefined): Promise<Paginated<Community>>
communities.create(input: CreateCommunityInput): Promise<Community>
admin.communityRequests
طلبات إنشاء المجتمعات التي رفعها مفتاحك، وحالتها.
communityRequests.list(params?: (PaginationParams & { status?: CommunityRequestStatus | undefined; }) | undefined): Promise<Paginated<CommunityRequest>>
communityRequests.get(requestId: string): Promise<CommunityRequest>
communityRequests.approve(requestId: string): Promise<CommunityRequest>
communityRequests.reject(requestId: string, reason: string): Promise<CommunityRequest>
admin.apiKeys
إصدار وإلغاء المفاتيح التي تعمل عليها التكاملات الأخرى.
apiKeys.list(params?: (PaginationParams & { communityId?: string | undefined; }) | undefined): Promise<Paginated<ApiKeySummary>>
apiKeys.create(input: { communityId: string; name: string; scopes?: ("read" | "write")[] | undefined; }): Promise<ApiKeyWithSecret>
apiKeys.revoke(keyId: string): Promise<ApiKeySummary>
admin
دوال على العميل نفسه.
me(): Promise<SdkIdentity>