[CMB-501] ADd non-changes

lob · Feb 28, 2024 · e8c5a02 · e8c5a02
1 parent 97258ce
commit e8c5a02
Show file tree

Hide file tree

Showing 392 changed files with 5,559 additions and 770 deletions.
diff --git a/.github/workflows/run_tests.yml b/.github/workflows/run_tests.yml
diff --git a/.github/workflows/update_gem.yml b/.github/workflows/update_gem.yml
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION
diff --git a/.rspec b/.rspec
diff --git a/.rubocop.yml b/.rubocop.yml
diff --git a/CODE_SNIPPETS.md b/CODE_SNIPPETS.md
@@ -51,7 +51,7 @@ curl https://api.lob.com/v1/addresses \
   -d "[email protected]" \
   -d "phone=5555555555" \
   -d "address_line1=2261 Market Street" \
-  -d "address_line2=Ste 5668" \
+  -d "address_line2=STE 5668" \
   -d "address_city=San Francisco" \
   -d "address_state=CA" \
   -d "address_zip=94114" \
@@ -66,7 +66,7 @@ addressCreate = AddressEditable.new({
   email: "[email protected]",
   phone: "5555555555",
   address_line1: "2261 Market Street",
-  address_line2: "Ste 5668",
+  address_line2: "STE 5668",
   address_city: "San Francisco",
   address_state: "CA",
   address_zip: "94114",
@@ -196,7 +196,7 @@ curl https://api.lob.com/v1/postcards \
   --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_line2]=STE 5668" \
   -d "to[address_city]=San Francisco" \
   -d "to[address_state]=CA" \
   -d "to[address_zip]=94114" \
@@ -212,7 +212,7 @@ postcardCreate = PostcardEditable.new({
   to: AddressEditable.new({ 
     name: "Harry Zhang",
     address_line1: "2261 Market Street",
-    address_line2: "Ste 5668",
+    address_line2: "STE 5668",
     address_city: "San Francisco",
     address_state: "CA",
     address_zip: "94114",
@@ -305,7 +305,7 @@ curl https://api.lob.com/v1/self_mailers \
   --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_line2]=STE 5668" \
   -d "to[address_city]=San Francisco" \
   -d "to[address_state]=CA" \
   -d "to[address_zip]=94114" \
@@ -321,7 +321,7 @@ selfMailerCreate = SelfMailerEditable.new({
   to: AddressEditable.new({ 
     name: "Harry Zhang",
     address_line1: "2261 Market Street",
-    address_line2: "Ste 5668",
+    address_line2: "STE 5668",
     address_city: "San Francisco",
     address_state: "CA",
     address_zip: "94114",
@@ -414,7 +414,7 @@ curl https://api.lob.com/v1/letters \
   -d "color=true" \
   -d "to[name]=Harry Zhang" \
   -d "to[address_line1]=2261 Market Street" \
-  -d "to[address_line2]=Ste 5668" \
+  -d "to[address_line2]=STE 5668" \
   -d "to[address_city]=San Francisco" \
   -d "to[address_state]=CA" \
   -d "to[address_zip]=94114" \
@@ -431,7 +431,7 @@ letterCreate = LetterEditable.new({
   to: AddressEditable.new({ 
     name: "Harry Zhang",
     address_line1: "2261 Market Street",
-    address_line2: "Ste 5668",
+    address_line2: "STE 5668",
     address_city: "San Francisco",
     address_state: "CA",
     address_zip: "94114",
@@ -530,7 +530,7 @@ curl https://api.lob.com/v1/checks \
   -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_line2]=STE 5668" \
   -d "to[address_city]=San Francisco" \
   -d "to[address_state]=CA" \
   -d "to[address_zip]=94114" \
@@ -549,7 +549,7 @@ checkCreate = CheckEditable.new({
   to: AddressDomestic.new({ 
     name: "Harry Zhang",
     address_line1: "2261 Market Street",
-    address_line2: "Ste 5668",
+    address_line2: "STE 5668",
     address_city: "San Francisco",
     address_state: "CA",
     address_zip: "94114",

diff --git a/Gemfile b/Gemfile
diff --git a/LICENSE b/LICENSE
diff --git a/MIGRATION.md b/MIGRATION.md
diff --git a/Rakefile b/Rakefile
diff --git a/docs/Address.md b/docs/Address.md
@@ -1,49 +1,52 @@
 # Lob::Address
 
-## Class instance methods
-
-### `openapi_one_of`
-
-Returns the list of classes defined in oneOf.
-
-#### Example
-
-```ruby
-require 'lob'
-
-Lob::Address.openapi_one_of
-# =>
-# [
-#   :'IntlAddress',
-#   :'UsAddress'
-# ]
-```
-
-### build
-
-Find the appropriate object from the `openapi_one_of` list and casts the data into it.
-
-#### Example
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier prefixed with &#x60;adr_&#x60;. | [optional] |
+| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters.  | [optional] |
+| **name** | **String** | name associated with address | [optional] |
+| **company** | **String** | Either &#x60;name&#x60; or &#x60;company&#x60; is required, you may also add both. | [optional] |
+| **phone** | **String** | Must be no longer than 40 characters. | [optional] |
+| **email** | **String** | Must be no longer than 100 characters. | [optional] |
+| **metadata** | **Hash&lt;String, String&gt;** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters &#x60;\&quot;&#x60; and &#x60;\\&#x60;. i.e. &#39;{\&quot;customer_id\&quot; : \&quot;NEWYORK2015\&quot;}&#39; Nested objects are not supported.  See [Metadata](#section/Metadata) for more information. | [optional] |
+| **address_line1** | **String** |  | [optional] |
+| **address_line2** | **String** |  | [optional] |
+| **address_city** | **String** |  | [optional] |
+| **address_state** | **String** | 2 letter state short-name code | [optional] |
+| **address_zip** | **String** | Must follow the ZIP format of &#x60;12345&#x60; or ZIP+4 format of &#x60;12345-1234&#x60;.  | [optional] |
+| **address_country** | [**CountryExtendedExpanded**](CountryExtendedExpanded.md) |  | [optional] |
+| **object** | **String** |  | [optional][default to &#39;address&#39;] |
+| **date_created** | **Time** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] |
+| **date_modified** | **Time** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] |
+| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
+| **recipient_moved** | **Boolean** | Only returned for accounts on certain &lt;a href&#x3D;\&quot;https://dashboard.lob.com/#/settings/editions\&quot;&gt;Print &amp;amp; Mail Editions&lt;/a&gt;. Value is &#x60;true&#x60; if the address was altered because the recipient filed for a &lt;a href&#x3D;\&quot;#ncoa\&quot;&gt;National Change of Address (NCOA)&lt;/a&gt;, &#x60;false&#x60; if the NCOA check was run but no altered address was found, and &#x60;null&#x60; if the NCOA check was not run. The NCOA check does not happen for non-US addresses, for non-deliverable US addresses, or for addresses created before the NCOA feature was added to your account.  | [optional] |
+
+## Example
 
 ```ruby
 require 'lob'
 
-Lob::Address.build(data)
-# => #<IntlAddress:0x00007fdd4aab02a0>
-
-Lob::Address.build(data_that_doesnt_match)
-# => nil
+instance = Lob::Address.new(
+  id: null,
+  description: null,
+  name: null,
+  company: null,
+  phone: null,
+  email: null,
+  metadata: null,
+  address_line1: null,
+  address_line2: null,
+  address_city: null,
+  address_state: null,
+  address_zip: null,
+  address_country: null,
+  object: null,
+  date_created: null,
+  date_modified: null,
+  deleted: null,
+  recipient_moved: null
+)
 ```
 
-#### Parameters
-
-| Name | Type | Description |
-| ---- | ---- | ----------- |
-| **data** | **Mixed** | data to be matched against the list of oneOf items |
-
-#### Return type
-
-- `IntlAddress`
-- `UsAddress`
-- `nil` (if no type matches)
-
diff --git a/docs/AddressDeletion.md b/docs/AddressDeletion.md
@@ -11,7 +11,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::AddressDeletion.new(
   id: null,

diff --git a/docs/AddressDomestic.md b/docs/AddressDomestic.md
@@ -20,7 +20,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::AddressDomestic.new(
   address_line1: null,

diff --git a/docs/AddressDomesticExpanded.md b/docs/AddressDomesticExpanded.md
@@ -20,7 +20,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::AddressDomesticExpanded.new(
   address_line1: null,

diff --git a/docs/AddressEditable.md b/docs/AddressEditable.md
@@ -20,7 +20,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::AddressEditable.new(
   address_line1: null,

diff --git a/docs/AddressList.md b/docs/AddressList.md
@@ -14,7 +14,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::AddressList.new(
   data: null,

diff --git a/docs/AddressesApi.md b/docs/AddressesApi.md
@@ -22,7 +22,7 @@ Creates a new address given information
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -92,7 +92,7 @@ Deletes the details of an existing address.
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -162,7 +162,7 @@ Retrieves the details of an existing address.
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -232,7 +232,7 @@ Returns a list of your addresses.
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth

diff --git a/docs/BankAccount.md b/docs/BankAccount.md
@@ -22,7 +22,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::BankAccount.new(
   description: null,

diff --git a/docs/BankAccountDeletion.md b/docs/BankAccountDeletion.md
@@ -11,7 +11,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::BankAccountDeletion.new(
   id: null,

diff --git a/docs/BankAccountList.md b/docs/BankAccountList.md
@@ -14,7 +14,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::BankAccountList.new(
   data: null,

diff --git a/docs/BankAccountVerify.md b/docs/BankAccountVerify.md
@@ -9,7 +9,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::BankAccountVerify.new(
   amounts: null

diff --git a/docs/BankAccountWritable.md b/docs/BankAccountWritable.md
@@ -14,7 +14,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::BankAccountWritable.new(
   description: null,

diff --git a/docs/BankAccountsApi.md b/docs/BankAccountsApi.md
@@ -23,7 +23,7 @@ Creates a new bank account with the provided properties. Bank accounts created i
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -93,7 +93,7 @@ Permanently deletes a bank account. It cannot be undone.
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -163,7 +163,7 @@ Retrieves the details of an existing bank account. You need only supply the uniq
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -233,7 +233,7 @@ Verify a bank account in order to create a check.
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -305,7 +305,7 @@ Returns a list of your bank accounts. The bank accounts are returned sorted by c
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth

diff --git a/docs/BankTypeEnum.md b/docs/BankTypeEnum.md
@@ -8,7 +8,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::BankTypeEnum.new()
 ```

diff --git a/docs/BillingGroup.md b/docs/BillingGroup.md
@@ -14,7 +14,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::BillingGroup.new(
   description: null,

diff --git a/docs/BillingGroupEditable.md b/docs/BillingGroupEditable.md
@@ -10,7 +10,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::BillingGroupEditable.new(
   description: null,

diff --git a/docs/BillingGroupList.md b/docs/BillingGroupList.md
@@ -13,7 +13,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::BillingGroupList.new(
   data: null,