Skip to content

Commit 1d5cd21

Browse files
committed
chore: update OpenAPI specs to v226.26.0
1 parent 2323190 commit 1d5cd21

58 files changed

Lines changed: 1248 additions & 84 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

openapi/chat-openapi-clientside.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

openapi/chat-openapi-clientside.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15699,7 +15699,7 @@ components:
1569915699
type: apiKey
1570015700
info:
1570115701
title: Stream API
15702-
version: v226.25.0
15702+
version: v226.26.0
1570315703
openapi: 3.0.3
1570415704
paths:
1570515705
/app:

openapi/chat-openapi.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

openapi/chat-openapi.yaml

Lines changed: 297 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1327,7 +1327,6 @@ components:
13271327
x-stream-index: "001"
13281328
required:
13291329
- type
1330-
- custom
13311330
type: object
13321331
CampaignCompletedEvent:
13331332
nullable: true
@@ -1384,10 +1383,6 @@ components:
13841383
x-stream-index: "001"
13851384
required:
13861385
- text
1387-
- attachments
1388-
- poll_id
1389-
- custom
1390-
- searchable
13911386
type: object
13921387
CampaignResponse:
13931388
properties:
@@ -4095,6 +4090,116 @@ components:
40954090
- duration
40964091
title: Response
40974092
type: object
4093+
CreateCampaignRequest:
4094+
nullable: true
4095+
properties:
4096+
channel_template:
4097+
$ref: '#/components/schemas/CampaignChannelTemplate'
4098+
description: The channel template for the campaign
4099+
title: Channel Template
4100+
x-stream-index: "001.013"
4101+
create_channels:
4102+
description: Whether to create channels for the campaign, if they don't
4103+
exist
4104+
title: Create Channels
4105+
type: boolean
4106+
x-stream-index: "001.008"
4107+
description:
4108+
description: The description of the campaign
4109+
title: Description
4110+
type: string
4111+
x-stream-index: "001.007"
4112+
id:
4113+
maxLength: 255
4114+
type: string
4115+
x-stream-index: "001.001"
4116+
message_template:
4117+
$ref: '#/components/schemas/CampaignMessageTemplate'
4118+
description: The message template for the campaign
4119+
title: Message Template
4120+
x-stream-index: "001.012"
4121+
name:
4122+
description: The name of the campaign
4123+
title: Name
4124+
type: string
4125+
x-stream-index: "001.006"
4126+
segment_ids:
4127+
description: The IDs of the segments to send the campaign to. Duplicate
4128+
user IDs are removed. Use either user_ids or segment_ids, not both
4129+
items:
4130+
type: string
4131+
maxItems: 25
4132+
title: Segment IDs
4133+
type: array
4134+
x-stream-index: "001.002"
4135+
sender_id:
4136+
description: The user ID of the sender
4137+
title: Sender ID
4138+
type: string
4139+
x-stream-index: "001.004"
4140+
sender_mode:
4141+
description: The sender mode of the campaign
4142+
enum:
4143+
- exclude
4144+
- include
4145+
title: Sender Mode
4146+
type: string
4147+
x-stream-index: "001.005"
4148+
sender_visibility:
4149+
description: The visibility of the created channels for the sender
4150+
enum:
4151+
- hidden
4152+
- archived
4153+
title: Sender Visibility
4154+
type: string
4155+
x-stream-index: "001.014"
4156+
show_channels:
4157+
description: Whether the campaign should show channels, if they are hidden
4158+
title: Show Channels
4159+
type: boolean
4160+
x-stream-index: "001.009"
4161+
skip_push:
4162+
description: Whether to skip push notifications
4163+
title: Skip Push
4164+
type: boolean
4165+
x-stream-index: "001.010"
4166+
skip_webhook:
4167+
description: Whether to skip webhooks
4168+
title: Skip Webhook
4169+
type: boolean
4170+
x-stream-index: "001.011"
4171+
user_ids:
4172+
description: The userIDs to send the campaign to. Use either segment ids
4173+
or user ids not both
4174+
items:
4175+
type: string
4176+
maxItems: 10000
4177+
title: User IDs
4178+
type: array
4179+
x-stream-index: "001.003"
4180+
required:
4181+
- sender_id
4182+
- message_template
4183+
type: object
4184+
CreateCampaignResponse:
4185+
description: Basic response information
4186+
nullable: true
4187+
properties:
4188+
campaign:
4189+
$ref: '#/components/schemas/CampaignResponse'
4190+
x-stream-index: "001"
4191+
duration:
4192+
description: Duration of the request in milliseconds
4193+
title: Duration
4194+
type: string
4195+
x-stream-index: "003.001"
4196+
users:
4197+
$ref: '#/components/schemas/PagerResponse'
4198+
x-stream-index: "002"
4199+
required:
4200+
- duration
4201+
title: Response
4202+
type: object
40984203
CreateChannelTypeRequest:
40994204
nullable: true
41004205
properties:
@@ -5135,6 +5240,19 @@ components:
51355240
- duration
51365241
title: Response
51375242
type: object
5243+
DeleteCampaignResponse:
5244+
description: Basic response information
5245+
nullable: true
5246+
properties:
5247+
duration:
5248+
description: Duration of the request in milliseconds
5249+
title: Duration
5250+
type: string
5251+
x-stream-index: "001.001"
5252+
required:
5253+
- duration
5254+
title: Response
5255+
type: object
51385256
DeleteChannelResponse:
51395257
description: Basic response information
51405258
nullable: true
@@ -17734,6 +17852,68 @@ components:
1773417852
- duration
1773517853
title: Response
1773617854
type: object
17855+
UpdateCampaignRequest:
17856+
nullable: true
17857+
properties:
17858+
channel_template:
17859+
$ref: '#/components/schemas/CampaignChannelTemplate'
17860+
x-stream-index: "001.013"
17861+
create_channels:
17862+
type: boolean
17863+
x-stream-index: "001.008"
17864+
description:
17865+
type: string
17866+
x-stream-index: "001.007"
17867+
id:
17868+
maxLength: 255
17869+
type: string
17870+
x-stream-index: "001.001"
17871+
message_template:
17872+
$ref: '#/components/schemas/CampaignMessageTemplate'
17873+
x-stream-index: "001.012"
17874+
name:
17875+
type: string
17876+
x-stream-index: "001.006"
17877+
segment_ids:
17878+
items:
17879+
type: string
17880+
maxItems: 25
17881+
type: array
17882+
x-stream-index: "001.002"
17883+
sender_id:
17884+
type: string
17885+
x-stream-index: "001.004"
17886+
sender_mode:
17887+
enum:
17888+
- exclude
17889+
- include
17890+
type: string
17891+
x-stream-index: "001.005"
17892+
sender_visibility:
17893+
enum:
17894+
- hidden
17895+
- archived
17896+
type: string
17897+
x-stream-index: "001.014"
17898+
show_channels:
17899+
type: boolean
17900+
x-stream-index: "001.009"
17901+
skip_push:
17902+
type: boolean
17903+
x-stream-index: "001.010"
17904+
skip_webhook:
17905+
type: boolean
17906+
x-stream-index: "001.011"
17907+
user_ids:
17908+
items:
17909+
type: string
17910+
maxItems: 10000
17911+
type: array
17912+
x-stream-index: "001.003"
17913+
required:
17914+
- sender_id
17915+
- message_template
17916+
type: object
1773717917
UpdateChannelPartialRequest:
1773817918
nullable: true
1773917919
properties:
@@ -20979,7 +21159,7 @@ components:
2097921159
type: apiKey
2098021160
info:
2098121161
title: Stream API
20982-
version: v226.25.0
21162+
version: v226.26.0
2098321163
openapi: 3.0.3
2098421164
paths:
2098521165
/app:
@@ -21233,7 +21413,77 @@ paths:
2123321413
summary: Update block list
2123421414
tags:
2123521415
- product:chat
21416+
/campaigns:
21417+
post:
21418+
description: |
21419+
Creates a campaign
21420+
operationId: CreateCampaign
21421+
requestBody:
21422+
content:
21423+
application/json:
21424+
schema:
21425+
$ref: '#/components/schemas/CreateCampaignRequest'
21426+
required: true
21427+
responses:
21428+
"201":
21429+
content:
21430+
application/json:
21431+
schema:
21432+
$ref: '#/components/schemas/CreateCampaignResponse'
21433+
description: Response
21434+
"400":
21435+
content:
21436+
application/json:
21437+
schema:
21438+
$ref: '#/components/schemas/APIError'
21439+
description: Bad request
21440+
"429":
21441+
content:
21442+
application/json:
21443+
schema:
21444+
$ref: '#/components/schemas/APIError'
21445+
description: Too many requests
21446+
summary: Create campaign
21447+
tags:
21448+
- product:chat
2123621449
/campaigns/{id}:
21450+
delete:
21451+
description: |
21452+
Delete campaign
21453+
operationId: DeleteCampaign
21454+
parameters:
21455+
- in: path
21456+
name: id
21457+
required: true
21458+
schema:
21459+
description: The ID of the campaign (uuid)
21460+
maxLength: 255
21461+
title: Campaign ID
21462+
type: string
21463+
writeOnly: true
21464+
x-stream-index: "001"
21465+
responses:
21466+
"200":
21467+
content:
21468+
application/json:
21469+
schema:
21470+
$ref: '#/components/schemas/DeleteCampaignResponse'
21471+
description: Response
21472+
"400":
21473+
content:
21474+
application/json:
21475+
schema:
21476+
$ref: '#/components/schemas/APIError'
21477+
description: Bad request
21478+
"429":
21479+
content:
21480+
application/json:
21481+
schema:
21482+
$ref: '#/components/schemas/APIError'
21483+
description: Too many requests
21484+
summary: Delete campaign
21485+
tags:
21486+
- product:chat
2123721487
get:
2123821488
description: |
2123921489
Get campaign by ID.
@@ -21299,6 +21549,47 @@ paths:
2129921549
summary: Get campaign
2130021550
tags:
2130121551
- product:chat
21552+
put:
21553+
description: |
21554+
Updates a campaign
21555+
operationId: UpdateCampaign
21556+
parameters:
21557+
- in: path
21558+
name: id
21559+
required: true
21560+
schema:
21561+
maxLength: 255
21562+
type: string
21563+
writeOnly: true
21564+
x-stream-index: "002"
21565+
requestBody:
21566+
content:
21567+
application/json:
21568+
schema:
21569+
$ref: '#/components/schemas/UpdateCampaignRequest'
21570+
required: true
21571+
responses:
21572+
"201":
21573+
content:
21574+
application/json:
21575+
schema:
21576+
$ref: '#/components/schemas/CampaignResponse'
21577+
description: Successful response
21578+
"400":
21579+
content:
21580+
application/json:
21581+
schema:
21582+
$ref: '#/components/schemas/APIError'
21583+
description: Bad request
21584+
"429":
21585+
content:
21586+
application/json:
21587+
schema:
21588+
$ref: '#/components/schemas/APIError'
21589+
description: Too many requests
21590+
summary: Update campaign
21591+
tags:
21592+
- product:chat
2130221593
/campaigns/{id}/start:
2130321594
post:
2130421595
description: |

openapi/clientside-api.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

openapi/clientside-api.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36716,7 +36716,7 @@ components:
3671636716
type: apiKey
3671736717
info:
3671836718
title: Stream API
36719-
version: v226.25.0
36719+
version: v226.26.0
3672036720
openapi: 3.0.3
3672136721
paths:
3672236722
/api/v2/app:

openapi/moderation-clientside-api.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

openapi/moderation-clientside-api.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6364,7 +6364,7 @@ components:
63646364
type: apiKey
63656365
info:
63666366
title: Stream API
6367-
version: v226.25.0
6367+
version: v226.26.0
63686368
openapi: 3.0.3
63696369
paths:
63706370
/api/v2/moderation/action_config:

openapi/moderation-openapi.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

openapi/moderation-openapi.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4570,7 +4570,7 @@ components:
45704570
type: apiKey
45714571
info:
45724572
title: Stream API
4573-
version: v226.25.0
4573+
version: v226.26.0
45744574
openapi: 3.0.3
45754575
paths:
45764576
/api/v1/moderation/chat_message_tasks:

0 commit comments

Comments
 (0)