@sparkrewards/sra-client 0.0.1

package/dist-types/commands/PlanPublicCommand.d.ts

@@ -0,0 +1,107 @@
+import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
+import { PlanGetInput, PlanOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link PlanPublicCommand}.
+ */
+export interface PlanPublicCommandInput extends PlanGetInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link PlanPublicCommand}.
+ */
+export interface PlanPublicCommandOutput extends PlanOutput, __MetadataBearer {
+}
+declare const PlanPublicCommand_base: {
+    new (input: PlanPublicCommandInput): import("@smithy/smithy-client").CommandImpl<PlanPublicCommandInput, PlanPublicCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: PlanPublicCommandInput): import("@smithy/smithy-client").CommandImpl<PlanPublicCommandInput, PlanPublicCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Retrieves the reward plan details for a specific organization, including visits, points for any user.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppAPIClient, PlanPublicCommand } from "@sparkrewards/sra-client"; // ES Modules import
+ * // const { AppAPIClient, PlanPublicCommand } = require("@sparkrewards/sra-client"); // CommonJS import
+ * const client = new AppAPIClient(config);
+ * const input = { // PlanGetInput
+ *   org_id: "STRING_VALUE", // required
+ * };
+ * const command = new PlanPublicCommand(input);
+ * const response = await client.send(command);
+ * // { // PlanOutput
+ * //   reward_plan: { // RewardPlan
+ * //     visits: { // VisitRewardProps
+ * //       tiers: { // TierMap // required
+ * //         "<keys>": { // Tier
+ * //           id: "STRING_VALUE", // required
+ * //           rewards: [ // StringList // required
+ * //             "STRING_VALUE",
+ * //           ],
+ * //         },
+ * //       },
+ * //       min_spend: Number("int"), // required
+ * //     },
+ * //     points: [ // PointsRewardOptionList
+ * //       { // PointsRewardOption
+ * //         id: "STRING_VALUE", // required
+ * //         reward: "STRING_VALUE", // required
+ * //         points: Number("int"), // required
+ * //       },
+ * //     ],
+ * //   },
+ * //   visits: Number("int"), // required
+ * //   points: Number("int"), // required
+ * //   redeemableRewards: [ // RewardList // required
+ * //     { // Reward
+ * //       reward_id: "STRING_VALUE",
+ * //       id: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   min_spend: Number("int"),
+ * //   visits_active: true || false, // required
+ * //   points_active: true || false, // required
+ * //   firstPlan: true || false, // required
+ * //   id: "STRING_VALUE", // required
+ * //   active: true || false, // required
+ * //   organization_id: "STRING_VALUE",
+ * //   name: "STRING_VALUE", // required
+ * //   favorite: true || false, // required
+ * //   first_time_reward: { // FirstTimeReward
+ * //     active: true || false,
+ * //     description: "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param PlanPublicCommandInput - {@link PlanPublicCommandInput}
+ * @returns {@link PlanPublicCommandOutput}
+ * @see {@link PlanPublicCommandInput} for command's `input` shape.
+ * @see {@link PlanPublicCommandOutput} for command's `response` shape.
+ * @see {@link AppAPIClientResolvedConfig | config} for AppAPIClient's `config` shape.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  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.
+ *
+ * @throws {@link RuntimeError} (server fault)
+ *
+ * @throws {@link AppAPIServiceException}
+ * <p>Base exception class for all service exceptions from AppAPI service.</p>
+ *
+ * @public
+ */
+export declare class PlanPublicCommand extends PlanPublicCommand_base {
+}

package/dist-types/commands/PlansCommand.d.ts

