flat_api 0.2.0 → 1.0.0
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 +5 -5
- data/CHANGELOG.md +60 -8
- data/LICENSE +201 -0
- data/README.md +62 -241
- data/lib/flat_api/api/account_api.rb +32 -22
- data/lib/flat_api/api/class_api.rb +1671 -453
- data/lib/flat_api/api/collection_api.rb +286 -185
- data/lib/flat_api/api/edu_resources_api.rb +863 -0
- data/lib/flat_api/api/group_api.rb +506 -57
- data/lib/flat_api/api/omr_api.rb +894 -0
- data/lib/flat_api/api/organization_api.rb +808 -192
- data/lib/flat_api/api/score_api.rb +1030 -589
- data/lib/flat_api/api/task_api.rb +85 -0
- data/lib/flat_api/api/user_api.rb +151 -82
- data/lib/flat_api/api_client.rb +223 -145
- data/lib/flat_api/api_error.rb +24 -4
- data/lib/flat_api/api_model_base.rb +88 -0
- data/lib/flat_api/client.rb +69 -0
- data/lib/flat_api/configuration.rb +224 -36
- data/lib/flat_api/errors.rb +86 -0
- data/lib/flat_api/models/add_group_user200_response.rb +148 -0
- data/lib/flat_api/models/add_group_user_request.rb +165 -0
- data/lib/flat_api/models/api_access_token.rb +201 -0
- data/lib/flat_api/models/app_scopes.rb +61 -0
- data/lib/flat_api/models/assignment.rb +362 -166
- data/lib/flat_api/models/assignment_capabilities.rb +256 -0
- data/lib/flat_api/models/assignment_capabilities_can_publish_in_class_error.rb +193 -0
- data/lib/flat_api/models/assignment_copy.rb +79 -169
- data/lib/flat_api/models/assignment_copy_response.rb +535 -0
- data/lib/flat_api/models/assignment_copy_to_class.rb +186 -0
- data/lib/flat_api/models/assignment_copy_to_resource_library.rb +176 -0
- data/lib/flat_api/models/assignment_group.rb +232 -0
- data/lib/flat_api/models/assignment_submission.rb +337 -131
- data/lib/flat_api/models/assignment_submission_comment.rb +209 -0
- data/lib/flat_api/models/assignment_submission_comment_creation.rb +166 -0
- data/lib/flat_api/models/assignment_submission_comments.rb +158 -0
- data/lib/flat_api/models/assignment_submission_history.rb +337 -0
- data/lib/flat_api/models/assignment_submission_history_attachment.rb +168 -0
- data/lib/flat_api/models/assignment_submission_history_state.rb +43 -0
- data/lib/flat_api/models/assignment_submission_lti.rb +200 -0
- data/lib/flat_api/models/assignment_submission_playback.rb +193 -0
- data/lib/flat_api/models/assignment_submission_state.rb +42 -0
- data/lib/flat_api/models/assignment_submission_students_mode.rb +40 -0
- data/lib/flat_api/models/assignment_submission_update.rb +157 -113
- data/lib/flat_api/models/assignment_type.rb +45 -0
- data/lib/flat_api/models/assignment_update.rb +538 -0
- data/lib/flat_api/models/class_assignment.rb +750 -0
- data/lib/flat_api/models/class_assignment_all_of_canvas.rb +159 -0
- data/lib/flat_api/models/class_assignment_all_of_lti.rb +149 -0
- data/lib/flat_api/models/class_assignment_all_of_mfc.rb +159 -0
- data/lib/flat_api/models/class_assignment_update.rb +652 -0
- data/lib/flat_api/models/class_assignment_update_all_of_google_classroom.rb +150 -0
- data/lib/flat_api/models/class_assignment_update_all_of_microsoft_graph.rb +152 -0
- data/lib/flat_api/models/class_attachment_creation.rb +140 -106
- data/lib/flat_api/models/class_creation.rb +142 -108
- data/lib/flat_api/models/class_details.rb +244 -125
- data/lib/flat_api/models/class_details_canvas.rb +59 -99
- data/lib/flat_api/models/class_details_clever.rb +74 -113
- data/lib/flat_api/models/class_details_google_classroom.rb +64 -124
- data/lib/flat_api/models/class_details_google_drive.rb +61 -101
- data/lib/flat_api/models/class_details_issues.rb +151 -0
- data/lib/flat_api/models/class_details_issues_sync_inner.rb +203 -0
- data/lib/flat_api/models/class_details_lti.rb +76 -106
- data/lib/flat_api/models/class_details_mfc.rb +159 -0
- data/lib/flat_api/models/class_details_microsoft_graph.rb +148 -0
- data/lib/flat_api/models/class_grade_level.rb +43 -0
- data/lib/flat_api/models/class_roles.rb +18 -9
- data/lib/flat_api/models/class_state.rb +19 -9
- data/lib/flat_api/models/class_update.rb +142 -107
- data/lib/flat_api/models/collection.rb +304 -115
- data/lib/flat_api/models/collection_app.rb +169 -0
- data/lib/flat_api/models/collection_capabilities.rb +157 -112
- data/lib/flat_api/models/collection_contents.rb +166 -0
- data/lib/flat_api/models/collection_creation.rb +120 -104
- data/lib/flat_api/models/collection_modification.rb +122 -100
- data/lib/flat_api/models/collection_privacy.rb +18 -9
- data/lib/flat_api/models/collection_type.rb +22 -11
- data/lib/flat_api/models/credit_transaction.rb +388 -0
- data/lib/flat_api/models/edu_library.rb +273 -0
- data/lib/flat_api/models/edu_resource.rb +383 -0
- data/lib/flat_api/models/edu_resource_assignment_creation.rb +170 -0
- data/lib/flat_api/models/edu_resource_capabilities.rb +179 -0
- data/lib/flat_api/models/edu_resource_copy.rb +166 -0
- data/lib/flat_api/models/edu_resource_creation.rb +311 -0
- data/lib/flat_api/models/edu_resource_folder.rb +171 -0
- data/lib/flat_api/models/edu_resource_lti_link.rb +166 -0
- data/lib/flat_api/models/edu_resource_move.rb +166 -0
- data/lib/flat_api/models/edu_resource_privacy.rb +41 -0
- data/lib/flat_api/models/edu_resource_resource.rb +104 -0
- data/lib/flat_api/models/edu_resource_type.rb +40 -0
- data/lib/flat_api/models/edu_resource_update.rb +292 -0
- data/lib/flat_api/models/edu_resource_use_in_class.rb +176 -0
- data/lib/flat_api/models/flat_error_response.rb +109 -105
- data/lib/flat_api/models/google_classroom_coursework.rb +74 -103
- data/lib/flat_api/models/google_classroom_submission.rb +112 -101
- data/lib/flat_api/models/grade.rb +51 -0
- data/lib/flat_api/models/group.rb +70 -122
- data/lib/flat_api/models/group_creation.rb +238 -0
- data/lib/flat_api/models/group_details.rb +253 -110
- data/lib/flat_api/models/group_type.rb +20 -9
- data/lib/flat_api/models/license_mode.rb +18 -9
- data/lib/flat_api/models/license_sources.rb +21 -9
- data/lib/flat_api/models/lms_name.rb +19 -9
- data/lib/flat_api/models/lti_configuration.rb +56 -0
- data/lib/flat_api/models/lti_configuration1p1.rb +361 -0
- data/lib/flat_api/models/lti_configuration1p1_all_of_tool.rb +199 -0
- data/lib/flat_api/models/lti_configuration1p3.rb +106 -0
- data/lib/flat_api/models/lti_configuration1p3_base.rb +336 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services.rb +166 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_ags.rb +179 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_deep_linking.rb +159 -0
- data/lib/flat_api/models/lti_configuration1p3_base_supported_services_nrps.rb +169 -0
- data/lib/flat_api/models/lti_configuration1p3_base_tool.rb +199 -0
- data/lib/flat_api/models/lti_configuration1p3_deployment.rb +529 -0
- data/lib/flat_api/models/lti_configuration1p3_dynamic.rb +530 -0
- data/lib/flat_api/models/lti_configuration1p3_manual.rb +489 -0
- data/lib/flat_api/models/lti_configuration_base.rb +306 -0
- data/lib/flat_api/models/lti_configuration_create.rb +60 -0
- data/lib/flat_api/models/lti_configuration_create1p1.rb +210 -0
- data/lib/flat_api/models/lti_configuration_create1p3_deployment.rb +264 -0
- data/lib/flat_api/models/lti_configuration_create1p3_dynamic.rb +209 -0
- data/lib/flat_api/models/lti_configuration_create1p3_dynamic_platform_info.rb +159 -0
- data/lib/flat_api/models/lti_configuration_create1p3_manual.rb +270 -0
- data/lib/flat_api/models/lti_configuration_update.rb +104 -0
- data/lib/flat_api/models/lti_configuration_update_deployment.rb +169 -0
- data/lib/flat_api/models/lti_configuration_update_standalone.rb +219 -0
- data/lib/flat_api/models/lti_credentials.rb +108 -114
- data/lib/flat_api/models/lti_credentials_creation.rb +99 -103
- data/lib/flat_api/models/media_attachment.rb +189 -137
- data/lib/flat_api/models/media_score_sharing_mode.rb +19 -9
- data/lib/flat_api/models/microsoft_graph_assignment.rb +259 -0
- data/lib/flat_api/models/microsoft_graph_submission.rb +193 -0
- data/lib/flat_api/models/omr_capabilities.rb +480 -0
- data/lib/flat_api/models/omr_details_step_data.rb +228 -0
- data/lib/flat_api/models/omr_details_submission.rb +288 -0
- data/lib/flat_api/models/omr_detected_instrument.rb +260 -0
- data/lib/flat_api/models/omr_imported_metadata.rb +181 -0
- data/lib/flat_api/models/omr_instrument_override.rb +311 -0
- data/lib/flat_api/models/omr_job.rb +394 -0
- data/lib/flat_api/models/omr_job_creation.rb +238 -0
- data/lib/flat_api/models/omr_job_file_metadata.rb +199 -0
- data/lib/flat_api/models/omr_job_file_upload.rb +176 -0
- data/lib/flat_api/models/omr_job_file_upload_result.rb +159 -0
- data/lib/flat_api/models/omr_job_input_file.rb +176 -0
- data/lib/flat_api/models/omr_job_output.rb +40 -0
- data/lib/flat_api/models/omr_job_progress.rb +169 -0
- data/lib/flat_api/models/omr_job_result.rb +161 -0
- data/lib/flat_api/models/omr_job_retention.rb +176 -0
- data/lib/flat_api/models/omr_job_status.rb +44 -0
- data/lib/flat_api/models/omr_locale_details.rb +193 -0
- data/lib/flat_api/models/omr_pending_step.rb +213 -0
- data/lib/flat_api/models/omr_step_name.rb +39 -0
- data/lib/flat_api/models/organization_invitation.rb +177 -109
- data/lib/flat_api/models/organization_invitation_creation.rb +97 -100
- data/lib/flat_api/models/organization_roles.rb +19 -10
- data/lib/flat_api/models/organization_user_access_token_creation.rb +168 -0
- data/lib/flat_api/models/rename_group_request.rb +165 -0
- data/lib/flat_api/models/resource_collaborator.rb +204 -116
- data/lib/flat_api/models/resource_collaborator_creation.rb +72 -112
- data/lib/flat_api/models/resource_rights.rb +168 -107
- data/lib/flat_api/models/score_comment.rb +200 -121
- data/lib/flat_api/models/score_comment_context.rb +161 -124
- data/lib/flat_api/models/score_comment_creation.rb +79 -107
- data/lib/flat_api/models/score_comment_moderation.rb +193 -0
- data/lib/flat_api/models/score_comment_update.rb +81 -115
- data/lib/flat_api/models/score_comments_counts.rb +78 -108
- data/lib/flat_api/models/score_creation.rb +80 -225
- data/lib/flat_api/models/score_creation_builder_data.rb +234 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data.rb +173 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_layout_data.rb +255 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data.rb +217 -0
- data/lib/flat_api/models/score_creation_builder_data_all_of_builder_data_score_data_instruments.rb +222 -0
- data/lib/flat_api/models/score_creation_common.rb +201 -0
- data/lib/flat_api/models/score_creation_file_import.rb +277 -0
- data/lib/flat_api/models/score_creation_google_drive_import.rb +234 -0
- data/lib/flat_api/models/score_creation_type.rb +18 -9
- data/lib/flat_api/models/score_details.rb +428 -146
- data/lib/flat_api/models/score_details_all_of_me.rb +193 -0
- data/lib/flat_api/models/score_fork.rb +84 -101
- data/lib/flat_api/models/score_license.rb +18 -9
- data/lib/flat_api/models/score_likes_counts.rb +73 -103
- data/lib/flat_api/models/score_modification.rb +178 -115
- data/lib/flat_api/models/score_plays_counts.rb +179 -0
- data/lib/flat_api/models/score_privacy.rb +18 -9
- data/lib/flat_api/models/score_revision.rb +142 -111
- data/lib/flat_api/models/score_revision_creation.rb +113 -105
- data/lib/flat_api/models/score_revision_statistics.rb +81 -101
- data/lib/flat_api/models/score_source.rb +59 -100
- data/lib/flat_api/models/score_summary.rb +172 -105
- data/lib/flat_api/models/score_track.rb +244 -117
- data/lib/flat_api/models/score_track_creation.rb +99 -104
- data/lib/flat_api/models/score_track_creation_response.rb +165 -0
- data/lib/flat_api/models/score_track_point.rb +78 -103
- data/lib/flat_api/models/score_track_purpose.rb +40 -0
- data/lib/flat_api/models/score_track_state.rb +18 -9
- data/lib/flat_api/models/score_track_type.rb +18 -9
- data/lib/flat_api/models/score_track_update.rb +98 -103
- data/lib/flat_api/models/score_views_counts.rb +73 -103
- data/lib/flat_api/models/task.rb +339 -0
- data/lib/flat_api/models/task_export_options.rb +151 -0
- data/lib/flat_api/models/task_progress.rb +159 -0
- data/lib/flat_api/models/task_result.rb +159 -0
- data/lib/flat_api/models/teaching_theme.rb +47 -0
- data/lib/flat_api/models/tutteo_product.rb +42 -0
- data/lib/flat_api/models/user_admin_update.rb +206 -106
- data/lib/flat_api/models/user_azure_details.rb +168 -0
- data/lib/flat_api/models/user_basics.rb +215 -120
- data/lib/flat_api/models/user_community_profile_links.rb +205 -0
- data/lib/flat_api/models/user_creation.rb +203 -114
- data/lib/flat_api/models/user_details.rb +331 -161
- data/lib/flat_api/models/user_details_admin.rb +272 -133
- data/lib/flat_api/models/user_details_admin_all_of_license.rb +211 -0
- data/lib/flat_api/models/user_public.rb +303 -145
- data/lib/flat_api/models/user_public_summary.rb +243 -126
- data/lib/flat_api/models/user_signin_link.rb +168 -0
- data/lib/flat_api/models/user_signin_link_creation.rb +150 -0
- data/lib/flat_api/oauth.rb +128 -0
- data/lib/flat_api/pagination.rb +88 -0
- data/lib/flat_api/retry.rb +56 -0
- data/lib/flat_api/version.rb +5 -5
- data/lib/flat_api.rb +144 -16
- metadata +154 -434
- data/Gemfile +0 -7
- data/Rakefile +0 -8
- data/docs/AccountApi.md +0 -55
- data/docs/Assignment.md +0 -18
- data/docs/AssignmentCopy.md +0 -8
- data/docs/AssignmentCreation.md +0 -12
- data/docs/AssignmentSubmission.md +0 -19
- data/docs/AssignmentSubmissionUpdate.md +0 -11
- data/docs/ClassApi.md +0 -1051
- data/docs/ClassAttachmentCreation.md +0 -10
- data/docs/ClassCreation.md +0 -9
- data/docs/ClassDetails.md +0 -25
- data/docs/ClassDetailsCanvas.md +0 -9
- data/docs/ClassDetailsClever.md +0 -14
- data/docs/ClassDetailsGoogleClassroom.md +0 -11
- data/docs/ClassDetailsGoogleDrive.md +0 -9
- data/docs/ClassDetailsLti.md +0 -10
- data/docs/ClassRoles.md +0 -7
- data/docs/ClassState.md +0 -7
- data/docs/ClassUpdate.md +0 -9
- data/docs/Collection.md +0 -18
- data/docs/CollectionApi.md +0 -521
- data/docs/CollectionCapabilities.md +0 -12
- data/docs/CollectionCreation.md +0 -8
- data/docs/CollectionModification.md +0 -8
- data/docs/CollectionPrivacy.md +0 -7
- data/docs/CollectionTitle.md +0 -7
- data/docs/CollectionType.md +0 -7
- data/docs/FlatErrorResponse.md +0 -11
- data/docs/FlatLocales.md +0 -7
- data/docs/GoogleClassroomCoursework.md +0 -10
- data/docs/GoogleClassroomSubmission.md +0 -10
- data/docs/Group.md +0 -14
- data/docs/GroupApi.md +0 -167
- data/docs/GroupDetails.md +0 -14
- data/docs/GroupType.md +0 -7
- data/docs/LicenseMode.md +0 -7
- data/docs/LicenseSources.md +0 -7
- data/docs/LmsName.md +0 -7
- data/docs/LtiCredentials.md +0 -16
- data/docs/LtiCredentialsCreation.md +0 -9
- data/docs/MediaAttachment.md +0 -23
- data/docs/MediaScoreSharingMode.md +0 -7
- data/docs/OrganizationApi.md +0 -538
- data/docs/OrganizationInvitation.md +0 -14
- data/docs/OrganizationInvitationCreation.md +0 -9
- data/docs/OrganizationRoles.md +0 -7
- data/docs/ResourceCollaborator.md +0 -16
- data/docs/ResourceCollaboratorCreation.md +0 -14
- data/docs/ResourceRights.md +0 -10
- data/docs/ResourceSharingKey.md +0 -7
- data/docs/ScoreApi.md +0 -1658
- data/docs/ScoreComment.md +0 -22
- data/docs/ScoreCommentContext.md +0 -14
- data/docs/ScoreCommentCreation.md +0 -13
- data/docs/ScoreCommentUpdate.md +0 -11
- data/docs/ScoreCommentsCounts.md +0 -11
- data/docs/ScoreCreation.md +0 -14
- data/docs/ScoreCreationType.md +0 -7
- data/docs/ScoreData.md +0 -7
- data/docs/ScoreDataEncoding.md +0 -7
- data/docs/ScoreDetails.md +0 -36
- data/docs/ScoreFork.md +0 -8
- data/docs/ScoreLicense.md +0 -7
- data/docs/ScoreLikesCounts.md +0 -10
- data/docs/ScoreModification.md +0 -14
- data/docs/ScorePrivacy.md +0 -7
- data/docs/ScoreRevision.md +0 -14
- data/docs/ScoreRevisionCreation.md +0 -11
- data/docs/ScoreRevisionStatistics.md +0 -9
- data/docs/ScoreSource.md +0 -8
- data/docs/ScoreSummary.md +0 -13
- data/docs/ScoreTrack.md +0 -19
- data/docs/ScoreTrackCreation.md +0 -12
- data/docs/ScoreTrackPoint.md +0 -10
- data/docs/ScoreTrackState.md +0 -7
- data/docs/ScoreTrackType.md +0 -7
- data/docs/ScoreTrackUpdate.md +0 -11
- data/docs/ScoreViewsCounts.md +0 -10
- data/docs/UserAdminUpdate.md +0 -9
- data/docs/UserApi.md +0 -173
- data/docs/UserBasics.md +0 -13
- data/docs/UserCreation.md +0 -11
- data/docs/UserDetails.md +0 -28
- data/docs/UserDetailsAdmin.md +0 -20
- data/docs/UserDetailsAdminLicense.md +0 -12
- data/docs/UserInstruments.md +0 -7
- data/docs/UserPublic.md +0 -25
- data/docs/UserPublicSummary.md +0 -17
- data/flat_api.gemspec +0 -48
- data/lib/flat_api/models/assignment_creation.rb +0 -230
- data/lib/flat_api/models/collection_title.rb +0 -179
- data/lib/flat_api/models/flat_locales.rb +0 -36
- data/lib/flat_api/models/resource_sharing_key.rb +0 -179
- data/lib/flat_api/models/score_data.rb +0 -179
- data/lib/flat_api/models/score_data_encoding.rb +0 -30
- data/lib/flat_api/models/user_details_admin_license.rb +0 -227
- data/lib/flat_api/models/user_instruments.rb +0 -179
- data/spec/api/account_api_spec.rb +0 -46
- data/spec/api/class_api_spec.rb +0 -278
- data/spec/api/collection_api_spec.rb +0 -159
- data/spec/api/group_api_spec.rb +0 -72
- data/spec/api/organization_api_spec.rb +0 -162
- data/spec/api/score_api_spec.rb +0 -426
- data/spec/api/user_api_spec.rb +0 -73
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/assignment_copy_spec.rb +0 -42
- data/spec/models/assignment_creation_spec.rb +0 -66
- data/spec/models/assignment_spec.rb +0 -106
- data/spec/models/assignment_submission_spec.rb +0 -108
- data/spec/models/assignment_submission_update_spec.rb +0 -60
- data/spec/models/class_attachment_creation_spec.rb +0 -58
- data/spec/models/class_creation_spec.rb +0 -48
- data/spec/models/class_details_canvas_spec.rb +0 -48
- data/spec/models/class_details_clever_spec.rb +0 -82
- data/spec/models/class_details_google_classroom_spec.rb +0 -60
- data/spec/models/class_details_google_drive_spec.rb +0 -48
- data/spec/models/class_details_lti_spec.rb +0 -54
- data/spec/models/class_details_spec.rb +0 -144
- data/spec/models/class_roles_spec.rb +0 -36
- data/spec/models/class_state_spec.rb +0 -36
- data/spec/models/class_update_spec.rb +0 -48
- data/spec/models/collection_capabilities_spec.rb +0 -66
- data/spec/models/collection_creation_spec.rb +0 -42
- data/spec/models/collection_modification_spec.rb +0 -42
- data/spec/models/collection_privacy_spec.rb +0 -36
- data/spec/models/collection_spec.rb +0 -102
- data/spec/models/collection_title_spec.rb +0 -36
- data/spec/models/collection_type_spec.rb +0 -36
- data/spec/models/flat_error_response_spec.rb +0 -60
- data/spec/models/flat_locales_spec.rb +0 -36
- data/spec/models/google_classroom_coursework_spec.rb +0 -54
- data/spec/models/google_classroom_submission_spec.rb +0 -54
- data/spec/models/group_details_spec.rb +0 -78
- data/spec/models/group_spec.rb +0 -82
- data/spec/models/group_type_spec.rb +0 -36
- data/spec/models/license_mode_spec.rb +0 -36
- data/spec/models/license_sources_spec.rb +0 -36
- data/spec/models/lms_name_spec.rb +0 -36
- data/spec/models/lti_credentials_creation_spec.rb +0 -48
- data/spec/models/lti_credentials_spec.rb +0 -90
- data/spec/models/media_attachment_spec.rb +0 -136
- data/spec/models/media_score_sharing_mode_spec.rb +0 -36
- data/spec/models/organization_invitation_creation_spec.rb +0 -48
- data/spec/models/organization_invitation_spec.rb +0 -78
- data/spec/models/organization_roles_spec.rb +0 -36
- data/spec/models/resource_collaborator_creation_spec.rb +0 -78
- data/spec/models/resource_collaborator_spec.rb +0 -90
- data/spec/models/resource_rights_spec.rb +0 -54
- data/spec/models/resource_sharing_key_spec.rb +0 -36
- data/spec/models/score_comment_context_spec.rb +0 -78
- data/spec/models/score_comment_creation_spec.rb +0 -72
- data/spec/models/score_comment_spec.rb +0 -130
- data/spec/models/score_comment_update_spec.rb +0 -60
- data/spec/models/score_comments_counts_spec.rb +0 -60
- data/spec/models/score_creation_spec.rb +0 -78
- data/spec/models/score_creation_type_spec.rb +0 -36
- data/spec/models/score_data_encoding_spec.rb +0 -36
- data/spec/models/score_data_spec.rb +0 -36
- data/spec/models/score_details_spec.rb +0 -210
- data/spec/models/score_fork_spec.rb +0 -42
- data/spec/models/score_license_spec.rb +0 -36
- data/spec/models/score_likes_counts_spec.rb +0 -54
- data/spec/models/score_modification_spec.rb +0 -78
- data/spec/models/score_privacy_spec.rb +0 -36
- data/spec/models/score_revision_creation_spec.rb +0 -60
- data/spec/models/score_revision_spec.rb +0 -78
- data/spec/models/score_revision_statistics_spec.rb +0 -48
- data/spec/models/score_source_spec.rb +0 -42
- data/spec/models/score_summary_spec.rb +0 -72
- data/spec/models/score_track_creation_spec.rb +0 -66
- data/spec/models/score_track_point_spec.rb +0 -58
- data/spec/models/score_track_spec.rb +0 -108
- data/spec/models/score_track_state_spec.rb +0 -36
- data/spec/models/score_track_type_spec.rb +0 -36
- data/spec/models/score_track_update_spec.rb +0 -60
- data/spec/models/score_views_counts_spec.rb +0 -54
- data/spec/models/user_admin_update_spec.rb +0 -48
- data/spec/models/user_basics_spec.rb +0 -72
- data/spec/models/user_creation_spec.rb +0 -60
- data/spec/models/user_details_admin_license_spec.rb +0 -66
- data/spec/models/user_details_admin_spec.rb +0 -114
- data/spec/models/user_details_spec.rb +0 -166
- data/spec/models/user_instruments_spec.rb +0 -36
- data/spec/models/user_public_spec.rb +0 -144
- data/spec/models/user_public_summary_spec.rb +0 -96
- data/spec/spec_helper.rb +0 -111
|
@@ -1,21 +1,22 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
OpenAPI
|
|
6
|
+
The version of the OpenAPI document: 2.26.1
|
|
7
7
|
Contact: developers@flat.io
|
|
8
|
-
Generated by: https://
|
|
9
|
-
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.24.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
|
+
require 'time'
|
|
14
15
|
|
|
15
16
|
module FlatApi
|
|
16
17
|
# Update of a comment
|
|
17
|
-
class ScoreCommentUpdate
|
|
18
|
-
# The unique
|
|
18
|
+
class ScoreCommentUpdate < ApiModelBase
|
|
19
|
+
# The unique identifier of the revision of the score where the comment was added. If this property is unspecified or contains \"last\", the API will automatically take the last revision created.
|
|
19
20
|
attr_accessor :revision
|
|
20
21
|
|
|
21
22
|
# The comment text that can includes mentions using the following format: `@[id:username]`.
|
|
@@ -26,7 +27,6 @@ module FlatApi
|
|
|
26
27
|
|
|
27
28
|
attr_accessor :context
|
|
28
29
|
|
|
29
|
-
|
|
30
30
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
31
31
|
def self.attribute_map
|
|
32
32
|
{
|
|
@@ -37,8 +37,18 @@ module FlatApi
|
|
|
37
37
|
}
|
|
38
38
|
end
|
|
39
39
|
|
|
40
|
+
# Returns attribute mapping this model knows about
|
|
41
|
+
def self.acceptable_attribute_map
|
|
42
|
+
attribute_map
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
# Returns all the JSON keys this model knows about
|
|
46
|
+
def self.acceptable_attributes
|
|
47
|
+
acceptable_attribute_map.values
|
|
48
|
+
end
|
|
49
|
+
|
|
40
50
|
# Attribute type mapping.
|
|
41
|
-
def self.
|
|
51
|
+
def self.openapi_types
|
|
42
52
|
{
|
|
43
53
|
:'revision' => :'String',
|
|
44
54
|
:'comment' => :'String',
|
|
@@ -47,75 +57,93 @@ module FlatApi
|
|
|
47
57
|
}
|
|
48
58
|
end
|
|
49
59
|
|
|
60
|
+
# List of attributes with nullable: true
|
|
61
|
+
def self.openapi_nullable
|
|
62
|
+
Set.new([
|
|
63
|
+
])
|
|
64
|
+
end
|
|
65
|
+
|
|
50
66
|
# Initializes the object
|
|
51
67
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
52
68
|
def initialize(attributes = {})
|
|
53
|
-
|
|
69
|
+
if (!attributes.is_a?(Hash))
|
|
70
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::ScoreCommentUpdate` initialize method"
|
|
71
|
+
end
|
|
54
72
|
|
|
55
|
-
# convert string to symbol for hash key
|
|
56
|
-
|
|
73
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
74
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
75
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
76
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
77
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::ScoreCommentUpdate`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
78
|
+
end
|
|
79
|
+
h[k.to_sym] = v
|
|
80
|
+
}
|
|
57
81
|
|
|
58
|
-
if attributes.
|
|
82
|
+
if attributes.key?(:'revision')
|
|
59
83
|
self.revision = attributes[:'revision']
|
|
60
84
|
end
|
|
61
85
|
|
|
62
|
-
if attributes.
|
|
86
|
+
if attributes.key?(:'comment')
|
|
63
87
|
self.comment = attributes[:'comment']
|
|
64
88
|
end
|
|
65
89
|
|
|
66
|
-
if attributes.
|
|
67
|
-
self.raw_comment = attributes[:'
|
|
90
|
+
if attributes.key?(:'raw_comment')
|
|
91
|
+
self.raw_comment = attributes[:'raw_comment']
|
|
68
92
|
end
|
|
69
93
|
|
|
70
|
-
if attributes.
|
|
94
|
+
if attributes.key?(:'context')
|
|
71
95
|
self.context = attributes[:'context']
|
|
72
96
|
end
|
|
73
|
-
|
|
74
97
|
end
|
|
75
98
|
|
|
76
99
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
77
100
|
# @return Array for valid properties with the reasons
|
|
78
101
|
def list_invalid_properties
|
|
102
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
79
103
|
invalid_properties = Array.new
|
|
80
104
|
if !@comment.nil? && @comment.to_s.length > 10000
|
|
81
|
-
invalid_properties.push(
|
|
105
|
+
invalid_properties.push('invalid value for "comment", the character length must be smaller than or equal to 10000.')
|
|
82
106
|
end
|
|
83
107
|
|
|
84
108
|
if !@comment.nil? && @comment.to_s.length < 1
|
|
85
|
-
invalid_properties.push(
|
|
109
|
+
invalid_properties.push('invalid value for "comment", the character length must be greater than or equal to 1.')
|
|
86
110
|
end
|
|
87
111
|
|
|
88
112
|
if !@raw_comment.nil? && @raw_comment.to_s.length > 10000
|
|
89
|
-
invalid_properties.push(
|
|
113
|
+
invalid_properties.push('invalid value for "raw_comment", the character length must be smaller than or equal to 10000.')
|
|
90
114
|
end
|
|
91
115
|
|
|
92
116
|
if !@raw_comment.nil? && @raw_comment.to_s.length < 1
|
|
93
|
-
invalid_properties.push(
|
|
117
|
+
invalid_properties.push('invalid value for "raw_comment", the character length must be greater than or equal to 1.')
|
|
94
118
|
end
|
|
95
119
|
|
|
96
|
-
|
|
120
|
+
invalid_properties
|
|
97
121
|
end
|
|
98
122
|
|
|
99
123
|
# Check to see if the all the properties in the model are valid
|
|
100
124
|
# @return true if the model is valid
|
|
101
125
|
def valid?
|
|
126
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
102
127
|
return false if !@comment.nil? && @comment.to_s.length > 10000
|
|
103
128
|
return false if !@comment.nil? && @comment.to_s.length < 1
|
|
104
129
|
return false if !@raw_comment.nil? && @raw_comment.to_s.length > 10000
|
|
105
130
|
return false if !@raw_comment.nil? && @raw_comment.to_s.length < 1
|
|
106
|
-
|
|
131
|
+
true
|
|
107
132
|
end
|
|
108
133
|
|
|
109
134
|
# Custom attribute writer method with validation
|
|
110
135
|
# @param [Object] comment Value to be assigned
|
|
111
136
|
def comment=(comment)
|
|
137
|
+
if comment.nil?
|
|
138
|
+
fail ArgumentError, 'comment cannot be nil'
|
|
139
|
+
end
|
|
112
140
|
|
|
113
|
-
if
|
|
114
|
-
fail ArgumentError,
|
|
141
|
+
if comment.to_s.length > 10000
|
|
142
|
+
fail ArgumentError, 'invalid value for "comment", the character length must be smaller than or equal to 10000.'
|
|
115
143
|
end
|
|
116
144
|
|
|
117
|
-
if
|
|
118
|
-
fail ArgumentError,
|
|
145
|
+
if comment.to_s.length < 1
|
|
146
|
+
fail ArgumentError, 'invalid value for "comment", the character length must be greater than or equal to 1.'
|
|
119
147
|
end
|
|
120
148
|
|
|
121
149
|
@comment = comment
|
|
@@ -124,13 +152,16 @@ module FlatApi
|
|
|
124
152
|
# Custom attribute writer method with validation
|
|
125
153
|
# @param [Object] raw_comment Value to be assigned
|
|
126
154
|
def raw_comment=(raw_comment)
|
|
155
|
+
if raw_comment.nil?
|
|
156
|
+
fail ArgumentError, 'raw_comment cannot be nil'
|
|
157
|
+
end
|
|
127
158
|
|
|
128
|
-
if
|
|
129
|
-
fail ArgumentError,
|
|
159
|
+
if raw_comment.to_s.length > 10000
|
|
160
|
+
fail ArgumentError, 'invalid value for "raw_comment", the character length must be smaller than or equal to 10000.'
|
|
130
161
|
end
|
|
131
162
|
|
|
132
|
-
if
|
|
133
|
-
fail ArgumentError,
|
|
163
|
+
if raw_comment.to_s.length < 1
|
|
164
|
+
fail ArgumentError, 'invalid value for "raw_comment", the character length must be greater than or equal to 1.'
|
|
134
165
|
end
|
|
135
166
|
|
|
136
167
|
@raw_comment = raw_comment
|
|
@@ -154,7 +185,7 @@ module FlatApi
|
|
|
154
185
|
end
|
|
155
186
|
|
|
156
187
|
# Calculates hash code according to all attributes.
|
|
157
|
-
# @return [
|
|
188
|
+
# @return [Integer] Hash code
|
|
158
189
|
def hash
|
|
159
190
|
[revision, comment, raw_comment, context].hash
|
|
160
191
|
end
|
|
@@ -162,75 +193,24 @@ module FlatApi
|
|
|
162
193
|
# Builds the object from hash
|
|
163
194
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
164
195
|
# @return [Object] Returns the model itself
|
|
165
|
-
def build_from_hash(attributes)
|
|
196
|
+
def self.build_from_hash(attributes)
|
|
166
197
|
return nil unless attributes.is_a?(Hash)
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
198
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
199
|
+
transformed_hash = {}
|
|
200
|
+
openapi_types.each_pair do |key, type|
|
|
201
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
202
|
+
transformed_hash["#{key}"] = nil
|
|
203
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
204
|
+
# check to ensure the input is an array given that the attribute
|
|
170
205
|
# is documented as an array but the input is not
|
|
171
|
-
if attributes[
|
|
172
|
-
|
|
173
|
-
end
|
|
174
|
-
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
175
|
-
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
176
|
-
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
177
|
-
end
|
|
178
|
-
|
|
179
|
-
self
|
|
180
|
-
end
|
|
181
|
-
|
|
182
|
-
# Deserializes the data based on type
|
|
183
|
-
# @param string type Data type
|
|
184
|
-
# @param string value Value to be deserialized
|
|
185
|
-
# @return [Object] Deserialized data
|
|
186
|
-
def _deserialize(type, value)
|
|
187
|
-
case type.to_sym
|
|
188
|
-
when :DateTime
|
|
189
|
-
DateTime.parse(value)
|
|
190
|
-
when :Date
|
|
191
|
-
Date.parse(value)
|
|
192
|
-
when :String
|
|
193
|
-
value.to_s
|
|
194
|
-
when :Integer
|
|
195
|
-
value.to_i
|
|
196
|
-
when :Float
|
|
197
|
-
value.to_f
|
|
198
|
-
when :BOOLEAN
|
|
199
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
200
|
-
true
|
|
201
|
-
else
|
|
202
|
-
false
|
|
203
|
-
end
|
|
204
|
-
when :Object
|
|
205
|
-
# generic object (usually a Hash), return directly
|
|
206
|
-
value
|
|
207
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
208
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
209
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
210
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
211
|
-
k_type = Regexp.last_match[:k_type]
|
|
212
|
-
v_type = Regexp.last_match[:v_type]
|
|
213
|
-
{}.tap do |hash|
|
|
214
|
-
value.each do |k, v|
|
|
215
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
206
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
207
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
216
208
|
end
|
|
209
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
210
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
217
211
|
end
|
|
218
|
-
else # model
|
|
219
|
-
temp_model = FlatApi.const_get(type).new
|
|
220
|
-
temp_model.build_from_hash(value)
|
|
221
212
|
end
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
# Returns the string representation of the object
|
|
225
|
-
# @return [String] String presentation of the object
|
|
226
|
-
def to_s
|
|
227
|
-
to_hash.to_s
|
|
228
|
-
end
|
|
229
|
-
|
|
230
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
231
|
-
# @return [Hash] Returns the object in the form of hash
|
|
232
|
-
def to_body
|
|
233
|
-
to_hash
|
|
213
|
+
new(transformed_hash)
|
|
234
214
|
end
|
|
235
215
|
|
|
236
216
|
# Returns the object in the form of hash
|
|
@@ -239,30 +219,16 @@ module FlatApi
|
|
|
239
219
|
hash = {}
|
|
240
220
|
self.class.attribute_map.each_pair do |attr, param|
|
|
241
221
|
value = self.send(attr)
|
|
242
|
-
|
|
222
|
+
if value.nil?
|
|
223
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
224
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
225
|
+
end
|
|
226
|
+
|
|
243
227
|
hash[param] = _to_hash(value)
|
|
244
228
|
end
|
|
245
229
|
hash
|
|
246
230
|
end
|
|
247
231
|
|
|
248
|
-
# Outputs non-array value in the form of hash
|
|
249
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
250
|
-
# @param [Object] value Any valid value
|
|
251
|
-
# @return [Hash] Returns the value in the form of hash
|
|
252
|
-
def _to_hash(value)
|
|
253
|
-
if value.is_a?(Array)
|
|
254
|
-
value.compact.map{ |v| _to_hash(v) }
|
|
255
|
-
elsif value.is_a?(Hash)
|
|
256
|
-
{}.tap do |hash|
|
|
257
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
258
|
-
end
|
|
259
|
-
elsif value.respond_to? :to_hash
|
|
260
|
-
value.to_hash
|
|
261
|
-
else
|
|
262
|
-
value
|
|
263
|
-
end
|
|
264
|
-
end
|
|
265
|
-
|
|
266
232
|
end
|
|
267
233
|
|
|
268
234
|
end
|
|
@@ -1,32 +1,35 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Flat API
|
|
3
3
|
|
|
4
|
-
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML
|
|
4
|
+
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
|
5
5
|
|
|
6
|
-
OpenAPI
|
|
6
|
+
The version of the OpenAPI document: 2.26.1
|
|
7
7
|
Contact: developers@flat.io
|
|
8
|
-
Generated by: https://
|
|
9
|
-
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.24.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
13
|
require 'date'
|
|
14
|
+
require 'time'
|
|
14
15
|
|
|
15
16
|
module FlatApi
|
|
16
|
-
# A computed version of the total, unique, weekly and
|
|
17
|
-
class ScoreCommentsCounts
|
|
18
|
-
# The total number of comments added
|
|
17
|
+
# A computed version of the total, unique, weekly, monthly and yearly number of comments added on the documents (this doesn't include inline comments).
|
|
18
|
+
class ScoreCommentsCounts < ApiModelBase
|
|
19
|
+
# The total number of comments added to the score
|
|
19
20
|
attr_accessor :total
|
|
20
21
|
|
|
21
|
-
# The unique (1/user) number of comments added
|
|
22
|
+
# The unique (1/user) number of comments added to the score
|
|
22
23
|
attr_accessor :unique
|
|
23
24
|
|
|
24
|
-
# The weekly unique number of comments added
|
|
25
|
+
# The weekly unique number of comments added to the score
|
|
25
26
|
attr_accessor :weekly
|
|
26
27
|
|
|
27
|
-
# The monthly unique number of comments added
|
|
28
|
+
# The monthly unique number of comments added to the score
|
|
28
29
|
attr_accessor :monthly
|
|
29
30
|
|
|
31
|
+
# The yearly unique number of comments added to the score
|
|
32
|
+
attr_accessor :yearly
|
|
30
33
|
|
|
31
34
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
32
35
|
def self.attribute_map
|
|
@@ -34,57 +37,88 @@ module FlatApi
|
|
|
34
37
|
:'total' => :'total',
|
|
35
38
|
:'unique' => :'unique',
|
|
36
39
|
:'weekly' => :'weekly',
|
|
37
|
-
:'monthly' => :'monthly'
|
|
40
|
+
:'monthly' => :'monthly',
|
|
41
|
+
:'yearly' => :'yearly'
|
|
38
42
|
}
|
|
39
43
|
end
|
|
40
44
|
|
|
45
|
+
# Returns attribute mapping this model knows about
|
|
46
|
+
def self.acceptable_attribute_map
|
|
47
|
+
attribute_map
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# Returns all the JSON keys this model knows about
|
|
51
|
+
def self.acceptable_attributes
|
|
52
|
+
acceptable_attribute_map.values
|
|
53
|
+
end
|
|
54
|
+
|
|
41
55
|
# Attribute type mapping.
|
|
42
|
-
def self.
|
|
56
|
+
def self.openapi_types
|
|
43
57
|
{
|
|
44
58
|
:'total' => :'Float',
|
|
45
59
|
:'unique' => :'Float',
|
|
46
60
|
:'weekly' => :'Float',
|
|
47
|
-
:'monthly' => :'Float'
|
|
61
|
+
:'monthly' => :'Float',
|
|
62
|
+
:'yearly' => :'Float'
|
|
48
63
|
}
|
|
49
64
|
end
|
|
50
65
|
|
|
66
|
+
# List of attributes with nullable: true
|
|
67
|
+
def self.openapi_nullable
|
|
68
|
+
Set.new([
|
|
69
|
+
])
|
|
70
|
+
end
|
|
71
|
+
|
|
51
72
|
# Initializes the object
|
|
52
73
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
53
74
|
def initialize(attributes = {})
|
|
54
|
-
|
|
75
|
+
if (!attributes.is_a?(Hash))
|
|
76
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::ScoreCommentsCounts` initialize method"
|
|
77
|
+
end
|
|
55
78
|
|
|
56
|
-
# convert string to symbol for hash key
|
|
57
|
-
|
|
79
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
80
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
81
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
82
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
83
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::ScoreCommentsCounts`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
84
|
+
end
|
|
85
|
+
h[k.to_sym] = v
|
|
86
|
+
}
|
|
58
87
|
|
|
59
|
-
if attributes.
|
|
88
|
+
if attributes.key?(:'total')
|
|
60
89
|
self.total = attributes[:'total']
|
|
61
90
|
end
|
|
62
91
|
|
|
63
|
-
if attributes.
|
|
92
|
+
if attributes.key?(:'unique')
|
|
64
93
|
self.unique = attributes[:'unique']
|
|
65
94
|
end
|
|
66
95
|
|
|
67
|
-
if attributes.
|
|
96
|
+
if attributes.key?(:'weekly')
|
|
68
97
|
self.weekly = attributes[:'weekly']
|
|
69
98
|
end
|
|
70
99
|
|
|
71
|
-
if attributes.
|
|
100
|
+
if attributes.key?(:'monthly')
|
|
72
101
|
self.monthly = attributes[:'monthly']
|
|
73
102
|
end
|
|
74
103
|
|
|
104
|
+
if attributes.key?(:'yearly')
|
|
105
|
+
self.yearly = attributes[:'yearly']
|
|
106
|
+
end
|
|
75
107
|
end
|
|
76
108
|
|
|
77
109
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
78
110
|
# @return Array for valid properties with the reasons
|
|
79
111
|
def list_invalid_properties
|
|
112
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
80
113
|
invalid_properties = Array.new
|
|
81
|
-
|
|
114
|
+
invalid_properties
|
|
82
115
|
end
|
|
83
116
|
|
|
84
117
|
# Check to see if the all the properties in the model are valid
|
|
85
118
|
# @return true if the model is valid
|
|
86
119
|
def valid?
|
|
87
|
-
|
|
120
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
121
|
+
true
|
|
88
122
|
end
|
|
89
123
|
|
|
90
124
|
# Checks equality by comparing each attribute.
|
|
@@ -95,7 +129,8 @@ module FlatApi
|
|
|
95
129
|
total == o.total &&
|
|
96
130
|
unique == o.unique &&
|
|
97
131
|
weekly == o.weekly &&
|
|
98
|
-
monthly == o.monthly
|
|
132
|
+
monthly == o.monthly &&
|
|
133
|
+
yearly == o.yearly
|
|
99
134
|
end
|
|
100
135
|
|
|
101
136
|
# @see the `==` method
|
|
@@ -105,83 +140,32 @@ module FlatApi
|
|
|
105
140
|
end
|
|
106
141
|
|
|
107
142
|
# Calculates hash code according to all attributes.
|
|
108
|
-
# @return [
|
|
143
|
+
# @return [Integer] Hash code
|
|
109
144
|
def hash
|
|
110
|
-
[total, unique, weekly, monthly].hash
|
|
145
|
+
[total, unique, weekly, monthly, yearly].hash
|
|
111
146
|
end
|
|
112
147
|
|
|
113
148
|
# Builds the object from hash
|
|
114
149
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
115
150
|
# @return [Object] Returns the model itself
|
|
116
|
-
def build_from_hash(attributes)
|
|
151
|
+
def self.build_from_hash(attributes)
|
|
117
152
|
return nil unless attributes.is_a?(Hash)
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
153
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
154
|
+
transformed_hash = {}
|
|
155
|
+
openapi_types.each_pair do |key, type|
|
|
156
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
157
|
+
transformed_hash["#{key}"] = nil
|
|
158
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
159
|
+
# check to ensure the input is an array given that the attribute
|
|
121
160
|
# is documented as an array but the input is not
|
|
122
|
-
if attributes[
|
|
123
|
-
|
|
161
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
162
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
124
163
|
end
|
|
125
|
-
elsif !attributes[
|
|
126
|
-
|
|
127
|
-
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
128
|
-
end
|
|
129
|
-
|
|
130
|
-
self
|
|
131
|
-
end
|
|
132
|
-
|
|
133
|
-
# Deserializes the data based on type
|
|
134
|
-
# @param string type Data type
|
|
135
|
-
# @param string value Value to be deserialized
|
|
136
|
-
# @return [Object] Deserialized data
|
|
137
|
-
def _deserialize(type, value)
|
|
138
|
-
case type.to_sym
|
|
139
|
-
when :DateTime
|
|
140
|
-
DateTime.parse(value)
|
|
141
|
-
when :Date
|
|
142
|
-
Date.parse(value)
|
|
143
|
-
when :String
|
|
144
|
-
value.to_s
|
|
145
|
-
when :Integer
|
|
146
|
-
value.to_i
|
|
147
|
-
when :Float
|
|
148
|
-
value.to_f
|
|
149
|
-
when :BOOLEAN
|
|
150
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
151
|
-
true
|
|
152
|
-
else
|
|
153
|
-
false
|
|
164
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
165
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
154
166
|
end
|
|
155
|
-
when :Object
|
|
156
|
-
# generic object (usually a Hash), return directly
|
|
157
|
-
value
|
|
158
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
159
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
160
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
161
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
162
|
-
k_type = Regexp.last_match[:k_type]
|
|
163
|
-
v_type = Regexp.last_match[:v_type]
|
|
164
|
-
{}.tap do |hash|
|
|
165
|
-
value.each do |k, v|
|
|
166
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
167
|
-
end
|
|
168
|
-
end
|
|
169
|
-
else # model
|
|
170
|
-
temp_model = FlatApi.const_get(type).new
|
|
171
|
-
temp_model.build_from_hash(value)
|
|
172
167
|
end
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
# Returns the string representation of the object
|
|
176
|
-
# @return [String] String presentation of the object
|
|
177
|
-
def to_s
|
|
178
|
-
to_hash.to_s
|
|
179
|
-
end
|
|
180
|
-
|
|
181
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
182
|
-
# @return [Hash] Returns the object in the form of hash
|
|
183
|
-
def to_body
|
|
184
|
-
to_hash
|
|
168
|
+
new(transformed_hash)
|
|
185
169
|
end
|
|
186
170
|
|
|
187
171
|
# Returns the object in the form of hash
|
|
@@ -190,30 +174,16 @@ module FlatApi
|
|
|
190
174
|
hash = {}
|
|
191
175
|
self.class.attribute_map.each_pair do |attr, param|
|
|
192
176
|
value = self.send(attr)
|
|
193
|
-
|
|
177
|
+
if value.nil?
|
|
178
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
179
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
180
|
+
end
|
|
181
|
+
|
|
194
182
|
hash[param] = _to_hash(value)
|
|
195
183
|
end
|
|
196
184
|
hash
|
|
197
185
|
end
|
|
198
186
|
|
|
199
|
-
# Outputs non-array value in the form of hash
|
|
200
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
201
|
-
# @param [Object] value Any valid value
|
|
202
|
-
# @return [Hash] Returns the value in the form of hash
|
|
203
|
-
def _to_hash(value)
|
|
204
|
-
if value.is_a?(Array)
|
|
205
|
-
value.compact.map{ |v| _to_hash(v) }
|
|
206
|
-
elsif value.is_a?(Hash)
|
|
207
|
-
{}.tap do |hash|
|
|
208
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
209
|
-
end
|
|
210
|
-
elsif value.respond_to? :to_hash
|
|
211
|
-
value.to_hash
|
|
212
|
-
else
|
|
213
|
-
value
|
|
214
|
-
end
|
|
215
|
-
end
|
|
216
|
-
|
|
217
187
|
end
|
|
218
188
|
|
|
219
189
|
end
|