Class UserAccessor

Hierarchy (View Summary)

CustomerAccessor
- UserAccessor

Index

Constructors

constructor

new UserAccessor(client: MembraneApiClient, selector: string): UserAccessor
Parameters
- client: MembraneApiClient
- selector: string
Returns UserAccessor
Overrides CustomerAccessor.constructor
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:5417

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from CustomerAccessor.getUniqueIdentifier
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:627

get

get(): 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;
    },
>
Inherited from CustomerAccessor.get
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:628

put

put(
    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 CustomerAccessor.put
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:629

patch

patch(
    data: Partial<UpdateRequest>,
): 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: Partial<UpdateRequest>
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 CustomerAccessor.patch
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:630

restore

restore(): 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;
    },
>
Inherited from CustomerAccessor.restore
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:632

getPath

getPath(operation?: string): string
Parameters
- Optionaloperation: string
Returns string
Inherited from CustomerAccessor.getPath
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:633

Properties

`Protected`options

options: {
    client: MembraneApiClient;
    path: string;
    selector: string | { id: string };
}

Class UserAccessor

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns UserAccessor

Methods

getUniqueIdentifier

Returns string

get

put

Parameters

patch

Parameters

archive

Returns Promise<void>

restore

getPath

Parameters

Returns string

Properties

`Protected`options

Settings

On This Page

Class UserAccessor

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns UserAccessor

Methods

getUniqueIdentifier

Returns string

get

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; },>

put

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; },>

patch

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; },>

archive

Returns Promise<void>

restore

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; },>

getPath

Parameters

Returns string

Properties

Protectedoptions

Settings

On This Page

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;
},
>

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;
},
>

`Protected`options