Class: Trello::Organization

Inherits:
BasicData show all
Includes:
HasActions
Defined in:
lib/trello/organization.rb

Overview

Organizations are useful for linking members together.

Instance Attribute Summary collapse

Attributes inherited from BasicData

#client

Class Method Summary collapse

Instance Method Summary collapse

Methods included from HasActions

#actions

Methods inherited from BasicData

#==, #attributes, client, #collection_name, #collection_path, create, #element_name, #element_path, #hash, #initialize, many, one, parse, parse_many, path_name, #refresh!, register_attrs, #save, save, schema, #schema, #update!, #update_fields

Methods included from JsonUtils

included

Constructor Details

This class inherits a constructor from Trello::BasicData

Instance Attribute Details

#desc_data ⇒ String (readonly)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trello/organization.rb', line 40

class Organization < BasicData
  schema do
    # Readonly
    attribute :id, readonly: true, primary_key: true
    attribute :team_type, readonly: true, remote_key: 'teamType'
    attribute :url, readonly: true
    attribute :desc_data, readonly: true, remote_key: 'descData'
    attribute :logo_hash, readonly: true, remote_key: 'logoHash'
    attribute :logo_url, readonly: true, remote_key: 'logoUrl'
    attribute :products, readonly: true
    attribute :power_ups, readonly: true, remote_key: 'powerUps'

    # Writable
    attribute :name
    attribute :display_name, remote_key: 'displayName'
    attribute :description, remote_key: 'desc'
    attribute :website

    # Writable but update only
    attribute :google_app_domain, update_only: true, remote_key: 'associatedDomain', class_name: 'BoardPref'
    attribute :google_app_version, update_only: true, remote_key: 'googleAppsVersion ', class_name: 'BoardPref'
    attribute :enable_add_external_members, update_only: true, remote_key: 'externalMembersDisabled', class_name: 'BoardPref'
    attribute :private_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/private', class_name: 'BoardPref'
    attribute :organization_visible_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/org', class_name: 'BoardPref'
    attribute :public_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/public', class_name: 'BoardPref'
    attribute :visibility_level, update_only: true, remote_key: 'permissionLevel ', class_name: 'BoardPref'
  end

  validates_presence_of :id, :name

  include HasActions

  class << self
    # Find an organization by its id.
    def find(id, params = {})
      client.find(:organization, id, params)
    end
  end

  # Returns a list of boards under this organization.
  def boards(params = {})
    boards = Board.from_response client.get("/organizations/#{id}/boards", params)
    MultiAssociation.new(self, boards).proxy
  end

  # Returns an array of members associated with the organization.
  def members(params = {})
    members = Member.from_response client.get("/organizations/#{id}/members/all", params)
    MultiAssociation.new(self, members).proxy
  end

  # :nodoc:
  def request_prefix
    "/organizations/#{id}"
  end
end

#description ⇒ String (readonly)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trello/organization.rb', line 40

class Organization < BasicData
  schema do
    # Readonly
    attribute :id, readonly: true, primary_key: true
    attribute :team_type, readonly: true, remote_key: 'teamType'
    attribute :url, readonly: true
    attribute :desc_data, readonly: true, remote_key: 'descData'
    attribute :logo_hash, readonly: true, remote_key: 'logoHash'
    attribute :logo_url, readonly: true, remote_key: 'logoUrl'
    attribute :products, readonly: true
    attribute :power_ups, readonly: true, remote_key: 'powerUps'

    # Writable
    attribute :name
    attribute :display_name, remote_key: 'displayName'
    attribute :description, remote_key: 'desc'
    attribute :website

    # Writable but update only
    attribute :google_app_domain, update_only: true, remote_key: 'associatedDomain', class_name: 'BoardPref'
    attribute :google_app_version, update_only: true, remote_key: 'googleAppsVersion ', class_name: 'BoardPref'
    attribute :enable_add_external_members, update_only: true, remote_key: 'externalMembersDisabled', class_name: 'BoardPref'
    attribute :private_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/private', class_name: 'BoardPref'
    attribute :organization_visible_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/org', class_name: 'BoardPref'
    attribute :public_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/public', class_name: 'BoardPref'
    attribute :visibility_level, update_only: true, remote_key: 'permissionLevel ', class_name: 'BoardPref'
  end

  validates_presence_of :id, :name

  include HasActions

  class << self
    # Find an organization by its id.
    def find(id, params = {})
      client.find(:organization, id, params)
    end
  end

  # Returns a list of boards under this organization.
  def boards(params = {})
    boards = Board.from_response client.get("/organizations/#{id}/boards", params)
    MultiAssociation.new(self, boards).proxy
  end

  # Returns an array of members associated with the organization.
  def members(params = {})
    members = Member.from_response client.get("/organizations/#{id}/members/all", params)
    MultiAssociation.new(self, members).proxy
  end

  # :nodoc:
  def request_prefix
    "/organizations/#{id}"
  end
end

#display_name ⇒ String (readonly)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trello/organization.rb', line 40

