Add batch endpoint

Author: Majored

spec.yaml

@@ -13,8 +13,10 @@ servers:
   - description: BuiltByBit
     url: 'https://api.builtbybit.com/'
 tags:
+  - name: analytics
+  - name: events
   - name: free
-  - name: global
+  - name: health
   - name: oauth2
   - name: resources/buyer
   - name: resources/creator
@@ -583,8 +585,6 @@ paths:
   /v2/events:
     get:
       summary: Fetch a list of pending events
-      tags:
-        - global
       responses:
         '200':
           description: OK
@@ -616,11 +616,11 @@ paths:
         id: 00f4ahftly4s2
       security:
         - token: []
+      tags:
+        - events
   /v2/events/complete:
     post:
       summary: Mark events as complete
-      tags:
-        - global
       responses:
         '200':
           description: OK
@@ -657,11 +657,11 @@ paths:
                     x-stoplight:
                       id: 9ykv6yr4xaldk
                     type: integer
+      tags:
+        - events
   /v2/analytics:
     get:
       summary: Fetch a list of analytics definitions
-      tags:
-        - global
       responses:
         '200':
           description: OK
@@ -689,11 +689,11 @@ paths:
         id: au6y5fszotgtf
       security:
         - token: []
+      tags:
+        - analytics
   /v2/analytics/graph:
     get:
       summary: Fetch analytics graph data
-      tags:
-        - global
       responses:
         '200':
           description: OK
@@ -741,11 +741,11 @@ paths:
           description: 'Only respected when ''period'' = ''custom_range'', in the format ''YYYY-MM-DD''.'
       security:
         - token: []
+      tags:
+        - analytics
   /v2/analytics/single:
     get:
       summary: Fetch a single analytics value
-      tags:
-        - global
       responses:
         '200':
           description: OK
@@ -826,6 +826,8 @@ paths:
           description: 'Only respected when ''period'' = ''custom_range'', in the format ''YYYY-MM-DD''.'
       security:
         - token: []
+      tags:
+        - analytics
   /v2/resources/creator/update:
     post:
       summary: Post a resource update
@@ -1354,7 +1356,8 @@ paths:
   /v2/resources/creator/coupons:
     get:
       summary: Fetch a list of your coupons
-      tags: []
+      tags:
+        - resources/creator
       responses:
         '200':
           description: OK
@@ -1389,7 +1392,6 @@ paths:
   /v2/health:
     get:
       summary: Retrieve a health status
-      tags: []
       responses:
         '200':
           description: OK
@@ -1413,10 +1415,13 @@ paths:
         id: t839xv25nj4y1
       security:
         - token: []
+      tags:
+        - health
   /v2/resources/creator/stores:
     get:
       summary: Fetch a list of your stores
-      tags: []
+      tags:
+        - resources/creator
       responses:
         '200':
           description: OK
@@ -1448,6 +1453,125 @@ paths:
         id: z941xq9jbm1ki
       security:
         - token: []
+  /v2/resources/creator/batch:
+    get:
+      summary: Fetch a list of your batches edits
+      tags: []
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  result:
+                    x-stoplight:
+                      id: vdj5lttfalg23
+                    enum:
+                      - success
+                  data:
+                    type: object
+                    x-stoplight:
+                      id: 4gavk9909u5jv
+                    properties:
+                      batches:
+                        type: array
+                        x-stoplight:
+                          id: snlln6bye6o3v
+                        items:
+                          $ref: '#/components/schemas/Batch'
+                      stats:
+                        $ref: '#/components/schemas/ListStats'
+      operationId: get-v2-resources-creator-batch
+      x-stoplight:
+        id: icz9ioupc63pq
+      security:
+        - token: []
+      parameters:
+        - schema:
+            type: array
+          in: query
+          name: batch_ids
+          explode: false
+          style: form
+          description: A comma-separated list of batch IDs to filter on. No filter is applied if empty.
+    post:
+      summary: Submit a new batch edit
+      tags: []
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  result:
+                    x-stoplight:
+                      id: 27p3h051x4t3x
+                    enum:
+                      - success
+                  data:
+                    type: object
+                    x-stoplight:
+                      id: txtvguoylrj8j
+                    properties:
+                      batch:
+                        $ref: '#/components/schemas/Batch'
+      operationId: post-v2-resources-creator-batch
+      x-stoplight:
+        id: qa9wz2n2gcuzh
+      security: []
+      description: Batch edits will be processed in the background meaning a successful call to this endpoint does not guarantee that the edits have been completed. You will instead receive an identifier to a batch edit which you can then use to fetch the status of via the below endpoint. This is not an atomic operation meaning some resources may be edited successfully and others may not be due to an error. You may only batch edit resources you own currently.
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+                - resources
+                - changes
+              properties:
+                resources:
+                  type: array
+                  x-stoplight:
+                    id: ir2feygtqs9js
+                  description: A list of resource IDs to edit.
+                  items: {}
+                changes:
+                  type: array
+                  x-stoplight:
+                    id: dga54iqms4398
+                  items:
+                    x-stoplight:
+                      id: kzylfe3aizlt7
+                    type: object
+                    required:
+                      - field
+                      - type
+                      - value
+                    properties:
+                      field:
+                        type: string
+                        x-stoplight:
+                          id: 7wxtfkz0jnfof
+                      type:
+                        type: string
+                        x-stoplight:
+                          id: t39muepw3xzgc
+                      search:
+                        type: string
+                        x-stoplight:
+                          id: ojc6jmztfj3y9
+                      value:
+                        x-stoplight:
+                          id: dup4famp2x8jh
+                        type:
+                          - number
+                          - string
+                          - array
+                        items: {}
 externalDocs:
   description: Find out more about Swagger
   url: 'http://swagger.io'
@@ -2287,14 +2411,6 @@ components:
             x-stoplight:
               id: irm0618am9i2d
             type: number
-        averages:
-          type: object
-          x-stoplight:
-            id: eyh6ty5q9nwvy
-          additionalProperties:
-            x-stoplight:
-              id: oud9zl7csn7r6
-            type: number
     Purchase:
       title: Purchase
       x-stoplight:
@@ -2533,6 +2649,44 @@ components:
           type: integer
           x-stoplight:
             id: xqf66r1k7quwk
+    Batch:
+      title: Batch
+      x-stoplight:
+        id: t08rlhuya7u4f
+      type: object
+      properties:
+        batch_id:
+          type: integer
+          x-stoplight:
+            id: rywmsoga1fe0d
+        user_id:
+          type: integer
+          x-stoplight:
+            id: 7xll9btyrfgot
+        errors:
+          x-stoplight:
+            id: xub0zolvnre7u
+          type: object
+          additionalProperties:
+            x-stoplight:
+              id: gt82q11gqjh88
+            type: array
+            items:
+              x-stoplight:
+                id: 0aer42sweluen
+              type: string
+        data:
+          type: string
+          x-stoplight:
+            id: q2mzi5v7ih9mx
+        created_at:
+          type: integer
+          x-stoplight:
+            id: vgtzd40pnfj4f
+        completed_at:
+          type: integer
+          x-stoplight:
+            id: y3phpy9xiq90a
   requestBodies: {}
   securitySchemes:
     token: