C# Class PodioAPI.Services.OrganizationService

Show file Open project: podio/podio-dotnet

Public Methods

Method	Description
AddNewOrganization ( string name, int logo ) : Task	Creates a new organization. Podio API Reference: https://developers.podio.com/doc/organizations/add-new-organization-22385
AddOrganizationAdmin ( int organizationId, int userId ) : Task	Adds a new administrator to the organization. The user must be administrator to perform this operation. Podio API Reference: https://developers.podio.com/doc/organizations/add-organization-admin-50854
CreateOrganizationAppStoreProfile ( int organizationId, Contact profileData ) : Task	Creates an app store profile for the organization if it doesn't already exist. Podio API Reference: https://developers.podio.com/doc/organizations/create-organization-app-store-profile-87819
DeleteOrganizationAppStoreProfile ( int organizationId ) : Task	Deletes the organizations app store profile. Podio API Reference: https://developers.podio.com/doc/organizations/delete-organization-app-store-profile-87808
DeleteOrganizationMemberRole ( int organizationId, int userId ) : Task	Removes the role from the given user on the given organization. Podio API Reference: https://developers.podio.com/doc/organizations/delete-organization-member-role-935217
GetMember ( int organizationId, int userId ) : Task	Returns the member data for the given user in the given organization. Podio API Reference: https://developers.podio.com/doc/organizations/get-organization-member-50908
GetMembers ( int organizationId, string memberType = null, string query = null, int limit = null, int offset = null, string sortBy = null, bool sortDesc = false ) : Task>	Returns the members, both invited and active, of the given organization. This method is only available for organization administrators. Podio API Reference: https://developers.podio.com/doc/organizations/get-organization-members-50661
GetOrganization ( int organizationId ) : Task	Gets the organization with the given id. Podio API Reference: https://developers.podio.com/doc/organizations/get-organization-22383
GetOrganizationAdmins ( int organizationId ) : Task>	Returns the administrators of the organization. Podio API Reference: https://developers.podio.com/doc/organizations/get-organization-admins-81542
GetOrganizationAppStoreProfile ( int organizationId ) : Task	Gets the appstore profile of an organization, if any. Podio API Reference: https://developers.podio.com/doc/organizations/get-organization-app-store-profile-87799
GetOrganizationBillingProfile ( int organizationId ) : Task	Gets the billing profile of an organization. Podio API Reference: https://developers.podio.com/doc/organizations/get-organization-billing-profile-51370
GetOrganizationByURL ( string orgUrl ) : Task	Returns the organization with the given full URL. The URL does not have to be truncated to the root, it can be to any resource on the URL. Podio API Reference: https://developers.podio.com/doc/organizations/get-organization-by-url-22384
GetOrganizationLoginReport ( int organizationId, int limit = 4, int offset ) : Task>	Returns the login report for the organization. This reports list the total number of users and the total number of active users per week. Podio API Reference: https://developers.podio.com/doc/organizations/get-organization-login-report-51730
GetOrganizations ( ) : Task>	Returns a list of all the organizations and spaces the user is member of. Podio API Reference: https://developers.podio.com/doc/organizations/get-organizations-22344
GetSharedOrganizations ( int userId ) : Task>	Returns all space memberships the specified org member has in this organization. If the org admin requesting this information is not a member of any of these workspaces, sensitive information like name and url will not be exposed.
GetSpaceMembershipsForOrgMember ( int organizationId, int userId ) : Task>	Returns all space memberships the specified org member has in this organization. If the org admin requesting this information is not a member of any of these workspaces, sensitive information like name and url will not be exposed.
GetSpacesOnOrganization ( int organizationId ) : Task>	Returns all the spaces for the organization. Podio API Reference: https://developers.podio.com/doc/organizations/get-spaces-on-organization-22387
OrganizationService ( Podio currentInstance ) : System.Collections.Generic
RemoveOrganizationAdmin ( int organizationId, int userId ) : Task	Removes the user as administrator from the organization. The active user must be an administrator of the organization. Podio API Reference: https://developers.podio.com/doc/organizations/remove-organization-admin-50855
UpdateOrganization ( int organizationId, string name = null, string urlLabel = null, int logo = null ) : Task	Updates an organization with new name and logo. Note that the URL of the organization will not change even though the name changes.
UpdateOrganizationAppStoreProfile ( int organizationId, Contact profileData ) : Task	Updates the appstore profile of the organization.
UpdateOrganizationBillingProfile ( int organizationId, Contact profileData ) : Task	Updates the billing profile of the organization. The profile is used for billing and contact information.