class Organization < BasicData
  schema do
    # Readonly
    attribute :id, readonly: true, primary_key: true
    attribute :team_type, readonly: true, remote_key: 'teamType'
    attribute :url, readonly: true
    attribute :desc_data, readonly: true, remote_key: 'descData'
    attribute :logo_hash, readonly: true, remote_key: 'logoHash'
    attribute :logo_url, readonly: true, remote_key: 'logoUrl'
    attribute :products, readonly: true
    attribute :power_ups, readonly: true, remote_key: 'powerUps'

    # Writable
    attribute :name
    attribute :display_name, remote_key: 'displayName'
    attribute :description, remote_key: 'desc'
    attribute :website

    # Writable but update only
    attribute :google_app_domain, update_only: true, remote_key: 'associatedDomain', class_name: 'BoardPref'
    attribute :google_app_version, update_only: true, remote_key: 'googleAppsVersion ', class_name: 'BoardPref'
    attribute :enable_add_external_members, update_only: true, remote_key: 'externalMembersDisabled', class_name: 'BoardPref'
    attribute :private_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/private', class_name: 'BoardPref'
    attribute :organization_visible_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/org', class_name: 'BoardPref'
    attribute :public_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/public', class_name: 'BoardPref'
    attribute :visibility_level, update_only: true, remote_key: 'permissionLevel ', class_name: 'BoardPref'
  end

  validates_presence_of :id, :name

  include HasActions

  class << self
    # Find an organization by its id.
    def find(id, params = {})
      client.find(:organization, id, params)
    end
  end

  # Returns a list of boards under this organization.
  def boards(params = {})
    boards = Board.from_response client.get("/organizations/#{id}/boards", params)
    MultiAssociation.new(self, boards).proxy
  end

  # Returns an array of members associated with the organization.
  def members(params = {})
    members = Member.from_response client.get("/organizations/#{id}/members/all", params)
    MultiAssociation.new(self, members).proxy
  end

  # :nodoc:
  def request_prefix
    "/organizations/#{id}"
  end
end

#enable_add_external_members=(value) ⇒ Boolean (writeonly)

Returns:

  • (Boolean) 


40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trello/organization.rb', line 40

class Organization < BasicData
  schema do
    # Readonly
    attribute :id, readonly: true, primary_key: true
    attribute :team_type, readonly: true, remote_key: 'teamType'
    attribute :url, readonly: true
    attribute :desc_data, readonly: true, remote_key: 'descData'
    attribute :logo_hash, readonly: true, remote_key: 'logoHash'
    attribute :logo_url, readonly: true, remote_key: 'logoUrl'
    attribute :products, readonly: true
    attribute :power_ups, readonly: true, remote_key: 'powerUps'

    # Writable
    attribute :name
    attribute :display_name, remote_key: 'displayName'
    attribute :description, remote_key: 'desc'
    attribute :website

    # Writable but update only
    attribute :google_app_domain, update_only: true, remote_key: 'associatedDomain', class_name: 'BoardPref'
    attribute :google_app_version, update_only: true, remote_key: 'googleAppsVersion ', class_name: 'BoardPref'
    attribute :enable_add_external_members, update_only: true, remote_key: 'externalMembersDisabled', class_name: 'BoardPref'
    attribute :private_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/private', class_name: 'BoardPref'
    attribute :organization_visible_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/org', class_name: 'BoardPref'
    attribute :public_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/public', class_name: 'BoardPref'
    attribute :visibility_level, update_only: true, remote_key: 'permissionLevel ', class_name: 'BoardPref'
  end

  validates_presence_of :id, :name

  include HasActions

  class << self
    # Find an organization by its id.
    def find(id, params = {})
      client.find(:organization, id, params)
    end
  end

  # Returns a list of boards under this organization.
  def boards(params = {})
    boards = Board.from_response client.get("/organizations/#{id}/boards", params)
    MultiAssociation.new(self, boards).proxy
  end

  # Returns an array of members associated with the organization.
  def members(params = {})
    members = Member.from_response client.get("/organizations/#{id}/members/all", params)
    MultiAssociation.new(self, members).proxy
  end

  # :nodoc:
  def request_prefix
    "/organizations/#{id}"
  end
end

#google_app_domain=(value) ⇒ String (writeonly)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trello/organization.rb', line 40

