/*
 * This code was auto generated by AfterShip SDK Generator.
 * Do not edit the class manually.
 */
import { AdditionalFields } from "./AdditionalFields";
import { CourierCredentials } from "./CourierCredentials";

/**
 * Courier object
 */
export interface Courier {
  /**
   * Unique code of courier. Get the slugs from .
   */
  slug?: string;
  /**
   * Name of courier
   */
  name?: string;
  /**
   * Contact phone number of courier
   */
  phone?: string | null;
  /**
   * Other name of courier
   */
  other_name?: string | null;
  /**
   * Website link of courier
   */
  web_url?: string | null;
  /**
   * The extra fields need for tracking, such as `tracking_account_number`, `tracking_postal_code`, `tracking_ship_date`, `tracking_key`, `tracking_destination_country_region`
   */
  required_fields?: AdditionalFields[] | null;
  /**
   * The extra fields which are optional for tracking. Basically it's the same as required_fields, but the difference is that only some of the tracking numbers require these fields.
   */
  optional_fields?: AdditionalFields[] | null;
  /**
   * Default language of tracking results
   */
  default_language?: string | null;
  /**
   * Other supported languages
   */
  support_languages?: string[] | null;
  /**
   * Country/Region code (ISO Alpha-3) where the courier provides service
   */
  service_from_country_regions?: string[] | null;
  /**
   * Refers to the authentication details required for each specific carrier (such as API keys, username, password, etc.) that the user must provide to create a carrier connection. The content varies by carrier.
   */
  credentials?: CourierCredentials;
}