Skip to content

Latest commit

 

History

History
1373 lines (1041 loc) · 31.6 KB

CODE_SNIPPETS.md

File metadata and controls

1373 lines (1041 loc) · 31.6 KB
Raw

Code Snippets

Address Api

Retrieve

curl https://api.lob.com/v1/addresses/adr_fa85158b26c3eb7c \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\AddressesApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->get("adr_fa85158b26c3eb7c");
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Delete

curl -X DELETE "https://api.lob.com/v1/addresses/adr_43769b47aed248c2" \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\AddressesApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->delete("adr_43769b47aed248c2");
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Create

curl https://api.lob.com/v1/addresses \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
  -d "description=Harry - Office" \
  -d "name=Harry Zhang" \
  -d "company=Lob" \
  -d "[email protected]" \
  -d "phone=5555555555" \
  -d "address_line1=2261 Market Street" \
  -d "address_line2=STE 5668" \
  -d "address_city=San Francisco" \
  -d "address_state=CA" \
  -d "address_zip=94114" \
  -d "address_country=US" \
$apiInstance = new OpenAPI\Client\Api\AddressesApi($config, new GuzzleHttp\Client());
$address_editable = new OpenAPI\Client\Model\AddressEditable();
$address_editable->setDescription("Harry - Office");
$address_editable->setName("Harry Zhang");
$address_editable->setCompany("Lob");
$address_editable->setEmail("[email protected]");
$address_editable->setPhone("5555555555");
$address_editable->setAddressLine1("2261 Market Street");
$address_editable->setAddressLine2("STE 5668");
$address_editable->setAddressCity("San Francisco");
$address_editable->setAddressState("CA");
$address_editable->setAddressZip("94114");
$address_editable->setAddressCountry("US");

