package Koha::REST::V1::Patrons::OldHolds;

# This file is part of Koha.

#

# Koha is free software; you can redistribute it and/or modify it

# under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 3 of the License, or

# (at your option) any later version.

#

# Koha is distributed in the hope that it will be useful, but

# WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with Koha; if not, see <http://www.gnu.org/licenses>.

use Modern::Perl;

use Mojo::Base 'Mojolicious::Controller';

use Koha::Patrons;

=head1 NAME

Koha::REST::V1::Patrons::OldHolds

=head1 API

=head2 Methods

=head3 list

Controller function that handles listing Koha::OldHold objects for the requested patron

=cut

sub list {

    my $c = shift->openapi->valid_input or return;

    my $patron = Koha::Patrons->find( $c->param('patron_id') );

    unless ( $patron ) {

        return $c->render(

            status  => 404,

            openapi => {

                error => 'Patron not found'

            }

        );

    }

    return try {

        my $old_holds = $c->objects->search( $patron->old_holds );

        return $c->render(

            status  => 200,

            openapi => $old_holds

        );

    }

    catch {

        $c->unhandled_exception($_);

    };

}

1;

---

"/patrons/{patron_id}/old_holds":

  get:

    x-mojo-to: Patrons::OldHolds#list

    operationId: getPatronOldHolds

    tags:

      - old_holds

    summary: List old holds for a patron

    parameters:

      - $ref: "../swagger.yaml#/parameters/patron_id_pp"

      - $ref: "../swagger.yaml#/parameters/match"

      - $ref: "../swagger.yaml#/parameters/order_by"

      - $ref: "../swagger.yaml#/parameters/page"

      - $ref: "../swagger.yaml#/parameters/per_page"

      - $ref: "../swagger.yaml#/parameters/q_param"

      - $ref: "../swagger.yaml#/parameters/q_body"

      - $ref: "../swagger.yaml#/parameters/request_id_header"

      - name: x-koha-embed

        in: header

        required: false

        description: Embed list sent as a request header

        type: array

        items:

          type: string

          enum:

            - cancellation_requested

          collectionFormat: csv

    produces:

      - application/json

    responses:

      "200":

        description: The patron old holds

        schema:

          type: array

          items:

            $ref: "../swagger.yaml#/definitions/hold"

      "401":

        description: Authentication required

        schema:

          $ref: "../swagger.yaml#/definitions/error"

      "403":

        description: Access forbidden

        schema:

          $ref: "../swagger.yaml#/definitions/error"

      "404":

        description: Patron not found

        schema:

          $ref: "../swagger.yaml#/definitions/error"

      "500":

        description: |

          Internal server error. Possible `error_code` attribute values:

          * `internal_server_error`

        schema:

          $ref: "../swagger.yaml#/definitions/error"

      "503":

        description: Under maintenance

        schema:

          $ref: "../swagger.yaml#/definitions/error"

    x-koha-authorization:

      permissions:

        borrowers: edit_borrowers

  "/patrons/{patron_id}/old_holds":

    $ref: "./paths/patrons_old_holds.yaml#/~1patrons~1{patron_id}~1old_holds"