Class UsersAccessor

Deprecated

use CustomersAccessor instead

Hierarchy (View Summary)

CustomersAccessor
- UsersAccessor

Index

Constructors

constructor

Methods

find findAll create

Constructors

constructor

new UsersAccessor(client: MembraneApiClient): UsersAccessor
Parameters
- client: MembraneApiClient
Returns UsersAccessor
Overrides CustomersAccessor.constructor
- Defined in accessors/customers-accessors.ts:31

Methods

find

find(
    query?: {
        search?: string;
        limit?: number;
        cursor?: string;
        isTest?: boolean;
    },
): Promise<
    PaginationResponse<
        {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        },
    >,
>
Parameters
- Optionalquery: { search?: string; limit?: number; cursor?: string; isTest?: boolean }
Returns Promise<
    PaginationResponse<
        {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        },
    >,
>
Inherited from CustomersAccessor.find
- Defined in accessors/base-accessors.ts:83

findAll

findAll(
    query?: Omit<
        { search?: string; limit?: number; cursor?: string; isTest?: boolean },
        "limit",
    >,
): Promise<
    {
        id: string;
        name: string;
        meta?: Record<string, any>;
        internalId: string;
        fields?: Record<string, any>;
        credentials?: any;
        lastActiveAt?: string;
        isTest?: boolean;
        isBillable?: boolean;
        createdAt?: string;
        archivedAt?: string;
    }[],
>
Parameters
- Optionalquery: Omit<
  { search?: string; limit?: number; cursor?: string; isTest?: boolean },
  "limit",
  >
Returns Promise<
    {
        id: string;
        name: string;
        meta?: Record<string, any>;
        internalId: string;
        fields?: Record<string, any>;
        credentials?: any;
        lastActiveAt?: string;
        isTest?: boolean;
        isBillable?: boolean;
        createdAt?: string;
        archivedAt?: string;
    }[],
>
Inherited from CustomersAccessor.findAll
- Defined in accessors/base-accessors.ts:89

create

create(
    data: {
        name?: string;
        internalId: string;
        fields?: any;
        credentials?: any;
    },
): Promise<
    {
        id: string;
        name: string;
        meta?: Record<string, any>;
        internalId: string;
        fields?: Record<string, any>;
        credentials?: any;
        lastActiveAt?: string;
        isTest?: boolean;
        isBillable?: boolean;
        createdAt?: string;
        archivedAt?: string;
    },
>
Parameters
- data: { name?: string; internalId: string; fields?: any; credentials?: any }
Returns Promise<
    {
        id: string;
        name: string;
        meta?: Record<string, any>;
        internalId: string;
        fields?: Record<string, any>;
        credentials?: any;
        lastActiveAt?: string;
        isTest?: boolean;
        isBillable?: boolean;
        createdAt?: string;
        archivedAt?: string;
    },
>
Inherited from CustomersAccessor.create
- Defined in accessors/base-accessors.ts:111

Class UsersAccessor

Deprecated

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns UsersAccessor

Methods

find

Parameters

findAll

Parameters

create

Parameters

Settings

On This Page

Class UsersAccessor

Deprecated

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns UsersAccessor

Methods

find

Parameters

Returns Promise< PaginationResponse< { id: string; name: string; meta?: Record<string, any>; internalId: string; fields?: Record<string, any>; credentials?: any; lastActiveAt?: string; isTest?: boolean; isBillable?: boolean; createdAt?: string; archivedAt?: string; }, >,>

findAll

Parameters

Returns Promise< { id: string; name: string; meta?: Record<string, any>; internalId: string; fields?: Record<string, any>; credentials?: any; lastActiveAt?: string; isTest?: boolean; isBillable?: boolean; createdAt?: string; archivedAt?: string; }[],>

create

Parameters

Returns Promise< { id: string; name: string; meta?: Record<string, any>; internalId: string; fields?: Record<string, any>; credentials?: any; lastActiveAt?: string; isTest?: boolean; isBillable?: boolean; createdAt?: string; archivedAt?: string; },>

Settings

On This Page

Returns Promise<
PaginationResponse<
{
id: string;
name: string;
meta?: Record<string, any>;
internalId: string;
fields?: Record<string, any>;
credentials?: any;
lastActiveAt?: string;
isTest?: boolean;
isBillable?: boolean;
createdAt?: string;
archivedAt?: string;
},
>,
>

Returns Promise<
{
id: string;
name: string;
meta?: Record<string, any>;
internalId: string;
fields?: Record<string, any>;
credentials?: any;
lastActiveAt?: string;
isTest?: boolean;
isBillable?: boolean;
createdAt?: string;
archivedAt?: string;
}[],
>

Returns Promise<
{
id: string;
name: string;
meta?: Record<string, any>;
internalId: string;
fields?: Record<string, any>;
credentials?: any;
lastActiveAt?: string;
isTest?: boolean;
isBillable?: boolean;
createdAt?: string;
archivedAt?: string;
},
>