Mayson Monorepo Documentation
    Preparing search index...

    Interface LocationUpdateParams

    interface LocationUpdateParams {
        address?: AddressParam;
        address_kana?: JapanAddressParam;
        address_kanji?: JapanAddressParam;
        configuration_overrides?: string;
        display_name?: string;
        display_name_kana?: string;
        display_name_kanji?: string;
        expand?: string[];
        metadata?: Emptyable<MetadataParam>;
        phone?: string;
    }
    Index

    Properties

    address? address_kana? address_kanji? configuration_overrides? display_name? display_name_kana? display_name_kanji? expand? metadata? phone?

    Properties

    address?: AddressParam

    The full address of the location. You can't change the location's country. If you need to modify the country field, create a new Location object and re-register any existing readers to that location.

    address_kana?: JapanAddressParam

    The Kana variation of the full address of the location (Japan only).

    address_kanji?: JapanAddressParam

    The Kanji variation of the full address of the location (Japan only).

    configuration_overrides?: string

    The ID of a configuration that will be used to customize all readers in this location.

    display_name?: string

    A name for the location.

    display_name_kana?: string

    The Kana variation of the name for the location (Japan only).

    display_name_kanji?: string

    The Kanji variation of the name for the location (Japan only).

    expand?: string[]

    Specifies which fields in the response should be expanded.

    metadata?: Emptyable<MetadataParam>

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    phone?: string

    The phone number for the location.

    Settings

    Member Visibility

    On This Page

    Properties