class Organization < BasicData
  schema do
    # Readonly
    attribute :id, readonly: true, primary_key: true
    attribute :team_type, readonly: true, remote_key: 'teamType'
    attribute :url, readonly: true
    attribute :desc_data, readonly: true, remote_key: 'descData'
    attribute :logo_hash, readonly: true, remote_key: 'logoHash'
    attribute :logo_url, readonly: true, remote_key: 'logoUrl'
    attribute :products, readonly: true
    attribute :power_ups, readonly: true, remote_key: 'powerUps'

    # Writable
    attribute :name
    attribute :display_name, remote_key: 'displayName'
    attribute :description, remote_key: 'desc'
    attribute :website

    # Writable but update only
    attribute :google_app_domain, update_only: true, remote_key: 'associatedDomain', class_name: 'BoardPref'
    attribute :google_app_version, update_only: true, remote_key: 'googleAppsVersion ', class_name: 'BoardPref'
    attribute :enable_add_external_members, update_only: true, remote_key: 'externalMembersDisabled', class_name: 'BoardPref'
    attribute :private_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/private', class_name: 'BoardPref'
    attribute :organization_visible_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/org', class_name: 'BoardPref'
    attribute :public_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/public', class_name: 'BoardPref'
    attribute :visibility_level, update_only: true, remote_key: 'permissionLevel ', class_name: 'BoardPref'
  end

  validates_presence_of :id, :name

  include HasActions

  class << self
    # Find an organization by its id.
    def find(id, params = {})
      client.find(:organization, id, params)
    end
  end

  # Returns a list of boards under this organization.
  def boards(params = {})
    boards = Board.from_response client.get("/organizations/#{id}/boards", params)
    MultiAssociation.new(self, boards).proxy
  end

  # Returns an array of members associated with the organization.
  def members(params = {})
    members = Member.from_response client.get("/organizations/#{id}/members/all", params)
    MultiAssociation.new(self, members).proxy
  end

  # :nodoc:
  def request_prefix
    "/organizations/#{id}"
  end
end

#google_app_version=(value) ⇒ String (writeonly)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trello/organization.rb', line 40

class Organization < BasicData
  schema do
    # Readonly
    attribute :id, readonly: true, primary_key: true
    attribute :team_type, readonly: true, remote_key: 'teamType'
    attribute :url, readonly: true
    attribute :desc_data, readonly: true, remote_key: 'descData'
    attribute :logo_hash, readonly: true, remote_key: 'logoHash'
    attribute :logo_url, readonly: true, remote_key: 'logoUrl'
    attribute :products, readonly: true
    attribute :power_ups, readonly: true, remote_key: 'powerUps'

    # Writable
    attribute :name
    attribute :display_name, remote_key: 'displayName'
    attribute :description, remote_key: 'desc'
    attribute :website

    # Writable but update only
    attribute :google_app_domain, update_only: true, remote_key: 'associatedDomain', class_name: 'BoardPref'
    attribute :google_app_version, update_only: true, remote_key: 'googleAppsVersion ', class_name: 'BoardPref'
    attribute :enable_add_external_members, update_only: true, remote_key: 'externalMembersDisabled', class_name: 'BoardPref'
    attribute :private_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/private', class_name: 'BoardPref'
    attribute :organization_visible_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/org', class_name: 'BoardPref'
    attribute :public_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/public', class_name: 'BoardPref'
    attribute :visibility_level, update_only: true, remote_key: 'permissionLevel ', class_name: 'BoardPref'
  end

  validates_presence_of :id, :name

  include HasActions

  class << self
    # Find an organization by its id.
    def find(id, params = {})
      client.find(:organization, id, params)
    end
  end

  # Returns a list of boards under this organization.
  def boards(params = {})
    boards = Board.from_response client.get("/organizations/#{id}/boards", params)
    MultiAssociation.new(self, boards).proxy
  end

  # Returns an array of members associated with the organization.
  def members(params = {})
    members = Member.from_response client.get("/organizations/#{id}/members/all", params)
    MultiAssociation.new(self, members).proxy
  end

  # :nodoc:
  def request_prefix
    "/organizations/#{id}"
  end
end

#id ⇒ String (readonly)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trello/organization.rb', line 40

class Organization < BasicData
  schema do
    # Readonly
    attribute :id, readonly: true, primary_key: true
    attribute :team_type, readonly: true, remote_key: 'teamType'
    attribute :url, readonly: true
    attribute :desc_data, readonly: true, remote_key: 'descData'
    attribute :logo_hash, readonly: true, remote_key: 'logoHash'
    attribute :logo_url, readonly: true, remote_key: 'logoUrl'
    attribute :products, readonly: true
    attribute :power_ups, readonly: true, remote_key: 'powerUps'

    # Writable
    attribute :name
    attribute :display_name, remote_key: 'displayName'
    attribute :description, remote_key: 'desc'
    attribute :website

    # Writable but update only
    attribute :google_app_domain, update_only: true, remote_key: 'associatedDomain', class_name: 'BoardPref'
    attribute :google_app_version, update_only: true, remote_key: 'googleAppsVersion ', class_name: 'BoardPref'
    attribute :enable_add_external_members, update_only: true, remote_key: 'externalMembersDisabled', class_name: 'BoardPref'
    attribute :private_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/private', class_name: 'BoardPref'
    attribute :organization_visible_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/org', class_name: 'BoardPref'
    attribute :public_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/public', class_name: 'BoardPref'
    attribute :visibility_level, update_only: true, remote_key: 'permissionLevel ', class_name: 'BoardPref'
  end

  validates_presence_of :id, :name

  include HasActions

  class << self
    # Find an organization by its id.
    def find(id, params = {})
      client.find(:organization, id, params)
    end
  end

  # Returns a list of boards under this organization.
  def boards(params = {})
    boards = Board.from_response client.get("/organizations/#{id}/boards", params)
    MultiAssociation.new(self, boards).proxy
  end

  # Returns an array of members associated with the organization.
  def members(params = {})
    members = Member.from_response client.get("/organizations/#{id}/members/all", params)
    MultiAssociation.new(self, members).proxy
  end

  # :nodoc:
  def request_prefix
    "/organizations/#{id}"
  end
