n8n-nodes-base

Version:
Base nodes of n8n
61 lines (56 loc) • 1.36 kB
text/typescript
/**
 * HaloPSA Node - Version 1
 * Discriminator: resource=user, operation=getAll
 */


interface Credentials {
  haloPSAApi: CredentialReference;
}

/** Get many clients */
export type HaloPSAV1UserGetAllParams = {
  resource: 'user';
  operation: 'getAll';
/**
 * Whether to return a simplified version of the response instead of the raw data
 * @default true
 */
    simplify?: boolean | Expression<boolean>;
/**
 * Whether to return all results or only up to a given limit
 * @default false
 */
    returnAll?: boolean | Expression<boolean>;
/**
 * Max number of results to return
 * @displayOptions.show { returnAll: [false] }
 * @default 50
 */
    limit?: number | Expression<number>;
/**
 * Filters
 * @default {}
 */
    filters?: {
    /** Active Status
     * @default all
     */
    activeStatus?: 'active' | 'all' | 'inactive' | Expression<string>;
    /** Filter users by your search string
     */
    search?: string | Expression<string> | PlaceholderValue;
  };
};

export type HaloPSAV1UserGetAllOutput = {
  emailaddress?: string;
  id?: number;
  inactive?: boolean;
  name?: string;
  site_id?: number;
  surname?: string;
};

export type HaloPSAV1UserGetAllNode = {
  type: 'n8n-nodes-base.haloPSA';
  version: 1;
  credentials?: Credentials;
  config: NodeConfig<HaloPSAV1UserGetAllParams>;
  output?: Items<HaloPSAV1UserGetAllOutput>;
};