group.md

Group

This model accepts additional fields of type Object.

Structure

Group

Fields

Name	Type	Tags	Description
created_time	String	Required	The time in ISO 8601 format when the group was created.
description	String	Required	The group's description.
link	String	Required	The link to the group.
metadata	Metadata6	Required	Metadata about the group.
modified_time	String	Required	The time in ISO 8601 format when the group was last modified.
name	String	Required	The group's display name.
pictures	Picture	Required	The active picture for the group.
privacy	Privacy4	Required	The group's privacy settings.
resource_key	String	Required	The resource key of the group.
uri	String	Required	The canonical relative URI of the group.
user	User	Optional	The owner of the group.
additional_properties	Hash[String, Object]	Optional	-

Example

group = Group.new(
  created_time: '2008-07-05T14:52:43+00:00',
  description: 'Want to participate in our weekly challenges? Join the group to receive messages and new challenges!',
  link: 'https://vimeo.com/groups/weekendchallenge',
  metadata: Metadata6.new(
    connections: Connections6.new(
      requested_clip: RequestedClip.new(
        options: [
          'options1',
          'options2'
        ],
        uri: 'videos/1232',
        additional_properties: {
          'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
        }
      ),
      users: Users2.new(
        options: [
          'options3'
        ],
        total: 25798,
        uri: '/groups/1108/users',
        additional_properties: {
          'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
        }
      ),
      videos: Videos6.new(
        options: [
          'options9'
        ],
        total: 7252,
        uri: '/groups/1108/videos',
        additional_properties: {
          'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
        }
      ),
      additional_properties: {
        'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
      }
    ),
    interactions: Interactions5.new(
      join: Join.new(
        added: true,
        added_time: 'added_time4',
        title: 'Vimeo Staff',
        type: Type8::MEMBER,
        uri: '/users/152184/groups/1108',
        additional_properties: {
          'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
        }
      ),
      additional_properties: {
        'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
      }
    ),
    additional_properties: {
      'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
    }
  ),
  modified_time: '2018-09-16T15:41:45+00:00',
  name: 'Vimeo Weekend Challenge',
  pictures: Picture.new(
    active: true,
    base_link: 'https://i.vimeocdn.com/video/1130929417-276se668248611ce41e6f7d438196e3412863bad9a5c3bcaf1a14453454cc5-d',
    default_picture: false,
    resource_key: 'dc724af18fbdd4e59189f5fe768a5f8311527050',
    sizes: [
      Size.new(
        height: 720,
        link: 'https://i.vimeocdn.com/video/581495283_1280x720?r=pad&subrect=0,12,21,22&r=cover',
        width: 1280,
        link_with_play_button: 'https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F581495283_1280x720&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png',
        additional_properties: {
          'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
        }
      )
    ],
    type: Type::CAUTION,
    uri: '/users/152184/pictures/12345',
    link: 'link2',
    additional_properties: {
      'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
    }
  ),
  privacy: Privacy4.new(
    comment: Comment2::ALL,
    invite: Invite2::ALL,
    join: Join1::ANYBODY,
    videos: Videos7::ALL,
    view: View5::ANYBODY,
    additional_properties: {
      'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
    }
  ),
  resource_key: 'dc724af18fbdd4e59189f5fe768a5f8311527050',
  uri: '/groups/1108',
  user: User.new(
    age_verification_status: AgeVerificationStatus::PENDING,
    available_for_hire: false,
    can_work_remotely: false,
    clients: 'clients8',
    created_time: 'created_time0',
    is_expert: false,
    is_staff_picked: false,
    link: 'link0',
    max_team_members: 30.22,
    membership: Membership.new(
      display: Display::BASIC,
      subscription: Subscription3.new(
        billing: Billing.new(
          status: Status::ON_HOLD,
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        renewal: Renewal.new(
          display_date: 'display_date2',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        trial: Trial.new(
          has_been_in_free_trial: false,
          is_reverse_free_trial: false,
          status: 'status6',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        additional_properties: {
          'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
        }
      ),
      type: Type2::FREE,
      additional_properties: {
        'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
      }
    ),
    metadata: Metadata3.new(
      connections: Connections3.new(
        albums: Albums.new(
          options: [
            'options3',
            'options4',
            'options5'
          ],
          total: 123.82,
          uri: 'uri2',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        appearances: Appearances.new(
          options: [
            'options5'
          ],
          total: 23.88,
          uri: 'uri2',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        categories: Categories.new(
          options: [
            'options5',
            'options6'
          ],
          total: 3.62,
          uri: 'uri2',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        channels: Channels1.new(
          options: [
            'options7'
          ],
          total: 1.4,
          uri: 'uri4',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        feed: Feed.new(
          options: [
            'options9'
          ],
          uri: 'uri8',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        folders_root: FoldersRoot.new(
          options: [
            'options3'
          ],
          uri: 'uri0',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        followers: Followers.new(
          options: [
            'options5',
            'options4',
            'options3'
          ],
          total: 116.02,
          uri: 'uri2',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        following: Following.new(
          options: [
            'options3',
            'options4'
          ],
          total: 40.32,
          uri: 'uri2',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        groups: Groups1.new(
          options: [
            'options3',
            'options4'
          ],
          total: 194.86,
          uri: 'uri0',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        likes: Likes.new(
          options: [
            'options1'
          ],
          total: 198.54,
          uri: 'uri8',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        moderated_channels: ModeratedChannels.new(
          options: [
            'options9',
            'options8'
          ],
          total: 128.06,
          uri: 'uri8',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        ms_teams_team_folder_id: MsTeamsTeamFolderId.new(
          options: [
            'options5',
            'options6',
            'options7'
          ],
          uri: 'uri2',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        ms_teams_tenant_token_id: 'ms_teams_tenant_token_id2',
        pictures: Pictures.new(
          options: [
            'options1',
            'options0'
          ],
          total: 187.58,
          uri: 'uri6',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        portfolios: Portfolios.new(
          options: [
            'options3',
            'options4'
          ],
          total: 50.82,
          uri: 'uri2',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        projects: Projects.new(
          options: [
            'options9'
          ],
          total: 96.12,
          uri: 'uri6',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        shared: Shared.new(
          options: [
            'options5'
          ],
          total: 6.98,
          uri: 'uri2',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        videos: Videos3.new(
          options: [
            'options9'
          ],
          total: 239.7,
          uri: 'uri4',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        watchlater: Watchlater.new(
          options: [
            'options9',
            'options0'
          ],
          total: 99.22,
          uri: 'uri6',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        block: Block.new(
          options: [
            'options9'
          ],
          total: 31.02,
          uri: 'uri6',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        connected_apps: ConnectedApps.new(
          options: [
            'options3'
          ],
          total: 52.14,
          uri: 'uri0',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        import_apps: ImportApps.new(
          options: [
            'options9'
          ],
          total: 55.28,
          uri: 'uri6',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        lead_capture_form: LeadCaptureForm.new(
          options: [
            'options7'
          ],
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        recommended_channels: RecommendedChannels.new(
          options: [
            'options1',
            'options2'
          ],
          total: 210.04,
          uri: 'uri8',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        additional_properties: {
          'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
        }
      ),
      interactions: Interactions2.new(
        block: Block1.new(
          added: false,
          options: [
            'options9'
          ],
          uri: 'uri6',
          added_time: 'added_time4',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        report: Report.new(
          options: [
            'options1'
          ],
          reason: [
            'reason8'
          ],
          uri: 'uri8',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        add_privacy_user: AddPrivacyUser.new(
          options: [
            'options7',
            'options8'
          ],
          uri: 'uri4',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        connected_apps: ConnectedApps1.new(
          all_scopes: { 'key1' => 'val1', 'key2' => 'val2' },
          is_connected: false,
          needed_scopes: { 'key1' => 'val1', 'key2' => 'val2' },
          options: [
            'options3'
          ],
          uri: 'uri0',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        follow: Follow2.new(
          added: false,
          options: [
            'options1',
            'options2'
          ],
          uri: 'uri4',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        additional_properties: {
          'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
        }
      ),
      ms_teams_encrypted_team_id: 'ms_teams_encrypted_team_id4',
      public_videos: PublicVideos.new(
        total: 190.54,
        additional_properties: {
          'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
        }
      ),
      additional_properties: {
        'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
      }
    ),
    name: 'name0',
    pictures: Picture.new(
      active: false,
      base_link: 'base_link8',
      default_picture: false,
      resource_key: 'resource_key2',
      sizes: [
        Size.new(
          height: 222.16,
          link: 'link0',
          width: 211.96,
          link_with_play_button: 'link_with_play_button2',
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        )
      ],
      type: Type::CAUTION,
      uri: 'uri6',
      link: 'link2',
      additional_properties: {
        'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
      }
    ),
    preferences: Preferences.new(
      videos: Videos4.new(
        auto_generate_review_link: false,
        autocc_display_enabled_by_default: false,
        hide_stats: false,
        keep_source_files: false,
        license: License::BYNC,
        rating: Rating::UNRATED,
        sharing_link_default_expiry_days: 83.38,
        embed_preset_uri: 'embed_preset_uri6',
        page_preset_uri: 'page_preset_uri6',
        password: 'password4',
        privacy: Privacy1.new(
          add: false,
          allow_share_link: false,
          clip_embed_allowed_domains: [
            'clip_embed_allowed_domains2',
            'clip_embed_allowed_domains3'
          ],
          comments: Comments::ANYBODY,
          download: false,
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        additional_properties: {
          'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
        }
      ),
      additional_properties: {
        'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
      }
    ),
    profile_discovery: false,
    requires_age_verification: false,
    resource_key: 'resource_key0',
    upload_quota: UploadQuota.new(
      lifetime: Lifetime.new(
        free: 41.94,
        max: 54.84,
        unit: Unit::VIDEO_COUNT,
        used: 37.74,
        additional_properties: {
          'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
        }
      ),
      periodic: Periodic.new(
        free: 234.32,
        max: 8.78,
        period: Period3::LIFETIME,
        reset_date: 'reset_date8',
        unit: Unit::VIDEO_COUNT,
        used: 101.36,
        additional_properties: {
          'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
        }
      ),
      recently_deleted_disk_space: 87.9,
      restricted: Restricted.new(
        free: 234.92,
        max: 247.82,
        unit: 'unit0',
        used: 155.24,
        additional_properties: {
          'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
        }
      ),
      space: Space.new(
        free: 162.1,
        max: 175,
        showing: Showing::LIFETIME,
        unit: Unit::VIDEO_COUNT,
        used: 82.42,
        additional_properties: {
          'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
        }
      ),
      additional_properties: {
        'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
      }
    ),
    uri: 'uri4',
    websites: [
      Website.new(
        link: 'link6',
        type: 'type4',
        uri: 'uri0',
        description: 'description6',
        name: 'name6',
        additional_properties: {
          'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
        }
      ),
      Website.new(
        link: 'link6',
        type: 'type4',
        uri: 'uri0',
        description: 'description6',
        name: 'name6',
        additional_properties: {
          'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
        }
      ),
      Website.new(
        link: 'link6',
        type: 'type4',
        uri: 'uri0',
        description: 'description6',
        name: 'name6',
        additional_properties: {
          'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
        }
      )
    ],
    account_dictionary_quota: AccountDictionaryQuota.new(
      glossary_terms: GlossaryTerms.new(
        limit: 34.4,
        used: 100.96,
        additional_properties: {
          'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
        }
      ),
      language_replacement_terms: LanguageReplacementTerms.new(
        limit: 239.44,
        used: 151.92,
        additional_properties: {
          'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
        }
      ),
      additional_properties: {
        'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
      }
    ),
    ai_credits_quota: AiCreditsQuota.new(
      available: 139.08,
      balances: [
        Balance.new(
          expiration_date: 'expiration_date6',
          remaining: 145.72,
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        ),
        Balance.new(
          expiration_date: 'expiration_date6',
          remaining: 145.72,
          additional_properties: {
            'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
          }
        )
      ],
      period: Period::LIFETIME,
      remaining: 148.96,
      reset_date: 'reset_date4',
      additional_properties: {
        'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
      }
    ),
    bandwidth: Bandwidth.new(
      period: Period1::CALENDAR_MONTH,
      additional_properties: {
        'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
      }
    ),
    bio: 'bio2',
    capabilities: { 'key1' => 'val1', 'key2' => 'val2' },
    additional_properties: {
      'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
    }
  ),
  additional_properties: {
    'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
  }
)