@compassdigital/sdk.typescript 3.0.0-beta.14 → 3.0.0-beta.16

package/lib/location.d.ts

@@ -1,747 +0,0 @@
-export interface POS {
-    id?: string;
-    type?: string;
-    meta?: any;
-}
-export interface MenuHours {
-    id?: string;
-    label?: {
-        en?: string;
-    };
-    hours?: Hours[];
-    is_pickup?: boolean;
-    is_delivery?: boolean;
-    is_frictionless?: boolean;
-}
-export interface Hours {
-    id?: string;
-    date?: {
-        start?: string;
-        end?: string;
-    };
-    day?: {
-        start?: number;
-        end?: number;
-    };
-    hours?: string;
-}
-export interface DeliveryHours {
-    id?: string;
-    day?: {
-        start?: number;
-        end?: number;
-    };
-    hours?: string;
-}
-export interface Timeslot {
-    id?: number;
-    brand_id?: string;
-    start_time?: string;
-    duration?: string;
-    is_available?: boolean;
-    number_orders?: number;
-}
-export interface Address {
-    suite?: string;
-    address?: string;
-    city?: string;
-    state?: string;
-    country?: string;
-    zip?: string;
-    coordinates?: {
-        latitude?: number;
-        longitude?: number;
-    };
-}
-export interface Brand {
-    id?: string;
-    sector?: string;
-    name?: string;
-    label?: {
-        en?: string;
-        fr?: string;
-    };
-    timezone?: string;
-    description?: string;
-    latitude?: number;
-    longitude?: number;
-    address?: Address;
-    menus?: MenuHours[];
-    date?: {
-        created?: string;
-    };
-    hours?: Hours[];
-    deliveryHours?: DeliveryHours[];
-    style?: any;
-    pos?: string;
-    terminals?: any[];
-    timeslots?: {
-        time?: string;
-        averagePrepTime?: string;
-        duration_minutes?: number;
-        customers_per_slot?: number;
-        menu_items_per_slot?: number;
-        delivery_time?: string;
-        delivery_customers_per_slot?: number;
-        delivery_menu_items_per_slot?: number;
-        delivery_prep_time?: string;
-        delivery_is_user_defined?: boolean;
-        delivery_user_defined?: {
-            start_time: string;
-            end_time: string;
-            delivery_destinations?: string[];
-        }[];
-    };
-    is?: {
-        pickup_supported?: boolean;
-        delivery_supported?: boolean;
-        plu_enabled?: boolean;
-        promo_exemptions_enabled?: boolean;
-        local_images_enabled?: boolean;
-        hidden?: boolean;
-        item_desc_edit_enabled?: boolean;
-        scan_and_go_supported?: boolean;
-        calories_edit_enabled?: boolean;
-        special_instructions?: boolean;
-        [index: string]: any;
-    };
-    brand?: string;
-    location?: string;
-    payment_provider?: string;
-    location_description?: string;
-    company?: string;
-    config?: {
-        private?: any;
-        public?: any;
-    };
-    tax_rate?: number;
-    meta?: {
-        scout?: {
-            user_id?: string;
-            name?: {
-                first?: string;
-                last?: string;
-            };
-        };
-        partner?: {
-            user_id?: string;
-            name?: {
-                first?: string;
-                last?: string;
-            };
-        };
-        contact?: {
-            name?: string;
-            role?: string;
-            email?: string;
-            phone?: string;
-        };
-        market_id?: string;
-        partner_type?: string;
-        business_number?: number;
-        website?: string;
-        cuisine_types?: string[];
-        status?: PartnerStatus;
-        active?: boolean;
-        max_showcase_items?: number;
-        jde_category?: string;
-    };
-    descriptions?: {
-        location?: {
-            en?: string;
-            fr?: string;
-        };
-    };
-    [index: string]: any;
-}
-export interface BrandDocument {
-    id?: string;
-    type?: string;
-    url?: string;
-    is_archived?: boolean;
-    upload_date?: number;
-    name?: string;
-}
-export declare type BrandDocuments = BrandDocument[];
-export interface BrandDocumentsResponse {
-    documents?: BrandDocuments;
-}
-export declare type Brands = Brand[];
-export interface Location {
-    id?: string;
-    operation_id?: number;
-    name?: string;
-    label?: {
-        en?: string;
-        fr?: string;
-    };
-    search?: string[];
-    app?: string;
-    address?: Address;
-    latitude?: number;
-    longitude?: number;
-    brands?: Brand[];
-    meta?: any;
-    phone?: string;
-    location_group?: string;
-    location_multigroup?: string;
-    sector?: string;
-    date?: {
-        created?: string;
-        modified?: string;
-    };
-    market_place?: {
-        label?: {
-            en?: string;
-            fr?: string;
-        };
-        location_description?: {
-            en?: string;
-            fr?: string;
-        };
-        logo?: string;
-        is?: {
-            pickup_supported?: boolean;
-        };
-        pickup_instruction?: {
-            en?: string;
-            fr?: string;
-        };
-        hours?: any;
-        deliveryHours?: any;
-        service_fee?: {
-            type?: string;
-            value?: number;
-        };
-        [index: string]: any;
-    };
-    [index: string]: any;
-}
-export interface Group {
-    id?: string;
-    name?: string;
-    label?: {
-        en?: string;
-        fr?: string;
-    };
-    distance?: number;
-    locations?: Location[];
-    address?: Address;
-    meta?: any;
-    style?: any;
-    [index: string]: any;
-}
-export interface MultiGroup {
-    id?: string;
-    name?: string;
-    groups?: Group[];
-    [index: string]: any;
-}
-export interface Error {
-    error?: string;
-    code?: number;
-}
-export interface Sector {
-    id?: string;
-    name?: string;
-    label?: {
-        en?: string;
-        fr?: string;
-    };
-    companies?: Company[];
-}
-export interface Company {
-    id?: string;
-    name?: string;
-    label?: {
-        en?: string;
-        fr?: string;
-    };
-    sector?: string;
-    locations?: Location[];
-    is?: {
-        global_images_enabled?: boolean;
-    };
-    meta?: any;
-}
-export interface Locations {
-    locations?: Location[];
-}
-export interface Multigroups {
-    groups?: MultiGroup[];
-    multigroups?: MultiGroup[];
-}
-export interface Groups {
-    groups?: Group[];
-}
-export interface PostOrPatchDeliveryDestination {
-    name: string;
-    foodlocker: boolean;
-    address: Address;
-    information?: string;
-}
-export interface DeliveryDestination {
-    id?: string;
-    name: string;
-    foodlocker: boolean;
-    address: Address;
-    information?: string;
-}
-export declare type DeliveryDestinations = DeliveryDestination[];
-export interface DeliveryDestinationIDs {
-    delivery_destinations?: string[];
-}
-export interface TimeSlots {
-    timeslots?: Timeslot[];
-}
-export interface Sectors {
-    sectors?: Sector[];
-}
-export interface CompanyUpdateBody {
-    name?: string;
-    is?: {
-        global_images_enabled?: boolean;
-    };
-}
-export interface MarketPlace {
-    stations?: Station[];
-    [index: string]: any;
-}
-export interface Station {
-    brand?: string;
-    menu?: string;
-    [index: string]: any;
-}
-export interface CreateSector {
-    name?: string;
-}
-export interface BadRequest {
-    error?: string;
-}
-export declare type PartnerStatus = string;
-export declare type PostLocationBody = Location;
-export declare type PostLocationResponse = Location;
-export interface PostLocationRequest {
-    body: PostLocationBody;
-}
-export declare type GetLocationsResponse = Locations;
-export declare type GetLocationsRequest = {};
-export interface GetLocationSearchQuery {
-    lat?: number;
-    long?: number;
-    operation_id?: number;
-}
-export declare type GetLocationSearchResponse = Locations;
-export interface GetLocationSearchRequest extends GetLocationSearchQuery {
-}
-export interface GetLocationPath {
-    id: string;
-}
-export interface GetLocationQuery {
-    include_brands_config?: boolean;
-    active_cafes?: any[];
-    extended?: boolean;
-}
-export declare type GetLocationResponse = Location;
-export interface GetLocationRequest extends GetLocationQuery, GetLocationPath {
-}
-export interface PutLocationPath {
-    id: string;
-}
-export declare type PutLocationBody = Location;
-export declare type PutLocationResponse = Location;
-export interface PutLocationRequest extends PutLocationPath {
-    body: PutLocationBody;
-}
-export interface DeleteLocationPath {
-    id: string;
-}
-export interface DeleteLocationBody {
-    brands?: Brand[];
-}
-export declare type DeleteLocationResponse = Location;
-export interface DeleteLocationRequest extends DeleteLocationPath {
-    body: DeleteLocationBody;
-}
-export interface PatchLocationPath {
-    id: string;
-}
-export declare type PatchLocationBody = Location;
-export declare type PatchLocationResponse = Location;
-export interface PatchLocationRequest extends PatchLocationPath {
-    body: PatchLocationBody;
-}
-export interface GetLocationPosPath {
-    id: string;
-}
-export declare type GetLocationPosResponse = POS;
-export interface GetLocationPosRequest extends GetLocationPosPath {
-}
-export interface PutLocationPosPath {
-    id: string;
-}
-export declare type PutLocationPosBody = POS;
-export declare type PutLocationPosResponse = POS;
-export interface PutLocationPosRequest extends PutLocationPosPath {
-    body: PutLocationPosBody;
-}
-export declare type GetLocationMultigroupsResponse = Multigroups;
-export declare type GetLocationMultigroupsRequest = {};
-export declare type PostLocationMultigroupBody = MultiGroup;
-export declare type PostLocationMultigroupResponse = MultiGroup;
-export interface PostLocationMultigroupRequest {
-    body: PostLocationMultigroupBody;
-}
-export interface GetLocationMultigroupPath {
-    id: string;
-}
-export interface GetLocationMultigroupQuery {
-    latitude?: string;
-    longitude?: string;
-    merge?: string;
-    expanded?: boolean;
-    extended?: boolean;
-    hours?: boolean;
-}
-export declare type GetLocationMultigroupResponse = MultiGroup;
-export interface GetLocationMultigroupRequest extends GetLocationMultigroupQuery, GetLocationMultigroupPath {
-}
-export interface PutLocationMultigroupPath {
-    id: string;
-}
-export declare type PutLocationMultigroupBody = MultiGroup;
-export declare type PutLocationMultigroupResponse = MultiGroup;
-export interface PutLocationMultigroupRequest extends PutLocationMultigroupPath {
-    body: PutLocationMultigroupBody;
-}
-export interface DeleteLocationMultigroupPath {
-    id: string;
-}
-export interface DeleteLocationMultigroupBody {
-    groups?: Group[];
-}
-export declare type DeleteLocationMultigroupResponse = MultiGroup;
-export interface DeleteLocationMultigroupRequest extends DeleteLocationMultigroupPath {
-    body: DeleteLocationMultigroupBody;
-}
-export interface PatchLocationMultigroupPath {
-    id: string;
-}
-export declare type PatchLocationMultigroupBody = MultiGroup;
-export declare type PatchLocationMultigroupResponse = MultiGroup;
-export interface PatchLocationMultigroupRequest extends PatchLocationMultigroupPath {
-    body: PatchLocationMultigroupBody;
-}
-export interface GetLocationUserMultigroupPath {
-    id: string;
-    user_id: string;
-}
-export interface GetLocationUserMultigroupQuery {
-    expanded?: boolean;
-}
-export declare type GetLocationUserMultigroupResponse = Groups;
-export interface GetLocationUserMultigroupRequest extends GetLocationUserMultigroupQuery, GetLocationUserMultigroupPath {
-}
-export declare type PostLocationGroupBody = Group;
-export declare type PostLocationGroupResponse = Group;
-export interface PostLocationGroupRequest {
-    body: PostLocationGroupBody;
-}
-export interface GetLocationGroupPath {
-    id: string;
-}
-export interface GetLocationGroupQuery {
-    latitude?: number;
-    longitude?: number;
-    include_brands_config?: boolean;
-    extended?: boolean;
-    web?: boolean;
-}
-export declare type GetLocationGroupResponse = Group;
-export interface GetLocationGroupRequest extends GetLocationGroupQuery, GetLocationGroupPath {
-}
-export interface PutLocationGroupPath {
-    id: string;
-}
-export declare type PutLocationGroupBody = Group;
-export declare type PutLocationGroupResponse = Group;
-export interface PutLocationGroupRequest extends PutLocationGroupPath {
-    body: PutLocationGroupBody;
-}
-export interface DeleteLocationGroupPath {
-    id: string;
-}
-export interface DeleteLocationGroupBody {
-    locations?: Location[];
-}
-export declare type DeleteLocationGroupResponse = Group;
-export interface DeleteLocationGroupRequest extends DeleteLocationGroupPath {
-    body: DeleteLocationGroupBody;
-}
-export interface PatchLocationGroupPath {
-    id: string;
-}
-export declare type PatchLocationGroupBody = Group;
-export declare type PatchLocationGroupResponse = Group;
-export interface PatchLocationGroupRequest extends PatchLocationGroupPath {
-    body: PatchLocationGroupBody;
-}
-export interface GetLocationGroupDeliverydestinationPath {
-    id: string;
-}
-export interface GetLocationGroupDeliverydestinationQuery {
-    name?: string;
-}
-export interface GetLocationGroupDeliverydestinationResponse {
-    delivery_destinations?: DeliveryDestinations;
-}
-export interface GetLocationGroupDeliverydestinationRequest extends GetLocationGroupDeliverydestinationQuery, GetLocationGroupDeliverydestinationPath {
-}
-export interface PostLocationGroupDeliverydestinationPath {
-    id: string;
-}
-export declare type PostLocationGroupDeliverydestinationBody = PostOrPatchDeliveryDestination;
-export declare type PostLocationGroupDeliverydestinationResponse = DeliveryDestination;
-export interface PostLocationGroupDeliverydestinationRequest extends PostLocationGroupDeliverydestinationPath {
-    body: PostLocationGroupDeliverydestinationBody;
-}
-export interface GetLocationGroupDeliverydestinationPath {
-    id: string;
-    delivery_destination: string;
-}
-export declare type GetLocationGroupDeliverydestinationResponse = DeliveryDestination;
-export interface GetLocationGroupDeliverydestinationRequest extends GetLocationGroupDeliverydestinationPath {
-}
-export interface PatchLocationGroupDeliverydestinationPath {
-    id: string;
-    delivery_destination: string;
-}
-export declare type PatchLocationGroupDeliverydestinationBody = PostOrPatchDeliveryDestination;
-export declare type PatchLocationGroupDeliverydestinationResponse = DeliveryDestination;
-export interface PatchLocationGroupDeliverydestinationRequest extends PatchLocationGroupDeliverydestinationPath {
-    body: PatchLocationGroupDeliverydestinationBody;
-}
-export interface DeleteLocationGroupDeliverydestinationPath {
-    id: string;
-    delivery_destination: string;
-}
-export interface DeleteLocationGroupDeliverydestinationResponse {
-    deleted_delivery_destination?: DeliveryDestination;
-}
-export interface DeleteLocationGroupDeliverydestinationRequest extends DeleteLocationGroupDeliverydestinationPath {
-}
-export interface GetLocationUserGroupPath {
-    id: string;
-    user_id: string;
-}
-export interface GetLocationUserGroupQuery {
-    latitude?: number;
-    longitude?: number;
-}
-export declare type GetLocationUserGroupResponse = Group;
-export interface GetLocationUserGroupRequest extends GetLocationUserGroupQuery, GetLocationUserGroupPath {
-}
-export interface GetLocationBrandsResponse {
-    brands?: Brands;
-}
-export declare type GetLocationBrandsRequest = {};
-export interface GetLocationBrandDestinationsPath {
-    id: string;
-}
-export declare type GetLocationBrandDestinationsResponse = DeliveryDestinationIDs;
-export interface GetLocationBrandDestinationsRequest extends GetLocationBrandDestinationsPath {
-}
-export interface PostLocationBrandDocumentPath {
-    id: string;
-}
-export interface PostLocationBrandDocumentBody {
-    post_body: {
-        document_name?: string;
-        document_type?: string;
-        document?: string;
-    };
-}
-export declare type PostLocationBrandDocumentResponse = BrandDocumentsResponse;
-export interface PostLocationBrandDocumentRequest extends PostLocationBrandDocumentPath {
-    body: PostLocationBrandDocumentBody;
-}
-export interface PatchLocationBrandDocumentPath {
-    id: string;
-}
-export interface PatchLocationBrandDocumentResponse {
-    document?: BrandDocument;
-}
-export interface PatchLocationBrandDocumentRequest extends PatchLocationBrandDocumentPath {
-}
-export interface DeleteLocationBrandDocumentPath {
-    id: string;
-}
-export interface DeleteLocationBrandDocumentResponse {
-    deleted_document?: BrandDocument;
-}
-export interface DeleteLocationBrandDocumentRequest extends DeleteLocationBrandDocumentPath {
-}
-export interface GetLocationBrandDocumentsPath {
-    id: string;
-}
-export declare type GetLocationBrandDocumentsResponse = BrandDocumentsResponse;
-export interface GetLocationBrandDocumentsRequest extends GetLocationBrandDocumentsPath {
-}
-export interface GetLocationBrandTimeslotsPath {
-    id: string;
-}
-export interface GetLocationBrandTimeslotsQuery {
-    date?: number;
-    limit?: number;
-}
-export declare type GetLocationBrandTimeslotsResponse = TimeSlots;
-export interface GetLocationBrandTimeslotsRequest extends GetLocationBrandTimeslotsQuery, GetLocationBrandTimeslotsPath {
-}
-export interface PostLocationMarketplaceTimeslotsQuery {
-    date?: number;
-    limit?: number;
-}
-export declare type PostLocationMarketplaceTimeslotsBody = MarketPlace;
-export declare type PostLocationMarketplaceTimeslotsResponse = TimeSlots;
-export interface PostLocationMarketplaceTimeslotsRequest extends PostLocationMarketplaceTimeslotsQuery {
-    body: PostLocationMarketplaceTimeslotsBody;
-}
-export interface PostLocationMarketplaceTimeslotsDeliveryQuery {
-    date?: number;
-    limit?: number;
-}
-export declare type PostLocationMarketplaceTimeslotsDeliveryBody = MarketPlace;
-export declare type PostLocationMarketplaceTimeslotsDeliveryResponse = TimeSlots;
-export interface PostLocationMarketplaceTimeslotsDeliveryRequest extends PostLocationMarketplaceTimeslotsDeliveryQuery {
-    body: PostLocationMarketplaceTimeslotsDeliveryBody;
-}
-export interface GetLocationBrandMenuTimeslotsPath {
-    id: string;
-    menu: string;
-}
-export interface GetLocationBrandMenuTimeslotsQuery {
-    date?: number;
-    limit?: number;
-}
-export declare type GetLocationBrandMenuTimeslotsResponse = TimeSlots;
-export interface GetLocationBrandMenuTimeslotsRequest extends GetLocationBrandMenuTimeslotsQuery, GetLocationBrandMenuTimeslotsPath {
-}
-export interface GetLocationBrandDeliveryTimeslotsPath {
-    id: string;
-}
-export interface GetLocationBrandDeliveryTimeslotsQuery {
-    date?: number;
-    limit?: number;
-}
-export declare type GetLocationBrandDeliveryTimeslotsResponse = TimeSlots;
-export interface GetLocationBrandDeliveryTimeslotsRequest extends GetLocationBrandDeliveryTimeslotsQuery, GetLocationBrandDeliveryTimeslotsPath {
-}
-export interface GetLocationBrandMenuDeliveryTimeslostsPath {
-    id: string;
-    menu: string;
-}
-export interface GetLocationBrandMenuDeliveryTimeslostsQuery {
-    date?: number;
-    limit?: number;
-}
-export declare type GetLocationBrandMenuDeliveryTimeslostsResponse = TimeSlots;
-export interface GetLocationBrandMenuDeliveryTimeslostsRequest extends GetLocationBrandMenuDeliveryTimeslostsQuery, GetLocationBrandMenuDeliveryTimeslostsPath {
-}
-export declare type PostLocationBrandBody = Brand;
-export declare type PostLocationBrandResponse = Brand;
-export interface PostLocationBrandRequest {
-    body: PostLocationBrandBody;
-}
-export interface GetLocationBrandPath {
-    id: string;
-}
-export interface GetLocationBrandQuery {
-    include_config?: boolean;
-    extended?: boolean;
-}
-export declare type GetLocationBrandResponse = Brand;
-export interface GetLocationBrandRequest extends GetLocationBrandQuery, GetLocationBrandPath {
-}
-export interface PatchLocationBrandPath {
-    id: string;
-}
-export declare type PatchLocationBrandBody = Brand;
-export declare type PatchLocationBrandResponse = Brand;
-export interface PatchLocationBrandRequest extends PatchLocationBrandPath {
-    body: PatchLocationBrandBody;
-}
-export interface DeleteLocationBrandPath {
-    id: string;
-}
-export declare type DeleteLocationBrandBody = Brand;
-export declare type DeleteLocationBrandResponse = Brand;
-export interface DeleteLocationBrandRequest extends DeleteLocationBrandPath {
-    body: DeleteLocationBrandBody;
-}
-export interface PutLocationBrandPath {
-    id: string;
-}
-export declare type PutLocationBrandBody = Brand;
-export declare type PutLocationBrandResponse = Brand;
-export interface PutLocationBrandRequest extends PutLocationBrandPath {
-    body: PutLocationBrandBody;
-}
-export declare type GetLocationSectorsResponse = Sectors;
-export declare type GetLocationSectorsRequest = {};
-export declare type PostLocationSectorBody = CreateSector;
-export declare type PostLocationSectorResponse = Sector;
-export interface PostLocationSectorRequest {
-    body: PostLocationSectorBody;
-}
-export interface GetLocationSectorPath {
-    id: string;
-}
-export interface GetLocationSectorQuery {
-    expanded?: boolean;
-}
-export declare type GetLocationSectorResponse = Sector;
-export interface GetLocationSectorRequest extends GetLocationSectorQuery, GetLocationSectorPath {
-}
-export interface PatchLocationSectorPath {
-    id: string;
-}
-export interface PatchLocationSectorQuery {
-    expanded?: boolean;
-}
-export declare type PatchLocationSectorBody = CreateSector;
-export declare type PatchLocationSectorResponse = Sector;
-export interface PatchLocationSectorRequest extends PatchLocationSectorQuery, PatchLocationSectorPath {
-    body: PatchLocationSectorBody;
-}
-export interface PostLocationCompanyBody {
-    name: {
-        name: string;
-        sector: string;
-        label?: any;
-        is?: {
-            global_images_enabled?: boolean;
-        };
-    };
-}
-export declare type PostLocationCompanyResponse = Company;
-export interface PostLocationCompanyRequest {
-    body: PostLocationCompanyBody;
-}
-export interface GetLocationCompanyPath {
-    id: string;
-}
-export interface GetLocationCompanyQuery {
-    expanded?: boolean;
-}
-export declare type GetLocationCompanyResponse = Company;
-export interface GetLocationCompanyRequest extends GetLocationCompanyQuery, GetLocationCompanyPath {
-}
-export interface PatchLocationCompanyPath {
-    id: string;
-}
-export declare type PatchLocationCompanyBody = CompanyUpdateBody;
-export declare type PatchLocationCompanyResponse = Company;
-export interface PatchLocationCompanyRequest extends PatchLocationCompanyPath {
-    body: PatchLocationCompanyBody;
-}
-//# sourceMappingURL=location.d.ts.map