@sparkrewards/sra-client 0.0.1

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

@@ -0,0 +1,71 @@
+import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
+import { RedeemPointRewardInput, RedeemPointRewardOutput } 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 RedeemPointRewardCommand}.
+ */
+export interface RedeemPointRewardCommandInput extends RedeemPointRewardInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link RedeemPointRewardCommand}.
+ */
+export interface RedeemPointRewardCommandOutput extends RedeemPointRewardOutput, __MetadataBearer {
+}
+declare const RedeemPointRewardCommand_base: {
+    new (input: RedeemPointRewardCommandInput): import("@smithy/smithy-client").CommandImpl<RedeemPointRewardCommandInput, RedeemPointRewardCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: RedeemPointRewardCommandInput): import("@smithy/smithy-client").CommandImpl<RedeemPointRewardCommandInput, RedeemPointRewardCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Redeems a point-based reward for the authenticated user using accumulated points. The required points are deducted from the user's total points balance.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppAPIClient, RedeemPointRewardCommand } from "@sparkrewards/sra-client"; // ES Modules import
+ * // const { AppAPIClient, RedeemPointRewardCommand } = require("@sparkrewards/sra-client"); // CommonJS import
+ * const client = new AppAPIClient(config);
+ * const input = { // RedeemPointRewardInput
+ *   org_id: "STRING_VALUE", // required
+ *   reward_id: "STRING_VALUE", // required
+ * };
+ * const command = new RedeemPointRewardCommand(input);
+ * const response = await client.send(command);
+ * // { // RedeemPointRewardOutput
+ * //   message: "STRING_VALUE", // required
+ * //   redeemed: true || false, // required
+ * //   pointsUsed: Number("int"), // required
+ * //   remainingPoints: Number("int"), // required
+ * // };
+ *
+ * ```
+ *
+ * @param RedeemPointRewardCommandInput - {@link RedeemPointRewardCommandInput}
+ * @returns {@link RedeemPointRewardCommandOutput}
+ * @see {@link RedeemPointRewardCommandInput} for command's `input` shape.
+ * @see {@link RedeemPointRewardCommandOutput} 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 RedeemPointRewardCommand extends RedeemPointRewardCommand_base {
+}

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

@@ -0,0 +1,68 @@
+import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
+import { RedeemRewardOutput, RedeemVisitRewardInput } 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 RedeemVisitRewardCommand}.
+ */
+export interface RedeemVisitRewardCommandInput extends RedeemVisitRewardInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link RedeemVisitRewardCommand}.
+ */
+export interface RedeemVisitRewardCommandOutput extends RedeemRewardOutput, __MetadataBearer {
+}
+declare const RedeemVisitRewardCommand_base: {
+    new (input: RedeemVisitRewardCommandInput): import("@smithy/smithy-client").CommandImpl<RedeemVisitRewardCommandInput, RedeemVisitRewardCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: RedeemVisitRewardCommandInput): import("@smithy/smithy-client").CommandImpl<RedeemVisitRewardCommandInput, RedeemVisitRewardCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Redeems a visit-based reward for the authenticated user. This reward is earned after completing the required number of visits for a reward plan.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppAPIClient, RedeemVisitRewardCommand } from "@sparkrewards/sra-client"; // ES Modules import
+ * // const { AppAPIClient, RedeemVisitRewardCommand } = require("@sparkrewards/sra-client"); // CommonJS import
+ * const client = new AppAPIClient(config);
+ * const input = { // RedeemVisitRewardInput
+ *   reward_id: "STRING_VALUE", // required
+ * };
+ * const command = new RedeemVisitRewardCommand(input);
+ * const response = await client.send(command);
+ * // { // RedeemRewardOutput
+ * //   message: "STRING_VALUE", // required
+ * //   redeemed: true || false, // required
+ * // };
+ *
+ * ```
+ *
+ * @param RedeemVisitRewardCommandInput - {@link RedeemVisitRewardCommandInput}
+ * @returns {@link RedeemVisitRewardCommandOutput}
+ * @see {@link RedeemVisitRewardCommandInput} for command's `input` shape.
+ * @see {@link RedeemVisitRewardCommandOutput} 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 RedeemVisitRewardCommand extends RedeemVisitRewardCommand_base {
+}

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

