NAME

    WebService::GAMSTOP - GAMSTOP API Client Implementation

VERSION

    version 0.001

SYNOPSIS

        use WebService::GAMSTOP;
        my $instance = WebService::GAMSTOP->new(
            api_url => 'gamstop_api_url',
            api_key => 'gamstop_api_key',
            # optional (defaults to 5 seconds)
            timeout => 10,
        );
    
        $instance->get_exclusion_for(
            first_name    => 'Harry',
            last_name     => 'Potter',
            email         => 'harry.potter@example.com',
            date_of_birth => '1970-01-01',
            postcode      => 'hp11aa',
        );

DESCRIPTION

    This module implements a programmatic interface to
    [GAMSTOP](https://www.gamstop.co.uk/) API.

PRE-REQUISITE

    Before you can use this module, you'll need to obtain your own "Unique
    API Key" from [GAMSTOP](https://www.gamstop.co.uk/).

ATTRIBUTES

    WebService::GAMSTOP implements the following attributes

 api_url

    GAMSTOP API endpoint url (REQUIRED)

 api_key

    GAMSTOP API unique key for operator (REQUIRED)

 timeout

    Maximum amount of time in seconds establishing a connection may take
    before getting canceled (OPTIONAL - DEFAULT 5 seconds)

METHODS

 get_exclusion_for

    Given user details return WebService::GAMSTOP::Response object Note: it
    dies if an error occur connecting to GAMSTOP API endpoint

  Required parameters

      * first_name : First name of person, only 20 characters are
      significant

      * last_name : Last name of person, only 20 characters are significant

      * date_of_birth: Date of birth in ISO format (yyyy-mm-dd)

      * email : Email address

      * postcode : Postcode (spaces not significant)

      * mobile : UK mobile telephone number which may include spaces,
      hyphens and optionally be prefixed with the international dialling
      code(+44, 0044, +353, 00353).

  Optional parameters

      x_trace_id: A freeform field that is put into audit log that can be
      used by the caller to identify a request. This might be something to
      indicate the person being checked, a unique request ID, GUID, or a
      trace ID from a system such as zipkin.

  Return value

      A WebService::GAMSTOP::Response object

AUTHOR

    binary.com <cpan@binary.com>

COPYRIGHT AND LICENSE

    This is free software; you can redistribute it and/or modify it under
    the same terms as the Perl 5 programming language system itself.