@medusajs/types/dist/region/mutations.d.ts

Medusa Types definition

import { MetadataType } from "../common";
/**
 * The region to be created.
 */
export interface CreateRegionDTO {
    /**
     * The name of the region.
     */
    name: string;
    /**
     * The currency code of the region.
     */
    currency_code: string;
    /**
     * Setting to indicate whether taxes need to be applied automatically
     */
    automatic_taxes?: boolean;
    /**
     * The region's countries.
     */
    countries?: string[];
    /**
     * The region's payment providers.
     */
    payment_providers?: string[];
    /**
     * Holds custom data in key-value pairs.
     */
    metadata?: MetadataType;
}
/**
 * The attributes in the region to be created or updated.
 */
export interface UpsertRegionDTO {
    /**
     * The id of the region in the case of an update
     */
    id?: string;
    /**
     * The target name of the region. Required when
     * creating a region.
     */
    name?: string;
    /**
     * The currency code of the region. Required when
     * creating a region.
     */
    currency_code?: string;
    /**
     * Setting to indicate whether taxes need to be applied automatically.
     */
    automatic_taxes?: boolean;
    /**
     * The region's countries.
     */
    countries?: string[];
    /**
     * Holds custom data in key-value pairs.
     */
    metadata?: MetadataType;
}
/**
 * The attributes to update in the region.
 */
export interface UpdateRegionDTO {
    /**
     * The target name of the region
     */
    name?: string;
    /**
     * The currency code of the region.
     */
    currency_code?: string;
    /**
     * Setting to indicate whether taxes need to be applied automatically
     */
    automatic_taxes?: boolean;
    /**
     * The region's countries.
     */
    countries?: string[];
    /**
     * Holds custom data in key-value pairs.
     */
    metadata?: MetadataType;
}
//# sourceMappingURL=mutations.d.ts.map