@@ -0,0 +1,106 @@
+import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
+import { SearchShopsInput, 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 SearchShopsPublicCommand}.
+ */
+export interface SearchShopsPublicCommandInput extends SearchShopsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link SearchShopsPublicCommand}.
+ */
+export interface SearchShopsPublicCommandOutput extends ShopListWithPaginationOutput, __MetadataBearer {
+}
+declare const SearchShopsPublicCommand_base: {
+    new (input: SearchShopsPublicCommandInput): import("@smithy/smithy-client").CommandImpl<SearchShopsPublicCommandInput, SearchShopsPublicCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: SearchShopsPublicCommandInput): import("@smithy/smithy-client").CommandImpl<SearchShopsPublicCommandInput, SearchShopsPublicCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Retrieves a paginated list of shops based on the provided search query. 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, SearchShopsPublicCommand } from "@sparkrewards/sra-client"; // ES Modules import
+ * // const { AppAPIClient, SearchShopsPublicCommand } = require("@sparkrewards/sra-client"); // CommonJS import
+ * const client = new AppAPIClient(config);
+ * const input = { // SearchShopsInput
+ *   q: "STRING_VALUE", // required
+ *   limit: Number("int"),
+ *   lat: Number("double"),
+ *   lon: Number("double"),
+ *   page: Number("int"),
+ *   filters: "STRING_VALUE",
+ * };
+ * const command = new SearchShopsPublicCommand(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 SearchShopsPublicCommandInput - {@link SearchShopsPublicCommandInput}
+ * @returns {@link SearchShopsPublicCommandOutput}
+ * @see {@link SearchShopsPublicCommandInput} for command's `input` shape.
+ * @see {@link SearchShopsPublicCommandOutput} 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 SearchShopsPublicCommand extends SearchShopsPublicCommand_base {
+}

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

@@ -0,0 +1,78 @@
+import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
+import { SearchSuggestionInput, SearchSuggestionOutput } 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 SearchSuggestionCommand}.
+ */
+export interface SearchSuggestionCommandInput extends SearchSuggestionInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link SearchSuggestionCommand}.
+ */
+export interface SearchSuggestionCommandOutput extends SearchSuggestionOutput, __MetadataBearer {
+}
+declare const SearchSuggestionCommand_base: {
+    new (input: SearchSuggestionCommandInput): import("@smithy/smithy-client").CommandImpl<SearchSuggestionCommandInput, SearchSuggestionCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: SearchSuggestionCommandInput): import("@smithy/smithy-client").CommandImpl<SearchSuggestionCommandInput, SearchSuggestionCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Retrieves search suggestions for shops based on the provided search query. Returns matching shop and organization names.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppAPIClient, SearchSuggestionCommand } from "@sparkrewards/sra-client"; // ES Modules import
+ * // const { AppAPIClient, SearchSuggestionCommand } = require("@sparkrewards/sra-client"); // CommonJS import
+ * const client = new AppAPIClient(config);
+ * const input = { // SearchSuggestionInput
+ *   q: "STRING_VALUE", // required
+ *   limit: Number("int"),
+ *   lat: Number("double"),
+ *   lon: Number("double"),
+ * };
+ * const command = new SearchSuggestionCommand(input);
+ * const response = await client.send(command);
+ * // { // SearchSuggestionOutput
+ * //   value: [ // SearchSuggestionList
+ * //     { // SearchSuggestionItem
+ * //       shop_id: "STRING_VALUE", // required
+ * //       organization_id: "STRING_VALUE", // required
+ * //       search_name: "STRING_VALUE", // required
+ * //       favorite: true || false, // required
+ * //       distance: Number("double"), // required
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param SearchSuggestionCommandInput - {@link SearchSuggestionCommandInput}
+ * @returns {@link SearchSuggestionCommandOutput}
+ * @see {@link SearchSuggestionCommandInput} for command's `input` shape.
+ * @see {@link SearchSuggestionCommandOutput} 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 SearchSuggestionCommand extends SearchSuggestionCommand_base {
+}

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

