Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update readme + test grps of new SDK #160

Merged
merged 3 commits into from
Sep 27, 2022
Merged

update readme + test grps of new SDK #160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c91cc7d
update readme + test grps
jho44 Aug 9, 2022
1eeeda7
remove legacy docs link
jho44 Sep 10, 2022
d0d0826
chore: merge main
BennyKitchell Sep 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
217 changes: 41 additions & 176 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
# OpenAPIClient-php

The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [documentation](https://docs.lob.com/)?

The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors.

For more information, please visit [https://support.lob.com/](https://support.lob.com/).

## Installation & Usage

### Requirements
## Requirements

PHP 7.3 and later.
Should also work with PHP 8.0 but has not been tested.

### Composer
## Getting Started

### Registration

First, you will need to first create an account at [Lob.com](https://dashboard.lob.com/#/register) and obtain your Test and Live API Keys.

Once you have created an account, you can access your API Keys from the [Settings Panel](https://dashboard.lob.com/#/settings).

### Installation & Usage

#### Composer

To install the bindings via [Composer](https://getcomposer.org/), run `php composer.phar install`

Expand All @@ -25,9 +32,7 @@ Download the files and include `autoload.php`:
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:
## First API Call

```php
<?php
Expand Down Expand Up @@ -58,192 +63,52 @@ try {

```

## API Endpoints

All URIs are relative to *https://api.lob.com/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AddressesApi* | [**addressCreate**](docs/Api/AddressesApi.md#addresscreate) | **POST** /addresses | create
*AddressesApi* | [**addressDelete**](docs/Api/AddressesApi.md#addressdelete) | **DELETE** /addresses/{adr_id} | delete
*AddressesApi* | [**addressRetrieve**](docs/Api/AddressesApi.md#addressretrieve) | **GET** /addresses/{adr_id} | get
*AddressesApi* | [**addressesList**](docs/Api/AddressesApi.md#addresseslist) | **GET** /addresses | list
*BankAccountsApi* | [**bankAccountCreate**](docs/Api/BankAccountsApi.md#bankaccountcreate) | **POST** /bank_accounts | create
*BankAccountsApi* | [**bankAccountDelete**](docs/Api/BankAccountsApi.md#bankaccountdelete) | **DELETE** /bank_accounts/{bank_id} | delete
*BankAccountsApi* | [**bankAccountRetrieve**](docs/Api/BankAccountsApi.md#bankaccountretrieve) | **GET** /bank_accounts/{bank_id} | get
*BankAccountsApi* | [**bankAccountVerify**](docs/Api/BankAccountsApi.md#bankaccountverify) | **POST** /bank_accounts/{bank_id}/verify | verify
*BankAccountsApi* | [**bankAccountsList**](docs/Api/BankAccountsApi.md#bankaccountslist) | **GET** /bank_accounts | list
*BillingGroupsApi* | [**billingGroupCreate**](docs/Api/BillingGroupsApi.md#billinggroupcreate) | **POST** /billing_groups | create
*BillingGroupsApi* | [**billingGroupRetrieve**](docs/Api/BillingGroupsApi.md#billinggroupretrieve) | **GET** /billing_groups/{bg_id} | get
*BillingGroupsApi* | [**billingGroupUpdate**](docs/Api/BillingGroupsApi.md#billinggroupupdate) | **POST** /billing_groups/{bg_id} | update
*BillingGroupsApi* | [**billingGroupsList**](docs/Api/BillingGroupsApi.md#billinggroupslist) | **GET** /billing_groups | list
*CardOrdersApi* | [**cardOrderCreate**](docs/Api/CardOrdersApi.md#cardordercreate) | **POST** /cards/{card_id}/orders | create
*CardOrdersApi* | [**cardOrdersRetrieve**](docs/Api/CardOrdersApi.md#cardordersretrieve) | **GET** /cards/{card_id}/orders | get
*CardsApi* | [**cardCreate**](docs/Api/CardsApi.md#cardcreate) | **POST** /cards | create
*CardsApi* | [**cardDelete**](docs/Api/CardsApi.md#carddelete) | **DELETE** /cards/{card_id} | delete
*CardsApi* | [**cardRetrieve**](docs/Api/CardsApi.md#cardretrieve) | **GET** /cards/{card_id} | get
*CardsApi* | [**cardUpdate**](docs/Api/CardsApi.md#cardupdate) | **POST** /cards/{card_id} | update
*CardsApi* | [**cardsList**](docs/Api/CardsApi.md#cardslist) | **GET** /cards | list
*ChecksApi* | [**checkCancel**](docs/Api/ChecksApi.md#checkcancel) | **DELETE** /checks/{chk_id} | cancel
*ChecksApi* | [**checkCreate**](docs/Api/ChecksApi.md#checkcreate) | **POST** /checks | create
*ChecksApi* | [**checkRetrieve**](docs/Api/ChecksApi.md#checkretrieve) | **GET** /checks/{chk_id} | get
*ChecksApi* | [**checksList**](docs/Api/ChecksApi.md#checkslist) | **GET** /checks | list
*IntlVerificationsApi* | [**bulkIntlVerifications**](docs/Api/IntlVerificationsApi.md#bulkintlverifications) | **POST** /bulk/intl_verifications | verifyBulk
*IntlVerificationsApi* | [**intlVerification**](docs/Api/IntlVerificationsApi.md#intlverification) | **POST** /intl_verifications | verifySingle
*LettersApi* | [**letterCancel**](docs/Api/LettersApi.md#lettercancel) | **DELETE** /letters/{ltr_id} | cancel
*LettersApi* | [**letterCreate**](docs/Api/LettersApi.md#lettercreate) | **POST** /letters | create
*LettersApi* | [**letterRetrieve**](docs/Api/LettersApi.md#letterretrieve) | **GET** /letters/{ltr_id} | get
*LettersApi* | [**lettersList**](docs/Api/LettersApi.md#letterslist) | **GET** /letters | list
*PostcardsApi* | [**postcardCreate**](docs/Api/PostcardsApi.md#postcardcreate) | **POST** /postcards | create
*PostcardsApi* | [**postcardDelete**](docs/Api/PostcardsApi.md#postcarddelete) | **DELETE** /postcards/{psc_id} | cancel
*PostcardsApi* | [**postcardRetrieve**](docs/Api/PostcardsApi.md#postcardretrieve) | **GET** /postcards/{psc_id} | get
*PostcardsApi* | [**postcardsList**](docs/Api/PostcardsApi.md#postcardslist) | **GET** /postcards | list
*ReverseGeocodeLookupsApi* | [**reverseGeocodeLookup**](docs/Api/ReverseGeocodeLookupsApi.md#reversegeocodelookup) | **POST** /us_reverse_geocode_lookups | lookup
*SelfMailersApi* | [**selfMailerCreate**](docs/Api/SelfMailersApi.md#selfmailercreate) | **POST** /self_mailers | create
*SelfMailersApi* | [**selfMailerDelete**](docs/Api/SelfMailersApi.md#selfmailerdelete) | **DELETE** /self_mailers/{sfm_id} | delete
*SelfMailersApi* | [**selfMailerRetrieve**](docs/Api/SelfMailersApi.md#selfmailerretrieve) | **GET** /self_mailers/{sfm_id} | get
*SelfMailersApi* | [**selfMailersList**](docs/Api/SelfMailersApi.md#selfmailerslist) | **GET** /self_mailers | list
*TemplateVersionsApi* | [**createTemplateVersion**](docs/Api/TemplateVersionsApi.md#createtemplateversion) | **POST** /templates/{tmpl_id}/versions | create
*TemplateVersionsApi* | [**templateVersionDelete**](docs/Api/TemplateVersionsApi.md#templateversiondelete) | **DELETE** /templates/{tmpl_id}/versions/{vrsn_id} | delete
*TemplateVersionsApi* | [**templateVersionRetrieve**](docs/Api/TemplateVersionsApi.md#templateversionretrieve) | **GET** /templates/{tmpl_id}/versions/{vrsn_id} | get
*TemplateVersionsApi* | [**templateVersionUpdate**](docs/Api/TemplateVersionsApi.md#templateversionupdate) | **POST** /templates/{tmpl_id}/versions/{vrsn_id} | update
*TemplateVersionsApi* | [**templateVersionsList**](docs/Api/TemplateVersionsApi.md#templateversionslist) | **GET** /templates/{tmpl_id}/versions | list
*TemplatesApi* | [**createTemplate**](docs/Api/TemplatesApi.md#createtemplate) | **POST** /templates | create
*TemplatesApi* | [**templateDelete**](docs/Api/TemplatesApi.md#templatedelete) | **DELETE** /templates/{tmpl_id} | delete
*TemplatesApi* | [**templateRetrieve**](docs/Api/TemplatesApi.md#templateretrieve) | **GET** /templates/{tmpl_id} | get
*TemplatesApi* | [**templateUpdate**](docs/Api/TemplatesApi.md#templateupdate) | **POST** /templates/{tmpl_id} | update
*TemplatesApi* | [**templatesList**](docs/Api/TemplatesApi.md#templateslist) | **GET** /templates | list
*USAutocompletionsApi* | [**autocompletion**](docs/Api/USAutocompletionsApi.md#autocompletion) | **POST** /us_autocompletions | autocomplete
*USVerificationsApi* | [**bulkUsVerifications**](docs/Api/USVerificationsApi.md#bulkusverifications) | **POST** /bulk/us_verifications | verifyBulk
*USVerificationsApi* | [**usVerification**](docs/Api/USVerificationsApi.md#usverification) | **POST** /us_verifications | verifySingle
*ZipLookupsApi* | [**zipLookup**](docs/Api/ZipLookupsApi.md#ziplookup) | **POST** /us_zip_lookups | lookup

## Models

- [Address](docs/Model/Address.md)
- [AddressDeletion](docs/Model/AddressDeletion.md)
- [AddressDomesticExpanded](docs/Model/AddressDomesticExpanded.md)
- [AddressEditable](docs/Model/AddressEditable.md)
- [AddressList](docs/Model/AddressList.md)
- [BankAccount](docs/Model/BankAccount.md)
- [BankAccountDeletion](docs/Model/BankAccountDeletion.md)
- [BankAccountList](docs/Model/BankAccountList.md)
- [BankAccountVerify](docs/Model/BankAccountVerify.md)
- [BankAccountWritable](docs/Model/BankAccountWritable.md)
- [BankTypeEnum](docs/Model/BankTypeEnum.md)
- [BillingGroup](docs/Model/BillingGroup.md)
- [BillingGroupEditable](docs/Model/BillingGroupEditable.md)
- [BillingGroupList](docs/Model/BillingGroupList.md)
- [Card](docs/Model/Card.md)
- [CardDeletion](docs/Model/CardDeletion.md)
- [CardEditable](docs/Model/CardEditable.md)
- [CardList](docs/Model/CardList.md)
- [CardOrder](docs/Model/CardOrder.md)
- [CardOrderEditable](docs/Model/CardOrderEditable.md)
- [CardOrderList](docs/Model/CardOrderList.md)
- [CardUpdatable](docs/Model/CardUpdatable.md)
- [Check](docs/Model/Check.md)
- [CheckDeletion](docs/Model/CheckDeletion.md)
- [CheckEditable](docs/Model/CheckEditable.md)
- [CheckList](docs/Model/CheckList.md)
- [CountryExtended](docs/Model/CountryExtended.md)
- [CountryExtendedExpanded](docs/Model/CountryExtendedExpanded.md)
- [DeliverabilityAnalysis](docs/Model/DeliverabilityAnalysis.md)
- [DpvFootnote](docs/Model/DpvFootnote.md)
- [EngineHtml](docs/Model/EngineHtml.md)
- [EventType](docs/Model/EventType.md)
- [Events](docs/Model/Events.md)
- [GeocodeAddresses](docs/Model/GeocodeAddresses.md)
- [GeocodeComponents](docs/Model/GeocodeComponents.md)
- [IntlComponents](docs/Model/IntlComponents.md)
- [IntlVerification](docs/Model/IntlVerification.md)
- [IntlVerificationOrError](docs/Model/IntlVerificationOrError.md)
- [IntlVerificationWritable](docs/Model/IntlVerificationWritable.md)
- [IntlVerifications](docs/Model/IntlVerifications.md)
- [IntlVerificationsPayload](docs/Model/IntlVerificationsPayload.md)
- [Letter](docs/Model/Letter.md)
- [LetterCustomEnvelope](docs/Model/LetterCustomEnvelope.md)
- [LetterDeletion](docs/Model/LetterDeletion.md)
- [LetterEditable](docs/Model/LetterEditable.md)
- [LetterList](docs/Model/LetterList.md)
- [LobConfidenceScore](docs/Model/LobConfidenceScore.md)
- [LobError](docs/Model/LobError.md)
- [Location](docs/Model/Location.md)
- [LocationAnalysis](docs/Model/LocationAnalysis.md)
- [MailType](docs/Model/MailType.md)
- [MultipleComponents](docs/Model/MultipleComponents.md)
- [MultipleComponentsIntl](docs/Model/MultipleComponentsIntl.md)
- [MultipleComponentsList](docs/Model/MultipleComponentsList.md)
- [Postcard](docs/Model/Postcard.md)
- [PostcardDeletion](docs/Model/PostcardDeletion.md)
- [PostcardEditable](docs/Model/PostcardEditable.md)
- [PostcardList](docs/Model/PostcardList.md)
- [PostcardSize](docs/Model/PostcardSize.md)
- [ReverseGeocode](docs/Model/ReverseGeocode.md)
- [SelfMailer](docs/Model/SelfMailer.md)
- [SelfMailerDeletion](docs/Model/SelfMailerDeletion.md)
- [SelfMailerEditable](docs/Model/SelfMailerEditable.md)
- [SelfMailerList](docs/Model/SelfMailerList.md)
- [SelfMailerSize](docs/Model/SelfMailerSize.md)
- [SendDate](docs/Model/SendDate.md)
- [SortBy](docs/Model/SortBy.md)
- [SortBy1](docs/Model/SortBy1.md)
- [SortBy2](docs/Model/SortBy2.md)
- [SortBy3](docs/Model/SortBy3.md)
- [SortBy4](docs/Model/SortBy4.md)
- [SortBy5](docs/Model/SortBy5.md)
- [Suggestions](docs/Model/Suggestions.md)
- [Template](docs/Model/Template.md)
- [TemplateDeletion](docs/Model/TemplateDeletion.md)
- [TemplateList](docs/Model/TemplateList.md)
- [TemplateUpdate](docs/Model/TemplateUpdate.md)
- [TemplateVersion](docs/Model/TemplateVersion.md)
- [TemplateVersionDeletion](docs/Model/TemplateVersionDeletion.md)
- [TemplateVersionList](docs/Model/TemplateVersionList.md)
- [TemplateVersionUpdatable](docs/Model/TemplateVersionUpdatable.md)
- [TemplateVersionWritable](docs/Model/TemplateVersionWritable.md)
- [TemplateWritable](docs/Model/TemplateWritable.md)
- [Thumbnail](docs/Model/Thumbnail.md)
- [TrackingEventCertified](docs/Model/TrackingEventCertified.md)
- [TrackingEventDetails](docs/Model/TrackingEventDetails.md)
- [TrackingEventNormal](docs/Model/TrackingEventNormal.md)
- [UsAutocompletions](docs/Model/UsAutocompletions.md)
- [UsAutocompletionsWritable](docs/Model/UsAutocompletionsWritable.md)
- [UsComponents](docs/Model/UsComponents.md)
- [UsVerification](docs/Model/UsVerification.md)
- [UsVerificationOrError](docs/Model/UsVerificationOrError.md)
- [UsVerifications](docs/Model/UsVerifications.md)
- [UsVerificationsWritable](docs/Model/UsVerificationsWritable.md)
- [Zip](docs/Model/Zip.md)
- [ZipCodeType](docs/Model/ZipCodeType.md)
- [ZipEditable](docs/Model/ZipEditable.md)
- [ZipLookupCity](docs/Model/ZipLookupCity.md)
## API Documentation

The full and comprehensive documentation of Lob's APIs is available [here](https://docs.lob.com/).

## Authorization

### basicAuth

- **Type**: HTTP basic authentication

## Tests
## Testing

Before running tests,
Before running tests,
```bash
composer install
$ composer install
```

To run unit tests
### Unit Tests

```bash
$ vendor/bin/phpunit --group unit --coverage-text --coverage-html coverage/html
```

### Integration Tests

Integration tests run against a live deployment of the Lob API and require multiple valid API keys with access to specific features. As such, it is not expected that these tests will pass for every user in every environment.

To run integration tests:

```bash
vendor/bin/phpunit --group unit --coverage-text --coverage-html coverage/html
$ LOB_API_TEST_KEY=<<YOUR TEST KEY>> LOB_API_LIVE_KEY=<<YOUR LIVE KEY>> vendor/bin/phpunit --group integration --coverage-text --coverage-html coverage/html
```

To run the tests, use:
#### A cleaner alternative if you are going to run integration tests frequently

Run this the first time:

```bash
vendor/bin/phpunit
$ echo "LOB_API_TEST_KEY=<<YOUR TEST KEY>> LOB_API_LIVE_KEY=<<YOUR LIVE KEY>>" > LOCAL.env
```

Then, to run the integration tests:

```bash
$ env $(cat LOCAL.env) vendor/bin/phpunit --group integration --coverage-text --coverage-html coverage/html
```
## Author

[email protected]
Expand Down
47 changes: 44 additions & 3 deletions test/Integration/AddressesApiSpecTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,10 @@ public function tearDown(): void
}
}

/**
* @group integration
* @group addresses
*/
public function testAddressesApiInstantiation200() {
try {
$addressApi200 = new AddressesApi(self::$config);
Expand All @@ -125,6 +129,10 @@ public function testAddressesApiInstantiation200() {
}
}

/**
* @group integration
* @group addresses
*/
public function testCreate200()
{
try {
Expand All @@ -136,14 +144,27 @@ public function testCreate200()
}
}

/**
* @group integration
* @group addresses
*/
// does not include required field in request
public function testCreate422()
{
$this->expectException(ApiException::class);
$this->expectExceptionMessageMatches("/address_line1 is required/");
$errorResponse = self::$addressApi->create(self::$errorAddress);

try {
$this->expectException(ApiException::class);
$this->expectExceptionMessageMatches("/address_line1 is required/");
$errorResponse = self::$addressApi->create(self::$errorAddress);
} catch (Exception $createError) {
echo 'Caught exception: ', $createError->getMessage(), "\n";
}
}

/**
* @group integration
* @group addresses
*/
// uses a bad key to attempt to send a request
public function testAddressApi401() {
$wrongConfig = new Configuration();
Expand All @@ -155,6 +176,10 @@ public function testAddressApi401() {
$errorResponse = $addressApiError->create(self::$editableAddress);
}

/**
* @group integration
* @group addresses
*/
public function testGet200()
{
try {
Expand All @@ -167,13 +192,21 @@ public function testGet200()
}
}

/**
* @group integration
* @group addresses
*/
public function testGet404()
{
$this->expectException(ApiException::class);
$this->expectExceptionMessageMatches("/address not found/");
$badRetrieval = self::$addressApi->get("adr_NONEXISTENT");
}

/**
* @group integration
* @group addresses
*/
public function testList200()
{
$nextUrl = "";
Expand Down Expand Up @@ -268,6 +301,10 @@ public function testListWithParams($limit, $before, $after, $include, $date_crea
}
}

/**
* @group integration
* @group addresses
*/
public function testDelete200()
{
try {
Expand All @@ -280,6 +317,10 @@ public function testDelete200()
}
}

/**
* @group integration
* @group addresses
*/
public function testDelete404()
{
$this->expectException(ApiException::class);
Expand Down
Loading