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

    Class PackageAccessor

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

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

    Methods

    • Returns Promise<
          {
              appliedToIntegrations?: {
                  element: {
                      scenarioTemplateId?: string;
                      elements?: { id: string; type: WorkspaceElementType; element?: any }[];
                      key: string;
                      name: string;
                      isCustomized?: boolean;
                      isPublic?: boolean;
                      id: string;
                      uuid?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      state?:
                          | BUILDING
                          | CLIENT_ACTION_REQUIRED
                          | CONFIGURATION_ERROR
                          | SETUP_FAILED
                          | READY
                          | DISCONNECTING;
                      errors?: ErrorDataSchema[];
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      isReadOnly?: boolean;
                      integrationId?: string;
                      integrationUuid?: string;
                      integrationKey?: string;
                      parentId?: string;
                      parentUuid?: string;
                      parentKey?: string;
                      connectionId?: string;
                      instanceKey?: string;
                      isUniversal?: boolean;
                      externalAppId?: string;
                      externalAppUuid?: string;
                      externalAppKey?: string;
                  };
                  integration: {
                      logoUri: string;
                      connectorId?: string;
                      connectorVersion?: string;
                      oAuthCallbackUri?: string;
                      parameters?: any;
                      archivedAt?: string;
                      hasMissingParameters?: boolean;
                      hasDocumentation?: boolean;
                      hasOperations?: boolean;
                      operationsCount?: number;
                      hasData?: boolean;
                      dataCollectionsCount?: number;
                      hasEvents?: boolean;
                      eventsCount?: number;
                      hasGlobalWebhooks?: boolean;
                      hasUdm?: boolean;
                      isTest?: boolean;
                      externalAppId?: string;
                      appUuid?: string;
                      isDeactivated?: boolean;
                      authType?: | "proxy"
                      | "integration-app-token"
                      | "membrane-token"
                      | "oauth2"
                      | "oauth1"
                      | "client-credentials";
                      optionsConfig?: Record<
                          string,
                          { disabled?: boolean; parameters?: Record<(...), (...)> },
                      >;
                      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[];
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      isReadOnly?: boolean;
                  };
              }[];
              scenarioTemplateId?: string;
              key: string;
              name: string;
              isCustomized?: boolean;
              isPublic?: boolean;
              elements?: { id: string; type: WorkspaceElementType; element?: any }[];
              version?: string;
              changelog?: string;
              parentPackageVersion?: string;
              id: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              state?:
                  | BUILDING
                  | CLIENT_ACTION_REQUIRED
                  | CONFIGURATION_ERROR
                  | SETUP_FAILED
                  | READY
                  | DISCONNECTING;
              errors?: ErrorDataSchema[];
              revision?: string;
              createdAt?: string;
              updatedAt?: string;
              archivedAt?: string;
              isDeactivated?: boolean;
              isReadOnly?: boolean;
              integrationId?: string;
              integrationUuid?: string;
              integrationKey?: string;
              parentId?: string;
              parentUuid?: string;
              parentKey?: string;
              connectionId?: string;
              instanceKey?: string;
              isUniversal?: boolean;
              externalAppId?: string;
              externalAppUuid?: string;
              externalAppKey?: string;
          },
      >

    • Parameters

      Returns Promise<
          {
              appliedToIntegrations?: {
                  element: {
                      scenarioTemplateId?: string;
                      elements?: { id: string; type: WorkspaceElementType; element?: any }[];
                      key: string;
                      name: string;
                      isCustomized?: boolean;
                      isPublic?: boolean;
                      id: string;
                      uuid?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      state?:
                          | BUILDING
                          | CLIENT_ACTION_REQUIRED
                          | CONFIGURATION_ERROR
                          | SETUP_FAILED
                          | READY
                          | DISCONNECTING;
                      errors?: ErrorDataSchema[];
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      isReadOnly?: boolean;
                      integrationId?: string;
                      integrationUuid?: string;
                      integrationKey?: string;
                      parentId?: string;
                      parentUuid?: string;
                      parentKey?: string;
                      connectionId?: string;
                      instanceKey?: string;
                      isUniversal?: boolean;
                      externalAppId?: string;
                      externalAppUuid?: string;
                      externalAppKey?: string;
                  };
                  integration: {
                      logoUri: string;
                      connectorId?: string;
                      connectorVersion?: string;
                      oAuthCallbackUri?: string;
                      parameters?: any;
                      archivedAt?: string;
                      hasMissingParameters?: boolean;
                      hasDocumentation?: boolean;
                      hasOperations?: boolean;
                      operationsCount?: number;
                      hasData?: boolean;
                      dataCollectionsCount?: number;
                      hasEvents?: boolean;
                      eventsCount?: number;
                      hasGlobalWebhooks?: boolean;
                      hasUdm?: boolean;
                      isTest?: boolean;
                      externalAppId?: string;
                      appUuid?: string;
                      isDeactivated?: boolean;
                      authType?: | "proxy"
                      | "integration-app-token"
                      | "membrane-token"
                      | "oauth2"
                      | "oauth1"
                      | "client-credentials";
                      optionsConfig?: Record<
                          string,
                          { disabled?: boolean; parameters?: Record<(...), (...)> },
                      >;
                      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[];
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      isReadOnly?: boolean;
                  };
              }[];
              scenarioTemplateId?: string;
              key: string;
              name: string;
              isCustomized?: boolean;
              isPublic?: boolean;
              elements?: { id: string; type: WorkspaceElementType; element?: any }[];
              version?: string;
              changelog?: string;
              parentPackageVersion?: string;
              id: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              state?:
                  | BUILDING
                  | CLIENT_ACTION_REQUIRED
                  | CONFIGURATION_ERROR
                  | SETUP_FAILED
                  | READY
                  | DISCONNECTING;
              errors?: ErrorDataSchema[];
              revision?: string;
              createdAt?: string;
              updatedAt?: string;
              archivedAt?: string;
              isDeactivated?: boolean;
              isReadOnly?: boolean;
              integrationId?: string;
              integrationUuid?: string;
              integrationKey?: string;
              parentId?: string;
              parentUuid?: string;
              parentKey?: string;
              connectionId?: string;
              instanceKey?: string;
              isUniversal?: boolean;
              externalAppId?: string;
              externalAppUuid?: string;
              externalAppKey?: string;
          },
      >

    • Parameters

      Returns Promise<
          {
              appliedToIntegrations?: {
                  element: {
                      scenarioTemplateId?: string;
                      elements?: { id: string; type: WorkspaceElementType; element?: any }[];
                      key: string;
                      name: string;
                      isCustomized?: boolean;
                      isPublic?: boolean;
                      id: string;
                      uuid?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      state?:
                          | BUILDING
                          | CLIENT_ACTION_REQUIRED
                          | CONFIGURATION_ERROR
                          | SETUP_FAILED
                          | READY
                          | DISCONNECTING;
                      errors?: ErrorDataSchema[];
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      isReadOnly?: boolean;
                      integrationId?: string;
                      integrationUuid?: string;
                      integrationKey?: string;
                      parentId?: string;
                      parentUuid?: string;
                      parentKey?: string;
                      connectionId?: string;
                      instanceKey?: string;
                      isUniversal?: boolean;
                      externalAppId?: string;
                      externalAppUuid?: string;
                      externalAppKey?: string;
                  };
                  integration: {
                      logoUri: string;
                      connectorId?: string;
                      connectorVersion?: string;
                      oAuthCallbackUri?: string;
                      parameters?: any;
                      archivedAt?: string;
                      hasMissingParameters?: boolean;
                      hasDocumentation?: boolean;
                      hasOperations?: boolean;
                      operationsCount?: number;
                      hasData?: boolean;
                      dataCollectionsCount?: number;
                      hasEvents?: boolean;
                      eventsCount?: number;
                      hasGlobalWebhooks?: boolean;
                      hasUdm?: boolean;
                      isTest?: boolean;
                      externalAppId?: string;
                      appUuid?: string;
                      isDeactivated?: boolean;
                      authType?: | "proxy"
                      | "integration-app-token"
                      | "membrane-token"
                      | "oauth2"
                      | "oauth1"
                      | "client-credentials";
                      optionsConfig?: Record<
                          string,
                          { disabled?: boolean; parameters?: Record<(...), (...)> },
                      >;
                      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[];
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      isReadOnly?: boolean;
                  };
              }[];
              scenarioTemplateId?: string;
              key: string;
              name: string;
              isCustomized?: boolean;
              isPublic?: boolean;
              elements?: { id: string; type: WorkspaceElementType; element?: any }[];
              version?: string;
              changelog?: string;
              parentPackageVersion?: string;
              id: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              state?:
                  | BUILDING
                  | CLIENT_ACTION_REQUIRED
                  | CONFIGURATION_ERROR
                  | SETUP_FAILED
                  | READY
                  | DISCONNECTING;
              errors?: ErrorDataSchema[];
              revision?: string;
              createdAt?: string;
              updatedAt?: string;
              archivedAt?: string;
              isDeactivated?: boolean;
              isReadOnly?: boolean;
              integrationId?: string;
              integrationUuid?: string;
              integrationKey?: string;
              parentId?: string;
              parentUuid?: string;
              parentKey?: string;
              connectionId?: string;
              instanceKey?: string;
              isUniversal?: boolean;
              externalAppId?: string;
              externalAppUuid?: string;
              externalAppKey?: string;
          },
      >

    • Returns Promise<void>

    • Returns Promise<
          {
              appliedToIntegrations?: {
                  element: {
                      scenarioTemplateId?: string;
                      elements?: { id: string; type: WorkspaceElementType; element?: any }[];
                      key: string;
                      name: string;
                      isCustomized?: boolean;
                      isPublic?: boolean;
                      id: string;
                      uuid?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      state?:
                          | BUILDING
                          | CLIENT_ACTION_REQUIRED
                          | CONFIGURATION_ERROR
                          | SETUP_FAILED
                          | READY
                          | DISCONNECTING;
                      errors?: ErrorDataSchema[];
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      isReadOnly?: boolean;
                      integrationId?: string;
                      integrationUuid?: string;
                      integrationKey?: string;
                      parentId?: string;
                      parentUuid?: string;
                      parentKey?: string;
                      connectionId?: string;
                      instanceKey?: string;
                      isUniversal?: boolean;
                      externalAppId?: string;
                      externalAppUuid?: string;
                      externalAppKey?: string;
                  };
                  integration: {
                      logoUri: string;
                      connectorId?: string;
                      connectorVersion?: string;
                      oAuthCallbackUri?: string;
                      parameters?: any;
                      archivedAt?: string;
                      hasMissingParameters?: boolean;
                      hasDocumentation?: boolean;
                      hasOperations?: boolean;
                      operationsCount?: number;
                      hasData?: boolean;
                      dataCollectionsCount?: number;
                      hasEvents?: boolean;
                      eventsCount?: number;
                      hasGlobalWebhooks?: boolean;
                      hasUdm?: boolean;
                      isTest?: boolean;
                      externalAppId?: string;
                      appUuid?: string;
                      isDeactivated?: boolean;
                      authType?: | "proxy"
                      | "integration-app-token"
                      | "membrane-token"
                      | "oauth2"
                      | "oauth1"
                      | "client-credentials";
                      optionsConfig?: Record<
                          string,
                          { disabled?: boolean; parameters?: Record<(...), (...)> },
                      >;
                      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[];
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      isReadOnly?: boolean;
                  };
              }[];
              scenarioTemplateId?: string;
              key: string;
              name: string;
              isCustomized?: boolean;
              isPublic?: boolean;
              elements?: { id: string; type: WorkspaceElementType; element?: any }[];
              version?: string;
              changelog?: string;
              parentPackageVersion?: string;
              id: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              state?:
                  | BUILDING
                  | CLIENT_ACTION_REQUIRED
                  | CONFIGURATION_ERROR
                  | SETUP_FAILED
                  | READY
                  | DISCONNECTING;
              errors?: ErrorDataSchema[];
              revision?: string;
              createdAt?: string;
              updatedAt?: string;
              archivedAt?: string;
              isDeactivated?: boolean;
              isReadOnly?: boolean;
              integrationId?: string;
              integrationUuid?: string;
              integrationKey?: string;
              parentId?: string;
              parentUuid?: string;
              parentKey?: string;
              connectionId?: string;
              instanceKey?: string;
              isUniversal?: boolean;
              externalAppId?: string;
              externalAppUuid?: string;
              externalAppKey?: string;
          },
      >

    • Parameters

      • operation: string = ''

      Returns string