view release on metacpan or  search on metacpan

README.md  view on Meta::CPAN

Get a \[list of\] issue(s) / agenc(y|ies) / propert(y|ies) / property address(es) / landlord(s) / landlord\_property:

```perl
my $paginator = $ff->issues( %query_params );

my $issue     = $ff->issue( $id );
```

Will return a [Business::Fixflo::Paginator](https://metacpan.org/pod/Business%3A%3AFixflo%3A%3APaginator) object (when calling endpoints
that return lists of items) or a Business::Fixflo:: object for the Issue,
Agency, etc.

%query\_params refers to the possible query params as shown in the currency
Fixflo API documentation. For example: page=\[n\]. You can pass DateTime objects
through and these will be correctly changed into strings when calling the API:

```perl
# issues raised in the previous month
my $paginator = $ff->issues(
    CreatedSince  => DateTime->now->subtract( months => 1 ),
);

# properties in given postal code
my $paginator = $ff->properties(
    Keywords => 'NW1',
);
```

Refer to the [Business::Fixflo::Paginator](https://metacpan.org/pod/Business%3A%3AFixflo%3A%3APaginator) documentation for what to do with
the returned paginator object.

Note the property method can take a flag to indicate that the passed $id is an
external reference:

```perl
my $Property = $ff->property( 'P123',1 );
```

Note the landlord method can take a flag to indicate that the passed $id is an
email address

```perl
my $Landlord = $ff->landlord( 'leejo@cpan.org',1 );
```

Note the landlord\_property method can take two arguments, it only one is passed
this is taken as the LandlordPropertyId, if two arguments are passed they are
taken as the LandlordId and the PropertyId:

```perl
my $LandlordProperty = $ff->landlord_property( $landlord_property_id );

my $LandlordProperty = $ff->landlord_property( $landlord_id,$property_id );
```

# EXAMPLES

See the t/002\_end\_to\_end.t test included with this distribution. you can run
this test against the fixflo test server (requires ENV variables to set the
Fixflo credentials)

# SEE ALSO

[Business::Fixflo::Address](https://metacpan.org/pod/Business%3A%3AFixflo%3A%3AAddress)

[Business::Fixflo::Agency](https://metacpan.org/pod/Business%3A%3AFixflo%3A%3AAgency)

[Business::Fixflo::Client](https://metacpan.org/pod/Business%3A%3AFixflo%3A%3AClient)

[Business::Fixflo::Issue](https://metacpan.org/pod/Business%3A%3AFixflo%3A%3AIssue)

[Business::Fixflo::IssueDraft](https://metacpan.org/pod/Business%3A%3AFixflo%3A%3AIssueDraft)

[Business::Fixflo::IssueDraftMedia](https://metacpan.org/pod/Business%3A%3AFixflo%3A%3AIssueDraftMedia)

[Business::Fixflo::Landlord](https://metacpan.org/pod/Business%3A%3AFixflo%3A%3ALandlord)

[Business::Fixflo::LandlordProperty](https://metacpan.org/pod/Business%3A%3AFixflo%3A%3ALandlordProperty)

[Business::Fixflo::Paginator](https://metacpan.org/pod/Business%3A%3AFixflo%3A%3APaginator)

[Business::Fixflo::Property](https://metacpan.org/pod/Business%3A%3AFixflo%3A%3AProperty)

[Business::Fixflo::PropertyAddress](https://metacpan.org/pod/Business%3A%3AFixflo%3A%3APropertyAddress)

[Business::Fixflo::QuickViewPanel](https://metacpan.org/pod/Business%3A%3AFixflo%3A%3AQuickViewPanel)

[https://api-docs.fixflo.com/](https://api-docs.fixflo.com/)

# AUTHOR

Lee Johnson - `leejo@cpan.org`

# LICENSE

This library is free software; you can redistribute it and/or modify it under
the same terms as Perl itself. If you would like to contribute documentation,
features, bug fixes, or anything else then please raise an issue / pull request:

```
https://github.com/Humanstate/business-fixflo
```