utils

export interface IDelParams {
  /** Subscriber Id */
  id: string
}

export interface IFetchParams {
  /** Subscriber Id or Email */
  id: string
}

export interface IListParams {
  /** default to 25 */
  limit?: number
  /** Defaults to first page. Cursor value available in response body */
  cursor?: string
  sort?: `${SortOrder}${SortFields}`
  filter?: {
    [k in Filters]?: string
  }
}

export interface IListResult<TCustomFields> {
  data: Array<ISubscriber<TCustomFields>>
  links: ILinks
  meta: IMeta
}

export interface IMeta {
  path: string
  per_page: number
  next_cursor: string | null
  prev_cursor: string | null
}

export interface ISubscriber<TCustomFields> {
  id: string
  email: string
  status: string
  source: string
  sent: number
  opens_count: number
  clicks_count: number
  open_rate: number
  click_rate: number
  ip_address: string | null
  subscribed_at: DatetimeStr
  unsubscribed_at: DatetimeStr | null
  created_at: DatetimeStr
  updated_at: DatetimeStr
  fields: IStandardFields & TCustomFields
  groups: Array<string>
  opted_in_at: DatetimeStr | null
  optin_ip: DatetimeStr | null
}

export interface IUpsertParams<TCustomFields> {
  email: string
  fields?: Partial<IStandardFields & TCustomFields>
  groups?: Array<string>
  status?: 'active' | 'unsubscribed' | 'unconfirmed' | 'bounced' | 'junk'
  subscribed_at?: DatetimeStr
  ip_address?: string | null
  opted_in_at?: DatetimeStr | null
  optin_ip?: DatetimeStr | null
  unsubscribed_at?: DatetimeStr | null
}

export interface IUpsertResult<TCustomFields> {
  data: ISubscriber<TCustomFields>
}

export declare const del: (params: IDelParams) => Effect<IDelResult>

export declare const fetch: <TCustomFields>(params: IFetchParams) => Effect<IFetchResult<TCustomFields>>

export declare const list: <TCustomFields>(params: IListParams) => Effect<IListResult<TCustomFields>>

export declare const upsert: <TCustomFields>(
  params: IUpsertParams<TCustomFields>
) => Effect<IUpsertResult<TCustomFields>>

export declare const upsertBatch: <TCustomFields>(
  params: IUpsertParams<TCustomFields>
) => E.Either<Error, IBatchRequest>