@foxy.io/sdk/dist/types/backend/Graph/regions.d.ts

Universal SDK for a full server-side and a limited in-browser access to Foxy hAPI.

import type { Graph } from '../../core';
import type { PropertyHelpers } from './property_helpers';

export interface Regions extends Graph {
  curie: 'fx:regions';

  links: {
    /** This resource. */
    'self': Regions;
    /** Various predefined property values. */
    'fx:property_helpers': PropertyHelpers;
  };

  props: {
    /** A small, human readable explanation of this property helper. */
    message: string;
    /** JSON objects with the region codes as the keys. */
    values: {
      [key: string]: {
        /** The default name for this region. */
        default: string;
        /** The code for this region. */
        code: string;
        /** Array of alternative names for this region. */
        alternate_values: string[];
        /** This value determines which regions will show up first in our find-as-you-type system. */
        boost: number;
        /** True if this region is currently recognized. */
        active: boolean;
      };
    };
  };
}