@sparkrewards/sra-client 0.0.1

package/dist-types/commands/NearbyShopsCommand.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 NearbyShopsCommand}.
+ */
+export interface NearbyShopsCommandInput extends ShopListInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link NearbyShopsCommand}.
+ */
+export interface NearbyShopsCommandOutput extends ShopListWithPaginationOutput, __MetadataBearer {
+}
+declare const NearbyShopsCommand_base: {
+    new (input: NearbyShopsCommandInput): import("@smithy/smithy-client").CommandImpl<NearbyShopsCommandInput, NearbyShopsCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [NearbyShopsCommandInput]): import("@smithy/smithy-client").CommandImpl<NearbyShopsCommandInput, NearbyShopsCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Retrieves a paginated list of active 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, NearbyShopsCommand } from "@sparkrewards/sra-client"; // ES Modules import
+ * // const { AppAPIClient, NearbyShopsCommand } = 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 NearbyShopsCommand(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 NearbyShopsCommandInput - {@link NearbyShopsCommandInput}
+ * @returns {@link NearbyShopsCommandOutput}
+ * @see {@link NearbyShopsCommandInput} for command's `input` shape.
+ * @see {@link NearbyShopsCommandOutput} 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 NearbyShopsCommand extends NearbyShopsCommand_base {
+}

package/dist-types/commands/NearbyShopsPublicCommand.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 NearbyShopsPublicCommand}.
+ */
+export interface NearbyShopsPublicCommandInput extends ShopListInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link NearbyShopsPublicCommand}.
+ */
+export interface NearbyShopsPublicCommandOutput extends ShopListWithPaginationOutput, __MetadataBearer {
+}
+declare const NearbyShopsPublicCommand_base: {
+    new (input: NearbyShopsPublicCommandInput): import("@smithy/smithy-client").CommandImpl<NearbyShopsPublicCommandInput, NearbyShopsPublicCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [NearbyShopsPublicCommandInput]): import("@smithy/smithy-client").CommandImpl<NearbyShopsPublicCommandInput, NearbyShopsPublicCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Public endpoint: Retrieves a paginated list of active shops ordered by distance from the provided location coordinates. Returns enriched shop data with organization information. No authentication required.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppAPIClient, NearbyShopsPublicCommand } from "@sparkrewards/sra-client"; // ES Modules import
+ * // const { AppAPIClient, NearbyShopsPublicCommand } = 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 NearbyShopsPublicCommand(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 NearbyShopsPublicCommandInput - {@link NearbyShopsPublicCommandInput}
+ * @returns {@link NearbyShopsPublicCommandOutput}
+ * @see {@link NearbyShopsPublicCommandInput} for command's `input` shape.
+ * @see {@link NearbyShopsPublicCommandOutput} 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 NearbyShopsPublicCommand extends NearbyShopsPublicCommand_base {
+}

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

@@ -0,0 +1,91 @@
+import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
+import { EnrichedShop, NearestShopInput } 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 NearestShopCommand}.
+ */
+export interface NearestShopCommandInput extends NearestShopInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link NearestShopCommand}.
+ */
+export interface NearestShopCommandOutput extends EnrichedShop, __MetadataBearer {
+}
+declare const NearestShopCommand_base: {
+    new (input: NearestShopCommandInput): import("@smithy/smithy-client").CommandImpl<NearestShopCommandInput, NearestShopCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: NearestShopCommandInput): import("@smithy/smithy-client").CommandImpl<NearestShopCommandInput, NearestShopCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Retrieves the single nearest active shop to the provided location coordinates for a specific organization.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppAPIClient, NearestShopCommand } from "@sparkrewards/sra-client"; // ES Modules import
+ * // const { AppAPIClient, NearestShopCommand } = require("@sparkrewards/sra-client"); // CommonJS import
+ * const client = new AppAPIClient(config);
+ * const input = { // NearestShopInput
+ *   shop_name: "STRING_VALUE", // required
+ *   lat: Number("double"), // required
+ *   lon: Number("double"), // required
+ * };
+ * const command = new NearestShopCommand(input);
+ * const response = await client.send(command);
+ * // { // 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",
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param NearestShopCommandInput - {@link NearestShopCommandInput}
+ * @returns {@link NearestShopCommandOutput}
+ * @see {@link NearestShopCommandInput} for command's `input` shape.
+ * @see {@link NearestShopCommandOutput} 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 NearestShopCommand extends NearestShopCommand_base {
+}

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

@@ -0,0 +1,84 @@
+import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
+import { OnboardUserInput, OnboardUserOutput } 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 OnboardUserCommand}.
+ */
+export interface OnboardUserCommandInput extends OnboardUserInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link OnboardUserCommand}.
+ */
+export interface OnboardUserCommandOutput extends OnboardUserOutput, __MetadataBearer {
+}
+declare const OnboardUserCommand_base: {
+    new (input: OnboardUserCommandInput): import("@smithy/smithy-client").CommandImpl<OnboardUserCommandInput, OnboardUserCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [OnboardUserCommandInput]): import("@smithy/smithy-client").CommandImpl<OnboardUserCommandInput, OnboardUserCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Completes the onboarding process for a new user by marking their account as no longer new. Updates the user's newAccount status and returns the updated user profile.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppAPIClient, OnboardUserCommand } from "@sparkrewards/sra-client"; // ES Modules import
+ * // const { AppAPIClient, OnboardUserCommand } = require("@sparkrewards/sra-client"); // CommonJS import
+ * const client = new AppAPIClient(config);
+ * const input = {};
+ * const command = new OnboardUserCommand(input);
+ * const response = await client.send(command);
+ * // { // OnboardUserOutput
+ * //   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 OnboardUserCommandInput - {@link OnboardUserCommandInput}
+ * @returns {@link OnboardUserCommandOutput}
+ * @see {@link OnboardUserCommandInput} for command's `input` shape.
+ * @see {@link OnboardUserCommandOutput} 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 OnboardUserCommand extends OnboardUserCommand_base {
+}

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

@@ -0,0 +1,91 @@
+import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
+import { EnrichedShop, PinnedShopInput } 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 PinnedShopCommand}.
+ */
+export interface PinnedShopCommandInput extends PinnedShopInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link PinnedShopCommand}.
+ */
+export interface PinnedShopCommandOutput extends EnrichedShop, __MetadataBearer {
+}
+declare const PinnedShopCommand_base: {
+    new (input: PinnedShopCommandInput): import("@smithy/smithy-client").CommandImpl<PinnedShopCommandInput, PinnedShopCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: PinnedShopCommandInput): import("@smithy/smithy-client").CommandImpl<PinnedShopCommandInput, PinnedShopCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Retrieves the pinned shop details for the authenticated user. 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, PinnedShopCommand } from "@sparkrewards/sra-client"; // ES Modules import
+ * // const { AppAPIClient, PinnedShopCommand } = require("@sparkrewards/sra-client"); // CommonJS import
+ * const client = new AppAPIClient(config);
+ * const input = { // PinnedShopInput
+ *   shop_id: "STRING_VALUE", // required
+ *   lat: Number("double"), // required
+ *   lon: Number("double"), // required
+ * };
+ * const command = new PinnedShopCommand(input);
+ * const response = await client.send(command);
+ * // { // 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",
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param PinnedShopCommandInput - {@link PinnedShopCommandInput}
+ * @returns {@link PinnedShopCommandOutput}
+ * @see {@link PinnedShopCommandInput} for command's `input` shape.
+ * @see {@link PinnedShopCommandOutput} 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 PinnedShopCommand extends PinnedShopCommand_base {
+}

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

@@ -0,0 +1,91 @@
+import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
+import { EnrichedShop, PinnedShopInput } 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 PinnedShopPublicCommand}.
+ */
+export interface PinnedShopPublicCommandInput extends PinnedShopInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link PinnedShopPublicCommand}.
+ */
+export interface PinnedShopPublicCommandOutput extends EnrichedShop, __MetadataBearer {
+}
+declare const PinnedShopPublicCommand_base: {
+    new (input: PinnedShopPublicCommandInput): import("@smithy/smithy-client").CommandImpl<PinnedShopPublicCommandInput, PinnedShopPublicCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: PinnedShopPublicCommandInput): import("@smithy/smithy-client").CommandImpl<PinnedShopPublicCommandInput, PinnedShopPublicCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Retrieves the pinned shop details for the authenticated user. 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, PinnedShopPublicCommand } from "@sparkrewards/sra-client"; // ES Modules import
+ * // const { AppAPIClient, PinnedShopPublicCommand } = require("@sparkrewards/sra-client"); // CommonJS import
+ * const client = new AppAPIClient(config);
+ * const input = { // PinnedShopInput
+ *   shop_id: "STRING_VALUE", // required
+ *   lat: Number("double"), // required
+ *   lon: Number("double"), // required
+ * };
+ * const command = new PinnedShopPublicCommand(input);
+ * const response = await client.send(command);
+ * // { // 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",
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param PinnedShopPublicCommandInput - {@link PinnedShopPublicCommandInput}
+ * @returns {@link PinnedShopPublicCommandOutput}
+ * @see {@link PinnedShopPublicCommandInput} for command's `input` shape.
+ * @see {@link PinnedShopPublicCommandOutput} 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 PinnedShopPublicCommand extends PinnedShopPublicCommand_base {
+}

package/dist-types/commands/PlanCommand.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 PlanCommand}.
+ */
+export interface PlanCommandInput extends PlanGetInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link PlanCommand}.
+ */
+export interface PlanCommandOutput extends PlanOutput, __MetadataBearer {
+}
+declare const PlanCommand_base: {
+    new (input: PlanCommandInput): import("@smithy/smithy-client").CommandImpl<PlanCommandInput, PlanCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: PlanCommandInput): import("@smithy/smithy-client").CommandImpl<PlanCommandInput, PlanCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Retrieves the reward plan details for a specific organization, including visits, points, and redeemable rewards for the authenticated user.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppAPIClient, PlanCommand } from "@sparkrewards/sra-client"; // ES Modules import
+ * // const { AppAPIClient, PlanCommand } = require("@sparkrewards/sra-client"); // CommonJS import
+ * const client = new AppAPIClient(config);
+ * const input = { // PlanGetInput
+ *   org_id: "STRING_VALUE", // required
+ * };
+ * const command = new PlanCommand(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 PlanCommandInput - {@link PlanCommandInput}
+ * @returns {@link PlanCommandOutput}
+ * @see {@link PlanCommandInput} for command's `input` shape.
+ * @see {@link PlanCommandOutput} 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 PlanCommand extends PlanCommand_base {
+}