@@ -0,0 +1,89 @@
+import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
+import { UpdateUserInput, UpdateUserOutput } 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 UpdateUserCommand}.
+ */
+export interface UpdateUserCommandInput extends UpdateUserInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateUserCommand}.
+ */
+export interface UpdateUserCommandOutput extends UpdateUserOutput, __MetadataBearer {
+}
+declare const UpdateUserCommand_base: {
+    new (input: UpdateUserCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateUserCommandInput, UpdateUserCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [UpdateUserCommandInput]): import("@smithy/smithy-client").CommandImpl<UpdateUserCommandInput, UpdateUserCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Updates the authenticated user's profile information, including personal details and preferences. Only provided fields will be updated.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppAPIClient, UpdateUserCommand } from "@sparkrewards/sra-client"; // ES Modules import
+ * // const { AppAPIClient, UpdateUserCommand } = require("@sparkrewards/sra-client"); // CommonJS import
+ * const client = new AppAPIClient(config);
+ * const input = { // UpdateUserInput
+ *   fullname: { // UserFullnameUpdate
+ *     firstName: "STRING_VALUE",
+ *     lastName: "STRING_VALUE",
+ *   },
+ * };
+ * const command = new UpdateUserCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateUserOutput
+ * //   message: "STRING_VALUE",
+ * //   user: { // User
+ * //     id: "STRING_VALUE", // required
+ * //     email: "STRING_VALUE", // required
+ * //     birthdate: "STRING_VALUE", // required
+ * //     fullname: { // UserFullname
+ * //       firstName: "STRING_VALUE",
+ * //       lastName: "STRING_VALUE",
+ * //     },
+ * //     date_created: "STRING_VALUE", // required
+ * //     newAccount: true || false, // required
+ * //     preferences: { // UserPreferences
+ * //       lightMode: true || false,
+ * //     },
+ * //     total_visits: Number("int"), // required
+ * //     total_points: Number("int"), // required
+ * //     total_rewards: Number("int"), // required
+ * //     fraud_count: Number("int"),
+ * //     num_redeemableRewards: Number("int"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateUserCommandInput - {@link UpdateUserCommandInput}
+ * @returns {@link UpdateUserCommandOutput}
+ * @see {@link UpdateUserCommandInput} for command's `input` shape.
+ * @see {@link UpdateUserCommandOutput} 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 UpdateUserCommand extends UpdateUserCommand_base {
+}

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

@@ -0,0 +1,26 @@
+export * from "./DeleteUserCommand";
+export * from "./FavoritePlansCommand";
+export * from "./FavoriteShopsCommand";
+export * from "./GetShopCommand";
+export * from "./GetShopPublicCommand";
+export * from "./GetUserCommand";
+export * from "./LikeOrgCommand";
+export * from "./NearbyShopsCommand";
+export * from "./NearbyShopsPublicCommand";
+export * from "./NearestShopCommand";
+export * from "./OnboardUserCommand";
+export * from "./PinnedShopCommand";
+export * from "./PinnedShopPublicCommand";
+export * from "./PlanCommand";
+export * from "./PlanPublicCommand";
+export * from "./PlansCommand";
+export * from "./PopularShopsCommand";
+export * from "./PopularShopsPublicCommand";
+export * from "./RadiusShopsCommand";
+export * from "./RecordVisitCommand";
+export * from "./RedeemFirstTimeRewardCommand";
+export * from "./RedeemPointRewardCommand";
+export * from "./RedeemVisitRewardCommand";
+export * from "./SearchShopsPublicCommand";
+export * from "./SearchSuggestionCommand";
+export * from "./UpdateUserCommand";

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,8 @@
+import { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
+import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import { DefaultExtensionConfiguration } from "@smithy/types";
+/**
+ * @internal
+ */
+export interface AppAPIExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, HttpAuthExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Spark Rewards APP API Service
+ *
+ * @packageDocumentation
+ */
+export * from "./AppAPIClient";
+export * from "./AppAPI";
+export type { RuntimeExtension } from "./runtimeExtensions";
+export type { AppAPIExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./models";
+export { AppAPIServiceException } from "./models/AppAPIServiceException";

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

@@ -0,0 +1,14 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
+export type { __ServiceExceptionOptions };
+export { __ServiceException };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from AppAPI service.
+ */
+export declare class AppAPIServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

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

@@ -0,0 +1 @@
+export * from "./models_0";