/** * @example * { * object_type: "vehicle", * id: 16789, * ext_id: "507f1f77bc", * email: "jane.doe@example.com", * sms: "33612345678", * offset: 0 * } */ export interface GetAssociatedRecordsRequest { /** Object type of the source record, exactly as defined in your account. Accepts any object type defined in the account, for example a custom object type or `contact`. */ object_type: string; /** Internal Brevo ID of the source record. Must be a positive integer. Provide exactly one of `id`, `ext_id`, `email` or `sms`. */ id?: number; /** External ID of the source record in your system. Provide exactly one of `id`, `ext_id`, `email` or `sms`. */ ext_id?: string; /** Email address of the source contact. Only accepted when `object_type` is `contact`. Provide exactly one of `id`, `ext_id`, `email` or `sms`. */ email?: string; /** Phone number of the source contact, including the country code. It may be given with or without a leading `+`; percent-encode the `+` as `%2B`, because a literal `+` in a query string is read as a space. Only accepted when `object_type` is `contact`. Provide exactly one of `id`, `ext_id`, `email` or `sms`. */ sms?: string; /** Restricts the response to the given associated object types. Repeat the parameter to request several types, for example `?type=contact&type=garage`. Maximum 5 types per call. Associations of every type are returned when omitted. */ type?: string | string[]; /** Number of records to skip before the first record of the page. Defaults to 0. Increase by 20 to fetch the next page. */ offset?: number; }