Method Details

AddNewOrganization() public method

Creates a new organization.

Podio API Reference: https://developers.podio.com/doc/organizations/add-new-organization-22385

public AddNewOrganization ( string name, int logo ) : Task
name	string	The name of the new organization
logo	int	The file id of the logo of the organization
return	Task

AddOrganizationAdmin() public method

Adds a new administrator to the organization. The user must be administrator to perform this operation.

Podio API Reference: https://developers.podio.com/doc/organizations/add-organization-admin-50854

public AddOrganizationAdmin ( int organizationId, int userId ) : Task
organizationId	int
userId	int	The id of the user to be made administrator
return	Task

CreateOrganizationAppStoreProfile() public method

Creates an app store profile for the organization if it doesn't already exist.

Podio API Reference: https://developers.podio.com/doc/organizations/create-organization-app-store-profile-87819

public CreateOrganizationAppStoreProfile ( int organizationId, Contact profileData ) : Task
organizationId	int
profileData	PodioAPI.Models.Contact
return	Task

DeleteOrganizationAppStoreProfile() public method

Deletes the organizations app store profile.

Podio API Reference: https://developers.podio.com/doc/organizations/delete-organization-app-store-profile-87808

public DeleteOrganizationAppStoreProfile ( int organizationId ) : Task
organizationId	int
return	Task

DeleteOrganizationMemberRole() public method

Removes the role from the given user on the given organization.

Podio API Reference: https://developers.podio.com/doc/organizations/delete-organization-member-role-935217

public DeleteOrganizationMemberRole ( int organizationId, int userId ) : Task
organizationId	int
userId	int
return	Task

GetMember() public method

Returns the member data for the given user in the given organization.

Podio API Reference: https://developers.podio.com/doc/organizations/get-organization-member-50908

public GetMember ( int organizationId, int userId ) : Task
organizationId	int
userId	int
return	Task

GetMembers() public method

Returns the members, both invited and active, of the given organization. This method is only available for organization administrators.

Podio API Reference: https://developers.podio.com/doc/organizations/get-organization-members-50661

public GetMembers ( int organizationId, string memberType = null, string query = null, int limit = null, int offset = null, string sortBy = null, bool sortDesc = false ) : Task>
organizationId	int
memberType	string	/// The type of members that should be returned Possible values are: employee, external, admin, /// regular, guest, premium ///
query	string	Any search term to match.
limit	int	The maximum number of items to return
offset	int	The offset to use when returning the list Default value: 0
sortBy	string	The sorting order of the results returned. Valid options are "name" and "last_seen_on"
sortDesc	bool	True if the results should be sorted descending, false otherwise. Default value: false
return	Task>

GetOrganization() public method

Gets the organization with the given id.

Podio API Reference: https://developers.podio.com/doc/organizations/get-organization-22383

public GetOrganization ( int organizationId ) : Task
organizationId	int
return	Task

GetOrganizationAdmins() public method

Returns the administrators of the organization.

Podio API Reference: https://developers.podio.com/doc/organizations/get-organization-admins-81542

public GetOrganizationAdmins ( int organizationId ) : Task>
organizationId	int
return	Task>

GetOrganizationAppStoreProfile() public method

Gets the appstore profile of an organization, if any.