@@ -0,0 +1,119 @@
+import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
+import { PlansListInput, PlansOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link PlansCommand}.
+ */
+export interface PlansCommandInput extends PlansListInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link PlansCommand}.
+ */
+export interface PlansCommandOutput extends PlansOutput, __MetadataBearer {
+}
+declare const PlansCommand_base: {
+    new (input: PlansCommandInput): import("@smithy/smithy-client").CommandImpl<PlansCommandInput, PlansCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: PlansCommandInput): import("@smithy/smithy-client").CommandImpl<PlansCommandInput, PlansCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Retrieves a paginated list of all reward plans associated with the authenticated user, ordered by nearest shop location.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppAPIClient, PlansCommand } from "@sparkrewards/sra-client"; // ES Modules import
+ * // const { AppAPIClient, PlansCommand } = require("@sparkrewards/sra-client"); // CommonJS import
+ * const client = new AppAPIClient(config);
+ * const input = { // PlansListInput
+ *   page: Number("int"),
+ *   limit: Number("int"),
+ *   lat: Number("double"), // required
+ *   lon: Number("double"), // required
+ * };
+ * const command = new PlansCommand(input);
+ * const response = await client.send(command);
+ * // { // PlansOutput
+ * //   value: [ // GroupedPlanList // required
+ * //     { // GroupedPlan
+ * //       reward_plan: { // RewardPlan
+ * //         visits: { // VisitRewardProps
+ * //           tiers: { // TierMap // required
+ * //             "<keys>": { // Tier
+ * //               id: "STRING_VALUE", // required
+ * //               rewards: [ // StringList // required
+ * //                 "STRING_VALUE",
+ * //               ],
+ * //             },
+ * //           },
+ * //           min_spend: Number("int"), // required
+ * //         },
+ * //         points: [ // PointsRewardOptionList
+ * //           { // PointsRewardOption
+ * //             id: "STRING_VALUE", // required
+ * //             reward: "STRING_VALUE", // required
+ * //             points: Number("int"), // required
+ * //           },
+ * //         ],
+ * //       },
+ * //       visits: Number("int"), // required
+ * //       points: Number("int"), // required
+ * //       redeemableRewards: [ // RewardList // required
+ * //         { // Reward
+ * //           reward_id: "STRING_VALUE",
+ * //           id: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //       visits_active: true || false, // required
+ * //       points_active: true || false, // required
+ * //       banner: "STRING_VALUE", // required
+ * //       logo: "STRING_VALUE", // required
+ * //       org_id: "STRING_VALUE", // required
+ * //       shop_id: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE", // required
+ * //       id: "STRING_VALUE", // required
+ * //       active: true || false, // required
+ * //       favorite: true || false, // required
+ * //       num_redeemableRewards: Number("int"), // required
+ * //     },
+ * //   ],
+ * //   count: Number("int"), // required
+ * //   pagination: { // PaginationInfo
+ * //     currentPage: Number("int"),
+ * //     limit: Number("int"), // required
+ * //     hasMore: true || false, // required
+ * //     nextPage: Number("int"), // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param PlansCommandInput - {@link PlansCommandInput}
+ * @returns {@link PlansCommandOutput}
+ * @see {@link PlansCommandInput} for command's `input` shape.
+ * @see {@link PlansCommandOutput} for command's `response` shape.
+ * @see {@link AppAPIClientResolvedConfig | config} for AppAPIClient's `config` shape.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  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.
+ *
+ * @throws {@link RuntimeError} (server fault)
+ *
+ * @throws {@link AppAPIServiceException}
+ * <p>Base exception class for all service exceptions from AppAPI service.</p>
+ *
+ * @public
+ */
+export declare class PlansCommand extends PlansCommand_base {
+}

package/dist-types/commands/PopularShopsCommand.d.ts

