BILL-3438 add docs for getting account Lob Credits balance

.prettierignore

@@ -9,6 +9,7 @@ node_modules
 docs/chunks/
 docs/js/bundle.js
 docs/index.html
+README.md
 
 .github/ISSUE_TEMPLATE
 .github/pull_request_template.md

dist/lob-api-bundled.yml

@@ -13033,6 +13033,39 @@ x-webhooks:
         '200':
           $ref: '#/components/responses/tracking_events'
 paths:
+  /accounts:
+    get:
+      operationId: get_lob_credits_balance
+      summary: Get Lob Credits Balance
+      description: Returns the account's current balance of Lob Credits.
+      tags:
+        - Accounts
+        - Lob Credits
+      responses:
+        '200':
+          description: Returns a lob_credits_balance object.
+          content:
+            description: Account's current balance of Lob Credits
+            content:
+              application/json:
+                schema:
+                  $ref: ../models/lob_credits_balance.yml
+                examples:
+                  empty:
+                    value:
+                      balance: 0
+                  negative:
+                    value:
+                      balance: -1234.56
+                  positive:
+                    value:
+                      balance: 1000
+      x-codeSamples:
+        - lang: Shell
+          source: |
+            curl https://api.lob.com/v1/accounts/credits_balance \
+              -u <YOUR API KEY>:
+          label: CURL
   /addresses:
     get:
       operationId: addresses_list

lob-api-public.yml

@@ -2493,6 +2493,9 @@ x-webhooks:
           $ref: shared/resources/tracking_events/responses/tracking_events.yml
 
 paths:
+  /accounts:
+    $ref: resources/accounts/accounts.yml
+
   /addresses:
     $ref: resources/addresses/addresses.yml
 

resources/accounts/accounts.yml

@@ -0,0 +1,24 @@
+get:
+  operationId: get_lob_credits_balance
+
+  summary: Get Lob Credits Balance
+
+  description: >-
+    Returns the account's current balance of Lob Credits.
+
+  tags:
+    - Accounts
+    - Lob Credits
+
+  responses:
+    "200":
+      description: Returns a lob_credits_balance object.
+      content:
+        $ref: responses/lob_credits_balance.yml
+
+  x-codeSamples:
+    - lang: Shell
+      source: |
+        curl https://api.lob.com/v1/accounts/credits_balance \
+          -u <YOUR API KEY>:
+      label: CURL

resources/accounts/models/lob_credits_balance.yml

@@ -0,0 +1,8 @@
+type: object
+required:
+  - balance
+properties:
+  balance:
+    type: number
+    description: Account's current balance of Lob Credits. Can be positive, negative, or zero.
+    example: 1000.00

resources/accounts/responses/lob_credits_balance.yml

@@ -0,0 +1,17 @@
+description: Account's current balance of Lob Credits
+
+content:
+  application/json:
+    schema:
+      $ref: "../models/lob_credits_balance.yml"
+
+    examples:
+      empty:
+        value:
+          balance: 0
+      negative:
+        value:
+          balance: -1234.56
+      positive:
+        value:
+          balance: 1000.00