Skip to content

Update example addresses in documentation #528

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

Open
benjaminkitt wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update example addresses in documentation #528

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions lob-api-public.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
openapi: 3.0.3

Check warning on line 1 in lob-api-public.yml

View workflow job for this annotation

GitHub Actions / Lint (push)

oas3-valid-media-example 

This format violates OpenAPI 3.1 rules
info:
title: Lob
version: 1.20.9
Expand Down Expand Up @@ -994,7 +994,7 @@
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Getting Started
x-traitTag: true
description: |

Check warning on line 997 in lob-api-public.yml

View workflow job for this annotation

GitHub Actions / Lint (push)

no-script-tags-in-markdown 

Markdown descriptions must not have "<script>" tags.
### 1. Get Setup
* Create an account at <a href="https://dashboard.lob.com/#/register" target="_blank">Lob.com</a>
* Obtain your API keys in the Lob dashboard <a href="https://dashboard.lob.com/settings/api-keys" target="_blank">settings</a>
Expand Down Expand Up @@ -1442,7 +1442,7 @@


```javascript
primary_line=210 King Street&city=San Francisco&state=CA&zip_code=94107
primary_line=42 Example Road&city=Anytown&state=MA&zip_code=02134
```

### JSON
Expand All @@ -1454,10 +1454,10 @@

```javascript
{
"primary_line": "210 King Street",
"city": "San Francisco",
"state": "CA",
"zip_code": "94107"
"primary_line": "42 Example Road",
"city": "Anytown",
"state": "MA",
"zip_code": "02134"
}
```

Expand Down
84 changes: 42 additions & 42 deletions resources/addresses/addresses.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,11 +158,11 @@ post:
company: "Lob"
email: "harry@lob.com"
phone: "5555555555"
address_line1: "210 King St"
address_line1: "42 Example Rd"
address_line2: "# 6100"
address_city: "San Francisco"
address_state: "CA"
address_zip: "94107"
address_city: "Anytown"
address_state: "MA"
address_zip: "02134"
address_country: "US"
ncoa_us_test:
value:
Expand Down Expand Up @@ -202,11 +202,11 @@ post:
company: "Lob"
email: "harry@lob.com"
phone: "5555555555"
address_line1: "210 King St"
address_line1: "42 Example Rd"
address_line2: "# 6100"
address_city: "San Francisco"
address_state: "CA"
address_zip: "94107"
address_city: "Anytown"
address_state: "MA"
address_zip: "02134"
address_country: "US"
ncoa_us_test:
value:
Expand Down Expand Up @@ -300,11 +300,11 @@ post:
-d "company=Lob" \
-d "email=harry@lob.com" \
-d "phone=5555555555" \
-d "address_line1=210 King St" \
-d "address_line1=42 Example Rd" \
-d "address_line2=# 6100" \
-d "address_city=San Francisco" \
-d "address_state=CA" \
-d "address_zip=94107" \
-d "address_city=Anytown" \
-d "address_state=MA" \
-d "address_zip=02134" \
-d "address_country=US"
label: CURL
- lang: Typescript
Expand All @@ -315,11 +315,11 @@ post:
company: 'Lob',
email: 'harry@lob.com',
phone: '5555555555',
address_line1: '210 King St',
address_line1: '42 Example Rd',
address_line2: '# 6100',
address_city: 'San Francisco',
address_state: 'CA',
address_zip: '94107',
address_city: 'Anytown',
address_state: 'MA',
address_zip: '02134',
address_country: 'US'
});

Expand All @@ -337,11 +337,11 @@ post:
company: 'Lob',
email: 'harry@lob.com',
phone: '5555555555',
address_line1: '210 King St',
address_line1: '42 Example Rd',
address_line2: '# 6100',
address_city: 'San Francisco',
address_state: 'CA',
address_zip: '94107',
address_city: 'Anytown',
address_state: 'MA',
address_zip: '02134',
address_country: 'US'
}, function (err, res) {
console.log(err, res);
Expand All @@ -355,11 +355,11 @@ post:
company: "Lob",
email: "harry@lob.com",
phone: "5555555555",
address_line1: "210 King St",
address_line1: "42 Example Rd",
address_line2: "# 6100",
address_city: "San Francisco",
address_state: "CA",
address_zip: "94107",
address_city: "Anytown",
address_state: "MA",
address_zip: "02134",
address_country: "US",
});

Expand All @@ -379,11 +379,11 @@ post:
company = "Lob",
email = "harry@lob.com",
phone = "5555555555",
address_line1 = "210 King St",
address_line1 = "42 Example Rd",
address_line2 = "# 6100",
address_city = "San Francisco",
address_state = "CA",
address_zip = "94107",
address_city = "Anytown",
address_state = "MA",
address_zip = "02134",
address_country = CountryExtended("US"),
)

