Class Image

Staticpagination

alt

• get alt(): string | null

  Returns string | null

id

• get id(): number | null

  Returns number | null

name

• get name(): string | null

  Returns string | null

url

• get url(): string | null

  Returns string | null

Staticcreate

• create(
      __namedParameters: {
          imageData: CreateImage | null;
          siteId: number | null;
      },
  ): Promise<
      | {
          errors: { message: { status: number } }[]
          | null;
          result:
              | { homeflow_id: string
              | undefined; path: string; url: string }
              | null;
      }
      | null,
  >

  This will add an updloaded image asset to the DB

  Parameters

  • __namedParameters: { imageData: CreateImage | null; siteId: number | null }

  Returns Promise<
      | {
          errors: { message: { status: number } }[]
          | null;
          result:
              | { homeflow_id: string
              | undefined; path: string; url: string }
              | null;
      }
      | null,
  >

  Example

  const res = await ImageModel.create({ imageData: body, siteId: agency.siteId });
  Copy

  Image creation requires a Bearer token (app verification) via production users api, regardless of environment. This is handled in the images-api-client/index.ts

StaticfindAll

• findAll(
      __namedParameters: {
          name?: string;
          page?: number;
          pageSize?: number;
          type?: string;
      },
  ): Promise<
      {
          errors: ModelError[]
          | null;
          pagination: Pagination | null;
          results: Image[];
      },
  >

  This will return an array of image objects with the structure:

  Parameters

  • __namedParameters: { name?: string; page?: number; pageSize?: number; type?: string }

  Returns Promise<
      {
          errors: ModelError[]
          | null;
          pagination: Pagination | null;
          results: Image[];
      },
  >

  Example

  { url: string; alt: string; }
  Copy