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

    Class PackagesAccessor

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    find findAll create

    Constructors

    Methods

    • Parameters

      • Optionalquery: {
            limit?: number;
            cursor?: string;
            includeArchived?: boolean;
            search?: string;
            externalAppId?: string;
            integrationKey?: string;
            integrationId?: string;
            connectionId?: string;
            connectionKey?: string;
            instanceKey?: string;
            parentId?: string;
            universalParentId?: string;
            tenantId?: string;
            userId?: string;
            isUniversal?: boolean;
            layer?: "connection" | "integration" | "universal";
        }
        • Optionallimit?: number
        • Optionalcursor?: string
        • OptionalincludeArchived?: boolean
        • Optionalsearch?: string
        • OptionalexternalAppId?: string

          Filter packages by external app ID.

        • OptionalintegrationKey?: string
        • OptionalintegrationId?: string
        • OptionalconnectionId?: string
        • OptionalconnectionKey?: string
        • OptionalinstanceKey?: string
        • OptionalparentId?: string
        • OptionaluniversalParentId?: string
        • OptionaltenantId?: string
        • OptionaluserId?: string
        • OptionalisUniversal?: boolean
        • Optionallayer?: "connection" | "integration" | "universal"

      Returns Promise<
          PaginationResponse<
              {
                  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?: (...)
                              | (...)
                              | (...); parameters?: (...) | (...) },
                          >;
                          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

      • Optionalquery: Omit<
            {
                limit?: number;
                cursor?: string;
                includeArchived?: boolean;
                search?: string;
                externalAppId?: string;
                integrationKey?: string;
                integrationId?: string;
                connectionId?: string;
                connectionKey?: string;
                instanceKey?: string;
                parentId?: string;
                universalParentId?: string;
                tenantId?: string;
                userId?: string;
                isUniversal?: boolean;
                layer?: "connection"
                | "integration"
                | "universal";
            },
            "limit",
        >

      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?: (...)
                          | (...)
                          | (...); parameters?: (...) | (...) },
                      >;
                      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

      • data: {
            scenarioTemplateId?: string;
            elements?: { id: string; type: WorkspaceElementType; element?: any }[];
            uuid?: string;
            key?: string;
            name?: string;
            description?: string;
            meta?: Record<string, any>;
            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<
          {
              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;
          },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods