@wix/members 1.0.6 → 1.0.7

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.
Files changed (9) hide show
  1. package/build/cjs/src/badges-v3-badge.http.d.ts +6 -6
  2. package/build/cjs/src/badges-v3-badge.http.js +6 -6
  3. package/build/cjs/src/badges-v3-badge.universal.d.ts +6 -6
  4. package/build/cjs/src/badges-v3-badge.universal.js +6 -6
  5. package/build/es/src/badges-v3-badge.http.d.ts +6 -6
  6. package/build/es/src/badges-v3-badge.http.js +6 -6
  7. package/build/es/src/badges-v3-badge.universal.d.ts +6 -6
  8. package/build/es/src/badges-v3-badge.universal.js +6 -6
  9. package/package.json +2 -2
package/build/cjs/src/badges-v3-badge.http.d.ts CHANGED
@@ -24,10 +24,10 @@ export declare function createBadge(payload: CreateBadgeRequest): RequestOptions
24
24
  */
25
25
  export declare function updateBadge(payload: UpdateBadgeRequest): RequestOptionsFactory<UpdateBadgeResponse>;
26
26
  /**
27
- * Retrieves up to 1000 badges, given the requested paging.
28
- * Default `paging.limit` is 100, `paging.offset` - 0.
29
- * For more information, see
30
- * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
27
+ * Lists the badges assigned to each of the specified site members.
28
+ *
29
+ *
30
+ * Retrieves up to 1000 badges, given the requested paging. Default paging.limit is 100, paging.offset - 0. For more information, see [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
31
31
  */
32
32
  export declare function listBadges(payload: ListBadgesRequest): RequestOptionsFactory<ListBadgesResponse>;
33
33
  /** Retrieves a badge. */
@@ -45,7 +45,7 @@ export declare function deleteBadge(payload: DeleteBadgeRequest): RequestOptions
45
45
  * Assigns a badge to site members.
46
46
  *
47
47
  *
48
- * The `assignMembers()` function returns a Promise that resolves when the specified badge is assigned to the specified members.
48
+ * The `assignBadge()` function returns a Promise that resolves when the specified badge is assigned to the specified members.
49
49
  *
50
50
  * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.
51
51
  */
@@ -54,7 +54,7 @@ export declare function assignBadge(payload: AssignBadgeRequest): RequestOptions
54
54
  * Removes site members from an assigned badge.
55
55
  *
56
56
  *
57
- * The `removeMembers()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.
57
+ * The `unassignBadge()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.
58
58
  *
59
59
  * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.
60
60
  */
package/build/cjs/src/badges-v3-badge.http.js CHANGED
@@ -225,10 +225,10 @@ function updateBadge(payload) {
225
225
  }
226
226
  exports.updateBadge = updateBadge;
227
227
  /**
228
- * Retrieves up to 1000 badges, given the requested paging.
229
- * Default `paging.limit` is 100, `paging.offset` - 0.
230
- * For more information, see
231
- * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
228
+ * Lists the badges assigned to each of the specified site members.
229
+ *
230
+ *
231
+ * Retrieves up to 1000 badges, given the requested paging. Default paging.limit is 100, paging.offset - 0. For more information, see [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
232
232
  */
233
233
  function listBadges(payload) {
234
234
  const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_listBadgesRequest, {});
@@ -312,7 +312,7 @@ exports.deleteBadge = deleteBadge;
312
312
  * Assigns a badge to site members.
313
313
  *
314
314
  *
315
- * The `assignMembers()` function returns a Promise that resolves when the specified badge is assigned to the specified members.
315
+ * The `assignBadge()` function returns a Promise that resolves when the specified badge is assigned to the specified members.
316
316
  *
317
317
  * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.
318
318
  */
@@ -343,7 +343,7 @@ exports.assignBadge = assignBadge;
343
343
  * Removes site members from an assigned badge.
344
344
  *
345
345
  *
346
- * The `removeMembers()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.
346
+ * The `unassignBadge()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.
347
347
  *
348
348
  * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.
349
349
  */
package/build/cjs/src/badges-v3-badge.universal.d.ts CHANGED
@@ -345,10 +345,10 @@ export interface UpdateBadge {
345
345
  _updatedDate?: Date;
346
346
  }
347
347
  /**
348
- * Retrieves up to 1000 badges, given the requested paging.
349
- * Default `paging.limit` is 100, `paging.offset` - 0.
350
- * For more information, see
351
- * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
348
+ * Lists the badges assigned to each of the specified site members.
349
+ *
350
+ *
351
+ * Retrieves up to 1000 badges, given the requested paging. Default paging.limit is 100, paging.offset - 0. For more information, see [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
352
352
  * @public */
353
353
  export declare function listBadges(options?: ListBadgesOptions): Promise<ListBadgesResponse>;
354
354
  export interface ListBadgesOptions {
@@ -382,7 +382,7 @@ export declare function deleteBadge(_id: string): Promise<void>;
382
382
  * Assigns a badge to site members.
383
383
  *
384
384
  *
385
- * The `assignMembers()` function returns a Promise that resolves when the specified badge is assigned to the specified members.
385
+ * The `assignBadge()` function returns a Promise that resolves when the specified badge is assigned to the specified members.
386
386
  *
387
387
  * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.
388
388
  * @param _id - Badge ID.
@@ -396,7 +396,7 @@ export declare function assignBadge(_id: string, memberIds: string[]): Promise<A
396
396
  * Removes site members from an assigned badge.
397
397
  *
398
398
  *
399
- * The `removeMembers()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.
399
+ * The `unassignBadge()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.
400
400
  *
401
401
  * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.
402
402
  * @param _id - Badge ID.
package/build/cjs/src/badges-v3-badge.universal.js CHANGED
@@ -194,10 +194,10 @@ function updateBadge(_id, badge) {
194
194
  }
195
195
  exports.updateBadge = updateBadge;
196
196
  /**
197
- * Retrieves up to 1000 badges, given the requested paging.
198
- * Default `paging.limit` is 100, `paging.offset` - 0.
199
- * For more information, see
200
- * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
197
+ * Lists the badges assigned to each of the specified site members.
198
+ *
199
+ *
200
+ * Retrieves up to 1000 badges, given the requested paging. Default paging.limit is 100, paging.offset - 0. For more information, see [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
201
201
  * @public */
202
202
  function listBadges(options) {
203
203
  var _a, _b, _c;
@@ -353,7 +353,7 @@ exports.deleteBadge = deleteBadge;
353
353
  * Assigns a badge to site members.
354
354
  *
355
355
  *
356
- * The `assignMembers()` function returns a Promise that resolves when the specified badge is assigned to the specified members.
356
+ * The `assignBadge()` function returns a Promise that resolves when the specified badge is assigned to the specified members.
357
357
  *
358
358
  * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.
359
359
  * @param _id - Badge ID.
@@ -411,7 +411,7 @@ exports.assignBadge = assignBadge;
411
411
  * Removes site members from an assigned badge.
412
412
  *
413
413
  *
414
- * The `removeMembers()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.
414
+ * The `unassignBadge()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.
415
415
  *
416
416
  * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.
417
417
  * @param _id - Badge ID.
package/build/es/src/badges-v3-badge.http.d.ts CHANGED
@@ -24,10 +24,10 @@ export declare function createBadge(payload: CreateBadgeRequest): RequestOptions
24
24
  */
25
25
  export declare function updateBadge(payload: UpdateBadgeRequest): RequestOptionsFactory<UpdateBadgeResponse>;
26
26
  /**
27
- * Retrieves up to 1000 badges, given the requested paging.
28
- * Default `paging.limit` is 100, `paging.offset` - 0.
29
- * For more information, see
30
- * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
27
+ * Lists the badges assigned to each of the specified site members.
28
+ *
29
+ *
30
+ * Retrieves up to 1000 badges, given the requested paging. Default paging.limit is 100, paging.offset - 0. For more information, see [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
31
31
  */
32
32
  export declare function listBadges(payload: ListBadgesRequest): RequestOptionsFactory<ListBadgesResponse>;
33
33
  /** Retrieves a badge. */
@@ -45,7 +45,7 @@ export declare function deleteBadge(payload: DeleteBadgeRequest): RequestOptions
45
45
  * Assigns a badge to site members.
46
46
  *
47
47
  *
48
- * The `assignMembers()` function returns a Promise that resolves when the specified badge is assigned to the specified members.
48
+ * The `assignBadge()` function returns a Promise that resolves when the specified badge is assigned to the specified members.
49
49
  *
50
50
  * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.
51
51
  */
@@ -54,7 +54,7 @@ export declare function assignBadge(payload: AssignBadgeRequest): RequestOptions
54
54
  * Removes site members from an assigned badge.
55
55
  *
56
56
  *
57
- * The `removeMembers()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.
57
+ * The `unassignBadge()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.
58
58
  *
59
59
  * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.
60
60
  */
package/build/es/src/badges-v3-badge.http.js CHANGED
@@ -220,10 +220,10 @@ export function updateBadge(payload) {
220
220
  return __updateBadge;
221
221
  }
222
222
  /**
223
- * Retrieves up to 1000 badges, given the requested paging.
224
- * Default `paging.limit` is 100, `paging.offset` - 0.
225
- * For more information, see
226
- * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
223
+ * Lists the badges assigned to each of the specified site members.
224
+ *
225
+ *
226
+ * Retrieves up to 1000 badges, given the requested paging. Default paging.limit is 100, paging.offset - 0. For more information, see [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
227
227
  */
228
228
  export function listBadges(payload) {
229
229
  const { toJSON: toReq, fromJSON: fromReq } = serializer(_listBadgesRequest, {});
@@ -304,7 +304,7 @@ export function deleteBadge(payload) {
304
304
  * Assigns a badge to site members.
305
305
  *
306
306
  *
307
- * The `assignMembers()` function returns a Promise that resolves when the specified badge is assigned to the specified members.
307
+ * The `assignBadge()` function returns a Promise that resolves when the specified badge is assigned to the specified members.
308
308
  *
309
309
  * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.
310
310
  */
@@ -334,7 +334,7 @@ export function assignBadge(payload) {
334
334
  * Removes site members from an assigned badge.
335
335
  *
336
336
  *
337
- * The `removeMembers()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.
337
+ * The `unassignBadge()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.
338
338
  *
339
339
  * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.
340
340
  */
package/build/es/src/badges-v3-badge.universal.d.ts CHANGED
@@ -345,10 +345,10 @@ export interface UpdateBadge {
345
345
  _updatedDate?: Date;
346
346
  }
347
347
  /**
348
- * Retrieves up to 1000 badges, given the requested paging.
349
- * Default `paging.limit` is 100, `paging.offset` - 0.
350
- * For more information, see
351
- * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
348
+ * Lists the badges assigned to each of the specified site members.
349
+ *
350
+ *
351
+ * Retrieves up to 1000 badges, given the requested paging. Default paging.limit is 100, paging.offset - 0. For more information, see [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
352
352
  * @public */
353
353
  export declare function listBadges(options?: ListBadgesOptions): Promise<ListBadgesResponse>;
354
354
  export interface ListBadgesOptions {
@@ -382,7 +382,7 @@ export declare function deleteBadge(_id: string): Promise<void>;
382
382
  * Assigns a badge to site members.
383
383
  *
384
384
  *
385
- * The `assignMembers()` function returns a Promise that resolves when the specified badge is assigned to the specified members.
385
+ * The `assignBadge()` function returns a Promise that resolves when the specified badge is assigned to the specified members.
386
386
  *
387
387
  * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.
388
388
  * @param _id - Badge ID.
@@ -396,7 +396,7 @@ export declare function assignBadge(_id: string, memberIds: string[]): Promise<A
396
396
  * Removes site members from an assigned badge.
397
397
  *
398
398
  *
399
- * The `removeMembers()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.
399
+ * The `unassignBadge()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.
400
400
  *
401
401
  * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.
402
402
  * @param _id - Badge ID.
package/build/es/src/badges-v3-badge.universal.js CHANGED
@@ -170,10 +170,10 @@ export function updateBadge(_id, badge) {
170
170
  });
171
171
  }
172
172
  /**
173
- * Retrieves up to 1000 badges, given the requested paging.
174
- * Default `paging.limit` is 100, `paging.offset` - 0.
175
- * For more information, see
176
- * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
173
+ * Lists the badges assigned to each of the specified site members.
174
+ *
175
+ *
176
+ * Retrieves up to 1000 badges, given the requested paging. Default paging.limit is 100, paging.offset - 0. For more information, see [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
177
177
  * @public */
178
178
  export function listBadges(options) {
179
179
  var _a, _b, _c;
@@ -326,7 +326,7 @@ export function deleteBadge(_id) {
326
326
  * Assigns a badge to site members.
327
327
  *
328
328
  *
329
- * The `assignMembers()` function returns a Promise that resolves when the specified badge is assigned to the specified members.
329
+ * The `assignBadge()` function returns a Promise that resolves when the specified badge is assigned to the specified members.
330
330
  *
331
331
  * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.
332
332
  * @param _id - Badge ID.
@@ -383,7 +383,7 @@ export function assignBadge(_id, memberIds) {
383
383
  * Removes site members from an assigned badge.
384
384
  *
385
385
  *
386
- * The `removeMembers()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.
386
+ * The `unassignBadge()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.
387
387
  *
388
388
  * The `badgeId` parameter must be an ID from your site's `Members/Badges` collection. Typically, you retrieve the ID from the collection using a query or through a dataset.
389
389
  * @param _id - Badge ID.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/members",
3
- "version": "1.0.6",
3
+ "version": "1.0.7",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -33,5 +33,5 @@
33
33
  "groupId": "com.wixpress.public-sdk-autogen"
34
34
  }
35
35
  },
36
- "falconPackageHash": "9947726d1d4ba1bb53131a63a2dfc467bf4ea3b860a6f737733b77b0"
36
+ "falconPackageHash": "dc8eb977e626d4dd2a1e2418499b83087640d38195d161510f06781e"
37
37
  }