end

#logo_hash ⇒ String (readonly)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trello/organization.rb', line 40

class Organization < BasicData
  schema do
    # Readonly
    attribute :id, readonly: true, primary_key: true
    attribute :team_type, readonly: true, remote_key: 'teamType'
    attribute :url, readonly: true
    attribute :desc_data, readonly: true, remote_key: 'descData'
    attribute :logo_hash, readonly: true, remote_key: 'logoHash'
    attribute :logo_url, readonly: true, remote_key: 'logoUrl'
    attribute :products, readonly: true
    attribute :power_ups, readonly: true, remote_key: 'powerUps'

    # Writable
    attribute :name
    attribute :display_name, remote_key: 'displayName'
    attribute :description, remote_key: 'desc'
    attribute :website

    # Writable but update only
    attribute :google_app_domain, update_only: true, remote_key: 'associatedDomain', class_name: 'BoardPref'
    attribute :google_app_version, update_only: true, remote_key: 'googleAppsVersion ', class_name: 'BoardPref'
    attribute :enable_add_external_members, update_only: true, remote_key: 'externalMembersDisabled', class_name: 'BoardPref'
    attribute :private_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/private', class_name: 'BoardPref'
    attribute :organization_visible_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/org', class_name: 'BoardPref'
    attribute :public_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/public', class_name: 'BoardPref'
    attribute :visibility_level, update_only: true, remote_key: 'permissionLevel ', class_name: 'BoardPref'
  end

  validates_presence_of :id, :name

  include HasActions

  class << self
    # Find an organization by its id.
    def find(id, params = {})
      client.find(:organization, id, params)
    end
  end

  # Returns a list of boards under this organization.
  def boards(params = {})
    boards = Board.from_response client.get("/organizations/#{id}/boards", params)
    MultiAssociation.new(self, boards).proxy
  end

  # Returns an array of members associated with the organization.
  def members(params = {})
    members = Member.from_response client.get("/organizations/#{id}/members/all", params)
    MultiAssociation.new(self, members).proxy
  end

  # :nodoc:
  def request_prefix
    "/organizations/#{id}"
  end
end

#logo_url ⇒ String (readonly)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trello/organization.rb', line 40

class Organization < BasicData
  schema do
    # Readonly
    attribute :id, readonly: true, primary_key: true
    attribute :team_type, readonly: true, remote_key: 'teamType'
    attribute :url, readonly: true
    attribute :desc_data, readonly: true, remote_key: 'descData'
    attribute :logo_hash, readonly: true, remote_key: 'logoHash'
    attribute :logo_url, readonly: true, remote_key: 'logoUrl'
    attribute :products, readonly: true
    attribute :power_ups, readonly: true, remote_key: 'powerUps'

    # Writable
    attribute :name
    attribute :display_name, remote_key: 'displayName'
    attribute :description, remote_key: 'desc'
    attribute :website

    # Writable but update only
    attribute :google_app_domain, update_only: true, remote_key: 'associatedDomain', class_name: 'BoardPref'
    attribute :google_app_version, update_only: true, remote_key: 'googleAppsVersion ', class_name: 'BoardPref'
    attribute :enable_add_external_members, update_only: true, remote_key: 'externalMembersDisabled', class_name: 'BoardPref'
    attribute :private_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/private', class_name: 'BoardPref'
    attribute :organization_visible_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/org', class_name: 'BoardPref'
    attribute :public_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/public', class_name: 'BoardPref'
    attribute :visibility_level, update_only: true, remote_key: 'permissionLevel ', class_name: 'BoardPref'
  end

  validates_presence_of :id, :name

  include HasActions

  class << self
    # Find an organization by its id.
    def find(id, params = {})
      client.find(:organization, id, params)
    end
  end

  # Returns a list of boards under this organization.
  def boards(params = {})
    boards = Board.from_response client.get("/organizations/#{id}/boards", params)
    MultiAssociation.new(self, boards).proxy
  end

  # Returns an array of members associated with the organization.
  def members(params = {})
    members = Member.from_response client.get("/organizations/#{id}/members/all", params)
    MultiAssociation.new(self, members).proxy
  end

  # :nodoc:
  def request_prefix
    "/organizations/#{id}"
  end
end

#name ⇒ String (readonly)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trello/organization.rb', line 40