@@ -0,0 +1,104 @@
+import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
+import { ShopListInput, ShopListWithPaginationOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link PopularShopsCommand}.
+ */
+export interface PopularShopsCommandInput extends ShopListInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link PopularShopsCommand}.
+ */
+export interface PopularShopsCommandOutput extends ShopListWithPaginationOutput, __MetadataBearer {
+}
+declare const PopularShopsCommand_base: {
+    new (input: PopularShopsCommandInput): import("@smithy/smithy-client").CommandImpl<PopularShopsCommandInput, PopularShopsCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [PopularShopsCommandInput]): import("@smithy/smithy-client").CommandImpl<PopularShopsCommandInput, PopularShopsCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Retrieves a paginated list of popular shops ordered by distance from the provided location coordinates. Returns enriched shop data with organization information.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppAPIClient, PopularShopsCommand } from "@sparkrewards/sra-client"; // ES Modules import
+ * // const { AppAPIClient, PopularShopsCommand } = require("@sparkrewards/sra-client"); // CommonJS import
+ * const client = new AppAPIClient(config);
+ * const input = { // ShopListInput
+ *   lat: Number("double"),
+ *   lon: Number("double"),
+ *   page: Number("int"),
+ *   filters: "STRING_VALUE",
+ * };
+ * const command = new PopularShopsCommand(input);
+ * const response = await client.send(command);
+ * // { // ShopListWithPaginationOutput
+ * //   message: "STRING_VALUE",
+ * //   value: [ // EnrichedShopList
+ * //     { // EnrichedShop
+ * //       shop_id: "STRING_VALUE", // required
+ * //       org_id: "STRING_VALUE", // required
+ * //       preview: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE", // required
+ * //       distance: "STRING_VALUE", // required
+ * //       favorite: true || false,
+ * //       location: { // LocationDetails
+ * //         address: "STRING_VALUE", // required
+ * //         city: "STRING_VALUE", // required
+ * //         state: "STRING_VALUE", // required
+ * //         zipcode: "STRING_VALUE", // required
+ * //       },
+ * //       shop_hours: [ // ShopHoursList // required
+ * //         { // ShopHoursItem
+ * //           day: "STRING_VALUE", // required
+ * //           open: "STRING_VALUE", // required
+ * //           close: "STRING_VALUE", // required
+ * //         },
+ * //       ],
+ * //       logo: "STRING_VALUE",
+ * //       tags: [ // StringList // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //   ],
+ * //   count: Number("int"),
+ * //   pagination: { // PaginationInfo
+ * //     currentPage: Number("int"),
+ * //     limit: Number("int"), // required
+ * //     hasMore: true || false, // required
+ * //     nextPage: Number("int"), // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param PopularShopsCommandInput - {@link PopularShopsCommandInput}
+ * @returns {@link PopularShopsCommandOutput}
+ * @see {@link PopularShopsCommandInput} for command's `input` shape.
+ * @see {@link PopularShopsCommandOutput} for command's `response` shape.
+ * @see {@link AppAPIClientResolvedConfig | config} for AppAPIClient's `config` shape.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  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.
+ *
+ * @throws {@link RuntimeError} (server fault)
+ *
+ * @throws {@link AppAPIServiceException}
+ * <p>Base exception class for all service exceptions from AppAPI service.</p>
+ *
+ * @public
+ */
+export declare class PopularShopsCommand extends PopularShopsCommand_base {
+}

package/dist-types/commands/PopularShopsPublicCommand.d.ts

@@ -0,0 +1,104 @@
+import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
+import { ShopListInput, ShopListWithPaginationOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link PopularShopsPublicCommand}.
+ */
+export interface PopularShopsPublicCommandInput extends ShopListInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link PopularShopsPublicCommand}.
+ */
+export interface PopularShopsPublicCommandOutput extends ShopListWithPaginationOutput, __MetadataBearer {
+}
+declare const PopularShopsPublicCommand_base: {
+    new (input: PopularShopsPublicCommandInput): import("@smithy/smithy-client").CommandImpl<PopularShopsPublicCommandInput, PopularShopsPublicCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [PopularShopsPublicCommandInput]): import("@smithy/smithy-client").CommandImpl<PopularShopsPublicCommandInput, PopularShopsPublicCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Retrieves a paginated list of popular shops ordered by distance from the provided location coordinates. Returns enriched shop data with organization information.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppAPIClient, PopularShopsPublicCommand } from "@sparkrewards/sra-client"; // ES Modules import
+ * // const { AppAPIClient, PopularShopsPublicCommand } = require("@sparkrewards/sra-client"); // CommonJS import
+ * const client = new AppAPIClient(config);
+ * const input = { // ShopListInput
+ *   lat: Number("double"),
+ *   lon: Number("double"),
+ *   page: Number("int"),
+ *   filters: "STRING_VALUE",
+ * };
+ * const command = new PopularShopsPublicCommand(input);
+ * const response = await client.send(command);
+ * // { // ShopListWithPaginationOutput
+ * //   message: "STRING_VALUE",
+ * //   value: [ // EnrichedShopList
+ * //     { // EnrichedShop
+ * //       shop_id: "STRING_VALUE", // required
+ * //       org_id: "STRING_VALUE", // required
+ * //       preview: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE", // required
+ * //       distance: "STRING_VALUE", // required
+ * //       favorite: true || false,
+ * //       location: { // LocationDetails
+ * //         address: "STRING_VALUE", // required
+ * //         city: "STRING_VALUE", // required
+ * //         state: "STRING_VALUE", // required
+ * //         zipcode: "STRING_VALUE", // required
+ * //       },
+ * //       shop_hours: [ // ShopHoursList // required
+ * //         { // ShopHoursItem
+ * //           day: "STRING_VALUE", // required
+ * //           open: "STRING_VALUE", // required
+ * //           close: "STRING_VALUE", // required
+ * //         },
+ * //       ],
+ * //       logo: "STRING_VALUE",
+ * //       tags: [ // StringList // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //   ],
+ * //   count: Number("int"),
+ * //   pagination: { // PaginationInfo
+ * //     currentPage: Number("int"),
+ * //     limit: Number("int"), // required
+ * //     hasMore: true || false, // required
+ * //     nextPage: Number("int"), // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param PopularShopsPublicCommandInput - {@link PopularShopsPublicCommandInput}
+ * @returns {@link PopularShopsPublicCommandOutput}
+ * @see {@link PopularShopsPublicCommandInput} for command's `input` shape.
+ * @see {@link PopularShopsPublicCommandOutput} for command's `response` shape.
+ * @see {@link AppAPIClientResolvedConfig | config} for AppAPIClient's `config` shape.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  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.
+ *
+ * @throws {@link RuntimeError} (server fault)
+ *
+ * @throws {@link AppAPIServiceException}
+ * <p>Base exception class for all service exceptions from AppAPI service.</p>
+ *
+ * @public
+ */
+export declare class PopularShopsPublicCommand extends PopularShopsPublicCommand_base {
+}

