trello-for-wolves/lib/resources/Organization.d.ts

Node.js wrapper for Trello API...for wolves.

import { AllOrFieldOrListOf, BoardVisibilityFilter, FileUpload, MemberField, NestedActionsParams, NestedBoardsParams, NestedMembershipsParams, NestedMembersInvitedParams, NestedMembersParams, OrganizationField, OrganizationFilter, OrganizationRecord, PermissionLevel, TypedFetch, ValueResponse } from "../typeDefs";
import { Action } from "./Action";
import { BaseResource } from "./BaseResource";
import { Board } from "./Board";
import { Member } from "./Member";
import { Membership } from "./Membership";
import { OrganizationPref } from "./OrganizationPref";
/**
 * Organizations, or as they are referred to in Trello, "Teams", represent
 * collections of members and boards.
 * @see https://developers.trello.com/reference#organizations
 * @class
 */
export declare class Organization extends BaseResource {
    getOrganization(params?: {
        boardPluginData?: boolean;
        fields?: AllOrFieldOrListOf<OrganizationField>;
        memberActivity?: boolean;
        membershipsMember?: boolean;
        membershipsMemberFields?: AllOrFieldOrListOf<MemberField>;
        paidAccount?: boolean;
        pluginData?: boolean;
    } & NestedActionsParams & NestedBoardsParams & NestedMembersParams & NestedMembersInvitedParams & NestedMembershipsParams): TypedFetch<OrganizationRecord>;
    getOrganizations(params?: {
        filter?: OrganizationFilter;
        fields?: AllOrFieldOrListOf<OrganizationField>;
        paidAccount?: boolean;
    }): TypedFetch<OrganizationRecord[]>;
    getOrganizationsFilteredBy(filter: OrganizationFilter): TypedFetch<OrganizationRecord[]>;
    getFieldValue<T>(field: OrganizationField): TypedFetch<ValueResponse<T>>;
    getDeltas(params?: {
        ixLastUpdate?: number;
        tags?: string;
    }): TypedFetch<unknown>;
    getPluginData(): TypedFetch<unknown>;
    getTags(): TypedFetch<unknown>;
    getExports(): TypedFetch<unknown>;
    getIfTransferrableToEnterprise(): TypedFetch<unknown>;
    addOrganization(params: {
        displayName: string;
        desc?: string;
        name?: string;
        website?: string;
    }): TypedFetch<OrganizationRecord>;
    uploadLogo(file: FileUpload): TypedFetch<unknown>;
    addTag(name: string): TypedFetch<unknown>;
    startExport(params?: {
        attachments?: boolean;
    }): TypedFetch<unknown>;
    updateOrganization(params: {
        name?: string;
        displayName?: string;
        desc?: string;
        website?: string | null;
        prefs?: {
            associatedDomain?: string;
            boardVisibilityRestrict?: {
                orgRestriction?: BoardVisibilityFilter;
                privateRestriction?: BoardVisibilityFilter;
                publicRestriction?: BoardVisibilityFilter;
            };
            externalMembersDisabled?: boolean;
            googleAppsVersion?: number;
            orgInviteRestrict?: string;
            permissionLevel?: PermissionLevel;
        };
    }): TypedFetch<OrganizationRecord>;
    updateDescription(value: string): TypedFetch<OrganizationRecord>;
    updateDisplayName(value: string): TypedFetch<OrganizationRecord>;
    updateName(value: string): TypedFetch<OrganizationRecord>;
    updateWebsite(value: string | null): TypedFetch<OrganizationRecord>;
    transferToEnterprise(): TypedFetch<unknown>;
    deleteOrganization(): TypedFetch<unknown>;
    deleteLogo(): TypedFetch<unknown>;
    deleteTag(idTag: string): TypedFetch<unknown>;
    removeFromEnterprise(): TypedFetch<unknown>;
    actions(): Action;
    boards(idBoard?: string): Board;
    members(memberId?: string): Member;
    membersInvited(): Member;
    memberships(idMembership?: string): Membership;
    prefs(): OrganizationPref;
}