Class ConnectionDataCollectionAccessor

constructor

• new ConnectionDataCollectionAccessor(
      client: MembraneApiClient,
      connectionAccessor: ConnectionAccessor,
      key: string,
      parameters: Record<string, any>,
  ): ConnectionDataCollectionAccessor

  Parameters

  • client: MembraneApiClient
  • connectionAccessor: ConnectionAccessor
  • key: string
  • parameters: Record<string, any>

  Returns ConnectionDataCollectionAccessor

client

connectionAccessor

key

parameters

get

• get(): Promise<
      {
          type: "collection";
          key?: string;
          name: string;
          parametersSchema?: DataSchema;
          fieldsSchema?: DataSchema;
          list?: {
              apiRequests?: { path: unknown; method: unknown }[];
              filterFields?: string[];
          };
          search?: { apiRequests?: { path: unknown; method: unknown }[] };
          match?: {
              apiRequests?: { path: unknown; method: unknown }[];
              fields?: string[];
          };
          findById?: { apiRequests?: { path: unknown; method: unknown }[] };
          create?: {
              apiRequests?: { path: unknown; method: unknown }[];
              fields?: string[];
              requiredFields?: string[];
              excludedFields?: string[];
          };
          update?: {
              apiRequests?: { path: unknown; method: unknown }[];
              fields?: string[];
              excludedFields?: string[];
          };
          delete?: { apiRequests?: { path: unknown; method: unknown }[] };
          events?: {
              created?: {
                  type: "push" | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
              updated?: {
                  type: "push"
                  | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
              deleted?: {
                  type: "push"
                  | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
              all?: { type: "push"
              | "pull"; isFullScan?: boolean; isIdOnly?: boolean };
              [key: string]: {
                  type: "push" | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
          };
          customFields?: boolean;
          udm?: Record<
              string,
              {
                  fields?: string[];
                  extract?: Record<string, any>;
                  parse?: Record<string, any>;
              },
          >;
          find?: {
              apiRequests?: { path: unknown; method: unknown }[];
              queryFields?: string[];
          };
      },
  >

  Returns Promise<
      {
          type: "collection";
          key?: string;
          name: string;
          parametersSchema?: DataSchema;
          fieldsSchema?: DataSchema;
          list?: {
              apiRequests?: { path: unknown; method: unknown }[];
              filterFields?: string[];
          };
          search?: { apiRequests?: { path: unknown; method: unknown }[] };
          match?: {
              apiRequests?: { path: unknown; method: unknown }[];
              fields?: string[];
          };
          findById?: { apiRequests?: { path: unknown; method: unknown }[] };
          create?: {
              apiRequests?: { path: unknown; method: unknown }[];
              fields?: string[];
              requiredFields?: string[];
              excludedFields?: string[];
          };
          update?: {
              apiRequests?: { path: unknown; method: unknown }[];
              fields?: string[];
              excludedFields?: string[];
          };
          delete?: { apiRequests?: { path: unknown; method: unknown }[] };
          events?: {
              created?: {
                  type: "push" | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
              updated?: {
                  type: "push"
                  | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
              deleted?: {
                  type: "push"
                  | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
              all?: { type: "push"
              | "pull"; isFullScan?: boolean; isIdOnly?: boolean };
              [key: string]: {
                  type: "push" | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
          };
          customFields?: boolean;
          udm?: Record<
              string,
              {
                  fields?: string[];
                  extract?: Record<string, any>;
                  parse?: Record<string, any>;
              },
          >;
          find?: {
              apiRequests?: { path: unknown; method: unknown }[];
              queryFields?: string[];
          };
      },
  >

findById

• findById(
      request?: { parameters?: Record<string, any>; id: string; udm?: string },
  ): Promise<
      {
          record: {
              id: string;
              name?: string;
              uri?: string;
              iconUri?: string;
              fields?: Record<string, any>;
              udm?: string;
              unifiedFields?: Record<string, any>;
              rawFields?: Record<string, any>;
              createdTime?: string;
              updatedTime?: string;
              deletedTime?: string;
              createdById?: string;
              updatedById?: string;
          };
      },
  >

  Parameters

  • Optionalrequest: { parameters?: Record<string, any>; id: string; udm?: string }

  Returns Promise<
      {
          record: {
              id: string;
              name?: string;
              uri?: string;
              iconUri?: string;
              fields?: Record<string, any>;
              udm?: string;
              unifiedFields?: Record<string, any>;
              rawFields?: Record<string, any>;
              createdTime?: string;
              updatedTime?: string;
              deletedTime?: string;
              createdById?: string;
              updatedById?: string;
          };
      },
  >

list

• list(
      request?: {
          parameters?: Record<string, any>;
          filter?: any;
          unifiedFilter?: any;
          cursor?: string;
      },
  ): Promise<
      {
          records: {
              id: string;
              name?: string;
              uri?: string;
              iconUri?: string;
              fields?: Record<string, any>;
              udm?: string;
              unifiedFields?: Record<string, any>;
              rawFields?: Record<string, any>;
              createdTime?: string;
              updatedTime?: string;
              deletedTime?: string;
              createdById?: string;
              updatedById?: string;
          }[];
          drilldowns?: {
              parameters?: Record<string, any>;
              filter?: Record<string, any>;
          }[];
          cursor?: string;
      },
  >

  Parameters

  • Optionalrequest: {
        parameters?: Record<string, any>;
        filter?: any;
        unifiedFilter?: any;
        cursor?: string;
    }

  Returns Promise<
      {
          records: {
              id: string;
              name?: string;
              uri?: string;
              iconUri?: string;
              fields?: Record<string, any>;
              udm?: string;
              unifiedFields?: Record<string, any>;
              rawFields?: Record<string, any>;
              createdTime?: string;
              updatedTime?: string;
              deletedTime?: string;
              createdById?: string;
              updatedById?: string;
          }[];
          drilldowns?: {
              parameters?: Record<string, any>;
              filter?: Record<string, any>;
          }[];
          cursor?: string;
      },
  >

search

• search(
      request?: {
          parameters?: Record<string, any>;
          query: string;
          cursor?: string;
      },
  ): Promise<
      {
          records: {
              id: string;
              name?: string;
              uri?: string;
              iconUri?: string;
              fields?: Record<string, any>;
              udm?: string;
              unifiedFields?: Record<string, any>;
              rawFields?: Record<string, any>;
              createdTime?: string;
              updatedTime?: string;
              deletedTime?: string;
              createdById?: string;
              updatedById?: string;
          }[];
          cursor?: string;
      },
  >

  Parameters

  • Optionalrequest: { parameters?: Record<string, any>; query: string; cursor?: string }

  Returns Promise<
      {
          records: {
              id: string;
              name?: string;
              uri?: string;
              iconUri?: string;
              fields?: Record<string, any>;
              udm?: string;
              unifiedFields?: Record<string, any>;
              rawFields?: Record<string, any>;
              createdTime?: string;
              updatedTime?: string;
              deletedTime?: string;
              createdById?: string;
              updatedById?: string;
          }[];
          cursor?: string;
      },
  >

match

• match(
      request?: {
          parameters?: Record<string, any>;
          query: Record<string, any>;
      },
  ): Promise<
      {
          record?: {
              id: string;
              name?: string;
              uri?: string;
              iconUri?: string;
              fields?: Record<string, any>;
              udm?: string;
              unifiedFields?: Record<string, any>;
              rawFields?: Record<string, any>;
              createdTime?: string;
              updatedTime?: string;
              deletedTime?: string;
              createdById?: string;
              updatedById?: string;
          };
      },
  >

  Parameters

  • Optionalrequest: { parameters?: Record<string, any>; query: Record<string, any> }

  Returns Promise<
      {
          record?: {
              id: string;
              name?: string;
              uri?: string;
              iconUri?: string;
              fields?: Record<string, any>;
              udm?: string;
              unifiedFields?: Record<string, any>;
              rawFields?: Record<string, any>;
              createdTime?: string;
              updatedTime?: string;
              deletedTime?: string;
              createdById?: string;
              updatedById?: string;
          };
      },
  >

create

• create(
      request?: {
          parameters?: Record<string, any>;
          fields: Record<string, any>;
      },
  ): Promise<{ id: string }>

  Parameters

  • Optionalrequest: { parameters?: Record<string, any>; fields: Record<string, any> }

  Returns Promise<{ id: string }>

update

• update(
      request?: {
          parameters?: Record<string, any>;
          id: string;
          fields: Record<string, any>;
      },
  ): Promise<{ id: string }>

  Parameters

  • Optionalrequest: { parameters?: Record<string, any>; id: string; fields: Record<string, any> }

  Returns Promise<{ id: string }>

delete

• delete(
      request?: { parameters?: Record<string, any>; id: string },
  ): Promise<Record<string, never>>

  Parameters

  • Optionalrequest: { parameters?: Record<string, any>; id: string }

  Returns Promise<Record<string, never>>