@opusdns/api 1.16.0 → 1.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^1.2.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "1.16.0",
6
+ "version": "1.17.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -1278,8 +1278,9 @@ export type PUT_HostsByHostReference_Response_403 = Problem;
1278
1278
  export type PUT_HostsByHostReference_Response_404 = Problem;
1279
1279
  export type PUT_HostsByHostReference_Response_422 = HTTPValidationError;
1280
1280
 
1281
- export type PUT_UsersByUserIdRole_Response = PUT_UsersByUserIdRole_Response_200 | PUT_UsersByUserIdRole_Response_403 | PUT_UsersByUserIdRole_Response_422;
1281
+ export type PUT_UsersByUserIdRole_Response = PUT_UsersByUserIdRole_Response_200 | PUT_UsersByUserIdRole_Response_403 | PUT_UsersByUserIdRole_Response_404 | PUT_UsersByUserIdRole_Response_422;
1282
1282
 
1283
1283
  export type PUT_UsersByUserIdRole_Response_200 = PublicRoleAssignment;
1284
1284
  export type PUT_UsersByUserIdRole_Response_403 = Problem;
1285
+ export type PUT_UsersByUserIdRole_Response_404 = Problem;
1285
1286
  export type PUT_UsersByUserIdRole_Response_422 = HTTPValidationError;
@@ -69,6 +69,7 @@ export type CreateJobBatch = components['schemas']['CreateJobBatchResponse'];
69
69
  export type CreateReportReq = components['schemas']['CreateReportReq'];
70
70
  export type Currency = components['schemas']['Currency'];
71
71
  export type CustomRoleCreate = components['schemas']['CustomRoleCreate'];
72
+ export type CustomRoleLabel = components['schemas']['CustomRoleLabel'];
72
73
  export type CustomRoleUpdate = components['schemas']['CustomRoleUpdate'];
73
74
  export type DeletePolicyType = components['schemas']['DeletePolicyType'];
74
75
  export type DnsChangeAction = components['schemas']['DnsChangeAction'];
package/src/openapi.yaml CHANGED
@@ -2174,6 +2174,8 @@ components:
2174
2174
  - permissions
2175
2175
  title: CustomRoleCreate
2176
2176
  type: object
2177
+ CustomRoleLabel:
2178
+ type: string
2177
2179
  CustomRoleUpdate:
2178
2180
  description: 'Request body for updating a custom role. Omitted fields are left
2179
2181
  unchanged; `permissions`
@@ -10022,7 +10024,9 @@ components:
10022
10024
  role:
10023
10025
  anyOf:
10024
10026
  - $ref: '#/components/schemas/PublicRole'
10027
+ - $ref: '#/components/schemas/CustomRoleLabel'
10025
10028
  - type: 'null'
10029
+ title: Role
10026
10030
  title: PublicRoleAssignment
10027
10031
  type: object
10028
10032
  PublicRoleAssignmentRequest:
@@ -10030,7 +10034,9 @@ components:
10030
10034
  role:
10031
10035
  anyOf:
10032
10036
  - $ref: '#/components/schemas/AssignablePublicRole'
10037
+ - $ref: '#/components/schemas/CustomRoleLabel'
10033
10038
  - type: 'null'
10039
+ title: Role
10034
10040
  title: PublicRoleAssignmentRequest
10035
10041
  type: object
10036
10042
  PublicRoleDefinition:
@@ -10055,10 +10061,9 @@ components:
10055
10061
  description: Description of the role.
10056
10062
  title: Description
10057
10063
  label:
10064
+ $ref: '#/components/schemas/CustomRoleLabel'
10058
10065
  description: Per-organization unique identifier (snake_case, e.g. 'support_staff').
10059
10066
  Used as the URL path parameter.
10060
- title: Label
10061
- type: string
10062
10067
  name:
10063
10068
  description: Display name of the role (e.g. 'Support Staff').
10064
10069
  title: Name
@@ -11677,7 +11682,9 @@ components:
11677
11682
  role:
11678
11683
  anyOf:
11679
11684
  - $ref: '#/components/schemas/PublicRole'
11685
+ - $ref: '#/components/schemas/CustomRoleLabel'
11680
11686
  - type: 'null'
11687
+ title: Role
11681
11688
  status:
11682
11689
  $ref: '#/components/schemas/UserStatus'
11683
11690
  readOnly: true
@@ -11881,7 +11888,9 @@ components:
11881
11888
  role:
11882
11889
  anyOf:
11883
11890
  - $ref: '#/components/schemas/PublicRole'
11891
+ - $ref: '#/components/schemas/CustomRoleLabel'
11884
11892
  - type: 'null'
11893
+ title: Role
11885
11894
  status:
11886
11895
  $ref: '#/components/schemas/UserStatus'
11887
11896
  readOnly: true
@@ -12252,7 +12261,7 @@ info:
12252
12261
  \n\n"
12253
12262
  summary: OpusDNS - your gateway to a seamless domain management experience.
12254
12263
  title: OpusDNS API
12255
- version: 2026-06-16-085537
12264
+ version: 2026-06-16-093305
12256
12265
  x-logo:
12257
12266
  altText: OpusDNS API Reference
12258
12267
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -27119,7 +27128,8 @@ paths:
27119
27128
  x-required-permissions:
27120
27129
  - users:read
27121
27130
  put:
