mirror of
https://github.com/discord/discord-api-spec.git
synced 2026-05-01 06:20:33 -04:00
Compare commits
2 commits
65949ceee6
...
1b537b31c1
| Author | SHA1 | Date | |
|---|---|---|---|
|
1b537b31c1 | ||
|
|
b0c342fc3d |
2 changed files with 504 additions and 68 deletions
|
|
@ -11133,6 +11133,178 @@
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"/invites/{code}/target-users": {
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "code",
|
||||||
|
"in": "path",
|
||||||
|
"schema": {
|
||||||
|
"type": "string",
|
||||||
|
"maxLength": 152133
|
||||||
|
},
|
||||||
|
"required": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"get": {
|
||||||
|
"description": "Get the target users for an invite.",
|
||||||
|
"operationId": "get_invite_target_users",
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "200 response for get_invite_target_users",
|
||||||
|
"headers": {
|
||||||
|
"X-RateLimit-Limit": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Remaining": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Reset": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Reset-After": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Reset-After"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Bucket": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Bucket"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"content": {
|
||||||
|
"text/csv": {
|
||||||
|
"schema": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "CSV file containing target users for the invite.",
|
||||||
|
"contentEncoding": "binary"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"429": {
|
||||||
|
"$ref": "#/components/responses/ClientRatelimitedResponse"
|
||||||
|
},
|
||||||
|
"4XX": {
|
||||||
|
"$ref": "#/components/responses/ClientErrorResponse"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"security": [
|
||||||
|
{
|
||||||
|
"BotToken": []
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"put": {
|
||||||
|
"description": "Update the target users for an existing invite.",
|
||||||
|
"operationId": "update_invite_target_users",
|
||||||
|
"requestBody": {
|
||||||
|
"content": {
|
||||||
|
"multipart/form-data": {
|
||||||
|
"schema": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"target_users_file": {
|
||||||
|
"type": "string",
|
||||||
|
"contentEncoding": "binary"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"target_users_file"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": true
|
||||||
|
},
|
||||||
|
"responses": {
|
||||||
|
"204": {
|
||||||
|
"description": "204 response for update_invite_target_users",
|
||||||
|
"headers": {
|
||||||
|
"X-RateLimit-Limit": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Remaining": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Reset": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Reset-After": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Reset-After"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Bucket": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Bucket"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"429": {
|
||||||
|
"$ref": "#/components/responses/ClientRatelimitedResponse"
|
||||||
|
},
|
||||||
|
"4XX": {
|
||||||
|
"$ref": "#/components/responses/ClientErrorResponse"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"security": [
|
||||||
|
{
|
||||||
|
"BotToken": []
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"/invites/{code}/target-users/job-status": {
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "code",
|
||||||
|
"in": "path",
|
||||||
|
"schema": {
|
||||||
|
"type": "string",
|
||||||
|
"maxLength": 152133
|
||||||
|
},
|
||||||
|
"required": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"get": {
|
||||||
|
"description": "Get the target users job status for an invite.",
|
||||||
|
"operationId": "get_invite_target_users_job_status",
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "200 response for get_invite_target_users_job_status",
|
||||||
|
"headers": {
|
||||||
|
"X-RateLimit-Limit": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Remaining": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Reset": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Reset-After": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Reset-After"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Bucket": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Bucket"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/TargetUsersJobStatusResponse"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"429": {
|
||||||
|
"$ref": "#/components/responses/ClientRatelimitedResponse"
|
||||||
|
},
|
||||||
|
"4XX": {
|
||||||
|
"$ref": "#/components/responses/ClientErrorResponse"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"security": [
|
||||||
|
{
|
||||||
|
"BotToken": []
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
"/lobbies": {
|
"/lobbies": {
|
||||||
"put": {
|
"put": {
|
||||||
"operationId": "create_or_join_lobby",
|
"operationId": "create_or_join_lobby",
|
||||||
|
|
@ -19240,16 +19412,6 @@
|
||||||
"$ref": "#/components/schemas/CustomClientThemeShareRequest"
|
"$ref": "#/components/schemas/CustomClientThemeShareRequest"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
|
||||||
"confetti_potion": {
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"type": "null"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/ConfettiPotionCreateRequest"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
@ -20604,10 +20766,6 @@
|
||||||
"name"
|
"name"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"ConfettiPotionCreateRequest": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {}
|
|
||||||
},
|
|
||||||
"ConnectedAccountGuildResponse": {
|
"ConnectedAccountGuildResponse": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
|
@ -24535,6 +24693,15 @@
|
||||||
},
|
},
|
||||||
"is_nickname_changeable": {
|
"is_nickname_changeable": {
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
"roles": {
|
||||||
|
"type": [
|
||||||
|
"array",
|
||||||
|
"null"
|
||||||
|
],
|
||||||
|
"items": {
|
||||||
|
"$ref": "#/components/schemas/GuildRoleResponse"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
|
|
@ -29321,16 +29488,6 @@
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"confetti_potion": {
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"type": "null"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/ConfettiPotionCreateRequest"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"message_reference": {
|
"message_reference": {
|
||||||
"oneOf": [
|
"oneOf": [
|
||||||
{
|
{
|
||||||
|
|
@ -33148,16 +33305,6 @@
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"confetti_potion": {
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"type": "null"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/ConfettiPotionCreateRequest"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"message_reference": {
|
"message_reference": {
|
||||||
"oneOf": [
|
"oneOf": [
|
||||||
{
|
{
|
||||||
|
|
@ -34591,6 +34738,77 @@
|
||||||
"value"
|
"value"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
"TargetUsersJobStatusResponse": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"status": {
|
||||||
|
"$ref": "#/components/schemas/TargetUsersJobStatusTypes",
|
||||||
|
"description": "The status of the job processing the target users."
|
||||||
|
},
|
||||||
|
"total_users": {
|
||||||
|
"$ref": "#/components/schemas/UInt32Type",
|
||||||
|
"description": "The total number of users in the provided list."
|
||||||
|
},
|
||||||
|
"processed_users": {
|
||||||
|
"$ref": "#/components/schemas/UInt32Type",
|
||||||
|
"description": "The number of users processed so far."
|
||||||
|
},
|
||||||
|
"created_at": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
],
|
||||||
|
"description": "The timestamp when the job was created.",
|
||||||
|
"format": "date-time"
|
||||||
|
},
|
||||||
|
"completed_at": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
],
|
||||||
|
"description": "The timestamp when the job was successfully completed.",
|
||||||
|
"format": "date-time"
|
||||||
|
},
|
||||||
|
"error_message": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
],
|
||||||
|
"description": "The error message if the job failed."
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"status",
|
||||||
|
"total_users",
|
||||||
|
"processed_users"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"TargetUsersJobStatusTypes": {
|
||||||
|
"type": "integer",
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"title": "UNSPECIFIED",
|
||||||
|
"description": "The default value.",
|
||||||
|
"const": 0
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "PROCESSING",
|
||||||
|
"description": "The job is still being processed.",
|
||||||
|
"const": 1
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "COMPLETED",
|
||||||
|
"description": "The job has been completed successfully.",
|
||||||
|
"const": 2
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "FAILED",
|
||||||
|
"description": "The job has failed, see error_message field for more details.",
|
||||||
|
"const": 3
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"format": "int32"
|
||||||
|
},
|
||||||
"TeamMemberResponse": {
|
"TeamMemberResponse": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
|
|
||||||
|
|
@ -11473,6 +11473,178 @@
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"/invites/{code}/target-users": {
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "code",
|
||||||
|
"in": "path",
|
||||||
|
"schema": {
|
||||||
|
"type": "string",
|
||||||
|
"maxLength": 152133
|
||||||
|
},
|
||||||
|
"required": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"get": {
|
||||||
|
"description": "Get the target users for an invite.",
|
||||||
|
"operationId": "get_invite_target_users",
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "200 response for get_invite_target_users",
|
||||||
|
"headers": {
|
||||||
|
"X-RateLimit-Limit": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Remaining": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Reset": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Reset-After": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Reset-After"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Bucket": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Bucket"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"content": {
|
||||||
|
"text/csv": {
|
||||||
|
"schema": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "CSV file containing target users for the invite.",
|
||||||
|
"contentEncoding": "binary"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"429": {
|
||||||
|
"$ref": "#/components/responses/ClientRatelimitedResponse"
|
||||||
|
},
|
||||||
|
"4XX": {
|
||||||
|
"$ref": "#/components/responses/ClientErrorResponse"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"security": [
|
||||||
|
{
|
||||||
|
"BotToken": []
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"put": {
|
||||||
|
"description": "Update the target users for an existing invite.",
|
||||||
|
"operationId": "update_invite_target_users",
|
||||||
|
"requestBody": {
|
||||||
|
"content": {
|
||||||
|
"multipart/form-data": {
|
||||||
|
"schema": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"target_users_file": {
|
||||||
|
"type": "string",
|
||||||
|
"contentEncoding": "binary"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"target_users_file"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": true
|
||||||
|
},
|
||||||
|
"responses": {
|
||||||
|
"204": {
|
||||||
|
"description": "204 response for update_invite_target_users",
|
||||||
|
"headers": {
|
||||||
|
"X-RateLimit-Limit": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Remaining": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Reset": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Reset-After": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Reset-After"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Bucket": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Bucket"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"429": {
|
||||||
|
"$ref": "#/components/responses/ClientRatelimitedResponse"
|
||||||
|
},
|
||||||
|
"4XX": {
|
||||||
|
"$ref": "#/components/responses/ClientErrorResponse"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"security": [
|
||||||
|
{
|
||||||
|
"BotToken": []
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"/invites/{code}/target-users/job-status": {
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "code",
|
||||||
|
"in": "path",
|
||||||
|
"schema": {
|
||||||
|
"type": "string",
|
||||||
|
"maxLength": 152133
|
||||||
|
},
|
||||||
|
"required": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"get": {
|
||||||
|
"description": "Get the target users job status for an invite.",
|
||||||
|
"operationId": "get_invite_target_users_job_status",
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "200 response for get_invite_target_users_job_status",
|
||||||
|
"headers": {
|
||||||
|
"X-RateLimit-Limit": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Limit"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Remaining": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Remaining"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Reset": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Reset"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Reset-After": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Reset-After"
|
||||||
|
},
|
||||||
|
"X-RateLimit-Bucket": {
|
||||||
|
"$ref": "#/components/headers/X-RateLimit-Bucket"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/TargetUsersJobStatusResponse"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"429": {
|
||||||
|
"$ref": "#/components/responses/ClientRatelimitedResponse"
|
||||||
|
},
|
||||||
|
"4XX": {
|
||||||
|
"$ref": "#/components/responses/ClientErrorResponse"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"security": [
|
||||||
|
{
|
||||||
|
"BotToken": []
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
"/lobbies": {
|
"/lobbies": {
|
||||||
"put": {
|
"put": {
|
||||||
"operationId": "create_or_join_lobby",
|
"operationId": "create_or_join_lobby",
|
||||||
|
|
@ -19609,16 +19781,6 @@
|
||||||
"$ref": "#/components/schemas/CustomClientThemeShareRequest"
|
"$ref": "#/components/schemas/CustomClientThemeShareRequest"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
|
||||||
"confetti_potion": {
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"type": "null"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/ConfettiPotionCreateRequest"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
@ -21012,10 +21174,6 @@
|
||||||
"name"
|
"name"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"ConfettiPotionCreateRequest": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {}
|
|
||||||
},
|
|
||||||
"ConnectedAccountGuildResponse": {
|
"ConnectedAccountGuildResponse": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
|
@ -24975,6 +25133,15 @@
|
||||||
},
|
},
|
||||||
"is_nickname_changeable": {
|
"is_nickname_changeable": {
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
"roles": {
|
||||||
|
"type": [
|
||||||
|
"array",
|
||||||
|
"null"
|
||||||
|
],
|
||||||
|
"items": {
|
||||||
|
"$ref": "#/components/schemas/GuildRoleResponse"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": [
|
"required": [
|
||||||
|
|
@ -29907,16 +30074,6 @@
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"confetti_potion": {
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"type": "null"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/ConfettiPotionCreateRequest"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"message_reference": {
|
"message_reference": {
|
||||||
"oneOf": [
|
"oneOf": [
|
||||||
{
|
{
|
||||||
|
|
@ -34029,16 +34186,6 @@
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"confetti_potion": {
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"type": "null"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/ConfettiPotionCreateRequest"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"message_reference": {
|
"message_reference": {
|
||||||
"oneOf": [
|
"oneOf": [
|
||||||
{
|
{
|
||||||
|
|
@ -35903,6 +36050,77 @@
|
||||||
"value"
|
"value"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
"TargetUsersJobStatusResponse": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"status": {
|
||||||
|
"$ref": "#/components/schemas/TargetUsersJobStatusTypes",
|
||||||
|
"description": "The status of the job processing the target users."
|
||||||
|
},
|
||||||
|
"total_users": {
|
||||||
|
"$ref": "#/components/schemas/UInt32Type",
|
||||||
|
"description": "The total number of users in the provided list."
|
||||||
|
},
|
||||||
|
"processed_users": {
|
||||||
|
"$ref": "#/components/schemas/UInt32Type",
|
||||||
|
"description": "The number of users processed so far."
|
||||||
|
},
|
||||||
|
"created_at": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
],
|
||||||
|
"description": "The timestamp when the job was created.",
|
||||||
|
"format": "date-time"
|
||||||
|
},
|
||||||
|
"completed_at": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
],
|
||||||
|
"description": "The timestamp when the job was successfully completed.",
|
||||||
|
"format": "date-time"
|
||||||
|
},
|
||||||
|
"error_message": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
],
|
||||||
|
"description": "The error message if the job failed."
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"status",
|
||||||
|
"total_users",
|
||||||
|
"processed_users"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"TargetUsersJobStatusTypes": {
|
||||||
|
"type": "integer",
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"title": "UNSPECIFIED",
|
||||||
|
"description": "The default value.",
|
||||||
|
"const": 0
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "PROCESSING",
|
||||||
|
"description": "The job is still being processed.",
|
||||||
|
"const": 1
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "COMPLETED",
|
||||||
|
"description": "The job has been completed successfully.",
|
||||||
|
"const": 2
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "FAILED",
|
||||||
|
"description": "The job has failed, see error_message field for more details.",
|
||||||
|
"const": 3
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"format": "int32"
|
||||||
|
},
|
||||||
"TeamMemberResponse": {
|
"TeamMemberResponse": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue