@sparkrewards/sra-client 0.0.1

package/dist-types/models/models_0.d.ts

@@ -0,0 +1,550 @@
+import { AppAPIServiceException as __BaseException } from "./AppAPIServiceException";
+import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+/**
+ * Describes one specific validation failure for an input member.
+ * @public
+ */
+export interface ValidationExceptionField {
+    /**
+     * A JSONPointer expression to the structure member whose value failed to satisfy the modeled constraints.
+     * @public
+     */
+    path: string | undefined;
+    /**
+     * A detailed description of the validation failure.
+     * @public
+     */
+    message: string | undefined;
+}
+/**
+ * A standard error for input validation failures.
+ * This should be thrown by services when a member of the input structure
+ * falls outside of the modeled or documented constraints.
+ * @public
+ */
+export declare class ValidationException extends __BaseException {
+    readonly name: "ValidationException";
+    readonly $fault: "client";
+    /**
+     * A list of specific failures encountered while validating the input.
+     * A member can appear in this list more than once if it failed to satisfy multiple constraints.
+     * @public
+     */
+    fieldList?: (ValidationExceptionField)[];
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+}
+/**
+ * Input for DeleteUser - no query params, uses auth token
+ * @public
+ */
+export interface DeleteUserInput {
+}
+/**
+ * Output for DeleteUser
+ * @public
+ */
+export interface DeleteUserOutput {
+    message?: string;
+}
+/**
+ * @public
+ */
+export declare class RuntimeError extends __BaseException {
+    readonly name: "RuntimeError";
+    readonly $fault: "server";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<RuntimeError, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface PlansListInput {
+    page?: number;
+    limit?: number;
+    lat: number | undefined;
+    lon: number | undefined;
+}
+/**
+ * @public
+ */
+export interface PaginationInfo {
+    currentPage?: number;
+    limit: number | undefined;
+    hasMore: boolean | undefined;
+    /**
+     * The next page number, or null if there are no more pages
+     * @public
+     */
+    nextPage: number | undefined;
+}
+/**
+ * @public
+ */
+export interface Reward {
+    reward_id?: string;
+    id?: string;
+}
+/**
+ * @public
+ */
+export interface PointsRewardOption {
+    id: string | undefined;
+    reward: string | undefined;
+    points: number | undefined;
+}
+/**
+ * @public
+ */
+export interface Tier {
+    id: string | undefined;
+    rewards: (string)[] | undefined;
+}
+/**
+ * @public
+ */
+export interface VisitRewardProps {
+    tiers: Record<string, Tier> | undefined;
+    min_spend: number | undefined;
+}
+/**
+ * @public
+ */
+export interface RewardPlan {
+    visits?: VisitRewardProps;
+    points?: (PointsRewardOption)[];
+}
+/**
+ * @public
+ */
+export interface GroupedPlan {
+    reward_plan: RewardPlan | undefined;
+    visits: number | undefined;
+    points: number | undefined;
+    redeemableRewards: (Reward)[] | undefined;
+    visits_active: boolean | undefined;
+    points_active: boolean | undefined;
+    banner: string | undefined;
+    logo: string | undefined;
+    org_id: string | undefined;
+    shop_id: string | undefined;
+    name: string | undefined;
+    id: string | undefined;
+    active: boolean | undefined;
+    favorite: boolean | undefined;
+    num_redeemableRewards: number | undefined;
+}
+/**
+ * @public
+ */
+export interface PlansOutput {
+    value: (GroupedPlan)[] | undefined;
+    count: number | undefined;
+    pagination: PaginationInfo | undefined;
+}
+/**
+ * Input for shop list operations that require location and pagination
+ * @public
+ */
+export interface ShopListInput {
+    lat?: number;
+    lon?: number;
+    page?: number;
+    filters?: string;
+}
+/**
+ * Location details for a shop
+ * @public
+ */
+export interface LocationDetails {
+    address: string | undefined;
+    city: string | undefined;
+    state: string | undefined;
+    zipcode: string | undefined;
+}
+/**
+ * Individual shop hours entry for a day
+ * @public
+ */
+export interface ShopHoursItem {
+    day: string | undefined;
+    open: string | undefined;
+    close: string | undefined;
+}
+/**
+ * Base shop structure returned from enrichList/enrichSingle
+ * @public
+ */
+export interface EnrichedShop {
+    shop_id: string | undefined;
+    org_id: string | undefined;
+    preview: string | undefined;
+    name: string | undefined;
+    distance: string | undefined;
+    favorite?: boolean;
+    /**
+     * Location details for a shop
+     * @public
+     */
+    location: LocationDetails | undefined;
+    /**
+     * List of shop hours for all days
+     * @public
+     */
+    shop_hours: (ShopHoursItem)[] | undefined;
+    logo?: string;
+    tags: (string)[] | undefined;
+}
+/**
+ * Output for NearbyShops, FavoriteShops, PopularShops, RadiusShops
+ * @public
+ */
+export interface ShopListWithPaginationOutput {
+    message?: string;
+    value?: (EnrichedShop)[];
+    count?: number;
+    pagination?: PaginationInfo;
+}
+/**
+ * Input for getting shop details
+ * @public
+ */
+export interface GetShopInput {
+    shop_id: string | undefined;
+}
+/**
+ * @public
+ */
+export declare class NotFoundError extends __BaseException {
+    readonly name: "NotFoundError";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<NotFoundError, __BaseException>);
+}
+/**
+ * Full shop details structure
+ * @public
+ */
+export interface ShopDetails {
+    id: string | undefined;
+    org_id: string | undefined;
+    shop_name: string | undefined;
+    org_name: string | undefined;
+    banner?: string;
+    preview: string | undefined;
+    logo: string | undefined;
+    description: string | undefined;
+    country_code: string | undefined;
+    latitude?: number;
+    longitude: number | undefined;
+    active: boolean | undefined;
+    menu?: string;
+    phone_number?: string;
+    /**
+     * Location details for a shop
+     * @public
+     */
+    location: LocationDetails | undefined;
+    /**
+     * List of shop hours for all days
+     * @public
+     */
+    shop_hours: (ShopHoursItem)[] | undefined;
+    sent_setup?: boolean;
+    setup: boolean | undefined;
+    tags: (string)[] | undefined;
+}
+/**
+ * Input for GetUser - no query params, uses auth token
+ * @public
+ */
+export interface GetUserInput {
+}
+/**
+ * @public
+ */
+export interface UserFullname {
+    firstName?: string;
+    lastName?: string;
+}
+/**
+ * @public
+ */
+export interface UserPreferences {
+    lightMode?: boolean;
+}
+/**
+ * Full user object structure
+ * @public
+ */
+export interface User {
+    id: string | undefined;
+    email: string | undefined;
+    birthdate: string | undefined;
+    fullname?: UserFullname;
+    date_created: string | undefined;
+    newAccount: boolean | undefined;
+    preferences: UserPreferences | undefined;
+    total_visits: number | undefined;
+    total_points: number | undefined;
+    total_rewards: number | undefined;
+    fraud_count?: number;
+    num_redeemableRewards?: number;
+}
+/**
+ * Output for GetUser
+ * @public
+ */
+export interface GetUserOutput {
+    message?: string;
+    /**
+     * Full user object structure
+     * @public
+     */
+    user?: User;
+}
+/**
+ * Input for LikeOrg - likely needs org_id to like/unlike
+ * @public
+ */
+export interface LikeOrgInput {
+    org_id: string | undefined;
+}
+/**
+ * Output for LikeOrg
+ * @public
+ */
+export interface LikeOrgOutput {
+    message?: string;
+    liked?: boolean;
+}
+/**
+ * Input for nearest shop search
+ * @public
+ */
+export interface NearestShopInput {
+    shop_name: string | undefined;
+    lat: number | undefined;
+    lon: number | undefined;
+}
+/**
+ * Input for OnboardUser - no query params, uses auth token
+ * @public
+ */
+export interface OnboardUserInput {
+}
+/**
+ * Output for OnboardUser
+ * @public
+ */
+export interface OnboardUserOutput {
+    message?: string;
+    /**
+     * Full user object structure
+     * @public
+     */
+    user?: User;
+}
+/**
+ * Input for pinned shop (requires location)
+ * @public
+ */
+export interface PinnedShopInput {
+    shop_id: string | undefined;
+    lat: number | undefined;
+    lon: number | undefined;
+}
+/**
+ * @public
+ */
+export interface PlanGetInput {
+    org_id: string | undefined;
+}
+/**
+ * @public
+ */
+export interface FirstTimeReward {
+    active?: boolean;
+    description?: string;
+}
+/**
+ * @public
+ */
+export interface PlanOutput {
+    reward_plan: RewardPlan | undefined;
+    visits: number | undefined;
+    points: number | undefined;
+    redeemableRewards: (Reward)[] | undefined;
+    min_spend?: number;
+    visits_active: boolean | undefined;
+    points_active: boolean | undefined;
+    firstPlan: boolean | undefined;
+    id: string | undefined;
+    active: boolean | undefined;
+    organization_id?: string;
+    name: string | undefined;
+    favorite: boolean | undefined;
+    first_time_reward: FirstTimeReward | undefined;
+}
+/**
+ * Simple shop structure with just coordinates
+ * @public
+ */
+export interface ShopLocation {
+    id: string | undefined;
+    longitude: number | undefined;
+    latitude: number | undefined;
+}
+/**
+ * Output for RadiusShops (simple location list)
+ * @public
+ */
+export interface RadiusShopsOutput {
+    message?: string;
+    count?: number;
+    value?: (ShopLocation)[];
+}
+/**
+ * @public
+ */
+export declare class InvalidOperationError extends __BaseException {
+    readonly name: "InvalidOperationError";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidOperationError, __BaseException>);
+}
+/**
+ * Input for RecordVisit - records a visit/scan at a shop
+ * @public
+ */
+export interface RecordVisitInput {
+    shop_id: string | undefined;
+    timestamp: string | undefined;
+    lat: number | undefined;
+    lon: number | undefined;
+}
+/**
+ * Output for RecordVisit
+ * @public
+ */
+export interface RecordVisitOutput {
+    success: boolean | undefined;
+    message: string | undefined;
+    visitId: string | undefined;
+    reason?: string;
+}
+/**
+ * @public
+ */
+export interface RedeemFirstTimeRewardInput {
+    org_id: string | undefined;
+}
+/**
+ * @public
+ */
+export interface RedeemRewardOutput {
+    message: string | undefined;
+    redeemed: boolean | undefined;
+}
+/**
+ * @public
+ */
+export interface RedeemPointRewardInput {
+    org_id: string | undefined;
+    reward_id: string | undefined;
+}
+/**
+ * @public
+ */
+export interface RedeemPointRewardOutput {
+    message: string | undefined;
+    redeemed: boolean | undefined;
+    pointsUsed: number | undefined;
+    remainingPoints: number | undefined;
+}
+/**
+ * @public
+ */
+export interface RedeemVisitRewardInput {
+    reward_id: string | undefined;
+}
+/**
+ * @public
+ */
+export interface SearchShopsInput {
+    q: string | undefined;
+    limit?: number;
+    lat?: number;
+    lon?: number;
+    page?: number;
+    filters?: string;
+}
+/**
+ * Note: FilterShopsInput is the same as ShopListInput - reuse ShopListInput
+ * Input for search suggestions
+ * @public
+ */
+export interface SearchSuggestionInput {
+    q: string | undefined;
+    limit?: number;
+    lat?: number;
+    lon?: number;
+}
+/**
+ * Search suggestion result structure
+ * @public
+ */
+export interface SearchSuggestionItem {
+    shop_id: string | undefined;
+    organization_id: string | undefined;
+    search_name: string | undefined;
+    favorite: boolean | undefined;
+    distance: number | undefined;
+}
+/**
+ * Output for SearchSuggestion - returns SearchSuggestionList
+ * Handler should return \{ value: SearchSuggestionList \} where value is the array
+ * @public
+ */
+export interface SearchSuggestionOutput {
+    value?: (SearchSuggestionItem)[];
+}
+/**
+ * Partial fullname structure for updates (all fields optional)
+ * @public
+ */
+export interface UserFullnameUpdate {
+    firstName?: string;
+    lastName?: string;
+}
+/**
+ * Input for UpdateUser - body contains fullname fields
+ * @public
+ */
+export interface UpdateUserInput {
+    /**
+     * Partial fullname structure for updates (all fields optional)
+     * @public
+     */
+    fullname?: UserFullnameUpdate;
+}
+/**
+ * Output for UpdateUser
+ * @public
+ */
+export interface UpdateUserOutput {
+    message?: string;
+    /**
+     * Full user object structure
+     * @public
+     */
+    user?: User;
+}