Podio API Reference: https://developers.podio.com/doc/organizations/get-organization-app-store-profile-87799

public GetOrganizationAppStoreProfile ( int organizationId ) : Task
organizationId	int
return	Task

GetOrganizationBillingProfile() public method

Gets the billing profile of an organization.

Podio API Reference: https://developers.podio.com/doc/organizations/get-organization-billing-profile-51370

public GetOrganizationBillingProfile ( int organizationId ) : Task
organizationId	int
return	Task

GetOrganizationByURL() public method

Returns the organization with the given full URL. The URL does not have to be truncated to the root, it can be to any resource on the URL.

Podio API Reference: https://developers.podio.com/doc/organizations/get-organization-by-url-22384

public GetOrganizationByURL ( string orgUrl ) : Task
orgUrl	string
return	Task

GetOrganizationLoginReport() public method

Returns the login report for the organization. This reports list the total number of users and the total number of active users per week.

Podio API Reference: https://developers.podio.com/doc/organizations/get-organization-login-report-51730

public GetOrganizationLoginReport ( int organizationId, int limit = 4, int offset ) : Task>
organizationId	int
limit	int	/// The number of weeks to return counting backwards from the previous week, but no more than 16. It /// will also never return data older than when the organization was created. Default value: 4 ///
offset	int	The offset into the weeks to return. Default value: 0
return	Task>

GetOrganizations() public method

Returns a list of all the organizations and spaces the user is member of.

Podio API Reference: https://developers.podio.com/doc/organizations/get-organizations-22344

public GetOrganizations ( ) : Task>
return	Task>

GetSharedOrganizations() public method

Returns all space memberships the specified org member has in this organization. If the org admin requesting this information is not a member of any of these workspaces, sensitive information like name and url will not be exposed.

public GetSharedOrganizations ( int userId ) : Task>
userId	int
return	Task>

GetSpaceMembershipsForOrgMember() public method

public GetSpaceMembershipsForOrgMember ( int organizationId, int userId ) : Task>
organizationId	int
userId	int
return	Task>

GetSpacesOnOrganization() public method

Returns all the spaces for the organization.

Podio API Reference: https://developers.podio.com/doc/organizations/get-spaces-on-organization-22387

public GetSpacesOnOrganization ( int organizationId ) : Task>
organizationId	int
return	Task>

OrganizationService() public method

public OrganizationService ( Podio currentInstance ) : System.Collections.Generic
currentInstance	Podio
return	System.Collections.Generic

RemoveOrganizationAdmin() public method

Removes the user as administrator from the organization. The active user must be an administrator of the organization.

Podio API Reference: https://developers.podio.com/doc/organizations/remove-organization-admin-50855

public RemoveOrganizationAdmin ( int organizationId, int userId ) : Task
organizationId	int
userId	int
return	Task

UpdateOrganization() public method

Updates an organization with new name and logo. Note that the URL of the organization will not change even though the name changes.

public UpdateOrganization ( int organizationId, string name = null, string urlLabel = null, int logo = null ) : Task
organizationId	int
name	string	The name of the new organization
urlLabel	string	The new subdomain of the URL of the organization, defaults to the existing URL
logo	int	The file id of the logo of the organization
return	Task

UpdateOrganizationAppStoreProfile() public method

Updates the appstore profile of the organization.

public UpdateOrganizationAppStoreProfile ( int organizationId, Contact profileData ) : Task
organizationId	int
profileData	PodioAPI.Models.Contact	The value or list of values for the given field. For a list of fields see the contact area
return	Task

UpdateOrganizationBillingProfile() public method

Updates the billing profile of the organization. The profile is used for billing and contact information.

public UpdateOrganizationBillingProfile ( int organizationId, Contact profileData ) : Task
organizationId	int
profileData	PodioAPI.Models.Contact	The value or list of values for the given field. For a list of fields see the contact area
return	Task