Create Documentation of Public APIs for Seats Management

.generator/schemas/v2/openapi.yaml

@@ -5362,6 +5362,56 @@ components:
           example: _latest
           type: string
       type: object
+    AssignSeatsUserRequest:
+      properties:
+        data:
+          $ref: '#/components/schemas/AssignSeatsUserRequestData'
+      type: object
+    AssignSeatsUserRequestData:
+      properties:
+        attributes:
+          $ref: '#/components/schemas/AssignSeatsUserRequestDataAttributes'
+        id:
+          type: string
+        type:
+          $ref: '#/components/schemas/SeatAssignmentsDataType'
+      required:
+      - type
+      type: object
+    AssignSeatsUserRequestDataAttributes:
+      properties:
+        product_code:
+          type: string
+        user_uuids:
+          items:
+            type: string
+          type: array
+      type: object
+    AssignSeatsUserResponse:
+      properties:
+        data:
+          $ref: '#/components/schemas/AssignSeatsUserResponseData'
+      type: object
+    AssignSeatsUserResponseData:
+      properties:
+        attributes:
+          $ref: '#/components/schemas/AssignSeatsUserResponseDataAttributes'
+        id:
+          type: string
+        type:
+          $ref: '#/components/schemas/SeatAssignmentsDataType'
+      required:
+      - type
+      type: object
+    AssignSeatsUserResponseDataAttributes:
+      properties:
+        assigned_ids:
+          items:
+            type: string
+          type: array
+        product_code:
+          type: string
+      type: object
     AttachCaseRequest:
       description: Request for attaching security findings to a case.
       properties:
@@ -51879,6 +51929,65 @@ components:
       - ISSUE_ASSIGNEE
       - ISSUE_CASE
       - ISSUE_TEAM_OWNERS
+    SeatAssignmentsDataType:
+      default: seat-assignments
+      description: Seat assignments resource type.
+      enum:
+      - seat-assignments
+      example: seat-assignments
+      type: string
+      x-enum-varnames:
+      - SEAT_ASSIGNMENTS
+    SeatUserData:
+      properties:
+        attributes:
+          $ref: '#/components/schemas/SeatUserDataAttributes'
+        id:
+          type: string
+        type:
+          $ref: '#/components/schemas/SeatUserDataType'
+      required:
+      - type
+      type: object
+    SeatUserDataArray:
+      properties:
+        data:
+          items:
+            $ref: '#/components/schemas/SeatUserData'
+          type: array
+        meta:
+          $ref: '#/components/schemas/SeatUserMeta'
+      required:
+      - data
+      type: object
+    SeatUserDataAttributes:
+      properties:
+        assigned_at:
+          type: string
+        email:
+          type: string
+        name:
+          type: string
+      type: object
+    SeatUserDataType:
+      default: seat-users
+      description: Seat users resource type.
+      enum:
+      - seat-users
+      example: seat-users
+      type: string
+      x-enum-varnames:
+      - SEAT_USERS
+    SeatUserMeta:
+      properties:
+        cursor:
+          type: string
+        limit:
+          format: int64
+          type: integer
+        next_cursor:
+          type: string
+      type: object
     SecretRuleArray:
       properties:
         data:
@@ -63944,6 +64053,31 @@ components:
       type: string
       x-enum-varnames:
       - AZURE_UC_CONFIGS
+    UnassignSeatsUserRequest:
+      properties:
+        data:
+          $ref: '#/components/schemas/UnassignSeatsUserRequestData'
+      type: object
+    UnassignSeatsUserRequestData:
+      properties:
+        attributes:
+          $ref: '#/components/schemas/UnassignSeatsUserRequestDataAttributes'
+        id:
+          type: string
+        type:
+          $ref: '#/components/schemas/SeatAssignmentsDataType'
+      required:
+      - type
+      type: object
+    UnassignSeatsUserRequestDataAttributes:
+      properties:
+        product_code:
+          type: string
+        user_uuids:
+          items:
+            type: string
+          type: array
+      type: object
     Unit:
       description: Object containing the metric unit family, scale factor, name, and
         short name.
@@ -91707,6 +91841,95 @@ paths:
       x-unstable: '**Note**: This endpoint is in public beta.
 
         If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
