@apaleo/angular-api-proxy-booking - npm Package Compare versions

Comparing version 0.12.193 to 0.12.194

api/authorization.service.d.ts

@@ -101,3 +101,3 @@ import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
         /**
-        * Filter result by requested booking ids
+        * Filter result by requested booking ids. Returns authorizations that are related to the specified booking or booking reservations.  Use in combination with the Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.TargetTypes to get authorizations related only to bookings or to reservations.
         */
@@ -110,16 +110,52 @@ bookingIds?: Array<string>;
         /**
-        * Filter result by date and time attributes of authorization. Use in combination with Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.DateFilter
+        * Filter result by authorization status
         */
+        status?: Array<StatusEnum>;
+        /**
+        * Filter by target types
+        */
+        targetTypes?: Array<TargetTypesEnum>;
+        /**
+        * Filter result by date and time attributes of authorization. Use in combination with the Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.From and Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.To attributes.  All filters will check if the date specified by the filter type is between Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.From (included) and Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.To (excluded).
+        */
         dateField?: DateFieldEnum;
         /**
-        * Filter result by date and time<br />You can provide an array of string expressions which all need to apply.<br />Each expression has the form of 'OPERATION_VALUE' where VALUE needs to be of the valid format of the property type and OPERATION can be:<br />'eq' for equals<br />'neq' for not equals<br />'lt' for less than<br />'gt' for greater than<br />'lte' for less than or equals<br />'gte' for greater than or equals<br />For instance<br />'eq_5' would mean the value should equal 5<br />'lte_7' would mean the value should be less than or equal to 7
+        * The start of the time interval. When filtering by Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.DateField, at least one of Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.From and Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.To has to be specified<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO8601:2004</a>
         */
-        dateFilter?: Array<string>;
+        from?: Date;
         /**
+        * The end of the time interval, must be larger than Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.From. When filtering by Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.DateField, at least one of Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.From and Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.To has to be specified<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO8601:2004</a>
+        */
+        to?: Date;
+        /**
         * Use this parameter to override the current date and time for the current request. Specify a date and time (without fractional second part) in UTC or with UTC offset as defined in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO8601:2004</a>.This header will only take effect on development environments.
         */
         apaleoCurrentDateTime?: Date;
+        /**
+        * Page number, 1-based. Default value is 1 (if this is not set or not positive). Results in 204 if there are no items on that page.
+        */
+        pageNumber?: number;
+        /**
+        * Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.
+        */
+        pageSize?: number;
+        /**
+        * List of all fields that can be used to sort the results. Possible values are: created:asc, created:desc, updated:asc, updated:desc, expiresat:asc, expiresat:desc. All other values will be silently ignored.
+        */
+        sort?: Array<SortEnum>;
+        /**
+        * List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored.
+        */
+        expand?: Array<ExpandEnum>;
     }
+    type StatusEnum = 'Pending' | 'Success' | 'Failure' | 'Canceled' | 'Expired';
+    const StatusEnumValues: readonly StatusEnum[];
+    type TargetTypesEnum = 'Booking' | 'Reservation';
+    const TargetTypesEnumValues: readonly TargetTypesEnum[];
     type DateFieldEnum = 'Creation' | 'Modification' | 'Expiration';
     const DateFieldEnumValues: readonly DateFieldEnum[];
+    type SortEnum = 'created:asc' | 'created:desc' | 'updated:asc' | 'updated:desc' | 'expiresat:asc' | 'expiresat:desc';
+    const SortEnumValues: readonly SortEnum[];
+    type ExpandEnum = 'actions';
+    const ExpandEnumValues: readonly "actions"[];
 }
@@ -201,7 +237,14 @@ export declare class AuthorizationService {
      * @param $params.propertyIds Filter result by requested properties
-     * @param $params.bookingIds Filter result by requested booking ids
+     * @param $params.bookingIds Filter result by requested booking ids. Returns authorizations that are related to the specified booking or booking reservations.  Use in combination with the Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.TargetTypes to get authorizations related only to bookings or to reservations.
      * @param $params.reservationIds Filter result by requested reservation ids
-     * @param $params.dateField Filter result by date and time attributes of authorization. Use in combination with Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.DateFilter
-     * @param $params.dateFilter Filter result by date and time&lt;br /&gt;You can provide an array of string expressions which all need to apply.&lt;br /&gt;Each expression has the form of &#39;OPERATION_VALUE&#39; where VALUE needs to be of the valid format of the property type and OPERATION can be:&lt;br /&gt;&#39;eq&#39; for equals&lt;br /&gt;&#39;neq&#39; for not equals&lt;br /&gt;&#39;lt&#39; for less than&lt;br /&gt;&#39;gt&#39; for greater than&lt;br /&gt;&#39;lte&#39; for less than or equals&lt;br /&gt;&#39;gte&#39; for greater than or equals&lt;br /&gt;For instance&lt;br /&gt;&#39;eq_5&#39; would mean the value should equal 5&lt;br /&gt;&#39;lte_7&#39; would mean the value should be less than or equal to 7
+     * @param $params.status Filter result by authorization status
+     * @param $params.targetTypes Filter by target types
+     * @param $params.dateField Filter result by date and time attributes of authorization. Use in combination with the Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.From and Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.To attributes.  All filters will check if the date specified by the filter type is between Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.From (included) and Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.To (excluded).
+     * @param $params.from The start of the time interval. When filtering by Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.DateField, at least one of Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.From and Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.To has to be specified&lt;br /&gt;A date and time (without fractional second part) in UTC or with UTC offset as defined in &lt;a href&#x3D;\&quot;https://en.wikipedia.org/wiki/ISO_8601\&quot;&gt;ISO8601:2004&lt;/a&gt;
+     * @param $params.to The end of the time interval, must be larger than Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.From. When filtering by Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.DateField, at least one of Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.From and Apaleo.Api.Modules.Booking.Models.Authorization.AuthorizationListRequest.To has to be specified&lt;br /&gt;A date and time (without fractional second part) in UTC or with UTC offset as defined in &lt;a href&#x3D;\&quot;https://en.wikipedia.org/wiki/ISO_8601\&quot;&gt;ISO8601:2004&lt;/a&gt;
      * @param $params.apaleoCurrentDateTime Use this parameter to override the current date and time for the current request. Specify a date and time (without fractional second part) in UTC or with UTC offset as defined in the &lt;a href&#x3D;\&quot;https://en.wikipedia.org/wiki/ISO_8601\&quot;&gt;ISO8601:2004&lt;/a&gt;.This header will only take effect on development environments.
+     * @param $params.pageNumber Page number, 1-based. Default value is 1 (if this is not set or not positive). Results in 204 if there are no items on that page.
+     * @param $params.pageSize Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.
+     * @param $params.sort List of all fields that can be used to sort the results. Possible values are: created:asc, created:desc, updated:asc, updated:desc, expiresat:asc, expiresat:desc. All other values will be silently ignored.
+     * @param $params.expand List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored.
      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
@@ -208,0 +251,0 @@ * @param reportProgress flag to report request and response progress.

package.json

 {
   "name": "@apaleo/angular-api-proxy-booking",
-  "version": "0.12.193",
+  "version": "0.12.194",
   "description": "apaleo Api Proxy for Angular 12+",
@@ -5,0 +5,0 @@ "repository": {

No alert changes

Improved metrics

Total package byte prevSize

5282317

increased by0.7%

Lines of code

38149

increased by0.39%

No dependency changes