From 0d2c7f2ed65bc63152ba026362e455cedb86462b Mon Sep 17 00:00:00 2001 From: knock-eng-bot Date: Wed, 7 Jan 2026 15:47:55 +0000 Subject: [PATCH] chore: update switchboard openapi spec to v0.1.1307 --- data/specs/api/openapi.yml | 113 ++++++++++++++++++++++++++++++------- 1 file changed, 93 insertions(+), 20 deletions(-) diff --git a/data/specs/api/openapi.yml b/data/specs/api/openapi.yml index 0f1f77104..fb9f5aaad 100644 --- a/data/specs/api/openapi.yml +++ b/data/specs/api/openapi.yml @@ -7368,7 +7368,10 @@ paths: apiKey: process.env['KNOCK_API_KEY'], // This is the default and can be omitted }); - const response = await client.users.feeds.getSettings('user_id', '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'); + const response = await client.users.feeds.getSettings( + 'user_id', + '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', + ); console.log(response.features); python: |- @@ -8570,8 +8573,16 @@ paths: body: "Limited spots available for today's behind-the-scenes DNA extraction demonstration.", title: 'DNA Lab Tour Available', }, - data: { next_time: '14:30', spots_left: 8, tour_id: 'dna_lab_tour' }, - metadata: { cta: 'Reserve Spot', theme: 'amber', type: 'banner' }, + data: { + next_time: '14:30', + spots_left: 8, + tour_id: 'dna_lab_tour', + }, + metadata: { + cta: 'Reserve Spot', + theme: 'amber', + type: 'banner', + }, tenant: 'ingen_isla_nublar', }); @@ -9960,7 +9971,10 @@ paths: apiKey: process.env['KNOCK_API_KEY'], // This is the default and can be omitted }); - const channelData = await client.users.getChannelData('user_id', '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'); + const channelData = await client.users.getChannelData( + 'user_id', + '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', + ); console.log(channelData.channel_id); python: |- @@ -10061,9 +10075,11 @@ paths: apiKey: process.env['KNOCK_API_KEY'], // This is the default and can be omitted }); - const channelData = await client.users.setChannelData('user_id', '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { - data: { tokens: ['push_token_1'] }, - }); + const channelData = await client.users.setChannelData( + 'user_id', + '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', + { data: { tokens: ['push_token_1'] } }, + ); console.log(channelData.channel_id); python: |- @@ -11578,11 +11594,20 @@ paths: const bulkOperation = await client.users.bulk.setPreferences({ preferences: { __persistence_strategy__: 'merge', - categories: { marketing: false, transactional: { channel_types: { email: false } } }, + categories: { + marketing: false, + transactional: { channel_types: { email: false } }, + }, channel_types: { email: true }, channels: { '2f641633-95d3-4555-9222-9f1eb7888a80': { - conditions: [{ argument: 'US', operator: 'equal_to', variable: 'recipient.country_code' }], + conditions: [ + { + argument: 'US', + operator: 'equal_to', + variable: 'recipient.country_code', + }, + ], }, 'aef6e715-df82-4ab6-b61e-b743e249f7b6': true, }, @@ -11786,7 +11811,10 @@ paths: apiKey: process.env['KNOCK_API_KEY'], // This is the default and can be omitted }); - const response = await client.users.guides.getChannel('user_id', '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'); + const response = await client.users.guides.getChannel( + 'user_id', + '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', + ); console.log(response.guide_group_display_logs); python: |- @@ -11869,7 +11897,9 @@ paths: apiKey: process.env['KNOCK_API_KEY'], // This is the default and can be omitted }); - const schedules = await client.schedules.delete({ schedule_ids: ['123e4567-e89b-12d3-a456-426614174000'] }); + const schedules = await client.schedules.delete({ + schedule_ids: ['123e4567-e89b-12d3-a456-426614174000'], + }); console.log(schedules); python: |- @@ -12373,7 +12403,13 @@ paths: }); const bulkOperation = await client.objects.bulk.addSubscriptions('projects', { - subscriptions: [{ id: 'project-1', properties: null, recipients: [{ id: 'user_1' }] }], + subscriptions: [ + { + id: 'project-1', + properties: null, + recipients: [{ id: 'user_1' }], + }, + ], }); console.log(bulkOperation.id); @@ -12576,7 +12612,14 @@ paths: }); const bulkOperation = await client.users.bulk.identify({ - users: [{ email: 'jane@ingen.net', id: 'user_1', name: 'Jane Doe', timezone: 'America/New_York' }], + users: [ + { + email: 'jane@ingen.net', + id: 'user_1', + name: 'Jane Doe', + timezone: 'America/New_York', + }, + ], }); console.log(bulkOperation.id); @@ -13649,7 +13692,11 @@ paths: apiKey: process.env['KNOCK_API_KEY'], // This is the default and can be omitted }); - await client.objects.unsetChannelData('collection', 'object_id', '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'); + await client.objects.unsetChannelData( + 'collection', + 'object_id', + '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', + ); python: |- import os from knockapi import Knock @@ -14132,7 +14179,12 @@ paths: }); await client.audiences.addMembers('key', { - members: [{ tenant: 'ingen_isla_nublar', user: { id: 'dr_sattler' } }], + members: [ + { + tenant: 'ingen_isla_nublar', + user: { id: 'dr_sattler' }, + }, + ], }); python: |- import os @@ -16716,7 +16768,10 @@ paths: apiKey: process.env['KNOCK_API_KEY'], // This is the default and can be omitted }); - await client.workflows.cancel('key', { cancellation_key: 'cancel-workflow-123', recipients: ['jhammond'] }); + await client.workflows.cancel('key', { + cancellation_key: 'cancel-workflow-123', + recipients: ['jhammond'], + }); python: |- import os from knockapi import Knock @@ -17431,11 +17486,20 @@ paths: const preferenceSet = await client.objects.setPreferences('collection', 'object_id', 'default', { __persistence_strategy__: 'merge', - categories: { marketing: false, transactional: { channel_types: { email: false } } }, + categories: { + marketing: false, + transactional: { channel_types: { email: false } }, + }, channel_types: { email: true }, channels: { '2f641633-95d3-4555-9222-9f1eb7888a80': { - conditions: [{ argument: 'US', operator: 'equal_to', variable: 'recipient.country_code' }], + conditions: [ + { + argument: 'US', + operator: 'equal_to', + variable: 'recipient.country_code', + }, + ], }, 'aef6e715-df82-4ab6-b61e-b743e249f7b6': true, }, @@ -17933,11 +17997,20 @@ paths: const preferenceSet = await client.users.setPreferences('user_id', 'default', { __persistence_strategy__: 'merge', - categories: { marketing: false, transactional: { channel_types: { email: false } } }, + categories: { + marketing: false, + transactional: { channel_types: { email: false } }, + }, channel_types: { email: true }, channels: { '2f641633-95d3-4555-9222-9f1eb7888a80': { - conditions: [{ argument: 'US', operator: 'equal_to', variable: 'recipient.country_code' }], + conditions: [ + { + argument: 'US', + operator: 'equal_to', + variable: 'recipient.country_code', + }, + ], }, 'aef6e715-df82-4ab6-b61e-b743e249f7b6': true, },