class Organization < BasicData
  schema do
    # Readonly
    attribute :id, readonly: true, primary_key: true
    attribute :team_type, readonly: true, remote_key: 'teamType'
    attribute :url, readonly: true
    attribute :desc_data, readonly: true, remote_key: 'descData'
    attribute :logo_hash, readonly: true, remote_key: 'logoHash'
    attribute :logo_url, readonly: true, remote_key: 'logoUrl'
    attribute :products, readonly: true
    attribute :power_ups, readonly: true, remote_key: 'powerUps'

    # Writable
    attribute :name
    attribute :display_name, remote_key: 'displayName'
    attribute :description, remote_key: 'desc'
    attribute :website

    # Writable but update only
    attribute :google_app_domain, update_only: true, remote_key: 'associatedDomain', class_name: 'BoardPref'
    attribute :google_app_version, update_only: true, remote_key: 'googleAppsVersion ', class_name: 'BoardPref'
    attribute :enable_add_external_members, update_only: true, remote_key: 'externalMembersDisabled', class_name: 'BoardPref'
    attribute :private_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/private', class_name: 'BoardPref'
    attribute :organization_visible_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/org', class_name: 'BoardPref'
    attribute :public_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/public', class_name: 'BoardPref'
    attribute :visibility_level, update_only: true, remote_key: 'permissionLevel ', class_name: 'BoardPref'
  end

  validates_presence_of :id, :name

  include HasActions

  class << self
    # Find an organization by its id.
    def find(id, params = {})
      client.find(:organization, id, params)
    end
  end

  # Returns a list of boards under this organization.
  def boards(params = {})
    boards = Board.from_response client.get("/organizations/#{id}/boards", params)
    MultiAssociation.new(self, boards).proxy
  end

  # Returns an array of members associated with the organization.
  def members(params = {})
    members = Member.from_response client.get("/organizations/#{id}/members/all", params)
    MultiAssociation.new(self, members).proxy
  end

  # :nodoc:
  def request_prefix
    "/organizations/#{id}"
  end
end

#organization_visible_board_creation_permission_level=(value) ⇒ String (writeonly)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trello/organization.rb', line 40

class Organization < BasicData
  schema do
    # Readonly
    attribute :id, readonly: true, primary_key: true
    attribute :team_type, readonly: true, remote_key: 'teamType'
    attribute :url, readonly: true
    attribute :desc_data, readonly: true, remote_key: 'descData'
    attribute :logo_hash, readonly: true, remote_key: 'logoHash'
    attribute :logo_url, readonly: true, remote_key: 'logoUrl'
    attribute :products, readonly: true
    attribute :power_ups, readonly: true, remote_key: 'powerUps'

    # Writable
    attribute :name
    attribute :display_name, remote_key: 'displayName'
    attribute :description, remote_key: 'desc'
    attribute :website

    # Writable but update only
    attribute :google_app_domain, update_only: true, remote_key: 'associatedDomain', class_name: 'BoardPref'
    attribute :google_app_version, update_only: true, remote_key: 'googleAppsVersion ', class_name: 'BoardPref'
    attribute :enable_add_external_members, update_only: true, remote_key: 'externalMembersDisabled', class_name: 'BoardPref'
    attribute :private_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/private', class_name: 'BoardPref'
    attribute :organization_visible_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/org', class_name: 'BoardPref'
    attribute :public_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/public', class_name: 'BoardPref'
    attribute :visibility_level, update_only: true, remote_key: 'permissionLevel ', class_name: 'BoardPref'
  end

  validates_presence_of :id, :name

  include HasActions

  class << self
    # Find an organization by its id.
    def find(id, params = {})
      client.find(:organization, id, params)
    end
  end

  # Returns a list of boards under this organization.
  def boards(params = {})
    boards = Board.from_response client.get("/organizations/#{id}/boards", params)
    MultiAssociation.new(self, boards).proxy
  end

  # Returns an array of members associated with the organization.
  def members(params = {})
    members = Member.from_response client.get("/organizations/#{id}/members/all", params)
    MultiAssociation.new(self, members).proxy
  end

  # :nodoc:
  def request_prefix
    "/organizations/#{id}"
  end
end

#power_ups ⇒ Array (readonly)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trello/organization.rb', line 40

