lob 5.4.5 → 6.0.0.pre.rc

data/docs/UsComponents.md

@@ -0,0 +1,68 @@
+# OpenapiClient::UsComponents
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **primary_number** | **String** | The numeric or alphanumeric part of an address preceding the street name. Often the house, building, or PO Box number. |  |
+| **street_predirection** | **String** | Geographic direction preceding a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`).  |  |
+| **street_name** | **String** | The name of the street. |  |
+| **street_suffix** | **String** | The standard USPS abbreviation for the street suffix (`ST`, `AVE`, `BLVD`, etc).  |  |
+| **street_postdirection** | **String** | Geographic direction following a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`).  |  |
+| **secondary_designator** | **String** | The standard USPS abbreviation describing the `components[secondary_number]` (`STE`, `APT`, `BLDG`, etc).  |  |
+| **secondary_number** | **String** | Number of the apartment/unit/etc.  |  |
+| **pmb_designator** | **String** | Designator of a [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency) private mailbox.  |  |
+| **pmb_number** | **String** | Number of a [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency) private mailbox.  |  |
+| **extra_secondary_designator** | **String** | An extra (often unnecessary) secondary designator provided with the input address.  |  |
+| **extra_secondary_number** | **String** | An extra (often unnecessary) secondary number provided with the input address.  |  |
+| **city** | **String** |  |  |
+| **state** | **String** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state.  |  |
+| **zip_code** | **String** | The 5-digit ZIP code |  |
+| **zip_code_plus_4** | **String** |  |  |
+| **zip_code_type** | [**ZipCodeType**](ZipCodeType.md) |  |  |
+| **delivery_point_barcode** | **String** | A 12-digit identifier that uniquely identifies a delivery point (location where mail can be sent and received). It consists of the 5-digit ZIP code (`zip_code`), 4-digit ZIP+4 add-on (`zip_code_plus_4`), 2-digit delivery point, and 1-digit delivery point check digit.  |  |
+| **address_type** | **String** | Uses USPS's [Residential Delivery Indicator (RDI)](https://www.usps.com/nationalpremieraccounts/rdi.htm) to identify whether an address is classified as residential or business. Possible values are: * `residential` –– The address is residential or a PO Box. * `commercial` –– The address is commercial. * `''` –– Not enough information provided to be determined.  |  |
+| **record_type** | **String** | A description of the type of address. Populated if a DPV match is made (`deliverability_analysis[dpv_confirmation]` is `Y`, `S`, or `D`). For more detailed information about each record type, see [US Verification Details](#tag/US-Verification-Types).  |  |
+| **default_building_address** | **Boolean** | Designates whether or not the address is the default address for a building containing multiple delivery points.  |  |
+| **county** | **String** | County name of the address city. |  |
+| **county_fips** | **String** | A 5-digit [FIPS county code](https://en.wikipedia.org/wiki/FIPS_county_code) which uniquely identifies `components[county]`. It consists of a 2-digit state code and a 3-digit county code.  |  |
+| **carrier_route** | **String** | A 4-character code assigned to a mail delivery route within a ZIP code.  |  |
+| **carrier_route_type** | **String** | The type of `components[carrier_route]`. For more detailed information about each carrier route type, see [US Verification Details](#tag/US-Verification-Types).  |  |
+| **latitude** | **Float** | A positive or negative decimal indicating the geographic latitude of the address, specifying the north-to-south position of a location. This should be used with `longitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`).  | [optional] |
+| **longitude** | **Float** | A positive or negative decimal indicating the geographic longitude of the address, specifying the north-to-south position of a location. This should be used with `latitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`).  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UsComponents.new(
+  primary_number: null,
+  street_predirection: null,
+  street_name: null,
+  street_suffix: null,
+  street_postdirection: null,
+  secondary_designator: null,
+  secondary_number: null,
+  pmb_designator: null,
+  pmb_number: null,
+  extra_secondary_designator: null,
+  extra_secondary_number: null,
+  city: null,
+  state: null,
+  zip_code: null,
+  zip_code_plus_4: null,
+  zip_code_type: null,
+  delivery_point_barcode: null,
+  address_type: null,
+  record_type: null,
+  default_building_address: null,
+  county: null,
+  county_fips: null,
+  carrier_route: null,
+  carrier_route_type: null,
+  latitude: null,
+  longitude: null
+)
+```
+

data/docs/UsVerification.md

@@ -0,0 +1,38 @@
+# OpenapiClient::UsVerification
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier prefixed with `us_ver_`. | [optional] |
+| **recipient** | **String** | The intended recipient, typically a person's or firm's name. | [optional] |
+| **primary_line** | **String** | The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`  | [optional] |
+| **secondary_line** | **String** | The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.  | [optional] |
+| **urbanization** | **String** | Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification.  | [optional] |
+| **last_line** | **String** | Combination of the following applicable `components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`)  | [optional] |
+| **deliverability** | **String** | Summarizes the deliverability of the `us_verification` object. For full details, see the `deliverability_analysis` field. Possible values are: * `deliverable` – The address is deliverable by the USPS. * `deliverable_unnecessary_unit` – The address is deliverable, but the secondary unit information is unnecessary. * `deliverable_incorrect_unit` – The address is deliverable to the building's default address but the secondary unit provided may not exist. There is a chance the mail will not reach the intended recipient. * `deliverable_missing_unit` – The address is deliverable to the building's default address but is missing secondary unit information. There is a chance the mail will not reach the intended recipient. * `undeliverable` – The address is not deliverable according to the USPS.  | [optional] |
+| **components** | [**UsComponents**](UsComponents.md) |  | [optional] |
+| **deliverability_analysis** | [**DeliverabilityAnalysis**](DeliverabilityAnalysis.md) |  | [optional] |
+| **lob_confidence_score** | [**LobConfidenceScore**](LobConfidenceScore.md) |  | [optional] |
+| **object** | **String** |  | [optional][default to 'us_verification'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UsVerification.new(
+  id: null,
+  recipient: null,
+  primary_line: null,
+  secondary_line: null,
+  urbanization: null,
+  last_line: null,
+  deliverability: null,
+  components: null,
+  deliverability_analysis: null,
+  lob_confidence_score: null,
+  object: null
+)
+```
+

data/docs/UsVerificationOrError.md

@@ -0,0 +1,40 @@
+# OpenapiClient::UsVerificationOrError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier prefixed with `us_ver_`. | [optional] |
+| **recipient** | **String** | The intended recipient, typically a person's or firm's name. | [optional] |
+| **primary_line** | **String** | The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`  | [optional] |
+| **secondary_line** | **String** | The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.  | [optional] |
+| **urbanization** | **String** | Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification.  | [optional] |
+| **last_line** | **String** |  | [optional] |
+| **deliverability** | **String** |  | [optional] |
+| **components** | [**UsComponents**](UsComponents.md) |  | [optional] |
+| **deliverability_analysis** | [**DeliverabilityAnalysis**](DeliverabilityAnalysis.md) |  | [optional] |
+| **lob_confidence_score** | [**LobConfidenceScore**](LobConfidenceScore.md) |  | [optional] |
+| **object** | **String** |  | [optional][default to 'us_verification'] |
+| **error** | [**BulkError**](BulkError.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UsVerificationOrError.new(
+  id: null,
+  recipient: null,
+  primary_line: null,
+  secondary_line: null,
+  urbanization: null,
+  last_line: null,
+  deliverability: null,
+  components: null,
+  deliverability_analysis: null,
+  lob_confidence_score: null,
+  object: null,
+  error: null
+)
+```
+

data/docs/UsVerifications.md

@@ -0,0 +1,20 @@
+# OpenapiClient::UsVerifications
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **addresses** | [**Array<UsVerificationOrError>**](UsVerificationOrError.md) |  |  |
+| **errors** | **Boolean** | Indicates whether any errors occurred during the verification process. |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UsVerifications.new(
+  addresses: null,
+  errors: null
+)
+```
+

data/docs/UsVerificationsApi.md

@@ -0,0 +1,157 @@
+# OpenapiClient::UsVerificationsApi
+
+All URIs are relative to *https://api.lob.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**bulk_us_verifications**](UsVerificationsApi.md#bulk_us_verifications) | **POST** /bulk/us_verifications | verifyBulk |
+| [**us_verification**](UsVerificationsApi.md#us_verification) | **POST** /us_verifications | verifySingle |
+
+
+## bulk_us_verifications
+
+> <UsVerifications> bulk_us_verifications(multiple_components_list, opts)
+
+verifyBulk
+
+Verify a list of US or US territory addresses with a live API key.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = OpenapiClient::UsVerificationsApi.new
+multiple_components_list = OpenapiClient::MultipleComponentsList.new({addresses: [OpenapiClient::MultipleComponents.new({primary_line: 'primary_line_example'})]}) # MultipleComponentsList | 
+opts = {
+  _case: 'upper' # String | Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively.
+}
+
+begin
+  # verifyBulk
+  result = api_instance.verifyBulk(multiple_components_list, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UsVerificationsApi->verifyBulk: #{e}"
+end
+```
+
+#### Using the bulk_us_verifications_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UsVerifications>, Integer, Hash)> bulk_us_verifications_with_http_info(multiple_components_list, opts)
+
+```ruby
+begin
+  # verifyBulk
+  data, status_code, headers = api_instance.bulk_us_verifications_with_http_info(multiple_components_list, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UsVerifications>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UsVerificationsApi->bulk_us_verifications_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **multiple_components_list** | [**MultipleComponentsList**](MultipleComponentsList.md) |  |  |
+| **_case** | **String** | Casing of the verified address. Possible values are &#x60;upper&#x60; and &#x60;proper&#x60; for uppercased (e.g. \&quot;PO BOX\&quot;) and proper-cased (e.g. \&quot;PO Box\&quot;), respectively. | [optional][default to &#39;upper&#39;] |
+
+### Return type
+
+[**UsVerifications**](UsVerifications.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## us_verification
+
+> <UsVerification> us_verification(us_verifications_writable, opts)
+
+verifySingle
+
+Verify a US or US territory address with a live API key.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = OpenapiClient::UsVerificationsApi.new
+us_verifications_writable = OpenapiClient::UsVerificationsWritable.new # UsVerificationsWritable | 
+opts = {
+  _case: 'upper' # String | Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively.
+}
+
+begin
+  # verifySingle
+  result = api_instance.verifySingle(us_verifications_writable, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UsVerificationsApi->verifySingle: #{e}"
+end
+```
+
+#### Using the us_verification_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UsVerification>, Integer, Hash)> us_verification_with_http_info(us_verifications_writable, opts)
+
+```ruby
+begin
+  # verifySingle
+  data, status_code, headers = api_instance.us_verification_with_http_info(us_verifications_writable, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UsVerification>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UsVerificationsApi->us_verification_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **us_verifications_writable** | [**UsVerificationsWritable**](UsVerificationsWritable.md) |  |  |
+| **_case** | **String** | Casing of the verified address. Possible values are &#x60;upper&#x60; and &#x60;proper&#x60; for uppercased (e.g. \&quot;PO BOX\&quot;) and proper-cased (e.g. \&quot;PO Box\&quot;), respectively. | [optional][default to &#39;upper&#39;] |
+
+### Return type
+
+[**UsVerification**](UsVerification.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/UsVerificationsWritable.md

@@ -0,0 +1,32 @@
+# OpenapiClient::UsVerificationsWritable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | **String** | The entire address in one string (e.g., \"210 King Street 94107\"). _Does not support a recipient and will error when other payload parameters are provided._  | [optional] |
+| **recipient** | **String** | The intended recipient, typically a person's or firm's name. | [optional] |
+| **primary_line** | **String** | The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`  | [optional] |
+| **secondary_line** | **String** | The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.  | [optional] |
+| **urbanization** | **String** | Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification.  | [optional] |
+| **city** | **String** |  | [optional] |
+| **state** | **String** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed. | [optional] |
+| **zip_code** | **String** | Required if `city` and `state` are not passed in. If included, must be formatted as a US ZIP or ZIP+4 (e.g. `94107`, `941072282`, `94107-2282`). | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UsVerificationsWritable.new(
+  address: null,
+  recipient: null,
+  primary_line: null,
+  secondary_line: null,
+  urbanization: null,
+  city: null,
+  state: null,
+  zip_code: null
+)
+```
+

data/docs/ValidationError.md

@@ -0,0 +1,22 @@
+# OpenapiClient::ValidationError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **loc** | [**Array<AnyOfstringinteger>**](AnyOfstringinteger.md) |  |  |
+| **msg** | **String** |  |  |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::ValidationError.new(
+  loc: null,
+  msg: null,
+  type: null
+)
+```
+

data/docs/Zip.md

@@ -0,0 +1,26 @@
+# OpenapiClient::Zip
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **zip_code** | **String** | A 5-digit ZIP code. | [optional] |
+| **id** | **String** | Unique identifier prefixed with `us_zip_`. |  |
+| **cities** | [**Array<ZipLookupCity>**](ZipLookupCity.md) | An array of city objects containing valid cities for the `zip_code`. Multiple cities will be returned if more than one city is associated with the input ZIP code.  |  |
+| **zip_code_type** | [**ZipCodeType**](ZipCodeType.md) |  |  |
+| **object** | **String** |  | [default to 'us_zip_lookup'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::Zip.new(
+  zip_code: null,
+  id: null,
+  cities: null,
+  zip_code_type: null,
+  object: null
+)
+```
+

data/docs/ZipCodeType.md

@@ -0,0 +1,15 @@
+# OpenapiClient::ZipCodeType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::ZipCodeType.new()
+```
+

data/docs/ZipEditable.md

@@ -0,0 +1,18 @@
+# OpenapiClient::ZipEditable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **zip_code** | **String** | A 5-digit ZIP code. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::ZipEditable.new(
+  zip_code: null
+)
+```
+

data/docs/ZipLookupCity.md

@@ -0,0 +1,26 @@
+# OpenapiClient::ZipLookupCity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **city** | **String** |  |  |
+| **state** | **String** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state.  |  |
+| **county** | **String** | County name of the address city. |  |
+| **county_fips** | **String** | A 5-digit [FIPS county code](https://en.wikipedia.org/wiki/FIPS_county_code) which uniquely identifies `components[county]`. It consists of a 2-digit state code and a 3-digit county code.  |  |
+| **preferred** | **Boolean** | Indicates whether or not the city is the [USPS default city](https://en.wikipedia.org/wiki/ZIP_Code#ZIP_Codes_and_previous_zoning_lines) (preferred city) of a ZIP code. There is only one preferred city per ZIP code, which will always be in position 0 in the array of cities.  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::ZipLookupCity.new(
+  city: null,
+  state: null,
+  county: null,
+  county_fips: null,
+  preferred: null
+)
+```
+

data/docs/ZipLookupsApi.md

@@ -0,0 +1,78 @@
+# OpenapiClient::ZipLookupsApi
+
+All URIs are relative to *https://api.lob.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**zip_lookup**](ZipLookupsApi.md#zip_lookup) | **POST** /us_zip_lookups | lookup |
+
+
+## zip_lookup
+
+> <Zip> zip_lookup(zip_editable)
+
+lookup
+
+Returns information about a ZIP code
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = OpenapiClient::ZipLookupsApi.new
+zip_editable = OpenapiClient::ZipEditable.new # ZipEditable | 
+
+begin
+  # lookup
+  result = api_instance.lookup(zip_editable)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ZipLookupsApi->lookup: #{e}"
+end
+```
+
+#### Using the zip_lookup_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Zip>, Integer, Hash)> zip_lookup_with_http_info(zip_editable)
+
+```ruby
+begin
+  # lookup
+  data, status_code, headers = api_instance.zip_lookup_with_http_info(zip_editable)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Zip>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ZipLookupsApi->zip_lookup_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **zip_editable** | [**ZipEditable**](ZipEditable.md) |  |  |
+
+### Return type
+
+[**Zip**](Zip.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'