radiomanager_client 1.0.1
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.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/README.md +297 -0
- data/Rakefile +8 -0
- data/docs/Block.md +15 -0
- data/docs/BlockApi.md +233 -0
- data/docs/BlockRelations.md +10 -0
- data/docs/BlockRelationsBroadcast.md +11 -0
- data/docs/BlockRelationsBroadcastParams.md +8 -0
- data/docs/BlockRelationsItems.md +11 -0
- data/docs/BlockRelationsItemsParams.md +8 -0
- data/docs/BlockRelationsProgram.md +11 -0
- data/docs/BlockResult.md +18 -0
- data/docs/BlockResults.md +17 -0
- data/docs/Broadcast.md +29 -0
- data/docs/BroadcastApi.md +641 -0
- data/docs/BroadcastDataInput.md +31 -0
- data/docs/BroadcastFieldValues.md +8 -0
- data/docs/BroadcastInputOnly.md +9 -0
- data/docs/BroadcastOutputOnly.md +12 -0
- data/docs/BroadcastRelations.md +13 -0
- data/docs/BroadcastRelationsBlocks.md +11 -0
- data/docs/BroadcastRelationsItems.md +11 -0
- data/docs/BroadcastRelationsItemsParams.md +8 -0
- data/docs/BroadcastRelationsModelType.md +11 -0
- data/docs/BroadcastRelationsPresenters.md +11 -0
- data/docs/BroadcastRelationsTags.md +11 -0
- data/docs/BroadcastResult.md +40 -0
- data/docs/BroadcastResults.md +17 -0
- data/docs/Campaign.md +14 -0
- data/docs/CampaignApi.md +302 -0
- data/docs/CampaignDataInput.md +14 -0
- data/docs/CampaignOutputOnly.md +13 -0
- data/docs/CampaignRelations.md +9 -0
- data/docs/CampaignRelationsItems.md +11 -0
- data/docs/CampaignRelationsItemsParams.md +8 -0
- data/docs/CampaignResult.md +22 -0
- data/docs/CampaignResults.md +17 -0
- data/docs/Contact.md +13 -0
- data/docs/ContactApi.md +300 -0
- data/docs/ContactDataInput.md +13 -0
- data/docs/ContactFieldValues.md +8 -0
- data/docs/ContactOutputOnly.md +12 -0
- data/docs/ContactRelations.md +10 -0
- data/docs/ContactRelationsItems.md +11 -0
- data/docs/ContactRelationsTags.md +11 -0
- data/docs/ContactRelationsTagsParams.md +8 -0
- data/docs/ContactResult.md +21 -0
- data/docs/ContactResults.md +17 -0
- data/docs/Data.md +9 -0
- data/docs/Data1.md +9 -0
- data/docs/EPGBroadcast.md +10 -0
- data/docs/ExternalMessageApi.md +63 -0
- data/docs/ExternalMessageQueueData.md +14 -0
- data/docs/Forbidden.md +9 -0
- data/docs/Genre.md +11 -0
- data/docs/GenreApi.md +131 -0
- data/docs/GenreOutputOnly.md +8 -0
- data/docs/GenreRelations.md +9 -0
- data/docs/GenreRelationsBroadcasts.md +11 -0
- data/docs/GenreRelationsBroadcastsParams.md +8 -0
- data/docs/GenreRelationsPrograms.md +11 -0
- data/docs/GenreResult.md +14 -0
- data/docs/GenreResults.md +17 -0
- data/docs/ImportItem.md +18 -0
- data/docs/ImportItemFieldValues.md +8 -0
- data/docs/InlineResponse202.md +8 -0
- data/docs/InternalServerError.md +9 -0
- data/docs/InviteUserData.md +9 -0
- data/docs/InviteUserSuccess.md +8 -0
- data/docs/Item.md +23 -0
- data/docs/ItemApi.md +553 -0
- data/docs/ItemDataInput.md +26 -0
- data/docs/ItemInputOnly.md +10 -0
- data/docs/ItemOutputOnly.md +16 -0
- data/docs/ItemRelations.md +14 -0
- data/docs/ItemRelationsBlock.md +11 -0
- data/docs/ItemRelationsCampaign.md +11 -0
- data/docs/ItemRelationsContacts.md +11 -0
- data/docs/ItemRelationsContactsParams.md +8 -0
- data/docs/ItemRelationsProgram.md +11 -0
- data/docs/ItemRelationsTags.md +11 -0
- data/docs/ItemResult.md +39 -0
- data/docs/ItemResults.md +16 -0
- data/docs/ModelType.md +15 -0
- data/docs/ModelTypeApi.md +139 -0
- data/docs/ModelTypeOptions.md +8 -0
- data/docs/ModelTypeOutputOnly.md +8 -0
- data/docs/ModelTypeRelations.md +13 -0
- data/docs/ModelTypeRelationsBroadcasts.md +11 -0
- data/docs/ModelTypeRelationsCampaigns.md +11 -0
- data/docs/ModelTypeRelationsCampaignsParams.md +8 -0
- data/docs/ModelTypeRelationsContacts.md +11 -0
- data/docs/ModelTypeRelationsItems.md +11 -0
- data/docs/ModelTypeRelationsPresenters.md +11 -0
- data/docs/ModelTypeRelationsPrograms.md +11 -0
- data/docs/ModelTypeResult.md +22 -0
- data/docs/ModelTypeResults.md +17 -0
- data/docs/NotFound.md +9 -0
- data/docs/PostSuccess.md +9 -0
- data/docs/Presenter.md +13 -0
- data/docs/PresenterApi.md +300 -0
- data/docs/PresenterDataInput.md +13 -0
- data/docs/PresenterOutputOnly.md +12 -0
- data/docs/PresenterRelations.md +10 -0
- data/docs/PresenterRelationsBroadcasts.md +11 -0
- data/docs/PresenterRelationsPrograms.md +11 -0
- data/docs/PresenterRelationsProgramsParams.md +8 -0
- data/docs/PresenterResult.md +21 -0
- data/docs/PresenterResults.md +17 -0
- data/docs/Program.md +20 -0
- data/docs/ProgramApi.md +308 -0
- data/docs/ProgramDataInput.md +22 -0
- data/docs/ProgramFieldValues.md +8 -0
- data/docs/ProgramInputOnly.md +9 -0
- data/docs/ProgramOutputOnly.md +12 -0
- data/docs/ProgramRelations.md +13 -0
- data/docs/ProgramRelationsBlocks.md +11 -0
- data/docs/ProgramRelationsBroadcasts.md +11 -0
- data/docs/ProgramRelationsItems.md +11 -0
- data/docs/ProgramRelationsItemsParams.md +8 -0
- data/docs/ProgramRelationsPresenters.md +11 -0
- data/docs/ProgramRelationsTags.md +11 -0
- data/docs/ProgramResult.md +31 -0
- data/docs/ProgramResults.md +17 -0
- data/docs/ReadOnly.md +9 -0
- data/docs/RelationsPlaceholder.md +11 -0
- data/docs/StringApi.md +66 -0
- data/docs/Success.md +8 -0
- data/docs/Tag.md +8 -0
- data/docs/TagApi.md +302 -0
- data/docs/TagDataInput.md +8 -0
- data/docs/TagOutputOnly.md +12 -0
- data/docs/TagRelations.md +11 -0
- data/docs/TagRelationsBroadcasts.md +11 -0
- data/docs/TagRelationsBroadcastsParams.md +8 -0
- data/docs/TagRelationsContacts.md +11 -0
- data/docs/TagRelationsItems.md +11 -0
- data/docs/TagRelationsPrograms.md +11 -0
- data/docs/TagResult.md +17 -0
- data/docs/TagResults.md +16 -0
- data/docs/TextString.md +12 -0
- data/docs/TooManyRequests.md +8 -0
- data/docs/UnprocessableEntity.md +8 -0
- data/docs/UserApi.md +231 -0
- data/docs/UserResult.md +19 -0
- data/docs/UserResultSettings.md +13 -0
- data/docs/UserResults.md +17 -0
- data/docs/VisualResult.md +8 -0
- data/docs/VisualSlideApi.md +106 -0
- data/git_push.sh +55 -0
- data/lib/radiomanager_client.rb +185 -0
- data/lib/radiomanager_client/api/block_api.rb +257 -0
- data/lib/radiomanager_client/api/broadcast_api.rb +668 -0
- data/lib/radiomanager_client/api/campaign_api.rb +331 -0
- data/lib/radiomanager_client/api/contact_api.rb +328 -0
- data/lib/radiomanager_client/api/external_message_api.rb +78 -0
- data/lib/radiomanager_client/api/genre_api.rb +153 -0
- data/lib/radiomanager_client/api/item_api.rb +576 -0
- data/lib/radiomanager_client/api/model_type_api.rb +168 -0
- data/lib/radiomanager_client/api/presenter_api.rb +328 -0
- data/lib/radiomanager_client/api/program_api.rb +340 -0
- data/lib/radiomanager_client/api/string_api.rb +85 -0
- data/lib/radiomanager_client/api/tag_api.rb +331 -0
- data/lib/radiomanager_client/api/user_api.rb +255 -0
- data/lib/radiomanager_client/api/visual_slide_api.rb +121 -0
- data/lib/radiomanager_client/api_client.rb +389 -0
- data/lib/radiomanager_client/api_error.rb +38 -0
- data/lib/radiomanager_client/configuration.rb +209 -0
- data/lib/radiomanager_client/models/block.rb +293 -0
- data/lib/radiomanager_client/models/block_relations.rb +206 -0
- data/lib/radiomanager_client/models/block_relations_broadcast.rb +215 -0
- data/lib/radiomanager_client/models/block_relations_broadcast_params.rb +188 -0
- data/lib/radiomanager_client/models/block_relations_items.rb +215 -0
- data/lib/radiomanager_client/models/block_relations_items_params.rb +188 -0
- data/lib/radiomanager_client/models/block_relations_program.rb +215 -0
- data/lib/radiomanager_client/models/block_result.rb +320 -0
- data/lib/radiomanager_client/models/block_results.rb +271 -0
- data/lib/radiomanager_client/models/broadcast.rb +428 -0
- data/lib/radiomanager_client/models/broadcast_data_input.rb +450 -0
- data/lib/radiomanager_client/models/broadcast_field_values.rb +188 -0
- data/lib/radiomanager_client/models/broadcast_input_only.rb +201 -0
- data/lib/radiomanager_client/models/broadcast_output_only.rb +244 -0
- data/lib/radiomanager_client/models/broadcast_relations.rb +233 -0
- data/lib/radiomanager_client/models/broadcast_relations_blocks.rb +215 -0
- data/lib/radiomanager_client/models/broadcast_relations_items.rb +215 -0
- data/lib/radiomanager_client/models/broadcast_relations_items_params.rb +188 -0
- data/lib/radiomanager_client/models/broadcast_relations_model_type.rb +215 -0
- data/lib/radiomanager_client/models/broadcast_relations_presenters.rb +215 -0
- data/lib/radiomanager_client/models/broadcast_relations_tags.rb +215 -0
- data/lib/radiomanager_client/models/broadcast_result.rb +547 -0
- data/lib/radiomanager_client/models/broadcast_results.rb +271 -0
- data/lib/radiomanager_client/models/campaign.rb +259 -0
- data/lib/radiomanager_client/models/campaign_data_input.rb +259 -0
- data/lib/radiomanager_client/models/campaign_output_only.rb +255 -0
- data/lib/radiomanager_client/models/campaign_relations.rb +197 -0
- data/lib/radiomanager_client/models/campaign_relations_items.rb +215 -0
- data/lib/radiomanager_client/models/campaign_relations_items_params.rb +188 -0
- data/lib/radiomanager_client/models/campaign_result.rb +353 -0
- data/lib/radiomanager_client/models/campaign_results.rb +271 -0
- data/lib/radiomanager_client/models/contact.rb +248 -0
- data/lib/radiomanager_client/models/contact_data_input.rb +248 -0
- data/lib/radiomanager_client/models/contact_field_values.rb +188 -0
- data/lib/radiomanager_client/models/contact_output_only.rb +224 -0
- data/lib/radiomanager_client/models/contact_relations.rb +206 -0
- data/lib/radiomanager_client/models/contact_relations_items.rb +215 -0
- data/lib/radiomanager_client/models/contact_relations_tags.rb +215 -0
- data/lib/radiomanager_client/models/contact_relations_tags_params.rb +188 -0
- data/lib/radiomanager_client/models/contact_result.rb +320 -0
- data/lib/radiomanager_client/models/contact_results.rb +271 -0
- data/lib/radiomanager_client/models/data.rb +199 -0
- data/lib/radiomanager_client/models/data_1.rb +199 -0
- data/lib/radiomanager_client/models/epg_broadcast.rb +227 -0
- data/lib/radiomanager_client/models/external_message_queue_data.rb +333 -0
- data/lib/radiomanager_client/models/forbidden.rb +209 -0
- data/lib/radiomanager_client/models/genre.rb +225 -0
- data/lib/radiomanager_client/models/genre_output_only.rb +188 -0
- data/lib/radiomanager_client/models/genre_relations.rb +197 -0
- data/lib/radiomanager_client/models/genre_relations_broadcasts.rb +215 -0
- data/lib/radiomanager_client/models/genre_relations_broadcasts_params.rb +188 -0
- data/lib/radiomanager_client/models/genre_relations_programs.rb +215 -0
- data/lib/radiomanager_client/models/genre_result.rb +252 -0
- data/lib/radiomanager_client/models/genre_results.rb +271 -0
- data/lib/radiomanager_client/models/import_item.rb +292 -0
- data/lib/radiomanager_client/models/import_item_field_values.rb +188 -0
- data/lib/radiomanager_client/models/inline_response_202.rb +188 -0
- data/lib/radiomanager_client/models/internal_server_error.rb +209 -0
- data/lib/radiomanager_client/models/invite_user_data.rb +207 -0
- data/lib/radiomanager_client/models/invite_user_success.rb +188 -0
- data/lib/radiomanager_client/models/item.rb +366 -0
- data/lib/radiomanager_client/models/item_data_input.rb +397 -0
- data/lib/radiomanager_client/models/item_input_only.rb +210 -0
- data/lib/radiomanager_client/models/item_output_only.rb +260 -0
- data/lib/radiomanager_client/models/item_relations.rb +242 -0
- data/lib/radiomanager_client/models/item_relations_block.rb +215 -0
- data/lib/radiomanager_client/models/item_relations_campaign.rb +215 -0
- data/lib/radiomanager_client/models/item_relations_contacts.rb +215 -0
- data/lib/radiomanager_client/models/item_relations_contacts_params.rb +188 -0
- data/lib/radiomanager_client/models/item_relations_program.rb +215 -0
- data/lib/radiomanager_client/models/item_relations_tags.rb +215 -0
- data/lib/radiomanager_client/models/item_result.rb +510 -0
- data/lib/radiomanager_client/models/item_results.rb +262 -0
- data/lib/radiomanager_client/models/model_type.rb +289 -0
- data/lib/radiomanager_client/models/model_type_options.rb +188 -0
- data/lib/radiomanager_client/models/model_type_output_only.rb +188 -0
- data/lib/radiomanager_client/models/model_type_relations.rb +233 -0
- data/lib/radiomanager_client/models/model_type_relations_broadcasts.rb +215 -0
- data/lib/radiomanager_client/models/model_type_relations_campaigns.rb +215 -0
- data/lib/radiomanager_client/models/model_type_relations_campaigns_params.rb +188 -0
- data/lib/radiomanager_client/models/model_type_relations_contacts.rb +215 -0
- data/lib/radiomanager_client/models/model_type_relations_items.rb +215 -0
- data/lib/radiomanager_client/models/model_type_relations_presenters.rb +215 -0
- data/lib/radiomanager_client/models/model_type_relations_programs.rb +215 -0
- data/lib/radiomanager_client/models/model_type_result.rb +352 -0
- data/lib/radiomanager_client/models/model_type_results.rb +271 -0
- data/lib/radiomanager_client/models/not_found.rb +209 -0
- data/lib/radiomanager_client/models/post_success.rb +204 -0
- data/lib/radiomanager_client/models/presenter.rb +240 -0
- data/lib/radiomanager_client/models/presenter_data_input.rb +240 -0
- data/lib/radiomanager_client/models/presenter_output_only.rb +244 -0
- data/lib/radiomanager_client/models/presenter_relations.rb +206 -0
- data/lib/radiomanager_client/models/presenter_relations_broadcasts.rb +215 -0
- data/lib/radiomanager_client/models/presenter_relations_programs.rb +215 -0
- data/lib/radiomanager_client/models/presenter_relations_programs_params.rb +188 -0
- data/lib/radiomanager_client/models/presenter_result.rb +332 -0
- data/lib/radiomanager_client/models/presenter_results.rb +271 -0
- data/lib/radiomanager_client/models/program.rb +306 -0
- data/lib/radiomanager_client/models/program_data_input.rb +328 -0
- data/lib/radiomanager_client/models/program_field_values.rb +188 -0
- data/lib/radiomanager_client/models/program_input_only.rb +201 -0
- data/lib/radiomanager_client/models/program_output_only.rb +244 -0
- data/lib/radiomanager_client/models/program_relations.rb +233 -0
- data/lib/radiomanager_client/models/program_relations_blocks.rb +215 -0
- data/lib/radiomanager_client/models/program_relations_broadcasts.rb +215 -0
- data/lib/radiomanager_client/models/program_relations_items.rb +215 -0
- data/lib/radiomanager_client/models/program_relations_items_params.rb +188 -0
- data/lib/radiomanager_client/models/program_relations_presenters.rb +215 -0
- data/lib/radiomanager_client/models/program_relations_tags.rb +215 -0
- data/lib/radiomanager_client/models/program_result.rb +425 -0
- data/lib/radiomanager_client/models/program_results.rb +271 -0
- data/lib/radiomanager_client/models/read_only.rb +209 -0
- data/lib/radiomanager_client/models/relations_placeholder.rb +239 -0
- data/lib/radiomanager_client/models/success.rb +194 -0
- data/lib/radiomanager_client/models/tag.rb +193 -0
- data/lib/radiomanager_client/models/tag_data_input.rb +193 -0
- data/lib/radiomanager_client/models/tag_output_only.rb +229 -0
- data/lib/radiomanager_client/models/tag_relations.rb +215 -0
- data/lib/radiomanager_client/models/tag_relations_broadcasts.rb +215 -0
- data/lib/radiomanager_client/models/tag_relations_broadcasts_params.rb +188 -0
- data/lib/radiomanager_client/models/tag_relations_contacts.rb +215 -0
- data/lib/radiomanager_client/models/tag_relations_items.rb +215 -0
- data/lib/radiomanager_client/models/tag_relations_programs.rb +215 -0
- data/lib/radiomanager_client/models/tag_result.rb +279 -0
- data/lib/radiomanager_client/models/tag_results.rb +262 -0
- data/lib/radiomanager_client/models/text_string.rb +239 -0
- data/lib/radiomanager_client/models/too_many_requests.rb +193 -0
- data/lib/radiomanager_client/models/unprocessable_entity.rb +196 -0
- data/lib/radiomanager_client/models/user_result.rb +307 -0
- data/lib/radiomanager_client/models/user_result_settings.rb +233 -0
- data/lib/radiomanager_client/models/user_results.rb +271 -0
- data/lib/radiomanager_client/models/visual_result.rb +188 -0
- data/lib/radiomanager_client/version.rb +15 -0
- data/radiomanager_client-1.0.0.gem +0 -0
- data/radiomanager_client.gemspec +46 -0
- data/spec/api/block_api_spec.rb +88 -0
- data/spec/api/broadcast_api_spec.rb +180 -0
- data/spec/api/campaign_api_spec.rb +102 -0
- data/spec/api/contact_api_spec.rb +101 -0
- data/spec/api/external_message_api_spec.rb +47 -0
- data/spec/api/genre_api_spec.rb +64 -0
- data/spec/api/item_api_spec.rb +163 -0
- data/spec/api/model_type_api_spec.rb +68 -0
- data/spec/api/presenter_api_spec.rb +101 -0
- data/spec/api/program_api_spec.rb +105 -0
- data/spec/api/string_api_spec.rb +48 -0
- data/spec/api/tag_api_spec.rb +102 -0
- data/spec/api/user_api_spec.rb +84 -0
- data/spec/api/visual_slide_api_spec.rb +57 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/block_relations_broadcast_params_spec.rb +42 -0
- data/spec/models/block_relations_broadcast_spec.rb +60 -0
- data/spec/models/block_relations_items_params_spec.rb +42 -0
- data/spec/models/block_relations_items_spec.rb +60 -0
- data/spec/models/block_relations_program_spec.rb +60 -0
- data/spec/models/block_relations_spec.rb +54 -0
- data/spec/models/block_result_spec.rb +102 -0
- data/spec/models/block_results_spec.rb +96 -0
- data/spec/models/block_spec.rb +84 -0
- data/spec/models/broadcast_data_input_spec.rb +184 -0
- data/spec/models/broadcast_field_values_spec.rb +42 -0
- data/spec/models/broadcast_input_only_spec.rb +48 -0
- data/spec/models/broadcast_output_only_spec.rb +66 -0
- data/spec/models/broadcast_relations_blocks_spec.rb +60 -0
- data/spec/models/broadcast_relations_items_params_spec.rb +42 -0
- data/spec/models/broadcast_relations_items_spec.rb +60 -0
- data/spec/models/broadcast_relations_model_type_spec.rb +60 -0
- data/spec/models/broadcast_relations_presenters_spec.rb +60 -0
- data/spec/models/broadcast_relations_spec.rb +72 -0
- data/spec/models/broadcast_relations_tags_spec.rb +60 -0
- data/spec/models/broadcast_result_spec.rb +238 -0
- data/spec/models/broadcast_results_spec.rb +96 -0
- data/spec/models/broadcast_spec.rb +172 -0
- data/spec/models/campaign_data_input_spec.rb +78 -0
- data/spec/models/campaign_output_only_spec.rb +72 -0
- data/spec/models/campaign_relations_items_params_spec.rb +42 -0
- data/spec/models/campaign_relations_items_spec.rb +60 -0
- data/spec/models/campaign_relations_spec.rb +48 -0
- data/spec/models/campaign_result_spec.rb +126 -0
- data/spec/models/campaign_results_spec.rb +96 -0
- data/spec/models/campaign_spec.rb +78 -0
- data/spec/models/contact_data_input_spec.rb +72 -0
- data/spec/models/contact_field_values_spec.rb +42 -0
- data/spec/models/contact_output_only_spec.rb +66 -0
- data/spec/models/contact_relations_items_spec.rb +60 -0
- data/spec/models/contact_relations_spec.rb +54 -0
- data/spec/models/contact_relations_tags_params_spec.rb +42 -0
- data/spec/models/contact_relations_tags_spec.rb +60 -0
- data/spec/models/contact_result_spec.rb +120 -0
- data/spec/models/contact_results_spec.rb +96 -0
- data/spec/models/contact_spec.rb +72 -0
- data/spec/models/data_1_spec.rb +48 -0
- data/spec/models/data_spec.rb +48 -0
- data/spec/models/epg_broadcast_spec.rb +54 -0
- data/spec/models/external_message_queue_data_spec.rb +78 -0
- data/spec/models/forbidden_spec.rb +48 -0
- data/spec/models/genre_output_only_spec.rb +42 -0
- data/spec/models/genre_relations_broadcasts_params_spec.rb +42 -0
- data/spec/models/genre_relations_broadcasts_spec.rb +60 -0
- data/spec/models/genre_relations_programs_spec.rb +60 -0
- data/spec/models/genre_relations_spec.rb +48 -0
- data/spec/models/genre_result_spec.rb +78 -0
- data/spec/models/genre_results_spec.rb +96 -0
- data/spec/models/genre_spec.rb +60 -0
- data/spec/models/import_item_field_values_spec.rb +42 -0
- data/spec/models/import_item_spec.rb +102 -0
- data/spec/models/inline_response_202_spec.rb +42 -0
- data/spec/models/internal_server_error_spec.rb +48 -0
- data/spec/models/invite_user_data_spec.rb +48 -0
- data/spec/models/invite_user_success_spec.rb +42 -0
- data/spec/models/item_data_input_spec.rb +154 -0
- data/spec/models/item_input_only_spec.rb +54 -0
- data/spec/models/item_output_only_spec.rb +90 -0
- data/spec/models/item_relations_block_spec.rb +60 -0
- data/spec/models/item_relations_campaign_spec.rb +60 -0
- data/spec/models/item_relations_contacts_params_spec.rb +42 -0
- data/spec/models/item_relations_contacts_spec.rb +60 -0
- data/spec/models/item_relations_program_spec.rb +60 -0
- data/spec/models/item_relations_spec.rb +78 -0
- data/spec/models/item_relations_tags_spec.rb +60 -0
- data/spec/models/item_result_spec.rb +232 -0
- data/spec/models/item_results_spec.rb +90 -0
- data/spec/models/item_spec.rb +136 -0
- data/spec/models/model_type_options_spec.rb +42 -0
- data/spec/models/model_type_output_only_spec.rb +42 -0
- data/spec/models/model_type_relations_broadcasts_spec.rb +60 -0
- data/spec/models/model_type_relations_campaigns_params_spec.rb +42 -0
- data/spec/models/model_type_relations_campaigns_spec.rb +60 -0
- data/spec/models/model_type_relations_contacts_spec.rb +60 -0
- data/spec/models/model_type_relations_items_spec.rb +60 -0
- data/spec/models/model_type_relations_presenters_spec.rb +60 -0
- data/spec/models/model_type_relations_programs_spec.rb +60 -0
- data/spec/models/model_type_relations_spec.rb +72 -0
- data/spec/models/model_type_result_spec.rb +130 -0
- data/spec/models/model_type_results_spec.rb +96 -0
- data/spec/models/model_type_spec.rb +88 -0
- data/spec/models/not_found_spec.rb +48 -0
- data/spec/models/post_success_spec.rb +48 -0
- data/spec/models/presenter_data_input_spec.rb +72 -0
- data/spec/models/presenter_output_only_spec.rb +66 -0
- data/spec/models/presenter_relations_broadcasts_spec.rb +60 -0
- data/spec/models/presenter_relations_programs_params_spec.rb +42 -0
- data/spec/models/presenter_relations_programs_spec.rb +60 -0
- data/spec/models/presenter_relations_spec.rb +54 -0
- data/spec/models/presenter_result_spec.rb +120 -0
- data/spec/models/presenter_results_spec.rb +96 -0
- data/spec/models/presenter_spec.rb +72 -0
- data/spec/models/program_data_input_spec.rb +126 -0
- data/spec/models/program_field_values_spec.rb +42 -0
- data/spec/models/program_input_only_spec.rb +48 -0
- data/spec/models/program_output_only_spec.rb +66 -0
- data/spec/models/program_relations_blocks_spec.rb +60 -0
- data/spec/models/program_relations_broadcasts_spec.rb +60 -0
- data/spec/models/program_relations_items_params_spec.rb +42 -0
- data/spec/models/program_relations_items_spec.rb +60 -0
- data/spec/models/program_relations_presenters_spec.rb +60 -0
- data/spec/models/program_relations_spec.rb +72 -0
- data/spec/models/program_relations_tags_spec.rb +60 -0
- data/spec/models/program_result_spec.rb +180 -0
- data/spec/models/program_results_spec.rb +96 -0
- data/spec/models/program_spec.rb +114 -0
- data/spec/models/read_only_spec.rb +48 -0
- data/spec/models/relations_placeholder_spec.rb +60 -0
- data/spec/models/success_spec.rb +42 -0
- data/spec/models/tag_data_input_spec.rb +42 -0
- data/spec/models/tag_output_only_spec.rb +66 -0
- data/spec/models/tag_relations_broadcasts_params_spec.rb +42 -0
- data/spec/models/tag_relations_broadcasts_spec.rb +60 -0
- data/spec/models/tag_relations_contacts_spec.rb +60 -0
- data/spec/models/tag_relations_items_spec.rb +60 -0
- data/spec/models/tag_relations_programs_spec.rb +60 -0
- data/spec/models/tag_relations_spec.rb +60 -0
- data/spec/models/tag_result_spec.rb +96 -0
- data/spec/models/tag_results_spec.rb +90 -0
- data/spec/models/tag_spec.rb +42 -0
- data/spec/models/text_string_spec.rb +66 -0
- data/spec/models/too_many_requests_spec.rb +42 -0
- data/spec/models/unprocessable_entity_spec.rb +42 -0
- data/spec/models/user_result_settings_spec.rb +72 -0
- data/spec/models/user_result_spec.rb +108 -0
- data/spec/models/user_results_spec.rb +96 -0
- data/spec/models/visual_result_spec.rb +42 -0
- data/spec/spec_helper.rb +111 -0
- metadata +825 -0
@@ -0,0 +1,255 @@
|
|
1
|
+
=begin
|
2
|
+
#RadioManager
|
3
|
+
|
4
|
+
#RadioManager
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0
|
7
|
+
Contact: support@pluxbox.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.2.3-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require "uri"
|
14
|
+
|
15
|
+
module RadioManagerClient
|
16
|
+
class UserApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
|
23
|
+
# Remove user from station by Id
|
24
|
+
# Remove user from station by Id
|
25
|
+
# @param id id of User
|
26
|
+
# @param [Hash] opts the optional parameters
|
27
|
+
# @return [Success]
|
28
|
+
def delete_user_by_id(id, opts = {})
|
29
|
+
data, _status_code, _headers = delete_user_by_id_with_http_info(id, opts)
|
30
|
+
return data
|
31
|
+
end
|
32
|
+
|
33
|
+
# Remove user from station by Id
|
34
|
+
# Remove user from station by Id
|
35
|
+
# @param id id of User
|
36
|
+
# @param [Hash] opts the optional parameters
|
37
|
+
# @return [Array<(Success, Fixnum, Hash)>] Success data, response status code and response headers
|
38
|
+
def delete_user_by_id_with_http_info(id, opts = {})
|
39
|
+
if @api_client.config.debugging
|
40
|
+
@api_client.config.logger.debug "Calling API: UserApi.delete_user_by_id ..."
|
41
|
+
end
|
42
|
+
# verify the required parameter 'id' is set
|
43
|
+
if @api_client.config.client_side_validation && id.nil?
|
44
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling UserApi.delete_user_by_id"
|
45
|
+
end
|
46
|
+
if @api_client.config.client_side_validation && id < 0
|
47
|
+
fail ArgumentError, 'invalid value for "id" when calling UserApi.delete_user_by_id, must be greater than or equal to 0.'
|
48
|
+
end
|
49
|
+
|
50
|
+
# resource path
|
51
|
+
local_var_path = "/users/{id}".sub('{' + 'id' + '}', id.to_s)
|
52
|
+
|
53
|
+
# query parameters
|
54
|
+
query_params = {}
|
55
|
+
|
56
|
+
# header parameters
|
57
|
+
header_params = {}
|
58
|
+
# HTTP header 'Accept' (if needed)
|
59
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
60
|
+
# HTTP header 'Content-Type'
|
61
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
62
|
+
|
63
|
+
# form parameters
|
64
|
+
form_params = {}
|
65
|
+
|
66
|
+
# http body (model)
|
67
|
+
post_body = nil
|
68
|
+
auth_names = ['API Key']
|
69
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
70
|
+
:header_params => header_params,
|
71
|
+
:query_params => query_params,
|
72
|
+
:form_params => form_params,
|
73
|
+
:body => post_body,
|
74
|
+
:auth_names => auth_names,
|
75
|
+
:return_type => 'Success')
|
76
|
+
if @api_client.config.debugging
|
77
|
+
@api_client.config.logger.debug "API called: UserApi#delete_user_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
78
|
+
end
|
79
|
+
return data, status_code, headers
|
80
|
+
end
|
81
|
+
|
82
|
+
# Get user by id
|
83
|
+
# Get user by id
|
84
|
+
# @param id id of User
|
85
|
+
# @param [Hash] opts the optional parameters
|
86
|
+
# @return [UserResult]
|
87
|
+
def get_user_by_id(id, opts = {})
|
88
|
+
data, _status_code, _headers = get_user_by_id_with_http_info(id, opts)
|
89
|
+
return data
|
90
|
+
end
|
91
|
+
|
92
|
+
# Get user by id
|
93
|
+
# Get user by id
|
94
|
+
# @param id id of User
|
95
|
+
# @param [Hash] opts the optional parameters
|
96
|
+
# @return [Array<(UserResult, Fixnum, Hash)>] UserResult data, response status code and response headers
|
97
|
+
def get_user_by_id_with_http_info(id, opts = {})
|
98
|
+
if @api_client.config.debugging
|
99
|
+
@api_client.config.logger.debug "Calling API: UserApi.get_user_by_id ..."
|
100
|
+
end
|
101
|
+
# verify the required parameter 'id' is set
|
102
|
+
if @api_client.config.client_side_validation && id.nil?
|
103
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling UserApi.get_user_by_id"
|
104
|
+
end
|
105
|
+
if @api_client.config.client_side_validation && id < 0
|
106
|
+
fail ArgumentError, 'invalid value for "id" when calling UserApi.get_user_by_id, must be greater than or equal to 0.'
|
107
|
+
end
|
108
|
+
|
109
|
+
# resource path
|
110
|
+
local_var_path = "/users/{id}".sub('{' + 'id' + '}', id.to_s)
|
111
|
+
|
112
|
+
# query parameters
|
113
|
+
query_params = {}
|
114
|
+
|
115
|
+
# header parameters
|
116
|
+
header_params = {}
|
117
|
+
# HTTP header 'Accept' (if needed)
|
118
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
119
|
+
# HTTP header 'Content-Type'
|
120
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
121
|
+
|
122
|
+
# form parameters
|
123
|
+
form_params = {}
|
124
|
+
|
125
|
+
# http body (model)
|
126
|
+
post_body = nil
|
127
|
+
auth_names = ['API Key']
|
128
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
129
|
+
:header_params => header_params,
|
130
|
+
:query_params => query_params,
|
131
|
+
:form_params => form_params,
|
132
|
+
:body => post_body,
|
133
|
+
:auth_names => auth_names,
|
134
|
+
:return_type => 'UserResult')
|
135
|
+
if @api_client.config.debugging
|
136
|
+
@api_client.config.logger.debug "API called: UserApi#get_user_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
137
|
+
end
|
138
|
+
return data, status_code, headers
|
139
|
+
end
|
140
|
+
|
141
|
+
# Invite user by mail
|
142
|
+
# Invite user by mail
|
143
|
+
# @param data Data **(Required)**
|
144
|
+
# @param [Hash] opts the optional parameters
|
145
|
+
# @return [InviteUserSuccess]
|
146
|
+
def invite_user_by_mail(data, opts = {})
|
147
|
+
data, _status_code, _headers = invite_user_by_mail_with_http_info(data, opts)
|
148
|
+
return data
|
149
|
+
end
|
150
|
+
|
151
|
+
# Invite user by mail
|
152
|
+
# Invite user by mail
|
153
|
+
# @param data Data **(Required)**
|
154
|
+
# @param [Hash] opts the optional parameters
|
155
|
+
# @return [Array<(InviteUserSuccess, Fixnum, Hash)>] InviteUserSuccess data, response status code and response headers
|
156
|
+
def invite_user_by_mail_with_http_info(data, opts = {})
|
157
|
+
if @api_client.config.debugging
|
158
|
+
@api_client.config.logger.debug "Calling API: UserApi.invite_user_by_mail ..."
|
159
|
+
end
|
160
|
+
# verify the required parameter 'data' is set
|
161
|
+
if @api_client.config.client_side_validation && data.nil?
|
162
|
+
fail ArgumentError, "Missing the required parameter 'data' when calling UserApi.invite_user_by_mail"
|
163
|
+
end
|
164
|
+
# resource path
|
165
|
+
local_var_path = "/users/invite"
|
166
|
+
|
167
|
+
# query parameters
|
168
|
+
query_params = {}
|
169
|
+
|
170
|
+
# header parameters
|
171
|
+
header_params = {}
|
172
|
+
# HTTP header 'Accept' (if needed)
|
173
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
174
|
+
# HTTP header 'Content-Type'
|
175
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
176
|
+
|
177
|
+
# form parameters
|
178
|
+
form_params = {}
|
179
|
+
|
180
|
+
# http body (model)
|
181
|
+
post_body = @api_client.object_to_http_body(data)
|
182
|
+
auth_names = ['API Key']
|
183
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
184
|
+
:header_params => header_params,
|
185
|
+
:query_params => query_params,
|
186
|
+
:form_params => form_params,
|
187
|
+
:body => post_body,
|
188
|
+
:auth_names => auth_names,
|
189
|
+
:return_type => 'InviteUserSuccess')
|
190
|
+
if @api_client.config.debugging
|
191
|
+
@api_client.config.logger.debug "API called: UserApi#invite_user_by_mail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
192
|
+
end
|
193
|
+
return data, status_code, headers
|
194
|
+
end
|
195
|
+
|
196
|
+
# Get all users.
|
197
|
+
# List all users.
|
198
|
+
# @param [Hash] opts the optional parameters
|
199
|
+
# @option opts [Integer] :page Current page *(Optional)* (default to 1)
|
200
|
+
# @option opts [Integer] :role_id Search on Role ID *(Optional)*
|
201
|
+
# @return [UserResults]
|
202
|
+
def list_users(opts = {})
|
203
|
+
data, _status_code, _headers = list_users_with_http_info(opts)
|
204
|
+
return data
|
205
|
+
end
|
206
|
+
|
207
|
+
# Get all users.
|
208
|
+
# List all users.
|
209
|
+
# @param [Hash] opts the optional parameters
|
210
|
+
# @option opts [Integer] :page Current page *(Optional)*
|
211
|
+
# @option opts [Integer] :role_id Search on Role ID *(Optional)*
|
212
|
+
# @return [Array<(UserResults, Fixnum, Hash)>] UserResults data, response status code and response headers
|
213
|
+
def list_users_with_http_info(opts = {})
|
214
|
+
if @api_client.config.debugging
|
215
|
+
@api_client.config.logger.debug "Calling API: UserApi.list_users ..."
|
216
|
+
end
|
217
|
+
if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
|
218
|
+
fail ArgumentError, 'invalid value for "opts[:"page"]" when calling UserApi.list_users, must be greater than or equal to 0.'
|
219
|
+
end
|
220
|
+
|
221
|
+
# resource path
|
222
|
+
local_var_path = "/users"
|
223
|
+
|
224
|
+
# query parameters
|
225
|
+
query_params = {}
|
226
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
227
|
+
query_params[:'role_id'] = opts[:'role_id'] if !opts[:'role_id'].nil?
|
228
|
+
|
229
|
+
# header parameters
|
230
|
+
header_params = {}
|
231
|
+
# HTTP header 'Accept' (if needed)
|
232
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
233
|
+
# HTTP header 'Content-Type'
|
234
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
235
|
+
|
236
|
+
# form parameters
|
237
|
+
form_params = {}
|
238
|
+
|
239
|
+
# http body (model)
|
240
|
+
post_body = nil
|
241
|
+
auth_names = ['API Key']
|
242
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
243
|
+
:header_params => header_params,
|
244
|
+
:query_params => query_params,
|
245
|
+
:form_params => form_params,
|
246
|
+
:body => post_body,
|
247
|
+
:auth_names => auth_names,
|
248
|
+
:return_type => 'UserResults')
|
249
|
+
if @api_client.config.debugging
|
250
|
+
@api_client.config.logger.debug "API called: UserApi#list_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
251
|
+
end
|
252
|
+
return data, status_code, headers
|
253
|
+
end
|
254
|
+
end
|
255
|
+
end
|
@@ -0,0 +1,121 @@
|
|
1
|
+
=begin
|
2
|
+
#RadioManager
|
3
|
+
|
4
|
+
#RadioManager
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0
|
7
|
+
Contact: support@pluxbox.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.2.3-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require "uri"
|
14
|
+
|
15
|
+
module RadioManagerClient
|
16
|
+
class VisualSlideApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
|
23
|
+
# Get Visual Slide Image as JPEG
|
24
|
+
# Get Visual Slide Image as JPEG
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [VisualImageResult]
|
27
|
+
def download_visual_slide(opts = {})
|
28
|
+
data, _status_code, _headers = download_visual_slide_with_http_info(opts)
|
29
|
+
return data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Get Visual Slide Image as JPEG
|
33
|
+
# Get Visual Slide Image as JPEG
|
34
|
+
# @param [Hash] opts the optional parameters
|
35
|
+
# @return [Array<(VisualImageResult, Fixnum, Hash)>] VisualImageResult data, response status code and response headers
|
36
|
+
def download_visual_slide_with_http_info(opts = {})
|
37
|
+
if @api_client.config.debugging
|
38
|
+
@api_client.config.logger.debug "Calling API: VisualSlideApi.download_visual_slide ..."
|
39
|
+
end
|
40
|
+
# resource path
|
41
|
+
local_var_path = "/visual/image"
|
42
|
+
|
43
|
+
# query parameters
|
44
|
+
query_params = {}
|
45
|
+
|
46
|
+
# header parameters
|
47
|
+
header_params = {}
|
48
|
+
# HTTP header 'Accept' (if needed)
|
49
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
50
|
+
# HTTP header 'Content-Type'
|
51
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
52
|
+
|
53
|
+
# form parameters
|
54
|
+
form_params = {}
|
55
|
+
|
56
|
+
# http body (model)
|
57
|
+
post_body = nil
|
58
|
+
auth_names = ['API Key']
|
59
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
60
|
+
:header_params => header_params,
|
61
|
+
:query_params => query_params,
|
62
|
+
:form_params => form_params,
|
63
|
+
:body => post_body,
|
64
|
+
:auth_names => auth_names,
|
65
|
+
:return_type => 'VisualImageResult')
|
66
|
+
if @api_client.config.debugging
|
67
|
+
@api_client.config.logger.debug "API called: VisualSlideApi#download_visual_slide\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
68
|
+
end
|
69
|
+
return data, status_code, headers
|
70
|
+
end
|
71
|
+
|
72
|
+
# Get Visual Slide Image as Base64
|
73
|
+
# Get Visual Slide Image as Base64
|
74
|
+
# @param [Hash] opts the optional parameters
|
75
|
+
# @return [VisualResult]
|
76
|
+
def get_visual_slide(opts = {})
|
77
|
+
data, _status_code, _headers = get_visual_slide_with_http_info(opts)
|
78
|
+
return data
|
79
|
+
end
|
80
|
+
|
81
|
+
# Get Visual Slide Image as Base64
|
82
|
+
# Get Visual Slide Image as Base64
|
83
|
+
# @param [Hash] opts the optional parameters
|
84
|
+
# @return [Array<(VisualResult, Fixnum, Hash)>] VisualResult data, response status code and response headers
|
85
|
+
def get_visual_slide_with_http_info(opts = {})
|
86
|
+
if @api_client.config.debugging
|
87
|
+
@api_client.config.logger.debug "Calling API: VisualSlideApi.get_visual_slide ..."
|
88
|
+
end
|
89
|
+
# resource path
|
90
|
+
local_var_path = "/visual"
|
91
|
+
|
92
|
+
# query parameters
|
93
|
+
query_params = {}
|
94
|
+
|
95
|
+
# header parameters
|
96
|
+
header_params = {}
|
97
|
+
# HTTP header 'Accept' (if needed)
|
98
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
99
|
+
# HTTP header 'Content-Type'
|
100
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
101
|
+
|
102
|
+
# form parameters
|
103
|
+
form_params = {}
|
104
|
+
|
105
|
+
# http body (model)
|
106
|
+
post_body = nil
|
107
|
+
auth_names = ['API Key']
|
108
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
109
|
+
:header_params => header_params,
|
110
|
+
:query_params => query_params,
|
111
|
+
:form_params => form_params,
|
112
|
+
:body => post_body,
|
113
|
+
:auth_names => auth_names,
|
114
|
+
:return_type => 'VisualResult')
|
115
|
+
if @api_client.config.debugging
|
116
|
+
@api_client.config.logger.debug "API called: VisualSlideApi#get_visual_slide\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
117
|
+
end
|
118
|
+
return data, status_code, headers
|
119
|
+
end
|
120
|
+
end
|
121
|
+
end
|
@@ -0,0 +1,389 @@
|
|
1
|
+
=begin
|
2
|
+
#RadioManager
|
3
|
+
|
4
|
+
#RadioManager
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0
|
7
|
+
Contact: support@pluxbox.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.2.3-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'json'
|
15
|
+
require 'logger'
|
16
|
+
require 'tempfile'
|
17
|
+
require 'typhoeus'
|
18
|
+
require 'uri'
|
19
|
+
|
20
|
+
module RadioManagerClient
|
21
|
+
class ApiClient
|
22
|
+
# The Configuration object holding settings to be used in the API client.
|
23
|
+
attr_accessor :config
|
24
|
+
|
25
|
+
# Defines the headers to be used in HTTP requests of all API calls by default.
|
26
|
+
#
|
27
|
+
# @return [Hash]
|
28
|
+
attr_accessor :default_headers
|
29
|
+
|
30
|
+
# Initializes the ApiClient
|
31
|
+
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
32
|
+
def initialize(config = Configuration.default)
|
33
|
+
@config = config
|
34
|
+
@user_agent = "Swagger-Codegen/#{VERSION}/ruby"
|
35
|
+
@default_headers = {
|
36
|
+
'Content-Type' => "application/json",
|
37
|
+
'User-Agent' => @user_agent
|
38
|
+
}
|
39
|
+
end
|
40
|
+
|
41
|
+
def self.default
|
42
|
+
@@default ||= ApiClient.new
|
43
|
+
end
|
44
|
+
|
45
|
+
# Call an API with given options.
|
46
|
+
#
|
47
|
+
# @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
|
48
|
+
# the data deserialized from response body (could be nil), response status code and response headers.
|
49
|
+
def call_api(http_method, path, opts = {})
|
50
|
+
request = build_request(http_method, path, opts)
|
51
|
+
response = request.run
|
52
|
+
|
53
|
+
if @config.debugging
|
54
|
+
@config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
|
55
|
+
end
|
56
|
+
|
57
|
+
unless response.success?
|
58
|
+
if response.timed_out?
|
59
|
+
fail ApiError.new('Connection timed out')
|
60
|
+
elsif response.code == 0
|
61
|
+
# Errors from libcurl will be made visible here
|
62
|
+
fail ApiError.new(:code => 0,
|
63
|
+
:message => response.return_message)
|
64
|
+
else
|
65
|
+
fail ApiError.new(:code => response.code,
|
66
|
+
:response_headers => response.headers,
|
67
|
+
:response_body => response.body),
|
68
|
+
response.status_message
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
72
|
+
if opts[:return_type]
|
73
|
+
data = deserialize(response, opts[:return_type])
|
74
|
+
else
|
75
|
+
data = nil
|
76
|
+
end
|
77
|
+
return data, response.code, response.headers
|
78
|
+
end
|
79
|
+
|
80
|
+
# Builds the HTTP request
|
81
|
+
#
|
82
|
+
# @param [String] http_method HTTP method/verb (e.g. POST)
|
83
|
+
# @param [String] path URL path (e.g. /account/new)
|
84
|
+
# @option opts [Hash] :header_params Header parameters
|
85
|
+
# @option opts [Hash] :query_params Query parameters
|
86
|
+
# @option opts [Hash] :form_params Query parameters
|
87
|
+
# @option opts [Object] :body HTTP body (JSON/XML)
|
88
|
+
# @return [Typhoeus::Request] A Typhoeus Request
|
89
|
+
def build_request(http_method, path, opts = {})
|
90
|
+
url = build_request_url(path)
|
91
|
+
http_method = http_method.to_sym.downcase
|
92
|
+
|
93
|
+
header_params = @default_headers.merge(opts[:header_params] || {})
|
94
|
+
query_params = opts[:query_params] || {}
|
95
|
+
form_params = opts[:form_params] || {}
|
96
|
+
|
97
|
+
update_params_for_auth! header_params, query_params, opts[:auth_names]
|
98
|
+
|
99
|
+
# set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
|
100
|
+
_verify_ssl_host = @config.verify_ssl_host ? 2 : 0
|
101
|
+
|
102
|
+
req_opts = {
|
103
|
+
:method => http_method,
|
104
|
+
:headers => header_params,
|
105
|
+
:params => query_params,
|
106
|
+
:params_encoding => @config.params_encoding,
|
107
|
+
:timeout => @config.timeout,
|
108
|
+
:ssl_verifypeer => @config.verify_ssl,
|
109
|
+
:ssl_verifyhost => _verify_ssl_host,
|
110
|
+
:sslcert => @config.cert_file,
|
111
|
+
:sslkey => @config.key_file,
|
112
|
+
:verbose => @config.debugging
|
113
|
+
}
|
114
|
+
|
115
|
+
# set custom cert, if provided
|
116
|
+
req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
|
117
|
+
|
118
|
+
if [:post, :patch, :put, :delete].include?(http_method)
|
119
|
+
req_body = build_request_body(header_params, form_params, opts[:body])
|
120
|
+
req_opts.update :body => req_body
|
121
|
+
if @config.debugging
|
122
|
+
@config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
|
123
|
+
end
|
124
|
+
end
|
125
|
+
|
126
|
+
request = Typhoeus::Request.new(url, req_opts)
|
127
|
+
download_file(request) if opts[:return_type] == 'File'
|
128
|
+
request
|
129
|
+
end
|
130
|
+
|
131
|
+
# Check if the given MIME is a JSON MIME.
|
132
|
+
# JSON MIME examples:
|
133
|
+
# application/json
|
134
|
+
# application/json; charset=UTF8
|
135
|
+
# APPLICATION/JSON
|
136
|
+
# */*
|
137
|
+
# @param [String] mime MIME
|
138
|
+
# @return [Boolean] True if the MIME is application/json
|
139
|
+
def json_mime?(mime)
|
140
|
+
(mime == "*/*") || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
|
141
|
+
end
|
142
|
+
|
143
|
+
# Deserialize the response to the given return type.
|
144
|
+
#
|
145
|
+
# @param [Response] response HTTP response
|
146
|
+
# @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
|
147
|
+
def deserialize(response, return_type)
|
148
|
+
body = response.body
|
149
|
+
|
150
|
+
# handle file downloading - return the File instance processed in request callbacks
|
151
|
+
# note that response body is empty when the file is written in chunks in request on_body callback
|
152
|
+
return @tempfile if return_type == 'File'
|
153
|
+
|
154
|
+
return nil if body.nil? || body.empty?
|
155
|
+
|
156
|
+
# return response body directly for String return type
|
157
|
+
return body if return_type == 'String'
|
158
|
+
|
159
|
+
# ensuring a default content type
|
160
|
+
content_type = response.headers['Content-Type'] || 'application/json'
|
161
|
+
|
162
|
+
fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
|
163
|
+
|
164
|
+
begin
|
165
|
+
data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
|
166
|
+
rescue JSON::ParserError => e
|
167
|
+
if %w(String Date DateTime).include?(return_type)
|
168
|
+
data = body
|
169
|
+
else
|
170
|
+
raise e
|
171
|
+
end
|
172
|
+
end
|
173
|
+
|
174
|
+
convert_to_type data, return_type
|
175
|
+
end
|
176
|
+
|
177
|
+
# Convert data to the given return type.
|
178
|
+
# @param [Object] data Data to be converted
|
179
|
+
# @param [String] return_type Return type
|
180
|
+
# @return [Mixed] Data in a particular type
|
181
|
+
def convert_to_type(data, return_type)
|
182
|
+
return nil if data.nil?
|
183
|
+
case return_type
|
184
|
+
when 'String'
|
185
|
+
data.to_s
|
186
|
+
when 'Integer'
|
187
|
+
data.to_i
|
188
|
+
when 'Float'
|
189
|
+
data.to_f
|
190
|
+
when 'BOOLEAN'
|
191
|
+
data == true
|
192
|
+
when 'DateTime'
|
193
|
+
# parse date time (expecting ISO 8601 format)
|
194
|
+
DateTime.parse data
|
195
|
+
when 'Date'
|
196
|
+
# parse date time (expecting ISO 8601 format)
|
197
|
+
Date.parse data
|
198
|
+
when 'Object'
|
199
|
+
# generic object (usually a Hash), return directly
|
200
|
+
data
|
201
|
+
when /\AArray<(.+)>\z/
|
202
|
+
# e.g. Array<Pet>
|
203
|
+
sub_type = $1
|
204
|
+
data.map {|item| convert_to_type(item, sub_type) }
|
205
|
+
when /\AHash\<String, (.+)\>\z/
|
206
|
+
# e.g. Hash<String, Integer>
|
207
|
+
sub_type = $1
|
208
|
+
{}.tap do |hash|
|
209
|
+
data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
|
210
|
+
end
|
211
|
+
else
|
212
|
+
# models, e.g. Pet
|
213
|
+
RadioManagerClient.const_get(return_type).new.tap do |model|
|
214
|
+
model.build_from_hash data
|
215
|
+
end
|
216
|
+
end
|
217
|
+
end
|
218
|
+
|
219
|
+
# Save response body into a file in (the defined) temporary folder, using the filename
|
220
|
+
# from the "Content-Disposition" header if provided, otherwise a random filename.
|
221
|
+
# The response body is written to the file in chunks in order to handle files which
|
222
|
+
# size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
|
223
|
+
# process can use.
|
224
|
+
#
|
225
|
+
# @see Configuration#temp_folder_path
|
226
|
+
def download_file(request)
|
227
|
+
tempfile = nil
|
228
|
+
encoding = nil
|
229
|
+
request.on_headers do |response|
|
230
|
+
content_disposition = response.headers['Content-Disposition']
|
231
|
+
if content_disposition and content_disposition =~ /filename=/i
|
232
|
+
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
|
233
|
+
prefix = sanitize_filename(filename)
|
234
|
+
else
|
235
|
+
prefix = 'download-'
|
236
|
+
end
|
237
|
+
prefix = prefix + '-' unless prefix.end_with?('-')
|
238
|
+
encoding = response.body.encoding
|
239
|
+
tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
|
240
|
+
@tempfile = tempfile
|
241
|
+
end
|
242
|
+
request.on_body do |chunk|
|
243
|
+
chunk.force_encoding(encoding)
|
244
|
+
tempfile.write(chunk)
|
245
|
+
end
|
246
|
+
request.on_complete do |response|
|
247
|
+
tempfile.close
|
248
|
+
@config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
|
249
|
+
"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
|
250
|
+
"will be deleted automatically with GC. It's also recommended to delete the temp file "\
|
251
|
+
"explicitly with `tempfile.delete`"
|
252
|
+
end
|
253
|
+
end
|
254
|
+
|
255
|
+
# Sanitize filename by removing path.
|
256
|
+
# e.g. ../../sun.gif becomes sun.gif
|
257
|
+
#
|
258
|
+
# @param [String] filename the filename to be sanitized
|
259
|
+
# @return [String] the sanitized filename
|
260
|
+
def sanitize_filename(filename)
|
261
|
+
filename.gsub(/.*[\/\\]/, '')
|
262
|
+
end
|
263
|
+
|
264
|
+
def build_request_url(path)
|
265
|
+
# Add leading and trailing slashes to path
|
266
|
+
path = "/#{path}".gsub(/\/+/, '/')
|
267
|
+
URI.encode(@config.base_url + path)
|
268
|
+
end
|
269
|
+
|
270
|
+
# Builds the HTTP request body
|
271
|
+
#
|
272
|
+
# @param [Hash] header_params Header parameters
|
273
|
+
# @param [Hash] form_params Query parameters
|
274
|
+
# @param [Object] body HTTP body (JSON/XML)
|
275
|
+
# @return [String] HTTP body data in the form of string
|
276
|
+
def build_request_body(header_params, form_params, body)
|
277
|
+
# http form
|
278
|
+
if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
|
279
|
+
header_params['Content-Type'] == 'multipart/form-data'
|
280
|
+
data = {}
|
281
|
+
form_params.each do |key, value|
|
282
|
+
case value
|
283
|
+
when File, Array, nil
|
284
|
+
# let typhoeus handle File, Array and nil parameters
|
285
|
+
data[key] = value
|
286
|
+
else
|
287
|
+
data[key] = value.to_s
|
288
|
+
end
|
289
|
+
end
|
290
|
+
elsif body
|
291
|
+
data = body.is_a?(String) ? body : body.to_json
|
292
|
+
else
|
293
|
+
data = nil
|
294
|
+
end
|
295
|
+
data
|
296
|
+
end
|
297
|
+
|
298
|
+
# Update hearder and query params based on authentication settings.
|
299
|
+
#
|
300
|
+
# @param [Hash] header_params Header parameters
|
301
|
+
# @param [Hash] query_params Query parameters
|
302
|
+
# @param [String] auth_names Authentication scheme name
|
303
|
+
def update_params_for_auth!(header_params, query_params, auth_names)
|
304
|
+
Array(auth_names).each do |auth_name|
|
305
|
+
auth_setting = @config.auth_settings[auth_name]
|
306
|
+
next unless auth_setting
|
307
|
+
case auth_setting[:in]
|
308
|
+
when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
|
309
|
+
when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
|
310
|
+
else fail ArgumentError, 'Authentication token must be in `query` of `header`'
|
311
|
+
end
|
312
|
+
end
|
313
|
+
end
|
314
|
+
|
315
|
+
# Sets user agent in HTTP header
|
316
|
+
#
|
317
|
+
# @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
|
318
|
+
def user_agent=(user_agent)
|
319
|
+
@user_agent = user_agent
|
320
|
+
@default_headers['User-Agent'] = @user_agent
|
321
|
+
end
|
322
|
+
|
323
|
+
# Return Accept header based on an array of accepts provided.
|
324
|
+
# @param [Array] accepts array for Accept
|
325
|
+
# @return [String] the Accept header (e.g. application/json)
|
326
|
+
def select_header_accept(accepts)
|
327
|
+
return nil if accepts.nil? || accepts.empty?
|
328
|
+
# use JSON when present, otherwise use all of the provided
|
329
|
+
json_accept = accepts.find { |s| json_mime?(s) }
|
330
|
+
return json_accept || accepts.join(',')
|
331
|
+
end
|
332
|
+
|
333
|
+
# Return Content-Type header based on an array of content types provided.
|
334
|
+
# @param [Array] content_types array for Content-Type
|
335
|
+
# @return [String] the Content-Type header (e.g. application/json)
|
336
|
+
def select_header_content_type(content_types)
|
337
|
+
# use application/json by default
|
338
|
+
return 'application/json' if content_types.nil? || content_types.empty?
|
339
|
+
# use JSON when present, otherwise use the first one
|
340
|
+
json_content_type = content_types.find { |s| json_mime?(s) }
|
341
|
+
return json_content_type || content_types.first
|
342
|
+
end
|
343
|
+
|
344
|
+
# Convert object (array, hash, object, etc) to JSON string.
|
345
|
+
# @param [Object] model object to be converted into JSON string
|
346
|
+
# @return [String] JSON string representation of the object
|
347
|
+
def object_to_http_body(model)
|
348
|
+
return model if model.nil? || model.is_a?(String)
|
349
|
+
local_body = nil
|
350
|
+
if model.is_a?(Array)
|
351
|
+
local_body = model.map{|m| object_to_hash(m) }
|
352
|
+
else
|
353
|
+
local_body = object_to_hash(model)
|
354
|
+
end
|
355
|
+
local_body.to_json
|
356
|
+
end
|
357
|
+
|
358
|
+
# Convert object(non-array) to hash.
|
359
|
+
# @param [Object] obj object to be converted into JSON string
|
360
|
+
# @return [String] JSON string representation of the object
|
361
|
+
def object_to_hash(obj)
|
362
|
+
if obj.respond_to?(:to_hash)
|
363
|
+
obj.to_hash
|
364
|
+
else
|
365
|
+
obj
|
366
|
+
end
|
367
|
+
end
|
368
|
+
|
369
|
+
# Build parameter value according to the given collection format.
|
370
|
+
# @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
|
371
|
+
def build_collection_param(param, collection_format)
|
372
|
+
case collection_format
|
373
|
+
when :csv
|
374
|
+
param.join(',')
|
375
|
+
when :ssv
|
376
|
+
param.join(' ')
|
377
|
+
when :tsv
|
378
|
+
param.join("\t")
|
379
|
+
when :pipes
|
380
|
+
param.join('|')
|
381
|
+
when :multi
|
382
|
+
# return the array directly as typhoeus will handle it as expected
|
383
|
+
param
|
384
|
+
else
|
385
|
+
fail "unknown collection format: #{collection_format.inspect}"
|
386
|
+
end
|
387
|
+
end
|
388
|
+
end
|
389
|
+
end
|