pub struct Airtable { /* private fields */ }Expand description
Entrypoint for interacting with the Airtable API.
Implementations§
Source§impl Airtable
impl Airtable
Sourcepub fn new<K, B, E>(key: K, base_id: B, enterprise_account_id: E) -> Self
pub fn new<K, B, E>(key: K, base_id: B, enterprise_account_id: E) -> Self
Create a new Airtable client struct. It takes a type that can convert into
an &str (String or Vec<u8> for example). As long as the function is
given a valid API Key and Base ID your requests will work.
You can leave the Enterprise Account ID empty if you are not using the
Enterprise API features.
Sourcepub fn new_from_env() -> Self
pub fn new_from_env() -> Self
Create a new Airtable client struct from environment variables. It
takes a type that can convert into
an &str (String or Vec<u8> for example). As long as the function is
given a valid API Key and Base ID your requests will work.
Sourcepub async fn list_records<T: DeserializeOwned>(
&self,
table: &str,
view: &str,
fields: Vec<&str>,
) -> Result<Vec<Record<T>>>
pub async fn list_records<T: DeserializeOwned>( &self, table: &str, view: &str, fields: Vec<&str>, ) -> Result<Vec<Record<T>>>
List records in a table for a particular view.
Sourcepub async fn get_record<T: DeserializeOwned>(
&self,
table: &str,
record_id: &str,
) -> Result<Record<T>>
pub async fn get_record<T: DeserializeOwned>( &self, table: &str, record_id: &str, ) -> Result<Record<T>>
Get record from a table.
Sourcepub async fn delete_record(&self, table: &str, record_id: &str) -> Result<()>
pub async fn delete_record(&self, table: &str, record_id: &str) -> Result<()>
Delete record from a table.
Sourcepub async fn create_records<T: Serialize + DeserializeOwned>(
&self,
table: &str,
records: Vec<Record<T>>,
) -> Result<Vec<Record<T>>>
pub async fn create_records<T: Serialize + DeserializeOwned>( &self, table: &str, records: Vec<Record<T>>, ) -> Result<Vec<Record<T>>>
Bulk create records in a table.
Due to limitations on the Airtable API, you can only bulk create 10 records at a time.
Sourcepub async fn update_records<T: Serialize + DeserializeOwned>(
&self,
table: &str,
records: Vec<Record<T>>,
) -> Result<Vec<Record<T>>>
pub async fn update_records<T: Serialize + DeserializeOwned>( &self, table: &str, records: Vec<Record<T>>, ) -> Result<Vec<Record<T>>>
Bulk update records in a table.
Due to limitations on the Airtable API, you can only bulk update 10 records at a time.
Sourcepub async fn list_users(&self) -> Result<Vec<User>>
pub async fn list_users(&self) -> Result<Vec<User>>
List users. This is for an enterprise admin to do only. FROM: https://airtable.com/api/enterprise
Sourcepub async fn get_enterprise_user(&self, email: &str) -> Result<EnterpriseUser>
pub async fn get_enterprise_user(&self, email: &str) -> Result<EnterpriseUser>
Get an enterprise user. This is for an enterprise admin to do only. FROM: https://airtable.com/api/enterprise#enterpriseAccountUserGetInformationByEmail Permission level can be: owner | create | edit | comment | read
Sourcepub async fn add_collaborator_to_workspace(
&self,
workspace_id: &str,
user_id: &str,
permission_level: &str,
) -> Result<()>
pub async fn add_collaborator_to_workspace( &self, workspace_id: &str, user_id: &str, permission_level: &str, ) -> Result<()>
Add a collaborator to a workspace. This is for an enterprise admin to do only. FROM: https://airtable.com/api/enterprise#enterpriseWorkspaceAddCollaborator Permission level can be: owner | create | edit | comment | read
Sourcepub async fn get_enterprise_workspace<const N: usize>(
&self,
workspace_id: &str,
includes: Option<[WorkspaceIncludes; N]>,
) -> Result<Workspace>
pub async fn get_enterprise_workspace<const N: usize>( &self, workspace_id: &str, includes: Option<[WorkspaceIncludes; N]>, ) -> Result<Workspace>
Returns basic information on the workspace. Does not include deleted collaborators and only include outstanding invites. FROM: https://airtable.com/api/enterprise#enterpriseWorkspaceGetInformation
Sourcepub async fn delete_internal_user_by_email(&self, email: &str) -> Result<()>
pub async fn delete_internal_user_by_email(&self, email: &str) -> Result<()>
Delete internal user by email. This is for an enterprise admin to do only. The user must be an internal user, meaning they have an email with the company domain. FROM: https://airtable.com/api/enterprise#enterpriseAccountUserDeleteUserByEmail