Add new resource to api public yml

lob · Sep 15, 2023 · 877a70e · 877a70e
1 parent 18cab71
commit 877a70e
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 13 deletions.
diff --git a/dist/lob-api-bundled.yml b/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