Membrane SDK - v0.29.2
    Preparing search index...

    Class AppEventTypeAccessor

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    options

    Methods

    getUniqueIdentifier get put patch archive restore getPath

    Constructors

    Properties

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

    Methods

    • Returns Promise<
          {
              revision: string;
              archivedAt?: string;
              webhookKey: string;
              subscribeRequest?: {
                  method?: GET
                  | POST
                  | PATCH
                  | PUT
                  | DELETE;
                  uri: any;
                  headers?: Record<string, any>;
                  query?: Record<string, any>;
                  body?: any;
              };
              example?: any;
              schema?: DataSchema;
              globalWebhookUri: string;
              tenantIdFormula?: any;
              userIdFormula?: any;
              id: string;
              uuid?: string;
              key?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?:
                  | BUILDING
                  | CLIENT_ACTION_REQUIRED
                  | CONFIGURATION_ERROR
                  | SETUP_FAILED
                  | READY
                  | DISCONNECTING;
              errors?: ErrorDataSchema[];
              createdAt?: string;
              updatedAt?: string;
              isDeactivated?: boolean;
              isReadOnly?: boolean;
          },
      >

    • Parameters

      Returns Promise<
          {
              revision: string;
              archivedAt?: string;
              webhookKey: string;
              subscribeRequest?: {
                  method?: GET
                  | POST
                  | PATCH
                  | PUT
                  | DELETE;
                  uri: any;
                  headers?: Record<string, any>;
                  query?: Record<string, any>;
                  body?: any;
              };
              example?: any;
              schema?: DataSchema;
              globalWebhookUri: string;
              tenantIdFormula?: any;
              userIdFormula?: any;
              id: string;
              uuid?: string;
              key?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?:
                  | BUILDING
                  | CLIENT_ACTION_REQUIRED
                  | CONFIGURATION_ERROR
                  | SETUP_FAILED
                  | READY
                  | DISCONNECTING;
              errors?: ErrorDataSchema[];
              createdAt?: string;
              updatedAt?: string;
              isDeactivated?: boolean;
              isReadOnly?: boolean;
          },
      >

    • Parameters

      Returns Promise<
          {
              revision: string;
              archivedAt?: string;
              webhookKey: string;
              subscribeRequest?: {
                  method?: GET
                  | POST
                  | PATCH
                  | PUT
                  | DELETE;
                  uri: any;
                  headers?: Record<string, any>;
                  query?: Record<string, any>;
                  body?: any;
              };
              example?: any;
              schema?: DataSchema;
              globalWebhookUri: string;
              tenantIdFormula?: any;
              userIdFormula?: any;
              id: string;
              uuid?: string;
              key?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?:
                  | BUILDING
                  | CLIENT_ACTION_REQUIRED
                  | CONFIGURATION_ERROR
                  | SETUP_FAILED
                  | READY
                  | DISCONNECTING;
              errors?: ErrorDataSchema[];
              createdAt?: string;
              updatedAt?: string;
              isDeactivated?: boolean;
              isReadOnly?: boolean;
          },
      >

    • Returns Promise<void>

    • Returns Promise<
          {
              revision: string;
              archivedAt?: string;
              webhookKey: string;
              subscribeRequest?: {
                  method?: GET
                  | POST
                  | PATCH
                  | PUT
                  | DELETE;
                  uri: any;
                  headers?: Record<string, any>;
                  query?: Record<string, any>;
                  body?: any;
              };
              example?: any;
              schema?: DataSchema;
              globalWebhookUri: string;
              tenantIdFormula?: any;
              userIdFormula?: any;
              id: string;
              uuid?: string;
              key?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?:
                  | BUILDING
                  | CLIENT_ACTION_REQUIRED
                  | CONFIGURATION_ERROR
                  | SETUP_FAILED
                  | READY
                  | DISCONNECTING;
              errors?: ErrorDataSchema[];
              createdAt?: string;
              updatedAt?: string;
              isDeactivated?: boolean;
              isReadOnly?: boolean;
          },
      >

    • Parameters

      • operation: string = ''

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods