Skip to content

Commit

Permalink
Merge pull request #53 from apivideo/bugfix/swift5_model_documentation
Browse files Browse the repository at this point in the history
fix(swift5): fix model example in documentation
  • Loading branch information
bot-api-video authored Jul 5, 2023
2 parents 0405fa0 + 8a57538 commit abdf804
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions docs/AdvancedAuthenticationAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Returns a bearer token that can be used to authenticate other endpoint. You can
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ApiVideoClient

let authenticatePayload = authenticate-payload(apiKey: "apiKey_example") // AuthenticatePayload |
let authenticatePayload = AuthenticatePayload(apiKey: "apiKey_example") // AuthenticatePayload |

// Get Bearer Token
AdvancedAuthenticationAPI.authenticate(authenticatePayload: authenticatePayload) { (response, error) in
Expand Down Expand Up @@ -74,7 +74,7 @@ Accepts the old bearer token and returns a new bearer token that can be used to
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ApiVideoClient

let refreshTokenPayload = refresh-token-payload(refreshToken: "refreshToken_example") // RefreshTokenPayload |
let refreshTokenPayload = RefreshTokenPayload(refreshToken: "refreshToken_example") // RefreshTokenPayload |

// Refresh Bearer Token
AdvancedAuthenticationAPI.refresh(refreshTokenPayload: refreshTokenPayload) { (response, error) in
Expand Down
2 changes: 1 addition & 1 deletion docs/CaptionsAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ import ApiVideoClient

let videoId = "videoId_example" // String | The unique identifier for the video you want to have automatic captions for.
let language = "language_example" // String | A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation.
let captionsUpdatePayload = captions-update-payload(_default: false) // CaptionsUpdatePayload |
let captionsUpdatePayload = CaptionsUpdatePayload(_default: false) // CaptionsUpdatePayload |

// Update a caption
CaptionsAPI.update(videoId: videoId, language: language, captionsUpdatePayload: captionsUpdatePayload) { (response, error) in
Expand Down
4 changes: 2 additions & 2 deletions docs/LiveStreamsAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Creates a livestream object.
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ApiVideoClient

let liveStreamCreationPayload = live-stream-creation-payload(name: "name_example", record: true, _public: false, playerId: "playerId_example", restreams: [restreams-request-object(name: "name_example", serverUrl: "serverUrl_example", streamKey: "streamKey_example")]) // LiveStreamCreationPayload |
let liveStreamCreationPayload = LiveStreamCreationPayload(name: "name_example", record: true, _public: false, playerId: "playerId_example", restreams: [RestreamsRequestObject(name: "name_example", serverUrl: "serverUrl_example", streamKey: "streamKey_example")]) // LiveStreamCreationPayload |

// Create live stream
LiveStreamsAPI.create(liveStreamCreationPayload: liveStreamCreationPayload) { (response, error) in
Expand Down Expand Up @@ -131,7 +131,7 @@ Updates the livestream object.
import ApiVideoClient

let liveStreamId = "liveStreamId_example" // String | The unique ID for the live stream that you want to update information for such as player details, or whether you want the recording on or off.
let liveStreamUpdatePayload = live-stream-update-payload(name: "name_example", _public: false, record: true, playerId: "playerId_example", restreams: [restreams-request-object(name: "name_example", serverUrl: "serverUrl_example", streamKey: "streamKey_example")]) // LiveStreamUpdatePayload |
let liveStreamUpdatePayload = LiveStreamUpdatePayload(name: "name_example", _public: false, record: true, playerId: "playerId_example", restreams: [RestreamsRequestObject(name: "name_example", serverUrl: "serverUrl_example", streamKey: "streamKey_example")]) // LiveStreamUpdatePayload |

// Update a live stream
LiveStreamsAPI.update(liveStreamId: liveStreamId, liveStreamUpdatePayload: liveStreamUpdatePayload) { (response, error) in
Expand Down
4 changes: 2 additions & 2 deletions docs/PlayerThemesAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Create a player for your video, and customise it.
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ApiVideoClient

let playerThemeCreationPayload = player-theme-creation-payload(name: "name_example", text: "text_example", link: "link_example", linkHover: "linkHover_example", linkActive: "linkActive_example", trackPlayed: "trackPlayed_example", trackUnplayed: "trackUnplayed_example", trackBackground: "trackBackground_example", backgroundTop: "backgroundTop_example", backgroundBottom: "backgroundBottom_example", backgroundText: "backgroundText_example", enableApi: false, enableControls: false, forceAutoplay: false, hideTitle: false, forceLoop: false) // PlayerThemeCreationPayload |
let playerThemeCreationPayload = PlayerThemeCreationPayload(name: "name_example", text: "text_example", link: "link_example", linkHover: "linkHover_example", linkActive: "linkActive_example", trackPlayed: "trackPlayed_example", trackUnplayed: "trackUnplayed_example", trackBackground: "trackBackground_example", backgroundTop: "backgroundTop_example", backgroundBottom: "backgroundBottom_example", backgroundText: "backgroundText_example", enableApi: false, enableControls: false, forceAutoplay: false, hideTitle: false, forceLoop: false) // PlayerThemeCreationPayload |

// Create a player
PlayerThemesAPI.create(playerThemeCreationPayload: playerThemeCreationPayload) { (response, error) in
Expand Down Expand Up @@ -131,7 +131,7 @@ Use a player ID to update specific details for a player. NOTE: It may take up t
import ApiVideoClient

let playerId = "playerId_example" // String | The unique identifier for the player.
let playerThemeUpdatePayload = player-theme-update-payload(name: "name_example", text: "text_example", link: "link_example", linkHover: "linkHover_example", linkActive: "linkActive_example", trackPlayed: "trackPlayed_example", trackUnplayed: "trackUnplayed_example", trackBackground: "trackBackground_example", backgroundTop: "backgroundTop_example", backgroundBottom: "backgroundBottom_example", backgroundText: "backgroundText_example", enableApi: false, enableControls: false, forceAutoplay: false, hideTitle: false, forceLoop: false) // PlayerThemeUpdatePayload |
let playerThemeUpdatePayload = PlayerThemeUpdatePayload(name: "name_example", text: "text_example", link: "link_example", linkHover: "linkHover_example", linkActive: "linkActive_example", trackPlayed: "trackPlayed_example", trackUnplayed: "trackUnplayed_example", trackBackground: "trackBackground_example", backgroundTop: "backgroundTop_example", backgroundBottom: "backgroundBottom_example", backgroundText: "backgroundText_example", enableApi: false, enableControls: false, forceAutoplay: false, hideTitle: false, forceLoop: false) // PlayerThemeUpdatePayload |

// Update a player
PlayerThemesAPI.update(playerId: playerId, playerThemeUpdatePayload: playerThemeUpdatePayload) { (response, error) in
Expand Down
2 changes: 1 addition & 1 deletion docs/UploadTokensAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Generates an upload token that can be used to replace the API Key. More informat
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ApiVideoClient

let tokenCreationPayload = token-creation-payload(ttl: 123) // TokenCreationPayload |
let tokenCreationPayload = TokenCreationPayload(ttl: 123) // TokenCreationPayload |

// Generate an upload token
UploadTokensAPI.createToken(tokenCreationPayload: tokenCreationPayload) { (response, error) in
Expand Down
6 changes: 3 additions & 3 deletions docs/VideosAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Creates a video object. More information on video objects can be found [here](ht
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ApiVideoClient

let videoCreationPayload = video-creation-payload(title: "title_example", description: "description_example", source: "source_example", _public: true, panoramic: false, mp4Support: true, playerId: "playerId_example", tags: ["tags_example"], metadata: [metadata(key: "key_example", value: "value_example")], clip: video-clip(startTimecode: "startTimecode_example", endTimecode: "endTimecode_example"), watermark: video-watermark(id: "id_example", top: "top_example", _left: "_left_example", bottom: "bottom_example", _right: "_right_example", width: "width_example", height: "height_example", opacity: "opacity_example")) // VideoCreationPayload | video to create
let videoCreationPayload = VideoCreationPayload(title: "title_example", description: "description_example", source: "source_example", _public: true, panoramic: false, mp4Support: true, playerId: "playerId_example", tags: ["tags_example"], metadata: [Metadata(key: "key_example", value: "value_example")], clip: VideoClip(startTimecode: "startTimecode_example", endTimecode: "endTimecode_example"), watermark: VideoWatermark(id: "id_example", top: "top_example", _left: "_left_example", bottom: "bottom_example", _right: "_right_example", width: "width_example", height: "height_example", opacity: "opacity_example")) // VideoCreationPayload | video to create

// Create a video object
VideosAPI.create(videoCreationPayload: videoCreationPayload) { (response, error) in
Expand Down Expand Up @@ -264,7 +264,7 @@ NOTE: If you are updating an array, you must provide the entire array as what yo
import ApiVideoClient

let videoId = "videoId_example" // String | The video ID for the video you want to update.
let videoUpdatePayload = video-update-payload(playerId: NullableString(value: "pl4k0jvEUuaTdRAEjQ4Jfrgz"), title: "title_example", description: "description_example", _public: true, panoramic: false, mp4Support: true, tags: ["tags_example"], metadata: [metadata(key: "key_example", value: "value_example")]) // VideoUpdatePayload |
let videoUpdatePayload = VideoUpdatePayload(playerId: NullableString(value: "pl4k0jvEUuaTdRAEjQ4Jfrgz"), title: "title_example", description: "description_example", _public: true, panoramic: false, mp4Support: true, tags: ["tags_example"], metadata: [Metadata(key: "key_example", value: "value_example")]) // VideoUpdatePayload |

// Update a video object
VideosAPI.update(videoId: videoId, videoUpdatePayload: videoUpdatePayload) { (response, error) in
Expand Down Expand Up @@ -510,7 +510,7 @@ There may be a short delay for the thumbnail to update.
import ApiVideoClient

let videoId = "videoId_example" // String | Unique identifier of the video you want to add a thumbnail to, where you use a section of your video as the thumbnail.
let videoThumbnailPickPayload = video-thumbnail-pick-payload(timecode: "timecode_example") // VideoThumbnailPickPayload |
let videoThumbnailPickPayload = VideoThumbnailPickPayload(timecode: "timecode_example") // VideoThumbnailPickPayload |

// Set a thumbnail
VideosAPI.pickThumbnail(videoId: videoId, videoThumbnailPickPayload: videoThumbnailPickPayload) { (response, error) in
Expand Down
2 changes: 1 addition & 1 deletion docs/WebhooksAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Webhooks can push notifications to your server, rather than polling api.video fo
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ApiVideoClient

let webhooksCreationPayload = webhooks-creation-payload(events: ["events_example"], url: "url_example") // WebhooksCreationPayload |
let webhooksCreationPayload = WebhooksCreationPayload(events: ["events_example"], url: "url_example") // WebhooksCreationPayload |

// Create Webhook
WebhooksAPI.create(webhooksCreationPayload: webhooksCreationPayload) { (response, error) in
Expand Down

0 comments on commit abdf804

Please sign in to comment.