Class UserAccessor

Deprecated

use CustomerAccessor instead

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 accessors/customers-accessors.ts:40

Properties

`Protected`options

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

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from CustomerAccessor.getUniqueIdentifier
- Defined in accessors/base-accessors.ts:39

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 accessors/base-accessors.ts:43

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 accessors/base-accessors.ts:47

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 accessors/base-accessors.ts:51

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 accessors/base-accessors.ts:59

getPath

getPath(operation?: string): string
Parameters
- operation: string = ''
Returns string
Inherited from CustomerAccessor.getPath
- Defined in accessors/base-accessors.ts:63

Class UserAccessor

Deprecated

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UserAccessor

Properties

`Protected`options

Methods

getUniqueIdentifier

Returns string

get

put

Parameters

patch

Parameters

archive

Returns Promise<void>

restore

getPath

Parameters

Returns string

Settings

On This Page

Class UserAccessor

Deprecated

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UserAccessor

Properties

Protectedoptions

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

Settings

On This Page

`Protected`options

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