27122
- description: Set the role for a user, replacing any existing role
27131
+ description: Set the role for a user, replacing any existing role. Accepts a
27132
+ built-in role name or the label of a custom role owned by the user's organization
27123
27133
  operationId: set_user_role_v1_users__user_id__role_put
27124
27134
  parameters:
27125
27135
  - in: path
@@ -27158,6 +27168,19 @@ paths:
27158
27168
  schema:
27159
27169
  $ref: '#/components/schemas/Problem'
27160
27170
  description: Forbidden
27171
+ '404':
27172
+ content:
27173
+ application/problem+json:
27174
+ example:
27175
+ code: ERROR_ROLE_NOT_FOUND
27176
+ detail: Role not found
27177
+ role_name: support_staff
27178
+ status: 404
27179
+ title: Role Management Error
27180
+ type: role-not-found
27181
+ schema:
27182
+ $ref: '#/components/schemas/Problem'
27183
+ description: Not Found
27161
27184
  '422':
27162
27185
  content:
27163
27186
  application/problem+json:
package/src/schema.d.ts CHANGED
@@ -2550,7 +2550,7 @@ export interface paths {
2550
2550
  get: operations["get_role_v1_users__user_id__role_get"];
2551
2551
  /**
2552
2552
  * Set user role
2553
- * @description Set the role for a user, replacing any existing role
2553
+ * @description Set the role for a user, replacing any existing role. Accepts a built-in role name or the label of a custom role owned by the user's organization
2554
2554
  */
2555
2555
  put: operations["set_user_role_v1_users__user_id__role_put"];
2556
2556
  post?: never;
@@ -4087,6 +4087,7 @@ export interface components {
4087
4087
  */
4088
4088
  permissions: components["schemas"]["PublicPermission"][];
4089
4089
  };
4090
+ CustomRoleLabel: string;
4090
4091
  /**
4091
4092
  * CustomRoleUpdate
4092
4093
  * @description Request body for updating a custom role. Omitted fields are left unchanged; `permissions`
@@ -9193,11 +9194,13 @@ export interface components {
9193
9194
  PublicRole: "owner" | "admin" | "viewer" | "domain_manager" | "dns_manager" | "billing_manager";
9194
9195
  /** PublicRoleAssignment */
9195
9196
  PublicRoleAssignment: {
9196
- role?: components["schemas"]["PublicRole"] | null;
9197
+ /** Role */
9198
+ role?: components["schemas"]["PublicRole"] | components["schemas"]["CustomRoleLabel"] | null;
9197
9199
  };
9198
9200
  /** PublicRoleAssignmentRequest */
9199
9201
  PublicRoleAssignmentRequest: {
9200
- role?: components["schemas"]["AssignablePublicRole"] | null;
9202
+ /** Role */
9203
+ role?: components["schemas"]["AssignablePublicRole"] | components["schemas"]["CustomRoleLabel"] | null;
9201
9204
  };
9202
9205
  /**
9203
9206
  * PublicRoleDefinition
@@ -9219,11 +9222,8 @@ export interface components {
9219
9222
  * @description Description of the role.
9220
9223
  */
9221
9224
  description?: string | null;
9222
- /**
9223
- * Label
9224
- * @description Per-organization unique identifier (snake_case, e.g. 'support_staff'). Used as the URL path parameter.
9225
- */
9226
- label: string;
9225
+ /** @description Per-organization unique identifier (snake_case, e.g. 'support_staff'). Used as the URL path parameter. */
9226
+ label: components["schemas"]["CustomRoleLabel"];
9227
9227
  /**
9228
9228
  * Name
9229
9229
  * @description Display name of the role (e.g. 'Support Staff').
@@ -10350,7 +10350,8 @@ export interface components {
10350
10350
  * @example +1.2125552368
10351
10351
  */
10352
10352
  phone?: string | null;
10353
- role?: components["schemas"]["PublicRole"] | null;
10353
+ /** Role */
10354
+ role?: components["schemas"]["PublicRole"] | components["schemas"]["CustomRoleLabel"] | null;
10354
10355
  readonly status: components["schemas"]["UserStatus"];
10355
10356
  /**
10356
10357
  * Updated On
@@ -10497,7 +10498,8 @@ export interface components {
10497
10498
  * @example +1.2125552368
10498
10499
  */
10499
10500
  phone?: string | null;
10500
- role?: components["schemas"]["PublicRole"] | null;
10501
+ /** Role */
10502
+ role?: components["schemas"]["PublicRole"] | components["schemas"]["CustomRoleLabel"] | null;
10501
10503
  readonly status: components["schemas"]["UserStatus"];
10502
10504
  /**
10503
10505
  * Updated On
@@ -22109,6 +22111,23 @@ export interface operations {
22109
22111
  "application/problem+json": components["schemas"]["Problem"];
22110
22112
  };
22111
22113
  };
22114
+ /** @description Not Found */
22115
+ 404: {
22116
+ headers: {
22117
+ [name: string]: unknown;
22118
+ };
22119
+ content: {
22120
+ /** @example {
22121
+ * "code": "ERROR_ROLE_NOT_FOUND",
22122
+ * "detail": "Role not found",
22123
+ * "role_name": "support_staff",
22124
+ * "status": 404,
22125
+ * "title": "Role Management Error",
22126
+ * "type": "role-not-found"
22127
+ * } */
22128
+ "application/problem+json": components["schemas"]["Problem"];
22129
+ };
22130
+ };
22112
22131
  /** @description Validation Error */
22113
22132
  422: {
22114
22133
  headers: {