+  /api/v2/seats/users:
+    delete:
+      description: Unassign seats from users for a product code.
+      operationId: UnassignSeatsUserV2
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UnassignSeatsUserRequest'
+        required: true
+      responses:
+        '204':
+          description: No Content
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Unassign seats from users for a product code
+      tags:
+      - Seats
+      x-permission:
+        operator: OR
+        permissions:
+        - billing_edit
+        - incident_write
+        - on_call_write
+    get:
+      description: Get the list of seats users assigned to a product code.
+      operationId: GetSeatsUsersV2
+      parameters:
+      - description: The product code for which to retrieve seat users.
+        in: query
+        name: product_code
+        required: true
+        schema:
+          type: string
+      - description: Maximum number of results to return.
+        in: query
+        name: page[limit]
+        schema:
+          type: integer
+      - description: Cursor for pagination.
+        in: query
+        name: page[cursor]
+        schema:
+          type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SeatUserDataArray'
+          description: OK
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Get seats users for a product code
+      tags:
+      - Seats
+      x-permission:
+        operator: OR
+        permissions:
+        - billing_read
+        - incident_read
+        - on_call_read
+    post:
+      description: Assign seats to users for a product code.
+      operationId: AssignSeatsUserV2
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/AssignSeatsUserRequest'
+        required: true
+      responses:
+        '201':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AssignSeatsUserResponse'
+          description: Created
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Assign seats to users for a product code
+      tags:
+      - Seats
+      x-permission:
+        operator: OR
+        permissions:
+        - billing_edit
+        - incident_write
+        - on_call_write
   /api/v2/security-entities/risk-scores:
     get:
       description: Get a list of entity risk scores for your organization. Entity
@@ -102815,6 +103038,9 @@ tags:
 - description: Manage retention filters through [Manage Applications](https://app.datadoghq.com/rum/list)
     of RUM for your organization.
   name: Rum Retention Filters
+- description: The seats API allows you to view, assign, and unassign seats for your
+    organization.
+  name: Seats
 - description: Create and manage your security rules, signals, filters, and more.
     See the [Datadog Security page](https://docs.datadoghq.com/security/) for more
     information.

examples/v2/seats/AssignSeatsUserV2.java

@@ -0,0 +1,35 @@
+// Assign seats to users for a product code returns "Created" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.SeatsApi;
+import com.datadog.api.client.v2.model.AssignSeatsUserRequest;
+import com.datadog.api.client.v2.model.AssignSeatsUserRequestData;
+import com.datadog.api.client.v2.model.AssignSeatsUserRequestDataAttributes;
+import com.datadog.api.client.v2.model.AssignSeatsUserResponse;
+import com.datadog.api.client.v2.model.SeatAssignmentsDataType;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    SeatsApi apiInstance = new SeatsApi(defaultClient);
+
+    AssignSeatsUserRequest body =
+        new AssignSeatsUserRequest()
+            .data(
+                new AssignSeatsUserRequestData()
+                    .attributes(new AssignSeatsUserRequestDataAttributes())
+                    .type(SeatAssignmentsDataType.SEAT_ASSIGNMENTS));
+
+    try {
+      AssignSeatsUserResponse result = apiInstance.assignSeatsUserV2(body);
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling SeatsApi#assignSeatsUserV2");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/seats/GetSeatsUsersV2.java

@@ -0,0 +1,24 @@
+// Get seats users for a product code returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.SeatsApi;
+import com.datadog.api.client.v2.model.SeatUserDataArray;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    SeatsApi apiInstance = new SeatsApi(defaultClient);
+
+    try {
+      SeatUserDataArray result = apiInstance.getSeatsUsersV2("product_code");
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling SeatsApi#getSeatsUsersV2");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/seats/UnassignSeatsUserV2.java

@@ -0,0 +1,33 @@
+// Unassign seats from users for a product code returns "No Content" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.SeatsApi;
+import com.datadog.api.client.v2.model.SeatAssignmentsDataType;
+import com.datadog.api.client.v2.model.UnassignSeatsUserRequest;
+import com.datadog.api.client.v2.model.UnassignSeatsUserRequestData;
+import com.datadog.api.client.v2.model.UnassignSeatsUserRequestDataAttributes;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    SeatsApi apiInstance = new SeatsApi(defaultClient);
+
+    UnassignSeatsUserRequest body =
+        new UnassignSeatsUserRequest()
+            .data(
+                new UnassignSeatsUserRequestData()
+                    .attributes(new UnassignSeatsUserRequestDataAttributes())
+                    .type(SeatAssignmentsDataType.SEAT_ASSIGNMENTS));
+
+    try {
+      apiInstance.unassignSeatsUserV2(body);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling SeatsApi#unassignSeatsUserV2");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}