@wix/auto_sdk_bookings_resource-types 1.0.1 → 1.0.3

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 (41) hide show
  1. package/build/cjs/src/bookings-resources-v2-resource-type-resource-types.http.d.ts +12 -7
  2. package/build/cjs/src/bookings-resources-v2-resource-type-resource-types.http.js +12 -7
  3. package/build/cjs/src/bookings-resources-v2-resource-type-resource-types.http.js.map +1 -1
  4. package/build/cjs/src/bookings-resources-v2-resource-type-resource-types.public.d.ts +15 -10
  5. package/build/cjs/src/bookings-resources-v2-resource-type-resource-types.public.js.map +1 -1
  6. package/build/cjs/src/bookings-resources-v2-resource-type-resource-types.types.d.ts +41 -19
  7. package/build/cjs/src/bookings-resources-v2-resource-type-resource-types.types.js.map +1 -1
  8. package/build/cjs/src/bookings-resources-v2-resource-type-resource-types.universal.d.ts +74 -33
  9. package/build/cjs/src/bookings-resources-v2-resource-type-resource-types.universal.js +15 -10
  10. package/build/cjs/src/bookings-resources-v2-resource-type-resource-types.universal.js.map +1 -1
  11. package/build/es/src/bookings-resources-v2-resource-type-resource-types.http.d.ts +12 -7
  12. package/build/es/src/bookings-resources-v2-resource-type-resource-types.http.js +12 -7
  13. package/build/es/src/bookings-resources-v2-resource-type-resource-types.http.js.map +1 -1
  14. package/build/es/src/bookings-resources-v2-resource-type-resource-types.public.d.ts +15 -10
  15. package/build/es/src/bookings-resources-v2-resource-type-resource-types.public.js.map +1 -1
  16. package/build/es/src/bookings-resources-v2-resource-type-resource-types.types.d.ts +41 -19
  17. package/build/es/src/bookings-resources-v2-resource-type-resource-types.types.js.map +1 -1
  18. package/build/es/src/bookings-resources-v2-resource-type-resource-types.universal.d.ts +74 -33
  19. package/build/es/src/bookings-resources-v2-resource-type-resource-types.universal.js +15 -10
  20. package/build/es/src/bookings-resources-v2-resource-type-resource-types.universal.js.map +1 -1
  21. package/build/internal/cjs/src/bookings-resources-v2-resource-type-resource-types.http.d.ts +12 -7
  22. package/build/internal/cjs/src/bookings-resources-v2-resource-type-resource-types.http.js +12 -7
  23. package/build/internal/cjs/src/bookings-resources-v2-resource-type-resource-types.http.js.map +1 -1
  24. package/build/internal/cjs/src/bookings-resources-v2-resource-type-resource-types.public.d.ts +15 -10
  25. package/build/internal/cjs/src/bookings-resources-v2-resource-type-resource-types.public.js.map +1 -1
  26. package/build/internal/cjs/src/bookings-resources-v2-resource-type-resource-types.types.d.ts +41 -19
  27. package/build/internal/cjs/src/bookings-resources-v2-resource-type-resource-types.types.js.map +1 -1
  28. package/build/internal/cjs/src/bookings-resources-v2-resource-type-resource-types.universal.d.ts +74 -33
  29. package/build/internal/cjs/src/bookings-resources-v2-resource-type-resource-types.universal.js +15 -10
  30. package/build/internal/cjs/src/bookings-resources-v2-resource-type-resource-types.universal.js.map +1 -1
  31. package/build/internal/es/src/bookings-resources-v2-resource-type-resource-types.http.d.ts +12 -7
  32. package/build/internal/es/src/bookings-resources-v2-resource-type-resource-types.http.js +12 -7
  33. package/build/internal/es/src/bookings-resources-v2-resource-type-resource-types.http.js.map +1 -1
  34. package/build/internal/es/src/bookings-resources-v2-resource-type-resource-types.public.d.ts +15 -10
  35. package/build/internal/es/src/bookings-resources-v2-resource-type-resource-types.public.js.map +1 -1
  36. package/build/internal/es/src/bookings-resources-v2-resource-type-resource-types.types.d.ts +41 -19
  37. package/build/internal/es/src/bookings-resources-v2-resource-type-resource-types.types.js.map +1 -1
  38. package/build/internal/es/src/bookings-resources-v2-resource-type-resource-types.universal.d.ts +74 -33
  39. package/build/internal/es/src/bookings-resources-v2-resource-type-resource-types.universal.js +15 -10
  40. package/build/internal/es/src/bookings-resources-v2-resource-type-resource-types.universal.js.map +1 -1
  41. package/package.json +2 -2
package/build/cjs/src/bookings-resources-v2-resource-type-resource-types.http.d.ts CHANGED
@@ -1,19 +1,22 @@
1
1
  import { RequestOptionsFactory } from '@wix/sdk-types';
2
2
  /** Creates a new resource type. */
3
3
  export declare function createResourceType(payload: object): RequestOptionsFactory<any>;
4
- /** Retrieves a resource type by ID. */
4
+ /** Retrieves a resource type. */
5
5
  export declare function getResourceType(payload: object): RequestOptionsFactory<any>;
6
6
  /**
7
7
  * Updates a resource type.
8
8
  *
9
- * Each time the resource type is updated, `revision` increments by 1. You must include current revision of the resource type when updating it.
10
- * This ensures you're working with the latest service information and prevents unintended overwrites.
9
+ *
10
+ * Each time the resource type is updated, `revision` increments by 1. You must
11
+ * include current revision of the resource type when updating it. This ensures
12
+ * you're working with the latest service information and prevents unintended overwrites.
11
13
  */
12
14
  export declare function updateResourceType(payload: object): RequestOptionsFactory<any>;
13
15
  /**
14
16
  * Deletes a resource type.
15
17
  *
16
- * Deleting a resource type will automatically delete all resources of this type.
18
+ *
19
+ * Deleting a resource type also automatically deletes all resources connected to it.
17
20
  */
18
21
  export declare function deleteResourceType(payload: object): RequestOptionsFactory<any>;