class Organization < BasicData
  schema do
    # Readonly
    attribute :id, readonly: true, primary_key: true
    attribute :team_type, readonly: true, remote_key: 'teamType'
    attribute :url, readonly: true
    attribute :desc_data, readonly: true, remote_key: 'descData'
    attribute :logo_hash, readonly: true, remote_key: 'logoHash'
    attribute :logo_url, readonly: true, remote_key: 'logoUrl'
    attribute :products, readonly: true
    attribute :power_ups, readonly: true, remote_key: 'powerUps'

    # Writable
    attribute :name
    attribute :display_name, remote_key: 'displayName'
    attribute :description, remote_key: 'desc'
    attribute :website

    # Writable but update only
    attribute :google_app_domain, update_only: true, remote_key: 'associatedDomain', class_name: 'BoardPref'
    attribute :google_app_version, update_only: true, remote_key: 'googleAppsVersion ', class_name: 'BoardPref'
    attribute :enable_add_external_members, update_only: true, remote_key: 'externalMembersDisabled', class_name: 'BoardPref'
    attribute :private_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/private', class_name: 'BoardPref'
    attribute :organization_visible_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/org', class_name: 'BoardPref'
    attribute :public_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/public', class_name: 'BoardPref'
    attribute :visibility_level, update_only: true, remote_key: 'permissionLevel ', class_name: 'BoardPref'
  end

  validates_presence_of :id, :name

  include HasActions

  class << self
    # Find an organization by its id.
    def find(id, params = {})
      client.find(:organization, id, params)
    end
  end

  # Returns a list of boards under this organization.
  def boards(params = {})
    boards = Board.from_response client.get("/organizations/#{id}/boards", params)
    MultiAssociation.new(self, boards).proxy
  end

  # Returns an array of members associated with the organization.
  def members(params = {})
    members = Member.from_response client.get("/organizations/#{id}/members/all", params)
    MultiAssociation.new(self, members).proxy
  end

  # :nodoc:
  def request_prefix
    "/organizations/#{id}"
  end
end

#private_board_creation_permission_level=(value) ⇒ String (writeonly)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trello/organization.rb', line 40

class Organization < BasicData
  schema do
    # Readonly
    attribute :id, readonly: true, primary_key: true
    attribute :team_type, readonly: true, remote_key: 'teamType'
    attribute :url, readonly: true
    attribute :desc_data, readonly: true, remote_key: 'descData'
    attribute :logo_hash, readonly: true, remote_key: 'logoHash'
    attribute :logo_url, readonly: true, remote_key: 'logoUrl'
    attribute :products, readonly: true
    attribute :power_ups, readonly: true, remote_key: 'powerUps'

    # Writable
    attribute :name
    attribute :display_name, remote_key: 'displayName'
    attribute :description, remote_key: 'desc'
    attribute :website

    # Writable but update only
    attribute :google_app_domain, update_only: true, remote_key: 'associatedDomain', class_name: 'BoardPref'
    attribute :google_app_version, update_only: true, remote_key: 'googleAppsVersion ', class_name: 'BoardPref'
    attribute :enable_add_external_members, update_only: true, remote_key: 'externalMembersDisabled', class_name: 'BoardPref'
    attribute :private_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/private', class_name: 'BoardPref'
    attribute :organization_visible_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/org', class_name: 'BoardPref'
    attribute :public_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/public', class_name: 'BoardPref'
    attribute :visibility_level, update_only: true, remote_key: 'permissionLevel ', class_name: 'BoardPref'
  end

  validates_presence_of :id, :name

  include HasActions

  class << self
    # Find an organization by its id.
    def find(id, params = {})
      client.find(:organization, id, params)
    end
  end

  # Returns a list of boards under this organization.
  def boards(params = {})
    boards = Board.from_response client.get("/organizations/#{id}/boards", params)
    MultiAssociation.new(self, boards).proxy
  end

  # Returns an array of members associated with the organization.
  def members(params = {})
    members = Member.from_response client.get("/organizations/#{id}/members/all", params)
    MultiAssociation.new(self, members).proxy
  end

  # :nodoc:
  def request_prefix
    "/organizations/#{id}"
  end
end

#public_board_creation_permission_level=(value) ⇒ String (writeonly)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trello/organization.rb', line 40

class Organization < BasicData
  schema do
    # Readonly
    attribute :id, readonly: true, primary_key: true
    attribute :team_type, readonly: true, remote_key: 'teamType'
    attribute :url, readonly: true
    attribute :desc_data, readonly: true, remote_key: 'descData'
    attribute :logo_hash, readonly: true, remote_key: 'logoHash'
    attribute :logo_url, readonly: true, remote_key: 'logoUrl'
    attribute :products, readonly: true
    attribute :power_ups, readonly: true, remote_key: 'powerUps'

    # Writable
    attribute :name
    attribute :display_name, remote_key: 'displayName'
    attribute :description, remote_key: 'desc'
    attribute :website

    # Writable but update only
    attribute :google_app_domain, update_only: true, remote_key: 'associatedDomain', class_name: 'BoardPref'
    attribute :google_app_version, update_only: true, remote_key: 'googleAppsVersion ', class_name: 'BoardPref'
    attribute :enable_add_external_members, update_only: true, remote_key: 'externalMembersDisabled', class_name: 'BoardPref'
    attribute :private_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/private', class_name: 'BoardPref'
    attribute :organization_visible_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/org', class_name: 'BoardPref'
    attribute :public_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/public', class_name: 'BoardPref'
    attribute :visibility_level, update_only: true, remote_key: 'permissionLevel ', class_name: 'BoardPref'
  end

  validates_presence_of :id, :name

  include HasActions

  class << self
    # Find an organization by its id.
    def find(id, params = {})
      client.find(:organization, id, params)
    end
  end

  # Returns a list of boards under this organization.
  def boards(params = {})
    boards = Board.from_response client.get("/organizations/#{id}/boards", params)
    MultiAssociation.new(self, boards).proxy
  end

  # Returns an array of members associated with the organization.
  def members(params = {})
    members = Member.from_response client.get("/organizations/#{id}/members/all", params)
    MultiAssociation.new(self, members).proxy
  end

  # :nodoc:
  def request_prefix
    "/organizations/#{id}"
  end