Expand All @@ -406,11 +406,11 @@ post:
"company" => "Lob",
"email" => "harry@lob.com",
"phone" => "5555555555",
"address_line1" => "210 King St",
"address_line1" => "42 Example Rd",
"address_line2" => "# 6100",
"address_city" => "San Francisco",
"address_state" => "CA",
"address_zip" => "94107",
"address_city" => "Anytown",
"address_state" => "MA",
"address_zip" => "02134",
"address_country" => "US",
)
);
Expand All @@ -431,11 +431,11 @@ post:
addressEditable.setCompany("Lob");
addressEditable.setEmail("harry@lob.com");
addressEditable.setPhone("5555555555");
addressEditable.setAddressLine1("210 King St");
addressEditable.setAddressLine1("42 Example Rd");
addressEditable.setAddressLine2("# 6100");
addressEditable.setAddressCity("San Francisco");
addressEditable.setAddressState("CA");
addressEditable.setAddressZip("94107");
addressEditable.setAddressCity("Anytown");
addressEditable.setAddressState("MA");
addressEditable.setAddressZip("02134");
addressEditable.setAddressCountry(CountryExtended.US);

Address result = apiInstance.create(addressEditable);
Expand Down Expand Up @@ -466,9 +466,9 @@ post:
AddressEditable addressEditable = new AddressEditable(
"210 King St", // addressLine1
"# 6100", // addressLine2
"San Francisco", // addressCity
"CA", // addressState
"94107", // addressZip
"Anytown", // addressCity
"MA", // addressState
"02134", // addressZip
CountryExtended.US, // addressCountry
"Harry - Office", // description
"Harry Zhang", // name
Expand Down Expand Up @@ -499,9 +499,9 @@ post:
addressCreate.SetPhone("5555555555")
addressCreate.SetAddressLine1("210 King St")
addressCreate.SetAddressLine2("# 6100")
addressCreate.SetAddressCity("San Francisco")
addressCreate.SetAddressState("CA")
addressCreate.SetAddressZip("94107")
addressCreate.SetAddressCity("Anytown")
addressCreate.SetAddressState("MA")
addressCreate.SetAddressZip("02134")
addressCreate.SetAddressCountry("US")


Expand Down
6 changes: 3 additions & 3 deletions resources/addresses/responses/all_addresses.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ content:
email: harry@lob.com
address_line1: 210 KING ST STE 6100
address_line2:
address_city: SAN FRANCISCO
address_state: CA
address_zip: 94107-1741
address_city: ANYTOWN
address_state: MA
address_zip: 02134
address_country: UNITED STATES
metadata: {}
date_created: "2019-08-12T00:16:00.361Z"
Expand Down
8 changes: 4 additions & 4 deletions resources/addresses/responses/post_address.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ content:
phone: "5555555555"
email: "harry@lob.com"
address_line1: "210 KING ST STE 6100"
address_city: "SAN FRANCISCO"
address_state: "CA"
address_zip: "94107"
address_city: "ANYTOWN"
address_state: "MA"
address_zip: "02134"
address_country: "UNITED STATES"
metadata: {}
date_created: "2017-09-05T17:47:53.767Z"
Expand Down Expand Up @@ -58,7 +58,7 @@ content:
email: "harry@lob.com"
address_line1: "████"
address_line2: "████"
address_city: "SAN FRANCISCO"
address_city: "ANYTOWN"
address_state: "CA"
address_zip: "94107"
address_country: "UNITED STATES"
Expand Down
40 changes: 20 additions & 20 deletions resources/booklets/booklets.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
creation date, with the most recently created booklets appearing first.

tags:
- Booklets

Check warning on line 11 in resources/booklets/booklets.yml

View workflow job for this annotation

GitHub Actions / Lint (push)

operation-tag-defined 

Operation tags must be defined in global tags.

parameters:
- $ref: "../../shared/parameters/limit.yml"
Expand Down Expand Up @@ -45,7 +45,7 @@
Creates a new booklet.

tags:
- Booklets

Check warning on line 48 in resources/booklets/booklets.yml

View workflow job for this annotation

GitHub Actions / Lint (push)

operation-tag-defined 

Operation tags must be defined in global tags.

parameters:
- $ref: "../../shared/parameters/idempotency.yml#/idem-header"
Expand All @@ -65,19 +65,19 @@
company: "Lob"
email: "harry@lob.com"
phone: "5555555555"
address_line1: "210 King St"
address_line1: "42 Example Rd"
address_line2: "# 6100"
address_city: "San Francisco"
address_state: "CA"
address_zip: "94107"
address_city: "Anytown"
address_state: "MA"
address_zip: "02134"
address_country: "US"
from:
name: Harry
address_line1: 210 King St
address_line1: 42 Example Rd
address_line2: "# 6100"
address_city: San Francisco
address_state: CA
address_zip: "94107"
address_city: Anytown
address_state: MA
address_zip: "02134"
file: "<html style='padding-top: 3in; margin: .5in;'>HTML Booklet for {{name}}</html>"
mail_type: usps_first_class
merge_variables:
Expand Down Expand Up @@ -108,19 +108,19 @@
company: "Lob"
email: "harry@lob.com"
phone: "5555555555"
address_line1: "210 King St"
address_line1: "42 Example Rd"
address_line2: "# 6100"
address_city: "San Francisco"
address_state: "CA"
address_zip: "94107"
address_city: "Anytown"
address_state: "MA"
address_zip: "02134"
address_country: "US"
from:
name: Harry
address_line1: 210 King St
address_line1: 42 Example Rd
address_line2: "# 6100"
address_city: San Francisco
address_state: CA
address_zip: "94107"
address_city: Anytown
address_state: MA
address_zip: "02134"
file: "<html style='padding-top: 3in; margin: .5in;'>HTML Booklet for {{name}}</html>"
mail_type: usps_first_class
merge_variables:
Expand Down Expand Up @@ -197,11 +197,11 @@
-u YOUR_API_KEY \
-d 'description=Demo Booklet' \
-d 'to[name]=Harry Zhang' \
-d 'to[address_line1]=210 King St' \
-d 'to[address_line1]=42 Example Rd' \
-d 'to[address_line2]=# 6100' \
-d 'to[address_city]=San Francisco' \
-d 'to[address_state]=CA' \
-d 'to[address_zip]=94107' \
-d 'to[address_city]=Anytown' \
-d 'to[address_state]=MA' \
-d 'to[address_zip]=02134' \
-d 'from=adr_210a8d4b0b76d77b' \
--data-urlencode 'file=<html style="padding-top: 3in; margin: .5in;">HTML Booklet for {{name}}</html>' \
-d 'merge_variables[name]=Harry' \
Expand Down
18 changes: 9 additions & 9 deletions resources/booklets/responses/all_booklets.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ content:
company: null
phone: null
email: null
address_line1: 210 KING ST STE 6100
address_line1: 42 EXAMPLE RD STE 6100
address_line2: null
address_city: SAN FRANCISCO
address_city: ANYTOWN
address_state: CA
address_zip: 94107-1741
address_zip: 02134
address_country: UNITED STATES
metadata: {}
date_created: "2017-09-05T15:54:53.264Z"
Expand All @@ -50,11 +50,11 @@ content:
company: null
phone: null
email: null
address_line1: 210 KING ST STE 6100
address_line1: 42 EXAMPLE RD STE 6100
address_line2: null
address_city: SAN FRANCISCO
address_city: ANYTOWN
address_state: CA
address_zip: 94107-1741
address_zip: 02134
address_country: UNITED STATES
metadata: {}
date_created: "2017-09-05T15:54:53.264Z"
Expand Down Expand Up @@ -110,11 +110,11 @@ content:
company: LOB
phone: null
email: null
address_line1: 210 KING ST STE 6100
address_line1: 42 EXAMPLE RD STE 6100
address_line2: null
address_city: SAN FRANCISCO
address_city: ANYTOWN
address_state: CA
address_zip: 94107-1741
address_zip: 02134
address_country: UNITED STATES
metadata: {}
date_created: "2018-12-08T03:01:07.651Z"
Expand Down
16 changes: 8 additions & 8 deletions resources/booklets/responses/booklet.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ application/json:
company: null
phone: null
email: null
address_line1: 210 KING ST STE 6100
address_line1: 42 EXAMPLE RD STE 6100
address_line2: null
address_city: SAN FRANCISCO
address_state: CA
address_zip: 94107-1741
address_city: ANYTOWN
address_state: MA
address_zip: 02134
address_country: UNITED STATES
metadata: {}
date_created: "2017-09-05T15:54:53.264Z"
Expand All @@ -30,11 +30,11 @@ application/json:
company: null
phone: null
email: null
address_line1: 210 KING ST STE 6100
address_line1: 42 EXAMPLE RD STE 6100
address_line2: null
address_city: SAN FRANCISCO
address_state: CA
address_zip: 94107-1741
address_city: ANYTOWN
address_state: MA
address_zip: 02134
address_country: UNITED STATES
metadata: {}
date_created: "2017-09-05T15:54:53.264Z"
Expand Down
Loading
Loading