cloudflare/resources/user/invites.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as InvitesAPI from 'cloudflare/resources/user/invites';
import * as RolesAPI from 'cloudflare/resources/accounts/roles';
import { SinglePage } from 'cloudflare/pagination';
export declare class Invites extends APIResource {
    /**
     * Lists all invitations associated with my user.
     */
    list(options?: Core.RequestOptions): Core.PagePromise<InviteListResponsesSinglePage, InviteListResponse>;
    /**
     * Responds to an invitation.
     */
    edit(inviteId: string, body: InviteEditParams, options?: Core.RequestOptions): Core.APIPromise<InviteEditResponse>;
    /**
     * Gets the details of an invitation.
     */
    get(inviteId: string, options?: Core.RequestOptions): Core.APIPromise<InviteGetResponse>;
}
export declare class InviteListResponsesSinglePage extends SinglePage<InviteListResponse> {
}
export interface UserInvite {
    /**
     * ID of the user to add to the organization.
     */
    invited_member_id: string | null;
    /**
     * ID of the organization the user will be added to.
     */
    organization_id: string;
    /**
     * Invite identifier tag.
     */
    id?: string;
    /**
     * When the invite is no longer active.
     */
    expires_on?: string;
    /**
     * The email address of the user who created the invite.
     */
    invited_by?: string;
    /**
     * Email address of the user to add to the organization.
     */
    invited_member_email?: string;
    /**
     * When the invite was sent.
     */
    invited_on?: string;
    /**
     * Organization name.
     */
    organization_name?: string;
    /**
     * Roles to be assigned to this user.
     */
    roles?: Array<RolesAPI.Role>;
    /**
     * Current status of the invitation.
     */
    status?: 'pending' | 'accepted' | 'rejected' | 'expired';
}
export interface InviteListResponse {
    /**
     * ID of the user to add to the organization.
     */
    invited_member_id: string | null;
    /**
     * ID of the organization the user will be added to.
     */
    organization_id: string;
    /**
     * Invite identifier tag.
     */
    id?: string;
    /**
     * When the invite is no longer active.
     */
    expires_on?: string;
    /**
     * The email address of the user who created the invite.
     */
    invited_by?: string;
    /**
     * Email address of the user to add to the organization.
     */
    invited_member_email?: string;
    /**
     * When the invite was sent.
     */
    invited_on?: string;
    /**
     * Organization name.
     */
    organization_name?: string;
    /**
     * Roles to be assigned to this user.
     */
    roles?: Array<RolesAPI.Role>;
    /**
     * Current status of the invitation.
     */
    status?: 'pending' | 'accepted' | 'rejected' | 'expired';
}
export type InviteEditResponse = unknown | string | null;
export type InviteGetResponse = unknown | string | null;
export interface InviteEditParams {
    /**
     * Status of your response to the invitation (rejected or accepted).
     */
    status: 'accepted' | 'rejected';
}
export declare namespace Invites {
    export import UserInvite = InvitesAPI.UserInvite;
    export import InviteListResponse = InvitesAPI.InviteListResponse;
    export import InviteEditResponse = InvitesAPI.InviteEditResponse;
    export import InviteGetResponse = InvitesAPI.InviteGetResponse;
    export import InviteListResponsesSinglePage = InvitesAPI.InviteListResponsesSinglePage;
    export import InviteEditParams = InvitesAPI.InviteEditParams;
}
//# sourceMappingURL=invites.d.ts.map