end

#team_type ⇒ String (readonly)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trello/organization.rb', line 40

class Organization < BasicData
  schema do
    # Readonly
    attribute :id, readonly: true, primary_key: true
    attribute :team_type, readonly: true, remote_key: 'teamType'
    attribute :url, readonly: true
    attribute :desc_data, readonly: true, remote_key: 'descData'
    attribute :logo_hash, readonly: true, remote_key: 'logoHash'
    attribute :logo_url, readonly: true, remote_key: 'logoUrl'
    attribute :products, readonly: true
    attribute :power_ups, readonly: true, remote_key: 'powerUps'

    # Writable
    attribute :name
    attribute :display_name, remote_key: 'displayName'
    attribute :description, remote_key: 'desc'
    attribute :website

    # Writable but update only
    attribute :google_app_domain, update_only: true, remote_key: 'associatedDomain', class_name: 'BoardPref'
    attribute :google_app_version, update_only: true, remote_key: 'googleAppsVersion ', class_name: 'BoardPref'
    attribute :enable_add_external_members, update_only: true, remote_key: 'externalMembersDisabled', class_name: 'BoardPref'
    attribute :private_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/private', class_name: 'BoardPref'
    attribute :organization_visible_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/org', class_name: 'BoardPref'
    attribute :public_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/public', class_name: 'BoardPref'
    attribute :visibility_level, update_only: true, remote_key: 'permissionLevel ', class_name: 'BoardPref'
  end

  validates_presence_of :id, :name

  include HasActions

  class << self
    # Find an organization by its id.
    def find(id, params = {})
      client.find(:organization, id, params)
    end
  end

  # Returns a list of boards under this organization.
  def boards(params = {})
    boards = Board.from_response client.get("/organizations/#{id}/boards", params)
    MultiAssociation.new(self, boards).proxy
  end

  # Returns an array of members associated with the organization.
  def members(params = {})
    members = Member.from_response client.get("/organizations/#{id}/members/all", params)
    MultiAssociation.new(self, members).proxy
  end

  # :nodoc:
  def request_prefix
    "/organizations/#{id}"
  end
end

#url ⇒ String (readonly)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trello/organization.rb', line 40

class Organization < BasicData
  schema do
    # Readonly
    attribute :id, readonly: true, primary_key: true
    attribute :team_type, readonly: true, remote_key: 'teamType'
    attribute :url, readonly: true
    attribute :desc_data, readonly: true, remote_key: 'descData'
    attribute :logo_hash, readonly: true, remote_key: 'logoHash'
    attribute :logo_url, readonly: true, remote_key: 'logoUrl'
    attribute :products, readonly: true
    attribute :power_ups, readonly: true, remote_key: 'powerUps'

    # Writable
    attribute :name
    attribute :display_name, remote_key: 'displayName'
    attribute :description, remote_key: 'desc'
    attribute :website

    # Writable but update only
    attribute :google_app_domain, update_only: true, remote_key: 'associatedDomain', class_name: 'BoardPref'
    attribute :google_app_version, update_only: true, remote_key: 'googleAppsVersion ', class_name: 'BoardPref'
    attribute :enable_add_external_members, update_only: true, remote_key: 'externalMembersDisabled', class_name: 'BoardPref'
    attribute :private_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/private', class_name: 'BoardPref'
    attribute :organization_visible_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/org', class_name: 'BoardPref'
    attribute :public_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/public', class_name: 'BoardPref'
    attribute :visibility_level, update_only: true, remote_key: 'permissionLevel ', class_name: 'BoardPref'
  end

  validates_presence_of :id, :name

  include HasActions

  class << self
    # Find an organization by its id.
    def find(id, params = {})
      client.find(:organization, id, params)
    end
  end

  # Returns a list of boards under this organization.
  def boards(params = {})
    boards = Board.from_response client.get("/organizations/#{id}/boards", params)
    MultiAssociation.new(self, boards).proxy
  end

  # Returns an array of members associated with the organization.
  def members(params = {})
    members = Member.from_response client.get("/organizations/#{id}/members/all", params)
    MultiAssociation.new(self, members).proxy
  end

  # :nodoc:
  def request_prefix
    "/organizations/#{id}"
  end
end

#visibility_level=(value) ⇒ String (writeonly)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trello/organization.rb', line 40