package/dist-types/commands/RadiusShopsCommand.d.ts

@@ -0,0 +1,78 @@
+import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
+import { RadiusShopsOutput, ShopListInput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link RadiusShopsCommand}.
+ */
+export interface RadiusShopsCommandInput extends ShopListInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link RadiusShopsCommand}.
+ */
+export interface RadiusShopsCommandOutput extends RadiusShopsOutput, __MetadataBearer {
+}
+declare const RadiusShopsCommand_base: {
+    new (input: RadiusShopsCommandInput): import("@smithy/smithy-client").CommandImpl<RadiusShopsCommandInput, RadiusShopsCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [RadiusShopsCommandInput]): import("@smithy/smithy-client").CommandImpl<RadiusShopsCommandInput, RadiusShopsCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Retrieves shops within a specified radius from the provided location coordinates. Returns enriched shop data with organization information.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppAPIClient, RadiusShopsCommand } from "@sparkrewards/sra-client"; // ES Modules import
+ * // const { AppAPIClient, RadiusShopsCommand } = require("@sparkrewards/sra-client"); // CommonJS import
+ * const client = new AppAPIClient(config);
+ * const input = { // ShopListInput
+ *   lat: Number("double"),
+ *   lon: Number("double"),
+ *   page: Number("int"),
+ *   filters: "STRING_VALUE",
+ * };
+ * const command = new RadiusShopsCommand(input);
+ * const response = await client.send(command);
+ * // { // RadiusShopsOutput
+ * //   message: "STRING_VALUE",
+ * //   count: Number("int"),
+ * //   value: [ // ShopLocationList
+ * //     { // ShopLocation
+ * //       id: "STRING_VALUE", // required
+ * //       longitude: Number("double"), // required
+ * //       latitude: Number("double"), // required
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param RadiusShopsCommandInput - {@link RadiusShopsCommandInput}
+ * @returns {@link RadiusShopsCommandOutput}
+ * @see {@link RadiusShopsCommandInput} for command's `input` shape.
+ * @see {@link RadiusShopsCommandOutput} for command's `response` shape.
+ * @see {@link AppAPIClientResolvedConfig | config} for AppAPIClient's `config` shape.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  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.
+ *
+ * @throws {@link RuntimeError} (server fault)
+ *
+ * @throws {@link AppAPIServiceException}
+ * <p>Base exception class for all service exceptions from AppAPI service.</p>
+ *
+ * @public
+ */
+export declare class RadiusShopsCommand extends RadiusShopsCommand_base {
+}

package/dist-types/commands/RecordVisitCommand.d.ts