try {
    $result = $apiInstance->create($address_editable);
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

List

curl -X GET "https://api.lob.com/v1/addresses?limit=2" \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\AddressesApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->list(
      2, // limit 
      includeList, // include 
      dateCreated, // dateCreated 
      metadata, // metadata 
    );
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Postcards Api

Retrieve

curl https://api.lob.com/v1/postcards/psc_5c002b86ce47537a \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\PostcardsApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->get("psc_5c002b86ce47537a");
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Delete

curl -X DELETE "https://api.lob.com/v1/postcards/psc_5c002b86ce47537a" \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\PostcardsApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->cancel("psc_5c002b86ce47537a");
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Create

curl https://api.lob.com/v1/postcards \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
  -d "description=Demo Postcard job" \
  -d "from=adr_210a8d4b0b76d77b" \
  --data-urlencode "front=<html style='padding: 1in; font-size: 50;'>Front HTML for {{name}}</html>" \
  --data-urlencode "back=<html style='padding: 1in; font-size: 20;'>Back HTML for {{name}}</html>" \
  -d "to[name]=Harry Zhang" \
  -d "to[address_line1]=2261 Market Street" \
  -d "to[address_line2]=STE 5668" \
  -d "to[address_city]=San Francisco" \
  -d "to[address_state]=CA" \
  -d "to[address_zip]=94114" \
  -d "merge_variables[name]=Harry" \
$to = new OpenAPI\Client\Model\AddressEditable(
  array(
    "name"     => "Harry Zhang",
    "address_line1"     => "2261 Market Street",
    "address_line2"     => "STE 5668",
    "address_city"     => "San Francisco",
    "address_state"     => "CA",
    "address_zip"     => "94114",
  )
);

$merge_variables = new stdClass;
$merge_variables->name = "Harry";

$apiInstance = new OpenAPI\Client\Api\PostcardsApi($config, new GuzzleHttp\Client());
$postcard_editable = new OpenAPI\Client\Model\PostcardEditable();
$postcard_editable->setDescription("Demo Postcard job");
$postcard_editable->setFrom("adr_210a8d4b0b76d77b");
$postcard_editable->setFront("<html style='padding: 1in; font-size: 50;'>Front HTML for {{name}}</html>");
$postcard_editable->setBack("<html style='padding: 1in; font-size: 20;'>Back HTML for {{name}}</html>");
$postcard_editable->setTo($to);
$postcard_editable->setMergeVariables($merge_variables);

try {
    $result = $apiInstance->create($postcard_editable);
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

List

curl -X GET "https://api.lob.com/v1/postcards?limit=2" \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\PostcardsApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->list(
      2, // limit 
      includeList, // include 
      dateCreated, // dateCreated 
      metadata, // metadata 
      sizeArray, // size 
      true, // scheduled 
      sendDate, // sendDate 
      , // mailType 
      sortBy, // sortBy 
    );
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

SelfMailers Api

Retrieve

curl https://api.lob.com/v1/self_mailers/sfm_8ffbe811dea49dcf \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\SelfMailersApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->get("sfm_8ffbe811dea49dcf");
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Delete

curl -X DELETE "https://api.lob.com/v1/self_mailers/sfm_8ffbe811dea49dcf" \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\SelfMailersApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->delete("sfm_8ffbe811dea49dcf");
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Create

curl https://api.lob.com/v1/self_mailers \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
  -d "description=Demo Self Mailer job" \
  -d "from=adr_210a8d4b0b76d77b" \
  --data-urlencode "inside=<html style='padding: 1in; font-size: 50;'>Inside HTML for {{name}}</html>" \
  --data-urlencode "outside=<html style='padding: 1in; font-size: 20;'>Outside HTML for {{name}}</html>" \
  -d "to[name]=Harry Zhang" \
  -d "to[address_line1]=2261 Market Street" \
  -d "to[address_line2]=STE 5668" \
  -d "to[address_city]=San Francisco" \
  -d "to[address_state]=CA" \
  -d "to[address_zip]=94114" \
  -d "merge_variables[name]=Harry" \
$to = new OpenAPI\Client\Model\AddressEditable(
  array(
    "name"     => "Harry Zhang",
    "address_line1"     => "2261 Market Street",
    "address_line2"     => "STE 5668",
    "address_city"     => "San Francisco",
    "address_state"     => "CA",
    "address_zip"     => "94114",
  )
);

$merge_variables = new stdClass;
$merge_variables->name = "Harry";

$apiInstance = new OpenAPI\Client\Api\SelfMailersApi($config, new GuzzleHttp\Client());
$self_mailer_editable = new OpenAPI\Client\Model\SelfMailerEditable();
$self_mailer_editable->setDescription("Demo Self Mailer job");
$self_mailer_editable->setFrom("adr_210a8d4b0b76d77b");
$self_mailer_editable->setInside("<html style='padding: 1in; font-size: 50;'>Inside HTML for {{name}}</html>");
$self_mailer_editable->setOutside("<html style='padding: 1in; font-size: 20;'>Outside HTML for {{name}}</html>");
$self_mailer_editable->setTo($to);
$self_mailer_editable->setMergeVariables($merge_variables);

try {
    $result = $apiInstance->create($self_mailer_editable);
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

List

curl -X GET "https://api.lob.com/v1/self_mailers?limit=2" \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\SelfMailersApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->list(
      2, // limit 
      includeList, // include 
      dateCreated, // dateCreated 
      metadata, // metadata 
      null, // size 
      true, // scheduled 
      sendDate, // sendDate 
      , // mailType 
      sortBy, // sortBy 
    );
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Letters Api

Retrieve

curl https://api.lob.com/v1/letters/ltr_4868c3b754655f90 \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\LettersApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->get("ltr_4868c3b754655f90");
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Delete

curl -X DELETE "https://api.lob.com/v1/letters/ltr_4868c3b754655f90" \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\LettersApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->cancel("ltr_4868c3b754655f90");
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Create

curl https://api.lob.com/v1/letters \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
  -d "description=Demo Letter" \
  -d "from=adr_210a8d4b0b76d77b" \
  --data-urlencode "file=<html style='padding-top: 3in; margin: .5in;'>HTML Letter for {{name}}</html>" \
  -d "color=true" \
  -d "to[name]=Harry Zhang" \
  -d "to[address_line1]=2261 Market Street" \
  -d "to[address_line2]=STE 5668" \
  -d "to[address_city]=San Francisco" \
  -d "to[address_state]=CA" \
  -d "to[address_zip]=94114" \
  -d "merge_variables[name]=Harry" \
  -d "cards[]=card_c51ae96f5cebf3e"
$to = new OpenAPI\Client\Model\AddressEditable(
  array(
    "name"     => "Harry Zhang",
    "address_line1"     => "2261 Market Street",
    "address_line2"     => "STE 5668",
    "address_city"     => "San Francisco",
    "address_state"     => "CA",
    "address_zip"     => "94114",
  )
);

$merge_variables = new stdClass;
$merge_variables->name = "Harry";

$apiInstance = new OpenAPI\Client\Api\LettersApi($config, new GuzzleHttp\Client());
$letter_editable = new OpenAPI\Client\Model\LetterEditable();
$letter_editable->setDescription("Demo Letter");
$letter_editable->setFrom("adr_210a8d4b0b76d77b");
$letter_editable->setFile("<html style='padding-top: 3in; margin: .5in;'>HTML Letter for {{name}}</html>");
$letter_editable->setColor("true");
$letter_editable->setTo($to);
$letter_editable->setMergeVariables($merge_variables);
$letter_editable->setCards(array(
  "card_c51ae96f5cebf3e",
));

try {
    $result = $apiInstance->create($letter_editable);
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

List

curl -X GET "https://api.lob.com/v1/letters?limit=2" \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\LettersApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->list(
      2, // limit 
      includeList, // include 
      dateCreated, // dateCreated 
      metadata, // metadata 
      true, // scheduled 
      sendDate, // sendDate 
      , // mailType 
      sortBy, // sortBy 
    );
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Checks Api

Retrieve

curl https://api.lob.com/v1/checks/chk_534f10783683daa0 \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\ChecksApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->get("chk_534f10783683daa0");
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Delete

curl -X DELETE "https://api.lob.com/v1/checks/chk_534f10783683daa0" \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\ChecksApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->cancel("chk_534f10783683daa0");
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Create

curl https://api.lob.com/v1/checks \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
  -d "description=Demo Check" \
  -d "bank_account=bank_8cad8df5354d33f" \
  -d "amount=22.5" \
  -d "memo=rent" \
  --data-urlencode "logo=https://s3-us-west-2.amazonaws.com/public.lob.com/assets/check_logo.png" \
  --data-urlencode "check_bottom=<h1 style='padding-top:4in;'>Demo Check for {{name}}</h1>" \
  -d "from=adr_210a8d4b0b76d77b" \
  -d "to[name]=Harry Zhang" \
  -d "to[address_line1]=2261 Market Street" \
  -d "to[address_line2]=STE 5668" \
  -d "to[address_city]=San Francisco" \
  -d "to[address_state]=CA" \
  -d "to[address_zip]=94114" \
  -d "merge_variables[name]=Harry" \
$to = new OpenAPI\Client\Model\AddressDomestic(
  array(
    "name"     => "Harry Zhang",
    "address_line1"     => "2261 Market Street",
    "address_line2"     => "STE 5668",
    "address_city"     => "San Francisco",
    "address_state"     => "CA",
    "address_zip"     => "94114",
  )
);

$merge_variables = new stdClass;
$merge_variables->name = "Harry";

$apiInstance = new OpenAPI\Client\Api\ChecksApi($config, new GuzzleHttp\Client());
$check_editable = new OpenAPI\Client\Model\CheckEditable();
$check_editable->setDescription("Demo Check");
$check_editable->setBankAccount("bank_8cad8df5354d33f");
$check_editable->setAmount("22.5");
$check_editable->setMemo("rent");
$check_editable->setLogo("https://s3-us-west-2.amazonaws.com/public.lob.com/assets/check_logo.png");
$check_editable->setCheckBottom("<h1 style='padding-top:4in;'>Demo Check for {{name}}</h1>");
$check_editable->setFrom("adr_210a8d4b0b76d77b");
$check_editable->setTo($to);
$check_editable->setMergeVariables($merge_variables);

try {
    $result = $apiInstance->create($check_editable);
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

List

curl -X GET "https://api.lob.com/v1/checks?limit=2" \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\ChecksApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->list(
      2, // limit 
      includeList, // include 
      dateCreated, // dateCreated 
      metadata, // metadata 
      true, // scheduled 
      sendDate, // sendDate 
      , // mailType 
      sortBy, // sortBy 
    );
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

BankAccounts Api

Retrieve

curl https://api.lob.com/v1/bank_accounts/bank_8cad8df5354d33f \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\BankAccountsApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->get("bank_8cad8df5354d33f");
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Delete

curl -X DELETE "https://api.lob.com/v1/bank_accounts/bank_3e64d9904356b20" \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\BankAccountsApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->delete("bank_3e64d9904356b20");
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

List

curl -X GET "https://api.lob.com/v1/bank_accounts?limit=2" \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\BankAccountsApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->list(
      2, // limit 
      includeList, // include 
      dateCreated, // dateCreated 
      metadata, // metadata 
    );
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Verify

curl https://api.lob.com/v1/bank_accounts/bank_dfceb4a2a05b57e/verify \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \ 
  -d "amounts[]=25" \ 
  -d "amounts[]=63" \ 
$apiInstance = new OpenAPI\Client\Api\BankAccountsApi($config, new GuzzleHttp\Client());

$bankVerify = new OpenAPI\Client\Model\BankAccountVerify();
$bankVerify->setAmounts([
  25,
  63,
]);

try {
    $result = $apiInstance->verify(
      "bank_dfceb4a2a05b57e", $bankVerify
    );
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Create

curl https://api.lob.com/v1/bank_accounts \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
  -d "description=Test Bank Account" \
  -d "routing_number=322271627" \
  -d "account_number=123456789" \
  -d "signatory=John Doe" \
  -d "account_type=company" \
$apiInstance = new OpenAPI\Client\Api\BankAccountsApi($config, new GuzzleHttp\Client());
$bank_account_writable = new OpenAPI\Client\Model\BankAccountWritable();
$bank_account_writable->setDescription("Test Bank Account");
$bank_account_writable->setRoutingNumber("322271627");
$bank_account_writable->setAccountNumber("123456789");
$bank_account_writable->setSignatory("John Doe");
$bank_account_writable->setAccountType("company");

try {
    $result = $apiInstance->create($bank_account_writable);
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Templates Api

Retrieve

curl https://api.lob.com/v1/templates/tmpl_c94e83ca2cd5121 \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\TemplatesApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->get("tmpl_c94e83ca2cd5121");
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Delete

curl -X DELETE "https://api.lob.com/v1/templates/tmpl_df934eeda694203" \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\TemplatesApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->delete("tmpl_df934eeda694203");
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

List

curl -X GET "https://api.lob.com/v1/templates?limit=2" \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\TemplatesApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->list(
      2, // limit 
      includeList, // include 
      dateCreated, // dateCreated 
      metadata, // metadata 
    );
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Update

curl https://api.lob.com/v1/templates/tmpl_c94e83ca2cd5121 \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
  -d "description=Updated description" \
  -d "published_version=vrsn_362184d96d9b0c9"
$apiInstance = new OpenAPI\Client\Api\TemplatesApi($config, new GuzzleHttp\Client());

$templateUpdate = new OpenAPI\Client\Model\TemplateUpdate(array(
    "description" =>  "Updated description",
    "published_version" =>  "vrsn_362184d96d9b0c9"
));

try {
    $result = $apiInstance->update("tmpl_c94e83ca2cd5121", $templateUpdate);
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Create

curl https://api.lob.com/v1/templates \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
  -d "description=Test Template" \
  --data-urlencode "html=<html>HTML for {{name}}</html>" \
$apiInstance = new OpenAPI\Client\Api\TemplatesApi($config, new GuzzleHttp\Client());
$template_writable = new OpenAPI\Client\Model\TemplateWritable();
$template_writable->setDescription("Test Template");
$template_writable->setHtml("<html>HTML for {{name}}</html>");

try {
    $result = $apiInstance->create($template_writable);
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

TemplateVersions Api

Retrieve

curl https://api.lob.com/v1/templates/tmpl_c94e83ca2cd5121/versions/vrsn_534e339882d2282 \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\TemplateVersionsApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->get("tmpl_c94e83ca2cd5121", "vrsn_534e339882d2282");
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Delete

curl -X DELETE "https://api.lob.com/v1/templates/tmpl_4aa14648113e45b/versions/vrsn_534e339882d2282" \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\TemplateVersionsApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->delete("tmpl_4aa14648113e45b", "vrsn_534e339882d2282");
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

List

curl -X GET "https://api.lob.com/v1/templates/tmpl_dadaaf7b76c9f25/versions?limit=2" \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
$apiInstance = new OpenAPI\Client\Api\TemplateVersionsApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->list(
      "tmpl_dadaaf7b76c9f25", // tmplId 
      2, // limit 
      includeList, // include 
      dateCreated, // dateCreated 
    );
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Update

curl https://api.lob.com/v1/templates/tmpl_c94e83ca2cd5121/versions/vrsn_534e339882d2282 \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
  -d "description=Updated description"
$apiInstance = new OpenAPI\Client\Api\TemplateVersionsApi($config, new GuzzleHttp\Client());

$templateVersionUpdate = new OpenAPI\Client\Model\TemplateUpdate(array(
    "description" =>  "Updated template version"
));

try {
    $result = $apiInstance->update("tmpl_c94e83ca2cd5121", "vrsn_534e339882d2282", $templateVersionUpdate);
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Create

curl https://api.lob.com/v1/templates/tmpl_4aa14648113e45b/versions \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
  -d "description=Second Version" \
  --data-urlencode "html=<html>Second HTML for {{name}}</html>" \
$apiInstance = new OpenAPI\Client\Api\TemplateVersionsApi($config, new GuzzleHttp\Client());
$template_version_writable = new OpenAPI\Client\Model\TemplateVersionWritable();
$template_version_writable->setDescription("Second Version");
$template_version_writable->setHtml("<html>Second HTML for {{name}}</html>");

try {
    $result = $apiInstance->create("tmpl_4aa14648113e45b", $template_version_writable);
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Creatives Api

Update

curl -X PATCH https://api.lob.com/v1/crv_2a3b096c409b32c \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
  -d "description=Our updated 4x6 postcard creative" \

$apiInstance = new OpenAPI\Client\Api\CreativesApi($config, new GuzzleHttp\Client());

$creativeUpdate = new OpenAPI\Client\Model\CreativePatch(); $creativeUpdate->setDescription("Updated creative");

try { $result = $apiInstance->update("crv_2a3b096c409b32c", $creativeUpdate); print_r($result); } catch (Exception $e) { echo $e->getMessage(), PHP_EOL; }


### Retrieve
```bash
curl https://api.lob.com/v1/creatives/crv_2a3b096c409b32c \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:

$apiInstance = new OpenAPI\Client\Api\CreativesApi($config, new GuzzleHttp\Client());

try {
    $result = $apiInstance->get("crv_2a3b096c409b32c");
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Create

curl https://api.lob.com/v1/creatives \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
  -d "campaign_id=cmp_e05ee61ff80764b" \
  -d "resource_type=postcard" \
  -d "description=Our 4x6 postcard creative" \
  -d "from=adr_210a8d4b0b76d77b" \
  -d "front=tmpl_4aa14648113e45b" \
  -d "back=tmpl_4aa14648113e45b" \
  -d "details[mail_type]=usps_first_class" \
$details = new OpenAPI\Client\Model\PostcardDetailsWritable(
  array(
    "mail_type"     => "usps_first_class",
  )
);

$apiInstance = new OpenAPI\Client\Api\CreativesApi($config, new GuzzleHttp\Client());
$creative_writable = new OpenAPI\Client\Model\CreativeWritable();
$creative_writable->setCampaignId("cmp_e05ee61ff80764b");
$creative_writable->setResourceType("postcard");
$creative_writable->setDescription("Our 4x6 postcard creative");
$creative_writable->setFrom("adr_210a8d4b0b76d77b");
$creative_writable->setFront("tmpl_4aa14648113e45b");
$creative_writable->setBack("tmpl_4aa14648113e45b");
$creative_writable->setDetails($details);

try {
    $result = $apiInstance->create($creative_writable);
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

IntlVerifications Api

Single Verify

curl https://api.lob.com/v1/intl_verifications \
  -u <YOUR_LIVE_API_KEY>: \
  -d "primary_line=370 Water St" \
  -d "city=Summerside" \
  -d "state=Prince Edward Island" \
  -d "postal_code=C1N 1C4" \
  -d "country=CA" \
$apiInstance = new OpenAPI\Client\Api\IntlVerificationsApi($config, new GuzzleHttp\Client());

$verificationData = new OpenAPI\Client\Model\IntlVerificationWritable(array(
  'primary_line'     => '370 Water St',
  'city'     => 'Summerside',
  'state'     => 'Prince Edward Island',
  'postal_code'     => 'C1N 1C4',
  'country'     => 'CA',
));

try {
    $result = $apiInstance->verifySingle($verificationData);
        print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Bulk Verify

curl https://api.lob.com/v1/bulk/intl_verifications \
  -u <YOUR LIVE API KEY>: \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'addresses[0][primary_line]=35 Tower Hill' \
  --data-urlencode 'addresses[0][city]=London' \
  --data-urlencode 'addresses[0][postal_code]=EC3N 4DR' \
  --data-urlencode 'addresses[0][country]=GB' \
  --data-urlencode 'addresses[1][primary_line]=370 Water St' \
  --data-urlencode 'addresses[1][city]=Summerside' \
  --data-urlencode 'addresses[1][state]=Prince Edward Island' \
  --data-urlencode 'addresses[1][postal_code]=C1N 1C4' \
  --data-urlencode 'addresses[1][country]=CA' \
$verificationData0 = new OpenAPI\Client\Model\MultipleComponentsIntl(array( 
  'primary_line'     => '35 Tower Hill',
  'city'     => 'London',
  'postal_code'     => 'EC3N 4DR',
  'country'     => 'GB',
));

$verificationData1 = new OpenAPI\Client\Model\MultipleComponentsIntl(array( 
  'primary_line'     => '370 Water St',
  'city'     => 'Summerside',
  'state'     => 'Prince Edward Island',
  'postal_code'     => 'C1N 1C4',
  'country'     => 'CA',
));

$addressList = new OpenAPI\Client\Model\IntlVerificationsPayload(array(
  'addresses'     => [
    $verificationData0,
    $verificationData1,
  ]
));

try {
    $result = $apiInstance->verifyBulk($addressList);
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

UsVerifications Api

Bulk Verify

curl https://api.lob.com/v1/bulk/us_verifications \
  -u <YOUR LIVE API KEY>: \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'addresses[0][primary_line]=2261 Market Street' \
  --data-urlencode 'addresses[0][city]=San Francisco' \
  --data-urlencode 'addresses[0][state]=CA' \
  --data-urlencode 'addresses[0][zip_code]=94114' \
  --data-urlencode 'addresses[1][primary_line]=185 BERRY ST STE 6600' \
  --data-urlencode 'addresses[1][city]=SAN FRANCISCO' \
  --data-urlencode 'addresses[1][state]=CA' \
  --data-urlencode 'addresses[1][zip_code]=94017' \
$verificationData0 = new OpenAPI\Client\Model\MultipleComponents(array( 
  'primary_line'     => '2261 Market Street',
  'city'     => 'San Francisco',
  'state'     => 'CA',
  'zip_code'     => '94114',
));

$verificationData1 = new OpenAPI\Client\Model\MultipleComponents(array( 
  'primary_line'     => '185 BERRY ST STE 6600',
  'city'     => 'SAN FRANCISCO',
  'state'     => 'CA',
  'zip_code'     => '94017',
));

$addressList = new OpenAPI\Client\Model\MultipleComponentsList(array(
  'addresses'     => [
    $verificationData0,
    $verificationData1,
  ]
));

try {
    $result = $apiInstance->verifyBulk($addressList);
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Single Verify

curl https://api.lob.com/v1/us_verifications \
  -u <YOUR_LIVE_API_KEY>: \
  -d "primary_line=2261 Market Street" \
  -d "city=San Francisco" \
  -d "state=CA" \
  -d "zip_code=94114" \
$apiInstance = new OpenAPI\Client\Api\UsVerificationsApi($config, new GuzzleHttp\Client());

$verificationData = new OpenAPI\Client\Model\UsVerificationsWritable(array(
  'primary_line'     => '2261 Market Street',
  'city'     => 'San Francisco',
  'state'     => 'CA',
  'zip_code'     => '94114',
));

try {
    $result = $apiInstance->verifySingle($verificationData);
        print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

IntlAutocompletion Api

IntlAutocompletion

curl https://api.lob.com/v1/intl_autocompletions \
  -u <YOUR_LIVE_API_KEY>: \
  -d "address_prefix=340 Wat" \
  -d "city=Summerside" \
  -d "state=Prince Edward Island" \
  -d "zip_code=C1N 1C4" \
  -d "country=CA" \
$apiInstance = new OpenAPI\Client\Api\IntlAutocompletionsApi($config, new GuzzleHttp\Client());

$autoCompletionData = new OpenAPI\Client\Model\IntlAutocompletionsWritable(array(
    "address_prefix" =>  "340 Wat",
    "city" =>  "Summerside",
    "state" =>  "Prince Edward Island",
    "zip_code" =>  "C1N 1C4",
    "country" =>  "CA",
));

try {
    $result = $apiInstance->autocomplete($autoCompletionData);
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

ZipLookups Api

ZipLookup

curl https://api.lob.com/v1/us_zip_lookups \
  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
  -d "zip_code=94107"
$apiInstance = new OpenAPI\Client\Api\ZipLookupsApi($config, new GuzzleHttp\Client());

$zipRequest = new OpenAPI\Client\Model\ZipEditable(array(
    "zip_code"  =>  '94107'
));

try {
    $result = $apiInstance->lookup($zipRequest);
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Reverse Geocode Lookups Api

Reverse Geocode Lookup

curl https://api.lob.com/v1/us_reverse_geocode_lookups \
  -u <YOUR_LIVE_API_KEY>: \

  -d "latitude=37.777456" \

  -d "longitude=-122.393039" \
$apiInstance = new OpenAPI\Client\Api\ReverseGeocodeLookupsApi($config, new GuzzleHttp\Client());

$coordinates = new OpenAPI\Client\Model\Location(array(
    "latitude" =>  "37.777456",
    "longitude" =>  "-122.393039",
));

try {
    $result = $apiInstance->lookup($coordinates);
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

USAutoCompletions Api

Autocomplete

curl https://api.lob.com/v1/us_autocompletions \
  -u <YOUR_LIVE_API_KEY>: \
  -d "address_prefix=185 B" \
  -d "city=San Francisco" \
  -d "state=CA" \
  -d "zip_code=94017" \
$apiInstance = new OpenAPI\Client\Api\UsAutocompletionsApi($config, new GuzzleHttp\Client());

$autocompletionData = new OpenAPI\Client\Model\UsAutocompletionsWritable(array(
    "address_prefix" =>  "185 B",
    "city" =>  "San Francisco",
    "state" =>  "CA",
    "zip_code" =>  "94017",
));

try {
    $result = $apiInstance->autocomplete($autocompletionData);
    print_r($result);
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}