class Organization < BasicData
  schema do
    # Readonly
    attribute :id, readonly: true, primary_key: true
    attribute :team_type, readonly: true, remote_key: 'teamType'
    attribute :url, readonly: true
    attribute :desc_data, readonly: true, remote_key: 'descData'
    attribute :logo_hash, readonly: true, remote_key: 'logoHash'
    attribute :logo_url, readonly: true, remote_key: 'logoUrl'
    attribute :products, readonly: true
    attribute :power_ups, readonly: true, remote_key: 'powerUps'

    # Writable
    attribute :name
    attribute :display_name, remote_key: 'displayName'
    attribute :description, remote_key: 'desc'
    attribute :website

    # Writable but update only
    attribute :google_app_domain, update_only: true, remote_key: 'associatedDomain', class_name: 'BoardPref'
    attribute :google_app_version, update_only: true, remote_key: 'googleAppsVersion ', class_name: 'BoardPref'
    attribute :enable_add_external_members, update_only: true, remote_key: 'externalMembersDisabled', class_name: 'BoardPref'
    attribute :private_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/private', class_name: 'BoardPref'
    attribute :organization_visible_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/org', class_name: 'BoardPref'
    attribute :public_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/public', class_name: 'BoardPref'
    attribute :visibility_level, update_only: true, remote_key: 'permissionLevel ', class_name: 'BoardPref'
  end

  validates_presence_of :id, :name

  include HasActions

  class << self
    # Find an organization by its id.
    def find(id, params = {})
      client.find(:organization, id, params)
    end
  end

  # Returns a list of boards under this organization.
  def boards(params = {})
    boards = Board.from_response client.get("/organizations/#{id}/boards", params)
    MultiAssociation.new(self, boards).proxy
  end

  # Returns an array of members associated with the organization.
  def members(params = {})
    members = Member.from_response client.get("/organizations/#{id}/members/all", params)
    MultiAssociation.new(self, members).proxy
  end

  # :nodoc:
  def request_prefix
    "/organizations/#{id}"
  end
end

#website ⇒ String (readonly)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trello/organization.rb', line 40

class Organization < BasicData
  schema do
    # Readonly
    attribute :id, readonly: true, primary_key: true
    attribute :team_type, readonly: true, remote_key: 'teamType'
    attribute :url, readonly: true
    attribute :desc_data, readonly: true, remote_key: 'descData'
    attribute :logo_hash, readonly: true, remote_key: 'logoHash'
    attribute :logo_url, readonly: true, remote_key: 'logoUrl'
    attribute :products, readonly: true
    attribute :power_ups, readonly: true, remote_key: 'powerUps'

    # Writable
    attribute :name
    attribute :display_name, remote_key: 'displayName'
    attribute :description, remote_key: 'desc'
    attribute :website

    # Writable but update only
    attribute :google_app_domain, update_only: true, remote_key: 'associatedDomain', class_name: 'BoardPref'
    attribute :google_app_version, update_only: true, remote_key: 'googleAppsVersion ', class_name: 'BoardPref'
    attribute :enable_add_external_members, update_only: true, remote_key: 'externalMembersDisabled', class_name: 'BoardPref'
    attribute :private_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/private', class_name: 'BoardPref'
    attribute :organization_visible_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/org', class_name: 'BoardPref'
    attribute :public_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/public', class_name: 'BoardPref'
    attribute :visibility_level, update_only: true, remote_key: 'permissionLevel ', class_name: 'BoardPref'
  end

  validates_presence_of :id, :name

  include HasActions

  class << self
    # Find an organization by its id.
    def find(id, params = {})
      client.find(:organization, id, params)
    end
  end

  # Returns a list of boards under this organization.
  def boards(params = {})
    boards = Board.from_response client.get("/organizations/#{id}/boards", params)
    MultiAssociation.new(self, boards).proxy
  end

  # Returns an array of members associated with the organization.
  def members(params = {})
    members = Member.from_response client.get("/organizations/#{id}/members/all", params)
    MultiAssociation.new(self, members).proxy
  end

  # :nodoc:
  def request_prefix
    "/organizations/#{id}"
  end
end

Class Method Details

.find(id, params = {}) ⇒ Object

Find an organization by its id.



74
75
76
 
# File 'lib/trello/organization.rb', line 74

def find(id, params = {})
  client.find(:organization, id, params)
end

Instance Method Details

#boards(params = {}) ⇒ Object

Returns a list of boards under this organization.



80
81
82
83
 
# File 'lib/trello/organization.rb', line 80

def boards(params = {})
  boards = Board.from_response client.get("/organizations/#{id}/boards", params)
  MultiAssociation.new(self, boards).proxy
end

#members(params = {}) ⇒ Object

Returns an array of members associated with the organization.



86
87
88
89
 
# File 'lib/trello/organization.rb', line 86

def members(params = {})
  members = Member.from_response client.get("/organizations/#{id}/members/all", params)
  MultiAssociation.new(self, members).proxy
end

#request_prefix ⇒ Object

:nodoc:



92
93
94
 
# File 'lib/trello/organization.rb', line 92

def request_prefix
  "/organizations/#{id}"
end