@@ -0,0 +1,75 @@
+import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
+import { RecordVisitInput, RecordVisitOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link RecordVisitCommand}.
+ */
+export interface RecordVisitCommandInput extends RecordVisitInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link RecordVisitCommand}.
+ */
+export interface RecordVisitCommandOutput extends RecordVisitOutput, __MetadataBearer {
+}
+declare const RecordVisitCommand_base: {
+    new (input: RecordVisitCommandInput): import("@smithy/smithy-client").CommandImpl<RecordVisitCommandInput, RecordVisitCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: RecordVisitCommandInput): import("@smithy/smithy-client").CommandImpl<RecordVisitCommandInput, RecordVisitCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Records a visit to a shop for the authenticated user. Updates visit counts, tracks spending, awards points, and triggers rewards when thresholds are met. Also handles first-time rewards and visit-based rewards.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppAPIClient, RecordVisitCommand } from "@sparkrewards/sra-client"; // ES Modules import
+ * // const { AppAPIClient, RecordVisitCommand } = require("@sparkrewards/sra-client"); // CommonJS import
+ * const client = new AppAPIClient(config);
+ * const input = { // RecordVisitInput
+ *   shop_id: "STRING_VALUE", // required
+ *   timestamp: "STRING_VALUE", // required
+ *   lat: Number("double"), // required
+ *   lon: Number("double"), // required
+ * };
+ * const command = new RecordVisitCommand(input);
+ * const response = await client.send(command);
+ * // { // RecordVisitOutput
+ * //   success: true || false, // required
+ * //   message: "STRING_VALUE", // required
+ * //   visitId: "STRING_VALUE", // required
+ * //   reason: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param RecordVisitCommandInput - {@link RecordVisitCommandInput}
+ * @returns {@link RecordVisitCommandOutput}
+ * @see {@link RecordVisitCommandInput} for command's `input` shape.
+ * @see {@link RecordVisitCommandOutput} for command's `response` shape.
+ * @see {@link AppAPIClientResolvedConfig | config} for AppAPIClient's `config` shape.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  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.
+ *
+ * @throws {@link RuntimeError} (server fault)
+ *
+ * @throws {@link InvalidOperationError} (client fault)
+ *
+ * @throws {@link AppAPIServiceException}
+ * <p>Base exception class for all service exceptions from AppAPI service.</p>
+ *
+ * @public
+ */
+export declare class RecordVisitCommand extends RecordVisitCommand_base {
+}

package/dist-types/commands/RedeemFirstTimeRewardCommand.d.ts

@@ -0,0 +1,68 @@
+import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
+import { RedeemFirstTimeRewardInput, RedeemRewardOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link RedeemFirstTimeRewardCommand}.
+ */
+export interface RedeemFirstTimeRewardCommandInput extends RedeemFirstTimeRewardInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link RedeemFirstTimeRewardCommand}.
+ */
+export interface RedeemFirstTimeRewardCommandOutput extends RedeemRewardOutput, __MetadataBearer {
+}
+declare const RedeemFirstTimeRewardCommand_base: {
+    new (input: RedeemFirstTimeRewardCommandInput): import("@smithy/smithy-client").CommandImpl<RedeemFirstTimeRewardCommandInput, RedeemFirstTimeRewardCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: RedeemFirstTimeRewardCommandInput): import("@smithy/smithy-client").CommandImpl<RedeemFirstTimeRewardCommandInput, RedeemFirstTimeRewardCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Redeems a first-time reward for the authenticated user from a specific organization. This can only be redeemed once per user per organization.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppAPIClient, RedeemFirstTimeRewardCommand } from "@sparkrewards/sra-client"; // ES Modules import
+ * // const { AppAPIClient, RedeemFirstTimeRewardCommand } = require("@sparkrewards/sra-client"); // CommonJS import
+ * const client = new AppAPIClient(config);
+ * const input = { // RedeemFirstTimeRewardInput
+ *   org_id: "STRING_VALUE", // required
+ * };
+ * const command = new RedeemFirstTimeRewardCommand(input);
+ * const response = await client.send(command);
+ * // { // RedeemRewardOutput
+ * //   message: "STRING_VALUE", // required
+ * //   redeemed: true || false, // required
+ * // };
+ *
+ * ```
+ *
+ * @param RedeemFirstTimeRewardCommandInput - {@link RedeemFirstTimeRewardCommandInput}
+ * @returns {@link RedeemFirstTimeRewardCommandOutput}
+ * @see {@link RedeemFirstTimeRewardCommandInput} for command's `input` shape.
+ * @see {@link RedeemFirstTimeRewardCommandOutput} for command's `response` shape.
+ * @see {@link AppAPIClientResolvedConfig | config} for AppAPIClient's `config` shape.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  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.
+ *
+ * @throws {@link RuntimeError} (server fault)
+ *
+ * @throws {@link AppAPIServiceException}
+ * <p>Base exception class for all service exceptions from AppAPI service.</p>
+ *
+ * @public
+ */
+export declare class RedeemFirstTimeRewardCommand extends RedeemFirstTimeRewardCommand_base {
+}