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

    Class AppEventSubscriptionAccessor

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    options

    Methods

    subscribe getUniqueIdentifier get getId create put patch archive delete restore getPath

    Constructors

    Properties

    options: {
        client: MembraneApiClient;
        instancePath: string;
        selector: string | AppEventSubscriptionSelector;
        type?: WorkspaceElementType;
    }

    Methods

    • Returns Promise<void>

    • Returns Promise<
          {
              appEventType?: {
                  revision: string;
                  archivedAt?: 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;
                  userIdFormula?: any;
                  id: string;
                  key?: string;
                  uuid?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                  errors?: ErrorDataSchema[];
                  createdAt?: string;
                  updatedAt?: string;
                  isDeactivated?: boolean;
              };
              user?: {
                  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;
              };
              revision: string;
              appEventTypeId: string;
              userId: string;
              instanceKey?: string;
              isSubscribed: boolean;
              schema?: DataSchema;
              webhookUri: string;
              subscriptionRequest: {
                  method?: GET
                  | POST
                  | PATCH
                  | PUT
                  | DELETE;
                  uri: any;
                  headers?: Record<string, any>;
                  query?: Record<string, any>;
                  body?: any;
              };
              subscriptionResponse?: any;
              archivedAt?: string;
              id: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              errors?: ErrorDataSchema[];
              createdAt?: string;
              updatedAt?: string;
              isDeactivated?: boolean;
          },
      >

    • Parameters

      Returns Promise<
          {
              appEventType?: {
                  revision: string;
                  archivedAt?: 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;
                  userIdFormula?: any;
                  id: string;
                  key?: string;
                  uuid?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                  errors?: ErrorDataSchema[];
                  createdAt?: string;
                  updatedAt?: string;
                  isDeactivated?: boolean;
              };
              user?: {
                  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;
              };
              revision: string;
              appEventTypeId: string;
              userId: string;
              instanceKey?: string;
              isSubscribed: boolean;
              schema?: DataSchema;
              webhookUri: string;
              subscriptionRequest: {
                  method?: GET
                  | POST
                  | PATCH
                  | PUT
                  | DELETE;
                  uri: any;
                  headers?: Record<string, any>;
                  query?: Record<string, any>;
                  body?: any;
              };
              subscriptionResponse?: any;
              archivedAt?: string;
              id: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              errors?: ErrorDataSchema[];
              createdAt?: string;
              updatedAt?: string;
              isDeactivated?: boolean;
          },
      >

    • Parameters

      Returns Promise<
          {
              appEventType?: {
                  revision: string;
                  archivedAt?: 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;
                  userIdFormula?: any;
                  id: string;
                  key?: string;
                  uuid?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                  errors?: ErrorDataSchema[];
                  createdAt?: string;
                  updatedAt?: string;
                  isDeactivated?: boolean;
              };
              user?: {
                  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;
              };
              revision: string;
              appEventTypeId: string;
              userId: string;
              instanceKey?: string;
              isSubscribed: boolean;
              schema?: DataSchema;
              webhookUri: string;
              subscriptionRequest: {
                  method?: GET
                  | POST
                  | PATCH
                  | PUT
                  | DELETE;
                  uri: any;
                  headers?: Record<string, any>;
                  query?: Record<string, any>;
                  body?: any;
              };
              subscriptionResponse?: any;
              archivedAt?: string;
              id: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              errors?: ErrorDataSchema[];
              createdAt?: string;
              updatedAt?: string;
              isDeactivated?: boolean;
          },
      >

    • Parameters

      Returns Promise<
          {
              appEventType?: {
                  revision: string;
                  archivedAt?: 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;
                  userIdFormula?: any;
                  id: string;
                  key?: string;
                  uuid?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                  errors?: ErrorDataSchema[];
                  createdAt?: string;
                  updatedAt?: string;
                  isDeactivated?: boolean;
              };
              user?: {
                  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;
              };
              revision: string;
              appEventTypeId: string;
              userId: string;
              instanceKey?: string;
              isSubscribed: boolean;
              schema?: DataSchema;
              webhookUri: string;
              subscriptionRequest: {
                  method?: GET
                  | POST
                  | PATCH
                  | PUT
                  | DELETE;
                  uri: any;
                  headers?: Record<string, any>;
                  query?: Record<string, any>;
                  body?: any;
              };
              subscriptionResponse?: any;
              archivedAt?: string;
              id: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              errors?: ErrorDataSchema[];
              createdAt?: string;
              updatedAt?: string;
              isDeactivated?: boolean;
          },
      >

    • Returns Promise<void>

      • use archive instead

    • Returns Promise<
          {
              appEventType?: {
                  revision: string;
                  archivedAt?: 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;
                  userIdFormula?: any;
                  id: string;
                  key?: string;
                  uuid?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                  errors?: ErrorDataSchema[];
                  createdAt?: string;
                  updatedAt?: string;
                  isDeactivated?: boolean;
              };
              user?: {
                  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;
              };
              revision: string;
              appEventTypeId: string;
              userId: string;
              instanceKey?: string;
              isSubscribed: boolean;
              schema?: DataSchema;
              webhookUri: string;
              subscriptionRequest: {
                  method?: GET
                  | POST
                  | PATCH
                  | PUT
                  | DELETE;
                  uri: any;
                  headers?: Record<string, any>;
                  query?: Record<string, any>;
                  body?: any;
              };
              subscriptionResponse?: any;
              archivedAt?: string;
              id: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              errors?: ErrorDataSchema[];
              createdAt?: string;
              updatedAt?: string;
              isDeactivated?: boolean;
          },
      >

    • Parameters

      • operation: string = ''

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods