@sparkrewards/sra-client 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/dist-cjs/AppAPI.js +63 -0
- package/dist-cjs/AppAPIClient.js +43 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +35 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +35 -0
- package/dist-cjs/commands/DeleteUserCommand.js +21 -0
- package/dist-cjs/commands/FavoritePlansCommand.js +21 -0
- package/dist-cjs/commands/FavoriteShopsCommand.js +21 -0
- package/dist-cjs/commands/GetShopCommand.js +21 -0
- package/dist-cjs/commands/GetShopPublicCommand.js +21 -0
- package/dist-cjs/commands/GetUserCommand.js +21 -0
- package/dist-cjs/commands/LikeOrgCommand.js +21 -0
- package/dist-cjs/commands/NearbyShopsCommand.js +21 -0
- package/dist-cjs/commands/NearbyShopsPublicCommand.js +21 -0
- package/dist-cjs/commands/NearestShopCommand.js +21 -0
- package/dist-cjs/commands/OnboardUserCommand.js +21 -0
- package/dist-cjs/commands/PinnedShopCommand.js +21 -0
- package/dist-cjs/commands/PinnedShopPublicCommand.js +21 -0
- package/dist-cjs/commands/PlanCommand.js +21 -0
- package/dist-cjs/commands/PlanPublicCommand.js +21 -0
- package/dist-cjs/commands/PlansCommand.js +21 -0
- package/dist-cjs/commands/PopularShopsCommand.js +21 -0
- package/dist-cjs/commands/PopularShopsPublicCommand.js +21 -0
- package/dist-cjs/commands/RadiusShopsCommand.js +21 -0
- package/dist-cjs/commands/RecordVisitCommand.js +21 -0
- package/dist-cjs/commands/RedeemFirstTimeRewardCommand.js +21 -0
- package/dist-cjs/commands/RedeemPointRewardCommand.js +21 -0
- package/dist-cjs/commands/RedeemVisitRewardCommand.js +21 -0
- package/dist-cjs/commands/SearchShopsPublicCommand.js +21 -0
- package/dist-cjs/commands/SearchSuggestionCommand.js +21 -0
- package/dist-cjs/commands/UpdateUserCommand.js +21 -0
- package/dist-cjs/commands/index.js +29 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +10 -0
- package/dist-cjs/models/AppAPIServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +57 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1073 -0
- package/dist-cjs/runtimeConfig.browser.js +32 -0
- package/dist-cjs/runtimeConfig.js +36 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +23 -0
- package/dist-cjs/runtimeExtensions.js +22 -0
- package/dist-es/AppAPI.js +59 -0
- package/dist-es/AppAPIClient.js +39 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +30 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +29 -0
- package/dist-es/commands/DeleteUserCommand.js +17 -0
- package/dist-es/commands/FavoritePlansCommand.js +17 -0
- package/dist-es/commands/FavoriteShopsCommand.js +17 -0
- package/dist-es/commands/GetShopCommand.js +17 -0
- package/dist-es/commands/GetShopPublicCommand.js +17 -0
- package/dist-es/commands/GetUserCommand.js +17 -0
- package/dist-es/commands/LikeOrgCommand.js +17 -0
- package/dist-es/commands/NearbyShopsCommand.js +17 -0
- package/dist-es/commands/NearbyShopsPublicCommand.js +17 -0
- package/dist-es/commands/NearestShopCommand.js +17 -0
- package/dist-es/commands/OnboardUserCommand.js +17 -0
- package/dist-es/commands/PinnedShopCommand.js +17 -0
- package/dist-es/commands/PinnedShopPublicCommand.js +17 -0
- package/dist-es/commands/PlanCommand.js +17 -0
- package/dist-es/commands/PlanPublicCommand.js +17 -0
- package/dist-es/commands/PlansCommand.js +17 -0
- package/dist-es/commands/PopularShopsCommand.js +17 -0
- package/dist-es/commands/PopularShopsPublicCommand.js +17 -0
- package/dist-es/commands/RadiusShopsCommand.js +17 -0
- package/dist-es/commands/RecordVisitCommand.js +17 -0
- package/dist-es/commands/RedeemFirstTimeRewardCommand.js +17 -0
- package/dist-es/commands/RedeemPointRewardCommand.js +17 -0
- package/dist-es/commands/RedeemVisitRewardCommand.js +17 -0
- package/dist-es/commands/SearchShopsPublicCommand.js +17 -0
- package/dist-es/commands/SearchSuggestionCommand.js +17 -0
- package/dist-es/commands/UpdateUserCommand.js +17 -0
- package/dist-es/commands/index.js +26 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +5 -0
- package/dist-es/models/AppAPIServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +50 -0
- package/dist-es/protocols/Aws_restJson1.js +1017 -0
- package/dist-es/runtimeConfig.browser.js +27 -0
- package/dist-es/runtimeConfig.js +31 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +19 -0
- package/dist-es/runtimeExtensions.js +18 -0
- package/dist-types/AppAPI.d.ts +202 -0
- package/dist-types/AppAPIClient.d.ts +170 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +26 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +59 -0
- package/dist-types/commands/DeleteUserCommand.d.ts +65 -0
- package/dist-types/commands/FavoritePlansCommand.d.ts +119 -0
- package/dist-types/commands/FavoriteShopsCommand.d.ts +104 -0
- package/dist-types/commands/GetShopCommand.d.ts +100 -0
- package/dist-types/commands/GetShopPublicCommand.d.ts +100 -0
- package/dist-types/commands/GetUserCommand.d.ts +84 -0
- package/dist-types/commands/LikeOrgCommand.d.ts +68 -0
- package/dist-types/commands/NearbyShopsCommand.d.ts +104 -0
- package/dist-types/commands/NearbyShopsPublicCommand.d.ts +104 -0
- package/dist-types/commands/NearestShopCommand.d.ts +91 -0
- package/dist-types/commands/OnboardUserCommand.d.ts +84 -0
- package/dist-types/commands/PinnedShopCommand.d.ts +91 -0
- package/dist-types/commands/PinnedShopPublicCommand.d.ts +91 -0
- package/dist-types/commands/PlanCommand.d.ts +107 -0
- package/dist-types/commands/PlanPublicCommand.d.ts +107 -0
- package/dist-types/commands/PlansCommand.d.ts +119 -0
- package/dist-types/commands/PopularShopsCommand.d.ts +104 -0
- package/dist-types/commands/PopularShopsPublicCommand.d.ts +104 -0
- package/dist-types/commands/RadiusShopsCommand.d.ts +78 -0
- package/dist-types/commands/RecordVisitCommand.d.ts +75 -0
- package/dist-types/commands/RedeemFirstTimeRewardCommand.d.ts +68 -0
- package/dist-types/commands/RedeemPointRewardCommand.d.ts +71 -0
- package/dist-types/commands/RedeemVisitRewardCommand.d.ts +68 -0
- package/dist-types/commands/SearchShopsPublicCommand.d.ts +106 -0
- package/dist-types/commands/SearchSuggestionCommand.d.ts +78 -0
- package/dist-types/commands/UpdateUserCommand.d.ts +89 -0
- package/dist-types/commands/index.d.ts +26 -0
- package/dist-types/extensionConfiguration.d.ts +8 -0
- package/dist-types/index.d.ts +12 -0
- package/dist-types/models/AppAPIServiceException.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +550 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +236 -0
- package/dist-types/runtimeConfig.browser.d.ts +33 -0
- package/dist-types/runtimeConfig.d.ts +33 -0
- package/dist-types/runtimeConfig.native.d.ts +32 -0
- package/dist-types/runtimeConfig.shared.d.ts +16 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/package.json +81 -0
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
|
|
2
|
+
import { PlansListInput, PlansOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link FavoritePlansCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface FavoritePlansCommandInput extends PlansListInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link FavoritePlansCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface FavoritePlansCommandOutput extends PlansOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const FavoritePlansCommand_base: {
|
|
25
|
+
new (input: FavoritePlansCommandInput): import("@smithy/smithy-client").CommandImpl<FavoritePlansCommandInput, FavoritePlansCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: FavoritePlansCommandInput): import("@smithy/smithy-client").CommandImpl<FavoritePlansCommandInput, FavoritePlansCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Retrieves a paginated list of reward plans for organizations that the authenticated user has marked as favorites, ordered by nearest shop location.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { AppAPIClient, FavoritePlansCommand } from "@sparkrewards/sra-client"; // ES Modules import
|
|
35
|
+
* // const { AppAPIClient, FavoritePlansCommand } = require("@sparkrewards/sra-client"); // CommonJS import
|
|
36
|
+
* const client = new AppAPIClient(config);
|
|
37
|
+
* const input = { // PlansListInput
|
|
38
|
+
* page: Number("int"),
|
|
39
|
+
* limit: Number("int"),
|
|
40
|
+
* lat: Number("double"), // required
|
|
41
|
+
* lon: Number("double"), // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new FavoritePlansCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // PlansOutput
|
|
46
|
+
* // value: [ // GroupedPlanList // required
|
|
47
|
+
* // { // GroupedPlan
|
|
48
|
+
* // reward_plan: { // RewardPlan
|
|
49
|
+
* // visits: { // VisitRewardProps
|
|
50
|
+
* // tiers: { // TierMap // required
|
|
51
|
+
* // "<keys>": { // Tier
|
|
52
|
+
* // id: "STRING_VALUE", // required
|
|
53
|
+
* // rewards: [ // StringList // required
|
|
54
|
+
* // "STRING_VALUE",
|
|
55
|
+
* // ],
|
|
56
|
+
* // },
|
|
57
|
+
* // },
|
|
58
|
+
* // min_spend: Number("int"), // required
|
|
59
|
+
* // },
|
|
60
|
+
* // points: [ // PointsRewardOptionList
|
|
61
|
+
* // { // PointsRewardOption
|
|
62
|
+
* // id: "STRING_VALUE", // required
|
|
63
|
+
* // reward: "STRING_VALUE", // required
|
|
64
|
+
* // points: Number("int"), // required
|
|
65
|
+
* // },
|
|
66
|
+
* // ],
|
|
67
|
+
* // },
|
|
68
|
+
* // visits: Number("int"), // required
|
|
69
|
+
* // points: Number("int"), // required
|
|
70
|
+
* // redeemableRewards: [ // RewardList // required
|
|
71
|
+
* // { // Reward
|
|
72
|
+
* // reward_id: "STRING_VALUE",
|
|
73
|
+
* // id: "STRING_VALUE",
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // visits_active: true || false, // required
|
|
77
|
+
* // points_active: true || false, // required
|
|
78
|
+
* // banner: "STRING_VALUE", // required
|
|
79
|
+
* // logo: "STRING_VALUE", // required
|
|
80
|
+
* // org_id: "STRING_VALUE", // required
|
|
81
|
+
* // shop_id: "STRING_VALUE", // required
|
|
82
|
+
* // name: "STRING_VALUE", // required
|
|
83
|
+
* // id: "STRING_VALUE", // required
|
|
84
|
+
* // active: true || false, // required
|
|
85
|
+
* // favorite: true || false, // required
|
|
86
|
+
* // num_redeemableRewards: Number("int"), // required
|
|
87
|
+
* // },
|
|
88
|
+
* // ],
|
|
89
|
+
* // count: Number("int"), // required
|
|
90
|
+
* // pagination: { // PaginationInfo
|
|
91
|
+
* // currentPage: Number("int"),
|
|
92
|
+
* // limit: Number("int"), // required
|
|
93
|
+
* // hasMore: true || false, // required
|
|
94
|
+
* // nextPage: Number("int"), // required
|
|
95
|
+
* // },
|
|
96
|
+
* // };
|
|
97
|
+
*
|
|
98
|
+
* ```
|
|
99
|
+
*
|
|
100
|
+
* @param FavoritePlansCommandInput - {@link FavoritePlansCommandInput}
|
|
101
|
+
* @returns {@link FavoritePlansCommandOutput}
|
|
102
|
+
* @see {@link FavoritePlansCommandInput} for command's `input` shape.
|
|
103
|
+
* @see {@link FavoritePlansCommandOutput} for command's `response` shape.
|
|
104
|
+
* @see {@link AppAPIClientResolvedConfig | config} for AppAPIClient's `config` shape.
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link ValidationException} (client fault)
|
|
107
|
+
* A standard error for input validation failures.
|
|
108
|
+
* This should be thrown by services when a member of the input structure
|
|
109
|
+
* falls outside of the modeled or documented constraints.
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link RuntimeError} (server fault)
|
|
112
|
+
*
|
|
113
|
+
* @throws {@link AppAPIServiceException}
|
|
114
|
+
* <p>Base exception class for all service exceptions from AppAPI service.</p>
|
|
115
|
+
*
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
118
|
+
export declare class FavoritePlansCommand extends FavoritePlansCommand_base {
|
|
119
|
+
}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
|
|
2
|
+
import { ShopListInput, ShopListWithPaginationOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link FavoriteShopsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface FavoriteShopsCommandInput extends ShopListInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link FavoriteShopsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface FavoriteShopsCommandOutput extends ShopListWithPaginationOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const FavoriteShopsCommand_base: {
|
|
25
|
+
new (input: FavoriteShopsCommandInput): import("@smithy/smithy-client").CommandImpl<FavoriteShopsCommandInput, FavoriteShopsCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [FavoriteShopsCommandInput]): import("@smithy/smithy-client").CommandImpl<FavoriteShopsCommandInput, FavoriteShopsCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Retrieves a paginated list of shops from organizations that the authenticated user has marked as favorites, ordered by distance from the provided location coordinates.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { AppAPIClient, FavoriteShopsCommand } from "@sparkrewards/sra-client"; // ES Modules import
|
|
35
|
+
* // const { AppAPIClient, FavoriteShopsCommand } = require("@sparkrewards/sra-client"); // CommonJS import
|
|
36
|
+
* const client = new AppAPIClient(config);
|
|
37
|
+
* const input = { // ShopListInput
|
|
38
|
+
* lat: Number("double"),
|
|
39
|
+
* lon: Number("double"),
|
|
40
|
+
* page: Number("int"),
|
|
41
|
+
* filters: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new FavoriteShopsCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ShopListWithPaginationOutput
|
|
46
|
+
* // message: "STRING_VALUE",
|
|
47
|
+
* // value: [ // EnrichedShopList
|
|
48
|
+
* // { // EnrichedShop
|
|
49
|
+
* // shop_id: "STRING_VALUE", // required
|
|
50
|
+
* // org_id: "STRING_VALUE", // required
|
|
51
|
+
* // preview: "STRING_VALUE", // required
|
|
52
|
+
* // name: "STRING_VALUE", // required
|
|
53
|
+
* // distance: "STRING_VALUE", // required
|
|
54
|
+
* // favorite: true || false,
|
|
55
|
+
* // location: { // LocationDetails
|
|
56
|
+
* // address: "STRING_VALUE", // required
|
|
57
|
+
* // city: "STRING_VALUE", // required
|
|
58
|
+
* // state: "STRING_VALUE", // required
|
|
59
|
+
* // zipcode: "STRING_VALUE", // required
|
|
60
|
+
* // },
|
|
61
|
+
* // shop_hours: [ // ShopHoursList // required
|
|
62
|
+
* // { // ShopHoursItem
|
|
63
|
+
* // day: "STRING_VALUE", // required
|
|
64
|
+
* // open: "STRING_VALUE", // required
|
|
65
|
+
* // close: "STRING_VALUE", // required
|
|
66
|
+
* // },
|
|
67
|
+
* // ],
|
|
68
|
+
* // logo: "STRING_VALUE",
|
|
69
|
+
* // tags: [ // StringList // required
|
|
70
|
+
* // "STRING_VALUE",
|
|
71
|
+
* // ],
|
|
72
|
+
* // },
|
|
73
|
+
* // ],
|
|
74
|
+
* // count: Number("int"),
|
|
75
|
+
* // pagination: { // PaginationInfo
|
|
76
|
+
* // currentPage: Number("int"),
|
|
77
|
+
* // limit: Number("int"), // required
|
|
78
|
+
* // hasMore: true || false, // required
|
|
79
|
+
* // nextPage: Number("int"), // required
|
|
80
|
+
* // },
|
|
81
|
+
* // };
|
|
82
|
+
*
|
|
83
|
+
* ```
|
|
84
|
+
*
|
|
85
|
+
* @param FavoriteShopsCommandInput - {@link FavoriteShopsCommandInput}
|
|
86
|
+
* @returns {@link FavoriteShopsCommandOutput}
|
|
87
|
+
* @see {@link FavoriteShopsCommandInput} for command's `input` shape.
|
|
88
|
+
* @see {@link FavoriteShopsCommandOutput} for command's `response` shape.
|
|
89
|
+
* @see {@link AppAPIClientResolvedConfig | config} for AppAPIClient's `config` shape.
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ValidationException} (client fault)
|
|
92
|
+
* A standard error for input validation failures.
|
|
93
|
+
* This should be thrown by services when a member of the input structure
|
|
94
|
+
* falls outside of the modeled or documented constraints.
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link RuntimeError} (server fault)
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link AppAPIServiceException}
|
|
99
|
+
* <p>Base exception class for all service exceptions from AppAPI service.</p>
|
|
100
|
+
*
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
export declare class FavoriteShopsCommand extends FavoriteShopsCommand_base {
|
|
104
|
+
}
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
|
|
2
|
+
import { GetShopInput, ShopDetails } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetShopCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetShopCommandInput extends GetShopInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetShopCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetShopCommandOutput extends ShopDetails, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetShopCommand_base: {
|
|
25
|
+
new (input: GetShopCommandInput): import("@smithy/smithy-client").CommandImpl<GetShopCommandInput, GetShopCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetShopCommandInput): import("@smithy/smithy-client").CommandImpl<GetShopCommandInput, GetShopCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Retrieves detailed information for a specific shop by its ID, including organization details, menu, location, and shop hours.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { AppAPIClient, GetShopCommand } from "@sparkrewards/sra-client"; // ES Modules import
|
|
35
|
+
* // const { AppAPIClient, GetShopCommand } = require("@sparkrewards/sra-client"); // CommonJS import
|
|
36
|
+
* const client = new AppAPIClient(config);
|
|
37
|
+
* const input = { // GetShopInput
|
|
38
|
+
* shop_id: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetShopCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // ShopDetails
|
|
43
|
+
* // id: "STRING_VALUE", // required
|
|
44
|
+
* // org_id: "STRING_VALUE", // required
|
|
45
|
+
* // shop_name: "STRING_VALUE", // required
|
|
46
|
+
* // org_name: "STRING_VALUE", // required
|
|
47
|
+
* // banner: "STRING_VALUE",
|
|
48
|
+
* // preview: "STRING_VALUE", // required
|
|
49
|
+
* // logo: "STRING_VALUE", // required
|
|
50
|
+
* // description: "STRING_VALUE", // required
|
|
51
|
+
* // country_code: "STRING_VALUE", // required
|
|
52
|
+
* // latitude: Number("double"),
|
|
53
|
+
* // longitude: Number("double"), // required
|
|
54
|
+
* // active: true || false, // required
|
|
55
|
+
* // menu: "STRING_VALUE",
|
|
56
|
+
* // phone_number: "STRING_VALUE",
|
|
57
|
+
* // location: { // LocationDetails
|
|
58
|
+
* // address: "STRING_VALUE", // required
|
|
59
|
+
* // city: "STRING_VALUE", // required
|
|
60
|
+
* // state: "STRING_VALUE", // required
|
|
61
|
+
* // zipcode: "STRING_VALUE", // required
|
|
62
|
+
* // },
|
|
63
|
+
* // shop_hours: [ // ShopHoursList // required
|
|
64
|
+
* // { // ShopHoursItem
|
|
65
|
+
* // day: "STRING_VALUE", // required
|
|
66
|
+
* // open: "STRING_VALUE", // required
|
|
67
|
+
* // close: "STRING_VALUE", // required
|
|
68
|
+
* // },
|
|
69
|
+
* // ],
|
|
70
|
+
* // sent_setup: true || false,
|
|
71
|
+
* // setup: true || false, // required
|
|
72
|
+
* // tags: [ // StringList // required
|
|
73
|
+
* // "STRING_VALUE",
|
|
74
|
+
* // ],
|
|
75
|
+
* // };
|
|
76
|
+
*
|
|
77
|
+
* ```
|
|
78
|
+
*
|
|
79
|
+
* @param GetShopCommandInput - {@link GetShopCommandInput}
|
|
80
|
+
* @returns {@link GetShopCommandOutput}
|
|
81
|
+
* @see {@link GetShopCommandInput} for command's `input` shape.
|
|
82
|
+
* @see {@link GetShopCommandOutput} for command's `response` shape.
|
|
83
|
+
* @see {@link AppAPIClientResolvedConfig | config} for AppAPIClient's `config` shape.
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ValidationException} (client fault)
|
|
86
|
+
* A standard error for input validation failures.
|
|
87
|
+
* This should be thrown by services when a member of the input structure
|
|
88
|
+
* falls outside of the modeled or documented constraints.
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link RuntimeError} (server fault)
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link NotFoundError} (client fault)
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link AppAPIServiceException}
|
|
95
|
+
* <p>Base exception class for all service exceptions from AppAPI service.</p>
|
|
96
|
+
*
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
export declare class GetShopCommand extends GetShopCommand_base {
|
|
100
|
+
}
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
|
|
2
|
+
import { GetShopInput, ShopDetails } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetShopPublicCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetShopPublicCommandInput extends GetShopInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetShopPublicCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetShopPublicCommandOutput extends ShopDetails, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetShopPublicCommand_base: {
|
|
25
|
+
new (input: GetShopPublicCommandInput): import("@smithy/smithy-client").CommandImpl<GetShopPublicCommandInput, GetShopPublicCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetShopPublicCommandInput): import("@smithy/smithy-client").CommandImpl<GetShopPublicCommandInput, GetShopPublicCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Retrieves detailed information for a specific shop by its ID, including organization details, menu, location, and shop hours.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { AppAPIClient, GetShopPublicCommand } from "@sparkrewards/sra-client"; // ES Modules import
|
|
35
|
+
* // const { AppAPIClient, GetShopPublicCommand } = require("@sparkrewards/sra-client"); // CommonJS import
|
|
36
|
+
* const client = new AppAPIClient(config);
|
|
37
|
+
* const input = { // GetShopInput
|
|
38
|
+
* shop_id: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetShopPublicCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // ShopDetails
|
|
43
|
+
* // id: "STRING_VALUE", // required
|
|
44
|
+
* // org_id: "STRING_VALUE", // required
|
|
45
|
+
* // shop_name: "STRING_VALUE", // required
|
|
46
|
+
* // org_name: "STRING_VALUE", // required
|
|
47
|
+
* // banner: "STRING_VALUE",
|
|
48
|
+
* // preview: "STRING_VALUE", // required
|
|
49
|
+
* // logo: "STRING_VALUE", // required
|
|
50
|
+
* // description: "STRING_VALUE", // required
|
|
51
|
+
* // country_code: "STRING_VALUE", // required
|
|
52
|
+
* // latitude: Number("double"),
|
|
53
|
+
* // longitude: Number("double"), // required
|
|
54
|
+
* // active: true || false, // required
|
|
55
|
+
* // menu: "STRING_VALUE",
|
|
56
|
+
* // phone_number: "STRING_VALUE",
|
|
57
|
+
* // location: { // LocationDetails
|
|
58
|
+
* // address: "STRING_VALUE", // required
|
|
59
|
+
* // city: "STRING_VALUE", // required
|
|
60
|
+
* // state: "STRING_VALUE", // required
|
|
61
|
+
* // zipcode: "STRING_VALUE", // required
|
|
62
|
+
* // },
|
|
63
|
+
* // shop_hours: [ // ShopHoursList // required
|
|
64
|
+
* // { // ShopHoursItem
|
|
65
|
+
* // day: "STRING_VALUE", // required
|
|
66
|
+
* // open: "STRING_VALUE", // required
|
|
67
|
+
* // close: "STRING_VALUE", // required
|
|
68
|
+
* // },
|
|
69
|
+
* // ],
|
|
70
|
+
* // sent_setup: true || false,
|
|
71
|
+
* // setup: true || false, // required
|
|
72
|
+
* // tags: [ // StringList // required
|
|
73
|
+
* // "STRING_VALUE",
|
|
74
|
+
* // ],
|
|
75
|
+
* // };
|
|
76
|
+
*
|
|
77
|
+
* ```
|
|
78
|
+
*
|
|
79
|
+
* @param GetShopPublicCommandInput - {@link GetShopPublicCommandInput}
|
|
80
|
+
* @returns {@link GetShopPublicCommandOutput}
|
|
81
|
+
* @see {@link GetShopPublicCommandInput} for command's `input` shape.
|
|
82
|
+
* @see {@link GetShopPublicCommandOutput} for command's `response` shape.
|
|
83
|
+
* @see {@link AppAPIClientResolvedConfig | config} for AppAPIClient's `config` shape.
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ValidationException} (client fault)
|
|
86
|
+
* A standard error for input validation failures.
|
|
87
|
+
* This should be thrown by services when a member of the input structure
|
|
88
|
+
* falls outside of the modeled or documented constraints.
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link RuntimeError} (server fault)
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link NotFoundError} (client fault)
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link AppAPIServiceException}
|
|
95
|
+
* <p>Base exception class for all service exceptions from AppAPI service.</p>
|
|
96
|
+
*
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
export declare class GetShopPublicCommand extends GetShopPublicCommand_base {
|
|
100
|
+
}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
|
|
2
|
+
import { GetUserInput, GetUserOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetUserCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetUserCommandInput extends GetUserInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetUserCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetUserCommandOutput extends GetUserOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetUserCommand_base: {
|
|
25
|
+
new (input: GetUserCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserCommandInput, GetUserCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [GetUserCommandInput]): import("@smithy/smithy-client").CommandImpl<GetUserCommandInput, GetUserCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Retrieves the authenticated user's profile information, including personal details, preferences, visit statistics, and reward counts.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { AppAPIClient, GetUserCommand } from "@sparkrewards/sra-client"; // ES Modules import
|
|
35
|
+
* // const { AppAPIClient, GetUserCommand } = require("@sparkrewards/sra-client"); // CommonJS import
|
|
36
|
+
* const client = new AppAPIClient(config);
|
|
37
|
+
* const input = {};
|
|
38
|
+
* const command = new GetUserCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* // { // GetUserOutput
|
|
41
|
+
* // message: "STRING_VALUE",
|
|
42
|
+
* // user: { // User
|
|
43
|
+
* // id: "STRING_VALUE", // required
|
|
44
|
+
* // email: "STRING_VALUE", // required
|
|
45
|
+
* // birthdate: "STRING_VALUE", // required
|
|
46
|
+
* // fullname: { // UserFullname
|
|
47
|
+
* // firstName: "STRING_VALUE",
|
|
48
|
+
* // lastName: "STRING_VALUE",
|
|
49
|
+
* // },
|
|
50
|
+
* // date_created: "STRING_VALUE", // required
|
|
51
|
+
* // newAccount: true || false, // required
|
|
52
|
+
* // preferences: { // UserPreferences
|
|
53
|
+
* // lightMode: true || false,
|
|
54
|
+
* // },
|
|
55
|
+
* // total_visits: Number("int"), // required
|
|
56
|
+
* // total_points: Number("int"), // required
|
|
57
|
+
* // total_rewards: Number("int"), // required
|
|
58
|
+
* // fraud_count: Number("int"),
|
|
59
|
+
* // num_redeemableRewards: Number("int"),
|
|
60
|
+
* // },
|
|
61
|
+
* // };
|
|
62
|
+
*
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
65
|
+
* @param GetUserCommandInput - {@link GetUserCommandInput}
|
|
66
|
+
* @returns {@link GetUserCommandOutput}
|
|
67
|
+
* @see {@link GetUserCommandInput} for command's `input` shape.
|
|
68
|
+
* @see {@link GetUserCommandOutput} for command's `response` shape.
|
|
69
|
+
* @see {@link AppAPIClientResolvedConfig | config} for AppAPIClient's `config` shape.
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ValidationException} (client fault)
|
|
72
|
+
* A standard error for input validation failures.
|
|
73
|
+
* This should be thrown by services when a member of the input structure
|
|
74
|
+
* falls outside of the modeled or documented constraints.
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link RuntimeError} (server fault)
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link AppAPIServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from AppAPI service.</p>
|
|
80
|
+
*
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
export declare class GetUserCommand extends GetUserCommand_base {
|
|
84
|
+
}
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import { AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppAPIClient";
|
|
2
|
+
import { LikeOrgInput, LikeOrgOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link LikeOrgCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface LikeOrgCommandInput extends LikeOrgInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link LikeOrgCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface LikeOrgCommandOutput extends LikeOrgOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const LikeOrgCommand_base: {
|
|
25
|
+
new (input: LikeOrgCommandInput): import("@smithy/smithy-client").CommandImpl<LikeOrgCommandInput, LikeOrgCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: LikeOrgCommandInput): import("@smithy/smithy-client").CommandImpl<LikeOrgCommandInput, LikeOrgCommandOutput, AppAPIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Toggles the like status for an organization. If the organization is already liked, it will be unliked, and vice versa. Returns the current like status.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { AppAPIClient, LikeOrgCommand } from "@sparkrewards/sra-client"; // ES Modules import
|
|
35
|
+
* // const { AppAPIClient, LikeOrgCommand } = require("@sparkrewards/sra-client"); // CommonJS import
|
|
36
|
+
* const client = new AppAPIClient(config);
|
|
37
|
+
* const input = { // LikeOrgInput
|
|
38
|
+
* org_id: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new LikeOrgCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // LikeOrgOutput
|
|
43
|
+
* // message: "STRING_VALUE",
|
|
44
|
+
* // liked: true || false,
|
|
45
|
+
* // };
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param LikeOrgCommandInput - {@link LikeOrgCommandInput}
|
|
50
|
+
* @returns {@link LikeOrgCommandOutput}
|
|
51
|
+
* @see {@link LikeOrgCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link LikeOrgCommandOutput} for command's `response` shape.
|
|
53
|
+
* @see {@link AppAPIClientResolvedConfig | config} for AppAPIClient's `config` shape.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link ValidationException} (client fault)
|
|
56
|
+
* A standard error for input validation failures.
|
|
57
|
+
* This should be thrown by services when a member of the input structure
|
|
58
|
+
* falls outside of the modeled or documented constraints.
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link RuntimeError} (server fault)
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link AppAPIServiceException}
|
|
63
|
+
* <p>Base exception class for all service exceptions from AppAPI service.</p>
|
|
64
|
+
*
|
|
65
|
+
* @public
|
|
66
|
+
*/
|
|
67
|
+
export declare class LikeOrgCommand extends LikeOrgCommand_base {
|
|
68
|
+
}
|