19
22
  /**
@@ -36,9 +39,11 @@ export declare function deleteResourceType(payload: object): RequestOptionsFacto
36
39
  */
37
40
  export declare function queryResourceTypes(payload: object): RequestOptionsFactory<any>;
38
41
  /**
39
- * Counts resource types according to given criteria.
42
+ * Counts resource types, given the provided filtering.
43
+ *
40
44
  *
41
- * For field support for filters, see [Resource types: Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-type-v2/filtering-and-sorting).
42
- * Use [WQL filter](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section) to define the criteria.
45
+ * Refer to the *supported filters article*
46
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
47
+ * for a complete list of supported filters.
43
48
  */
44
49
  export declare function countResourceTypes(payload: object): RequestOptionsFactory<any>;
package/build/cjs/src/bookings-resources-v2-resource-type-resource-types.http.js CHANGED
@@ -79,7 +79,7 @@ function createResourceType(payload) {
79
79
  return __createResourceType;
80
80
  }
81
81
  exports.createResourceType = createResourceType;
82
- /** Retrieves a resource type by ID. */
82
+ /** Retrieves a resource type. */
83
83
  function getResourceType(payload) {
84
84
  function __getResourceType({ host }) {
85
85
  const metadata = {
@@ -111,8 +111,10 @@ exports.getResourceType = getResourceType;
111
111
  /**
112
112
  * Updates a resource type.
113
113
  *
114
- * Each time the resource type is updated, `revision` increments by 1. You must include current revision of the resource type when updating it.
115
- * This ensures you're working with the latest service information and prevents unintended overwrites.
114
+ *
115
+ * Each time the resource type is updated, `revision` increments by 1. You must
116
+ * include current revision of the resource type when updating it. This ensures
117
+ * you're working with the latest service information and prevents unintended overwrites.
116
118
  */
117
119
  function updateResourceType(payload) {
118
120
  function __updateResourceType({ host }) {
@@ -158,7 +160,8 @@ exports.updateResourceType = updateResourceType;
158
160
  /**
159
161
  * Deletes a resource type.
160
162
  *
161
- * Deleting a resource type will automatically delete all resources of this type.
163
+ *
164
+ * Deleting a resource type also automatically deletes all resources connected to it.
162
165
  */
163
166
  function deleteResourceType(payload) {
164
167
  function __deleteResourceType({ host }) {
@@ -226,10 +229,12 @@ function queryResourceTypes(payload) {
226
229
  }
227
230
  exports.queryResourceTypes = queryResourceTypes;
228
231
  /**
229
- * Counts resource types according to given criteria.
232
+ * Counts resource types, given the provided filtering.
233
+ *
230
234
  *
231
- * For field support for filters, see [Resource types: Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-type-v2/filtering-and-sorting).
232
- * Use [WQL filter](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section) to define the criteria.
235
+ * Refer to the *supported filters article*
236
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
237
+ * for a complete list of supported filters.
233
238
  */
234
239
  function countResourceTypes(payload) {
235
240
  function __countResourceTypes({ host }) {
package/build/cjs/src/bookings-resources-v2-resource-type-resource-types.http.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"bookings-resources-v2-resource-type-resource-types.http.js","sourceRoot":"","sources":["../../../src/bookings-resources-v2-resource-type-resource-types.http.ts"],"names":[],"mappings":";;;AAAA,gEAAkE;AAClE,0EAAkG;AAClG,0EAAkG;AAClG,4EAAmG;AACnG,sFAAkF;AAClF,gEAA2D;AAI3D,SAAS,iEAAiE,CACxE,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,uCAAuC;gBAChD,QAAQ,EAAE,8BAA8B;aACzC;YACD;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,8BAA8B;aACzC;SACF;QACD,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,iBAAiB;gBAC1B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,8BAA8B;aACzC;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,uCAAuC;gBAChD,QAAQ,EAAE,8BAA8B;aACzC;SACF;KACF,CAAC;IAEF,OAAO,IAAA,yBAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,YAAY,GAAG,uCAAuC,CAAC;AAE7D,mCAAmC;AACnC,SAAgB,kBAAkB,CAChC,OAAe;IAEf,SAAS,oBAAoB,CAAC,EAAE,IAAI,EAAO;QACzC,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE;oBACL,EAAE,IAAI,EAAE,0BAA0B,EAAE;oBACpC,EAAE,IAAI,EAAE,0BAA0B,EAAE;iBACrC;aACF;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yCAAyC;YACrD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,iFAAiF;YACnF,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,iEAAiE,CAAC;gBACrE,SAAS,EAAE,8BAA8B;gBACzC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,0BAA0B,EAAE;wBACpC,EAAE,IAAI,EAAE,0BAA0B,EAAE;qBACrC;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAzCD,gDAyCC;AAED,uCAAuC;AACvC,SAAgB,eAAe,CAAC,OAAe;IAC7C,SAAS,iBAAiB,CAAC,EAAE,IAAI,EAAO;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yCAAyC;YACrD,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,8EAA8E;YAChF,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,iEAAiE,CAAC;gBACrE,SAAS,EAAE,+CAA+C;gBAC1D,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;YAClC,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,0BAA0B,EAAE;wBACpC,EAAE,IAAI,EAAE,0BAA0B,EAAE;qBACrC;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AA9BD,0CA8BC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAChC,OAAe;IAEf,SAAS,oBAAoB,CAAC,EAAE,IAAI,EAAO;QACzC,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,iDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;aAC1B;YACD;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE;oBACL,EAAE,IAAI,EAAE,0BAA0B,EAAE;oBACpC,EAAE,IAAI,EAAE,0BAA0B,EAAE;iBACrC;aACF;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yCAAyC;YACrD,MAAM,EAAE,OAAc;YACtB,SAAS,EACP,iFAAiF;YACnF,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,iEAAiE,CAAC;gBACrE,SAAS,EAAE,gDAAgD;gBAC3D,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,0BAA0B,EAAE;wBACpC,EAAE,IAAI,EAAE,0BAA0B,EAAE;qBACrC;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AA7CD,gDA6CC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB,CAChC,OAAe;IAEf,SAAS,oBAAoB,CAAC,EAAE,IAAI,EAAO;QACzC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yCAAyC;YACrD,MAAM,EAAE,QAAe;YACvB,SAAS,EACP,iFAAiF;YACnF,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,iEAAiE,CAAC;gBACrE,SAAS,EAAE,+CAA+C;gBAC1D,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;SACnC,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAtBD,gDAsBC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,kBAAkB,CAChC,OAAe;IAEf,SAAS,oBAAoB,CAAC,EAAE,IAAI,EAAO;QACzC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yCAAyC;YACrD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,iFAAiF;YACnF,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,iEAAiE,CAAC;gBACrE,SAAS,EAAE,oCAAoC;gBAC/C,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;YACb,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,2BAA2B,EAAE;wBACrC,EAAE,IAAI,EAAE,2BAA2B,EAAE;qBACtC;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAhCD,gDAgCC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAChC,OAAe;IAEf,SAAS,oBAAoB,CAAC,EAAE,IAAI,EAAO;QACzC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yCAAyC;YACrD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,iFAAiF;YACnF,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,iEAAiE,CAAC;gBACrE,SAAS,EAAE,oCAAoC;gBAC/C,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;SACd,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAtBD,gDAsBC"}
1
+ {"version":3,"file":"bookings-resources-v2-resource-type-resource-types.http.js","sourceRoot":"","sources":["../../../src/bookings-resources-v2-resource-type-resource-types.http.ts"],"names":[],"mappings":";;;AAAA,gEAAkE;AAClE,0EAAkG;AAClG,0EAAkG;AAClG,4EAAmG;AACnG,sFAAkF;AAClF,gEAA2D;AAI3D,SAAS,iEAAiE,CACxE,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,uCAAuC;gBAChD,QAAQ,EAAE,8BAA8B;aACzC;YACD;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,8BAA8B;aACzC;SACF;QACD,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,iBAAiB;gBAC1B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,8BAA8B;aACzC;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,uCAAuC;gBAChD,QAAQ,EAAE,8BAA8B;aACzC;SACF;KACF,CAAC;IAEF,OAAO,IAAA,yBAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,YAAY,GAAG,uCAAuC,CAAC;AAE7D,mCAAmC;AACnC,SAAgB,kBAAkB,CAChC,OAAe;IAEf,SAAS,oBAAoB,CAAC,EAAE,IAAI,EAAO;QACzC,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE;oBACL,EAAE,IAAI,EAAE,0BAA0B,EAAE;oBACpC,EAAE,IAAI,EAAE,0BAA0B,EAAE;iBACrC;aACF;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yCAAyC;YACrD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,iFAAiF;YACnF,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,iEAAiE,CAAC;gBACrE,SAAS,EAAE,8BAA8B;gBACzC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,0BAA0B,EAAE;wBACpC,EAAE,IAAI,EAAE,0BAA0B,EAAE;qBACrC;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAzCD,gDAyCC;AAED,iCAAiC;AACjC,SAAgB,eAAe,CAAC,OAAe;IAC7C,SAAS,iBAAiB,CAAC,EAAE,IAAI,EAAO;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yCAAyC;YACrD,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,8EAA8E;YAChF,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,iEAAiE,CAAC;gBACrE,SAAS,EAAE,+CAA+C;gBAC1D,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;YAClC,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,0BAA0B,EAAE;wBACpC,EAAE,IAAI,EAAE,0BAA0B,EAAE;qBACrC;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AA9BD,0CA8BC;AAED;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAChC,OAAe;IAEf,SAAS,oBAAoB,CAAC,EAAE,IAAI,EAAO;QACzC,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,iDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;aAC1B;YACD;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE;oBACL,EAAE,IAAI,EAAE,0BAA0B,EAAE;oBACpC,EAAE,IAAI,EAAE,0BAA0B,EAAE;iBACrC;aACF;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yCAAyC;YACrD,MAAM,EAAE,OAAc;YACtB,SAAS,EACP,iFAAiF;YACnF,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,iEAAiE,CAAC;gBACrE,SAAS,EAAE,gDAAgD;gBAC3D,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,0BAA0B,EAAE;wBACpC,EAAE,IAAI,EAAE,0BAA0B,EAAE;qBACrC;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AA7CD,gDA6CC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAChC,OAAe;IAEf,SAAS,oBAAoB,CAAC,EAAE,IAAI,EAAO;QACzC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yCAAyC;YACrD,MAAM,EAAE,QAAe;YACvB,SAAS,EACP,iFAAiF;YACnF,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,iEAAiE,CAAC;gBACrE,SAAS,EAAE,+CAA+C;gBAC1D,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;SACnC,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAtBD,gDAsBC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,kBAAkB,CAChC,OAAe;IAEf,SAAS,oBAAoB,CAAC,EAAE,IAAI,EAAO;QACzC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yCAAyC;YACrD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,iFAAiF;YACnF,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,iEAAiE,CAAC;gBACrE,SAAS,EAAE,oCAAoC;gBAC/C,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;YACb,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,2BAA2B,EAAE;wBACrC,EAAE,IAAI,EAAE,2BAA2B,EAAE;qBACtC;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAhCD,gDAgCC;AAED;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAChC,OAAe;IAEf,SAAS,oBAAoB,CAAC,EAAE,IAAI,EAAO;QACzC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yCAAyC;YACrD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,iFAAiF;YACnF,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,iEAAiE,CAAC;gBACrE,SAAS,EAAE,oCAAoC;gBAC/C,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;SACd,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAtBD,gDAsBC"}
package/build/cjs/src/bookings-resources-v2-resource-type-resource-types.public.d.ts CHANGED
@@ -7,17 +7,17 @@ export declare function createResourceType(httpClient: HttpClient): CreateResour
7
7
  interface CreateResourceTypeSignature {
8
8
  /**
9
9
  * Creates a new resource type.
10
- * @param - Resource type to be created.
11
- * @returns The created resource type.
10
+ * @param - Resource type to create.
11
+ * @returns Created resource type.
12
12
  */
13
13
  (resourceType: ResourceType): Promise<ResourceType & ResourceTypeNonNullableFields>;
14
14
  }
15
15
  export declare function getResourceType(httpClient: HttpClient): GetResourceTypeSignature;
16
16
  interface GetResourceTypeSignature {
17
17
  /**
18
- * Retrieves a resource type by ID.
18
+ * Retrieves a resource type.
19
19
  * @param - ID of the resource type to retrieve.
20
- * @returns The requested resource type.
20
+ * @returns Retrieved resource type.
21
21
  */
22
22
  (resourceTypeId: string): Promise<ResourceType & ResourceTypeNonNullableFields>;
23
23
  }
@@ -26,8 +26,10 @@ interface UpdateResourceTypeSignature {
26
26
  /**
27
27
  * Updates a resource type.
28
28
  *
29
- * Each time the resource type is updated, `revision` increments by 1. You must include current revision of the resource type when updating it.
30
- * This ensures you're working with the latest service information and prevents unintended overwrites.
29
+ *
30
+ * Each time the resource type is updated, `revision` increments by 1. You must
31
+ * include current revision of the resource type when updating it. This ensures
32
+ * you're working with the latest service information and prevents unintended overwrites.
31
33
  * @param - Resource type ID.
32
34
  * @returns Updated resource type.
33
35
  */
@@ -38,7 +40,8 @@ interface DeleteResourceTypeSignature {
38
40
  /**
39
41
  * Deletes a resource type.
40
42
  *
41
- * Deleting a resource type will automatically delete all resources of this type.
43
+ *
44
+ * Deleting a resource type also automatically deletes all resources connected to it.
42
45
  * @param - ID of the resource type to delete.
43
46
  */
44
47
  (resourceTypeId: string): Promise<void>;
@@ -68,10 +71,12 @@ interface QueryResourceTypesSignature {
68
71
  export declare function countResourceTypes(httpClient: HttpClient): CountResourceTypesSignature;
69
72
  interface CountResourceTypesSignature {
70
73
  /**
71
- * Counts resource types according to given criteria.
74
+ * Counts resource types, given the provided filtering.
75
+ *
72
76
  *
73
- * For field support for filters, see [Resource types: Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-type-v2/filtering-and-sorting).
74
- * Use [WQL filter](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section) to define the criteria.
77
+ * Refer to the *supported filters article*
78
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
79
+ * for a complete list of supported filters.
75
80
  * @param - Filter to base the count on. See
76
81
  * [queryResourceTypes()](https://dev.wix.com/docs/sdk/backend-modules/bookings/resource-types/query-resource-types)
77
82
  * for supported filters.
package/build/cjs/src/bookings-resources-v2-resource-type-resource-types.public.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"bookings-resources-v2-resource-type-resource-types.public.js","sourceRoot":"","sources":["../../../src/bookings-resources-v2-resource-type-resource-types.public.ts"],"names":[],"mappings":";;;AAAA,oFAAkG;AAClG,0EAAkG;AAClG,sFAAkF;AAClF,8CAA6D;AAC7D,uJAkB2E;AAE9D,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AAE5D,SAAgB,kBAAkB,CAChC,UAAsB;IAEtB,OAAO,CAAC,YAA0B,EAAE,EAAE,CACpC,IAAA,oFAA2B,EACzB,YAAY;IACZ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,gDASC;AAaD,SAAgB,eAAe,CAC7B,UAAsB;IAEtB,OAAO,CAAC,cAAsB,EAAE,EAAE,CAChC,IAAA,iFAAwB,EACtB,cAAc;IACd,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,0CASC;AAaD,SAAgB,kBAAkB,CAChC,UAAsB;IAEtB,OAAO,CAAC,GAAkB,EAAE,YAAgC,EAAE,EAAE,CAC9D,IAAA,oFAA2B,EACzB,GAAG,EACH,YAAY;IACZ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAVD,gDAUC;AAgBD,SAAgB,kBAAkB,CAChC,UAAsB;IAEtB,OAAO,CAAC,cAAsB,EAAE,EAAE,CAChC,IAAA,oFAA2B,EACzB,cAAc;IACd,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,gDASC;AAYD,SAAgB,kBAAkB,CAChC,UAAsB;IAEtB,OAAO,CAAC,OAAmC,EAAE,EAAE,CAC7C,IAAA,oFAA2B,EACzB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,gDASC;AAwBD,SAAgB,kBAAkB,CAChC,UAAsB;IAEtB,OAAO,CAAC,OAAmC,EAAE,EAAE,CAC7C,IAAA,oFAA2B,EACzB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,gDASC;AAiBY,QAAA,qBAAqB,GAAG,IAAA,2BAAe,EAClD,iDAAiD,EACjD,IAAI,EACJ,CAAC,KAAkC,EAAE,EAAE,CACrC,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAA+B,CAAC;AACpB,QAAA,qBAAqB,GAAG,IAAA,2BAAe,EAClD,iDAAiD,EACjD,IAAI,EACJ,CAAC,KAAkC,EAAE,EAAE,CACrC,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,uBAAuB,EAAE;YACjC,EAAE,IAAI,EAAE,uBAAuB,EAAE;YACjC,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAA+B,CAAC;AACpB,QAAA,qBAAqB,GAAG,IAAA,2BAAe,EAClD,iDAAiD,EACjD,IAAI,EACJ,CAAC,KAAkC,EAAE,EAAE,CACrC,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAA+B,CAAC;AAEjC,qJAwD2E;AAhDzE,2KAAA,wBAAwB,OAAA;AA8BxB,kKAAA,eAAe,OAAA;AAUf,4JAAA,SAAS,OAAA;AAOT,sKAAA,mBAAmB,OAAA"}
1
+ {"version":3,"file":"bookings-resources-v2-resource-type-resource-types.public.js","sourceRoot":"","sources":["../../../src/bookings-resources-v2-resource-type-resource-types.public.ts"],"names":[],"mappings":";;;AAAA,oFAAkG;AAClG,0EAAkG;AAClG,sFAAkF;AAClF,8CAA6D;AAC7D,uJAkB2E;AAE9D,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AAE5D,SAAgB,kBAAkB,CAChC,UAAsB;IAEtB,OAAO,CAAC,YAA0B,EAAE,EAAE,CACpC,IAAA,oFAA2B,EACzB,YAAY;IACZ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,gDASC;AAaD,SAAgB,eAAe,CAC7B,UAAsB;IAEtB,OAAO,CAAC,cAAsB,EAAE,EAAE,CAChC,IAAA,iFAAwB,EACtB,cAAc;IACd,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,0CASC;AAaD,SAAgB,kBAAkB,CAChC,UAAsB;IAEtB,OAAO,CAAC,GAAkB,EAAE,YAAgC,EAAE,EAAE,CAC9D,IAAA,oFAA2B,EACzB,GAAG,EACH,YAAY;IACZ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAVD,gDAUC;AAkBD,SAAgB,kBAAkB,CAChC,UAAsB;IAEtB,OAAO,CAAC,cAAsB,EAAE,EAAE,CAChC,IAAA,oFAA2B,EACzB,cAAc;IACd,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,gDASC;AAaD,SAAgB,kBAAkB,CAChC,UAAsB;IAEtB,OAAO,CAAC,OAAmC,EAAE,EAAE,CAC7C,IAAA,oFAA2B,EACzB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,gDASC;AAwBD,SAAgB,kBAAkB,CAChC,UAAsB;IAEtB,OAAO,CAAC,OAAmC,EAAE,EAAE,CAC7C,IAAA,oFAA2B,EACzB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,gDASC;AAmBY,QAAA,qBAAqB,GAAG,IAAA,2BAAe,EAClD,iDAAiD,EACjD,IAAI,EACJ,CAAC,KAAkC,EAAE,EAAE,CACrC,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAA+B,CAAC;AACpB,QAAA,qBAAqB,GAAG,IAAA,2BAAe,EAClD,iDAAiD,EACjD,IAAI,EACJ,CAAC,KAAkC,EAAE,EAAE,CACrC,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,uBAAuB,EAAE;YACjC,EAAE,IAAI,EAAE,uBAAuB,EAAE;YACjC,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAA+B,CAAC;AACpB,QAAA,qBAAqB,GAAG,IAAA,2BAAe,EAClD,iDAAiD,EACjD,IAAI,EACJ,CAAC,KAAkC,EAAE,EAAE,CACrC,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAA+B,CAAC;AAEjC,qJAwD2E;AAhDzE,2KAAA,wBAAwB,OAAA;AA8BxB,kKAAA,eAAe,OAAA;AAUf,4JAAA,SAAS,OAAA;AAOT,sKAAA,mBAAmB,OAAA"}
package/build/cjs/src/bookings-resources-v2-resource-type-resource-types.types.d.ts CHANGED
@@ -1,4 +1,11 @@
1
- /** A resource type is a classification of resources, e.g. room, equipment or vehicle. */
1
+ /**
2
+ * A resource type is a classification of resources. For example room, equipment,
3
+ * or vehicle. Customers can only book *services*
4
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction))
5
+ * if at least 1 *resource*
6
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction))
7
+ * for every resource type connected to the service is available during the requested time.
8
+ */
2
9
  export interface ResourceType {
3
10
  /**
4
11
  * Resource type ID.
@@ -13,54 +20,59 @@ export interface ResourceType {
13
20
  */
14
21
  revision?: string | null;
15
22
  /**
16
- * Represents the time in `YYYY-MM-DDThh:mm:ss.sssZ` format this resource type was created.
23
+ * Time in `YYYY-MM-DDThh:mm:ss.sssZ` format the resource type was created.
17
24
  * @readonly
18
25
  */
19
26
  createdDate?: Date | null;
20
27
  /**
21
- * Represents the time in `YYYY-MM-DDThh:mm:ss.sssZ` format this resource type was last updated.
28
+ * Time in `YYYY-MM-DDThh:mm:ss.sssZ` format the resource type was last updated.
22
29
  * @readonly
23
30
  */
24
31
  updatedDate?: Date | null;
25
- /** The name of this resource type, for example `meeting room`. The name must be unique per site. */
32
+ /**
33
+ * Name of the resource type. For example, `meeting room`. The name must be
34
+ * unique per site.
35
+ */
26
36
  name?: string | null;
27
37
  /** Extensions enabling users to save custom data related to the resource type. */
28
38
  extendedFields?: ExtendedFields;
29
39
  }
30
40
  export interface ResourceCounts {
31
41
  /**
32
- * The number of resources that have this type.
42
+ * Total number of resources connected to the type.
33
43
  * @readonly
34
44
  */
35
45
  total?: number | null;
36
46
  /**
37
- * Whether a resource of this type exists that is available in all locations
47
+ * Whether at least 1 resource of the type is available in all business *locations*
48
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-locations#backend-modules_bookings_services_location-types) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations#location-types)).
38
49
  * @readonly
39
50
  */
40
51
  hasResourcesInAllLocations?: boolean | null;
41
52
  /**
42
- * Whether a resource of this type exists that is available in any customer location.
53
+ * Whether at least 1 resource of the type is available in customer locations.
43
54
  * @readonly
44
55
  */
45
56
  hasResourcesInCustomerLocations?: boolean | null;
46
57
  /**
47
- * Whether a resource of this type exists that is available in any custom location.
58
+ * Whether at least 1 resource of the type is available in custom business locations.
48
59
  * @readonly
49
60
  */
50
61
  hasResourcesInCustomLocations?: boolean | null;
51
62
  /**
52
- * Number of distinct business locations of resources with this type.
63
+ * Number of distinct business locations with resources connected to the type.
53
64
  * @readonly
54
65
  */
55
66
  distinctBusinessLocationsCount?: number | null;
56
67
  /**
57
- * Distinct business location ids of resources with this type. Only first 50 are returned.
68
+ * IDs of all business locations with resources connected to the type. If there
69
+ * are more than 50 location IDs, only the first 50 IDs are returned.
58
70
  * @readonly
59
71
  */
60
72
  distinctLocationIds?: DistinctLocationIds;
61
73
  }
62
74
  export interface DistinctLocationIds {
63
- /** Locations ids of business locations. */
75
+ /** IDs of the business locations with a resource connected to the type. */
64
76
  values?: string[];
65
77
  }
66
78
  export interface ExtendedFields {
@@ -75,7 +87,7 @@ export interface ExtendedFields {
75
87
  namespaces?: Record<string, Record<string, any>>;
76
88
  }
77
89
  export interface CreateResourceTypeRequest {
78
- /** Resource type to be created. */
90
+ /** Resource type to create. */
79
91
  resourceType: ResourceType;
80
92
  }
81
93
  export interface LocationOptions {
@@ -124,7 +136,7 @@ export declare enum RequestedFields {
124
136
  DISTINCT_RESOURCE_LOCATIONS = "DISTINCT_RESOURCE_LOCATIONS"
125
137
  }
126
138
  export interface CreateResourceTypeResponse {
127
- /** The created resource type. */
139
+ /** Created resource type. */
128
140
  resourceType?: ResourceType;
129
141
  }
130
142
  export declare enum CreateResourceTypeErrors {
@@ -137,7 +149,7 @@ export interface GetResourceTypeRequest {
137
149
  resourceTypeId: string;
138
150
  }
139
151
  export interface GetResourceTypeResponse {
140
- /** The requested resource type. */
152
+ /** Retrieved resource type. */
141
153
  resourceType?: ResourceType;
142
154
  }
143
155
  export interface UpdateResourceTypeRequest {
@@ -155,7 +167,12 @@ export interface DeleteResourceTypeRequest {
155
167
  export interface DeleteResourceTypeResponse {
156
168
  }
157
169
  export interface QueryResourceTypesRequest {
158
- /** WQL expression. */
170
+ /**
171
+ * Information about filtering and sorting.
172
+ * Refer to the *supported filters article*
173
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
174
+ * for a complete list of supported filters and sorting options.
175
+ */
159
176
  query?: CursorQuery;
160
177
  }
161
178
  export interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -204,9 +221,9 @@ export interface CursorPaging {
204
221
  cursor?: string | null;
205
222
  }
206
223
  export interface QueryResourceTypesResponse {
207
- /** The retrieved resource types. */
224
+ /** Retrieved resource types. */
208
225
  resourceTypes?: ResourceType[];
209
- /** Paging metadata, including offset and count. */
226
+ /** Paging metadata. */
210
227
  pagingMetadata?: CursorPagingMetadata;
211
228
  }
212
229
  export interface CursorPagingMetadata {
@@ -228,11 +245,16 @@ export interface Cursors {
228
245
  prev?: string | null;
229
246
  }
230
247
  export interface CountResourceTypesRequest {
231
- /** Filter to apply on resource types to count. */
248
+ /**
249
+ * Filter to base the count on.
250
+ * Refer to the *supported filters article*
251
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
252
+ * for a complete list of supported filters.
253
+ */
232
254
  filter?: Record<string, any> | null;
233
255
  }
234
256
  export interface CountResourceTypesResponse {
235
- /** The number of resource types matching the given filter. */
257
+ /** Number of resource types matching the filter. */
236
258
  count?: number;
237
259
  }
238
260
  export interface DomainEvent extends DomainEventBodyOneOf {
package/build/cjs/src/bookings-resources-v2-resource-type-resource-types.types.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"bookings-resources-v2-resource-type-resource-types.types.js","sourceRoot":"","sources":["../../../src/bookings-resources-v2-resource-type-resource-types.types.ts"],"names":[],"mappings":";;;AAgIA,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,gEAA6C,CAAA;IAC7C,oGAAiF,CAAA;IACjF,8EAA2D,CAAA;AAC7D,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B;AAOD,IAAY,wBAIX;AAJD,WAAY,wBAAwB;IAClC,qGAAyE,CAAA;IACzE,+EAA+E;IAC/E,qFAAyD,CAAA;AAC3D,CAAC,EAJW,wBAAwB,wCAAxB,wBAAwB,QAInC;AAkED,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAuKD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
1
+ {"version":3,"file":"bookings-resources-v2-resource-type-resource-types.types.js","sourceRoot":"","sources":["../../../src/bookings-resources-v2-resource-type-resource-types.types.ts"],"names":[],"mappings":";;;AA4IA,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,gEAA6C,CAAA;IAC7C,oGAAiF,CAAA;IACjF,8EAA2D,CAAA;AAC7D,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B;AAOD,IAAY,wBAIX;AAJD,WAAY,wBAAwB;IAClC,qGAAyE,CAAA;IACzE,+EAA+E;IAC/E,qFAAyD,CAAA;AAC3D,CAAC,EAJW,wBAAwB,wCAAxB,wBAAwB,QAInC;AAuED,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AA4KD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
package/build/cjs/src/bookings-resources-v2-resource-type-resource-types.universal.d.ts CHANGED
@@ -1,4 +1,11 @@
1
- /** A resource type is a classification of resources, e.g. room, equipment or vehicle. */
1
+ /**
2
+ * A resource type is a classification of resources. For example room, equipment,
3
+ * or vehicle. Customers can only book *services*
4
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction))
5
+ * if at least 1 *resource*
6
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction))
7
+ * for every resource type connected to the service is available during the requested time.
8
+ */
2
9
  export interface ResourceType {
3
10
  /**
4
11
  * Resource type ID.
@@ -13,54 +20,59 @@ export interface ResourceType {
13
20
  */
14
21
  revision?: string | null;
15
22
  /**
16
- * Represents the time in `YYYY-MM-DDThh:mm:ss.sssZ` format this resource type was created.
23
+ * Time in `YYYY-MM-DDThh:mm:ss.sssZ` format the resource type was created.
17
24
  * @readonly
18
25
  */
19
26
  _createdDate?: Date | null;
20
27
  /**
21
- * Represents the time in `YYYY-MM-DDThh:mm:ss.sssZ` format this resource type was last updated.
28
+ * Time in `YYYY-MM-DDThh:mm:ss.sssZ` format the resource type was last updated.
22
29
  * @readonly
23
30
  */
24
31
  _updatedDate?: Date | null;
25
- /** The name of this resource type, for example `meeting room`. The name must be unique per site. */
32
+ /**
33
+ * Name of the resource type. For example, `meeting room`. The name must be
34
+ * unique per site.
35
+ */
26
36
  name?: string | null;
27
37
  /** Extensions enabling users to save custom data related to the resource type. */
28
38
  extendedFields?: ExtendedFields;
29
39
  }
30
40
  export interface ResourceCounts {
31
41
  /**
32
- * The number of resources that have this type.
42
+ * Total number of resources connected to the type.
33
43
  * @readonly
34
44
  */
35
45
  total?: number | null;
36
46
  /**
37
- * Whether a resource of this type exists that is available in all locations
47
+ * Whether at least 1 resource of the type is available in all business *locations*
48
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-locations#backend-modules_bookings_services_location-types) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations#location-types)).
38
49
  * @readonly
39
50
  */
40
51
  hasResourcesInAllLocations?: boolean | null;
41
52
  /**
42
- * Whether a resource of this type exists that is available in any customer location.
53
+ * Whether at least 1 resource of the type is available in customer locations.
43
54
  * @readonly
44
55
  */
45
56
  hasResourcesInCustomerLocations?: boolean | null;
46
57
  /**
47
- * Whether a resource of this type exists that is available in any custom location.
58
+ * Whether at least 1 resource of the type is available in custom business locations.
48
59
  * @readonly
49
60
  */
50
61
  hasResourcesInCustomLocations?: boolean | null;
51
62
  /**
52
- * Number of distinct business locations of resources with this type.
63
+ * Number of distinct business locations with resources connected to the type.
53
64
  * @readonly
54
65
  */
55
66
  distinctBusinessLocationsCount?: number | null;
56
67
  /**
57
- * Distinct business location ids of resources with this type. Only first 50 are returned.
68
+ * IDs of all business locations with resources connected to the type. If there
69
+ * are more than 50 location IDs, only the first 50 IDs are returned.
58
70
  * @readonly
59
71
  */
60
72
  distinctLocationIds?: DistinctLocationIds;
61
73
  }
62
74
  export interface DistinctLocationIds {
63
- /** Locations ids of business locations. */
75
+ /** IDs of the business locations with a resource connected to the type. */
64
76
  values?: string[];
65
77
  }
66
78
  export interface ExtendedFields {
@@ -75,7 +87,7 @@ export interface ExtendedFields {
75
87
  namespaces?: Record<string, Record<string, any>>;
76
88
  }
77
89
  export interface CreateResourceTypeRequest {
78
- /** Resource type to be created. */
90
+ /** Resource type to create. */
79
91
  resourceType: ResourceType;
80
92
  }
81
93
  export interface LocationOptions {
@@ -124,7 +136,7 @@ export declare enum RequestedFields {
124
136
  DISTINCT_RESOURCE_LOCATIONS = "DISTINCT_RESOURCE_LOCATIONS"
125
137
  }
126
138
  export interface CreateResourceTypeResponse {
127
- /** The created resource type. */
139
+ /** Created resource type. */
128
140
  resourceType?: ResourceType;
129
141
  }
130
142
  export declare enum CreateResourceTypeErrors {
@@ -137,7 +149,7 @@ export interface GetResourceTypeRequest {
137
149
  resourceTypeId: string;
138
150
  }
139
151
  export interface GetResourceTypeResponse {
140
- /** The requested resource type. */
152
+ /** Retrieved resource type. */
141
153
  resourceType?: ResourceType;
142
154
  }
143
155
  export interface UpdateResourceTypeRequest {
@@ -155,7 +167,12 @@ export interface DeleteResourceTypeRequest {
155
167
  export interface DeleteResourceTypeResponse {
156
168
  }
157
169
  export interface QueryResourceTypesRequest {
158
- /** WQL expression. */
170
+ /**
171
+ * Information about filtering and sorting.
172
+ * Refer to the *supported filters article*
173
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
174
+ * for a complete list of supported filters and sorting options.
175
+ */
159
176
  query?: CursorQuery;
160
177
  }
161
178
  export interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -204,9 +221,9 @@ export interface CursorPaging {
204
221
  cursor?: string | null;
205
222
  }
206
223
  export interface QueryResourceTypesResponse {
207
- /** The retrieved resource types. */
224
+ /** Retrieved resource types. */
208
225
  resourceTypes?: ResourceType[];
209
- /** Paging metadata, including offset and count. */
226
+ /** Paging metadata. */
210
227
  pagingMetadata?: CursorPagingMetadata;
211
228
  }
212
229
  export interface CursorPagingMetadata {
@@ -228,11 +245,16 @@ export interface Cursors {
228
245
  prev?: string | null;
229
246
  }
230
247
  export interface CountResourceTypesRequest {
231
- /** Filter to apply on resource types to count. */
248
+ /**
249
+ * Filter to base the count on.
250
+ * Refer to the *supported filters article*
251
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
252
+ * for a complete list of supported filters.
253
+ */
232
254
  filter?: Record<string, any> | null;
233
255
  }
234
256
  export interface CountResourceTypesResponse {
235
- /** The number of resource types matching the given filter. */
257
+ /** Number of resource types matching the filter. */
236
258
  count?: number;
237
259
  }
238
260
  export interface DomainEvent extends DomainEventBodyOneOf {
@@ -424,6 +446,8 @@ export interface ResourceTypeCreatedEnvelope {
424
446
  * Triggered when a resource type is created.
425
447
  * @webhook
426
448
  * @eventType wix.bookings.resources.v2.resource_type_created
449
+ * @serviceIdentifier wix.bookings.resources.v2.resourcetypes.ResourceTypesService
450
+ * @slug created
427
451
  * @documentationMaturity preview
428
452
  */
429
453
  export declare function onResourceTypeCreated(handler: (event: ResourceTypeCreatedEnvelope) => void | Promise<void>): void;
@@ -434,6 +458,8 @@ export interface ResourceTypeDeletedEnvelope {
434
458
  * Triggered when a resource type is deleted.
435
459
  * @webhook
436
460
  * @eventType wix.bookings.resources.v2.resource_type_deleted
461
+ * @serviceIdentifier wix.bookings.resources.v2.resourcetypes.ResourceTypesService
462
+ * @slug deleted
437
463
  * @documentationMaturity preview
438
464
  */
439
465
  export declare function onResourceTypeDeleted(handler: (event: ResourceTypeDeletedEnvelope) => void | Promise<void>): void;
@@ -445,12 +471,14 @@ export interface ResourceTypeUpdatedEnvelope {
445
471
  * Triggered when a resource type is updated.
446
472
  * @webhook
447
473
  * @eventType wix.bookings.resources.v2.resource_type_updated
474
+ * @serviceIdentifier wix.bookings.resources.v2.resourcetypes.ResourceTypesService
475
+ * @slug updated
448
476
  * @documentationMaturity preview
449
477
  */
450
478
  export declare function onResourceTypeUpdated(handler: (event: ResourceTypeUpdatedEnvelope) => void | Promise<void>): void;
451
479
  /**
452
480
  * Creates a new resource type.
453
- * @param resourceType - Resource type to be created.
481
+ * @param resourceType - Resource type to create.
454
482
  * @public
455
483
  * @documentationMaturity preview
456
484
  * @requiredField resourceType
@@ -461,12 +489,12 @@ export declare function onResourceTypeUpdated(handler: (event: ResourceTypeUpdat
461
489
  * @permissionScope Manage Bookings - all permissions
462
490
  * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
463
491
  * @applicableIdentity APP
464
- * @returns The created resource type.
492
+ * @returns Created resource type.
465
493
  * @fqn wix.bookings.resources.v2.resourcetypes.ResourceTypesService.CreateResourceType
466
494
  */
467
495
  export declare function createResourceType(resourceType: ResourceType): Promise<ResourceType & ResourceTypeNonNullableFields>;
468
496
  /**
469
- * Retrieves a resource type by ID.
497
+ * Retrieves a resource type.
470
498
  * @param resourceTypeId - ID of the resource type to retrieve.
471
499
  * @public
472
500
  * @documentationMaturity preview
@@ -501,15 +529,17 @@ export declare function createResourceType(resourceType: ResourceType): Promise<
501
529
  * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
502
530
  * @applicableIdentity APP
503
531
  * @applicableIdentity VISITOR
504
- * @returns The requested resource type.
532
+ * @returns Retrieved resource type.
505
533
  * @fqn wix.bookings.resources.v2.resourcetypes.ResourceTypesService.GetResourceType
506
534
  */
507
535
  export declare function getResourceType(resourceTypeId: string): Promise<ResourceType & ResourceTypeNonNullableFields>;
508
536
  /**
509
537
  * Updates a resource type.
510
538
  *
511
- * Each time the resource type is updated, `revision` increments by 1. You must include current revision of the resource type when updating it.
512
- * This ensures you're working with the latest service information and prevents unintended overwrites.
539
+ *
540
+ * Each time the resource type is updated, `revision` increments by 1. You must
541
+ * include current revision of the resource type when updating it. This ensures
542
+ * you're working with the latest service information and prevents unintended overwrites.
513
543
  * @param _id - Resource type ID.
514
544
  * @public
515
545
  * @documentationMaturity preview
@@ -540,16 +570,19 @@ export interface UpdateResourceType {
540
570
  */
541
571
  revision?: string | null;
542
572
  /**
543
- * Represents the time in `YYYY-MM-DDThh:mm:ss.sssZ` format this resource type was created.
573
+ * Time in `YYYY-MM-DDThh:mm:ss.sssZ` format the resource type was created.
544
574
  * @readonly
545
575
  */
546
576
  _createdDate?: Date | null;
547
577
  /**
548
- * Represents the time in `YYYY-MM-DDThh:mm:ss.sssZ` format this resource type was last updated.
578
+ * Time in `YYYY-MM-DDThh:mm:ss.sssZ` format the resource type was last updated.
549
579
  * @readonly
550
580
  */
551
581
  _updatedDate?: Date | null;
552
- /** The name of this resource type, for example `meeting room`. The name must be unique per site. */
582
+ /**
583
+ * Name of the resource type. For example, `meeting room`. The name must be
584
+ * unique per site.
585
+ */
553
586
  name?: string | null;
554
587
  /** Extensions enabling users to save custom data related to the resource type. */
555
588
  extendedFields?: ExtendedFields;
@@ -557,7 +590,8 @@ export interface UpdateResourceType {
557
590
  /**
558
591
  * Deletes a resource type.
559
592
  *
560
- * Deleting a resource type will automatically delete all resources of this type.
593
+ *
594
+ * Deleting a resource type also automatically deletes all resources connected to it.
561
595
  * @param resourceTypeId - ID of the resource type to delete.
562
596
  * @public
563
597
  * @documentationMaturity preview
@@ -658,10 +692,12 @@ export interface ResourceTypesQueryBuilder {
658
692
  find: () => Promise<ResourceTypesQueryResult>;
659
693
  }
660
694
  /**
661
- * Counts resource types according to given criteria.
695
+ * Counts resource types, given the provided filtering.
696
+ *
662
697
  *
663
- * For field support for filters, see [Resource types: Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-type-v2/filtering-and-sorting).
664
- * Use [WQL filter](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section) to define the criteria.
698
+ * Refer to the *supported filters article*
699
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
700
+ * for a complete list of supported filters.
665
701
  * @public
666
702
  * @documentationMaturity preview
667
703
  * @param options - Filter to base the count on. See
@@ -684,7 +720,12 @@ export interface ResourceTypesQueryBuilder {
684
720
  */
685
721
  export declare function countResourceTypes(options?: CountResourceTypesOptions): Promise<CountResourceTypesResponse & CountResourceTypesResponseNonNullableFields>;
686
722
  export interface CountResourceTypesOptions {
687
- /** Filter to apply on resource types to count. */
723
+ /**
724
+ * Filter to base the count on.
725
+ * Refer to the *supported filters article*
726
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
727
+ * for a complete list of supported filters.
728
+ */
688
729
  filter?: Record<string, any> | null;
689
730
  }
690
731
  export {};