Struct Employments

Source

pub struct Employments {
    pub client: Client,
}

Fields§

§client: Client

Implementations§

Source §

impl Employments

Source

pub async fn get_index<'a>( &'a self, company_id: Option<String>, page: Option<i64>, page_size: Option<i64>, ) -> Result<ListEmploymentsResponse, Error>

List employments

Lists all employments, except for the deleted ones.

This endpoint requires and returns country-specific data. The exact required and returned fields will vary depending on which country the employment is in. To see the list of parameters for each country, see the Show form schema endpoint under the Countries category.

Please note that the compliance requirements for each country are subject to change, which will result in required and optional parameters being added and deleted without notice.

If you are using this endpoint to build an integration, make sure you are dynamically collecting or displaying the latest parameters for each country by querying the “Show form schema” endpoint.

For more information on JSON Schemas, see the How JSON Schemas work documentation.

To learn how you can dynamically generate forms to display in your UI, see the documentation for the json-schema-form tool.

Parameters:

company_id: Option<String>: Company ID
page: Option<i64>: Starts fetching records after the given page
page_size: Option<i64>: Change the amount of records returned per page, defaults to 20, limited to 100

async fn example_employments_get_index() -> anyhow::Result<()> {
    let client = remote_api::Client::new_from_env();
    let result: remote_api::types::ListEmploymentsResponse = client
        .employments()
        .get_index(
            Some("some-string".to_string()),
            Some(4 as i64),
            Some(4 as i64),
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

Source

pub async fn post_create<'a>( &'a self, body: &EmploymentBasicParams, ) -> Result<EmploymentResponse, Error>

Create employment

Creates an employment. We support creating employees and contractors.

This endpoint requires and returns country-specific data. The exact required and returned fields will vary depending on which country the employment is in. To see the list of parameters for each country, see the Show form schema endpoint under the Countries category.

Please note that the compliance requirements for each country are subject to change, which will result in required and optional parameters being added and deleted without notice.

If you are using this endpoint to build an integration, make sure you are dynamically collecting or displaying the latest parameters for each country by querying the “Show form schema” endpoint.

For more information on JSON Schemas, see the How JSON Schemas work documentation.

To learn how you can dynamically generate forms to display in your UI, see the documentation for the json-schema-form tool.

async fn example_employments_post_create() -> anyhow::Result<()> {
    let client = remote_api::Client::new_from_env();
    let result: remote_api::types::EmploymentResponse = client
        .employments()
        .post_create(&remote_api::types::EmploymentBasicParams {
            company_id: "some-string".to_string(),
            country_code: Some("some-string".to_string()),
            full_name: "some-string".to_string(),
            job_title: Some("some-string".to_string()),
            personal_email: "email@example.com".to_string(),
            provisional_start_date: Some(chrono::Utc::now().date_naive()),
            type_: remote_api::types::EmploymentBasicParamsType::Contractor,
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

Source

pub async fn get_show<'a>( &'a self, employment_id: &'a str, ) -> Result<EmploymentResponse, Error>

Show employment

Shows all the information of an employment.

This endpoint requires and returns country-specific data. The exact required and returned fields will vary depending on which country the employment is in. To see the list of parameters for each country, see the Show form schema endpoint under the Countries category.

Please note that the compliance requirements for each country are subject to change, which will result in required and optional parameters being added and deleted without notice.

If you are using this endpoint to build an integration, make sure you are dynamically collecting or displaying the latest parameters for each country by querying the “Show form schema” endpoint.

For more information on JSON Schemas, see the How JSON Schemas work documentation.

To learn how you can dynamically generate forms to display in your UI, see the documentation for the json-schema-form tool.

Parameters:

employment_id: &'astr: Employment ID (required)

async fn example_employments_get_show() -> anyhow::Result<()> {
    let client = remote_api::Client::new_from_env();
    let result: remote_api::types::EmploymentResponse =
        client.employments().get_show("some-string").await?;
    println!("{:?}", result);
    Ok(())
}

Source

pub async fn patch_update_2<'a>( &'a self, employment_id: &'a str, body: &EmploymentFullParams, ) -> Result<EmploymentResponse, Error>

Update employment

Updates an employment.

For created employments: You can change all basic params and onboarding tasks or perform a per onboarding task update.

For active employments: At this stage, it is only allowed to update the manager (manager_id field).

This endpoint requires and returns country-specific data. The exact required and returned fields will vary depending on which country the employment is in. To see the list of parameters for each country, see the Show form schema endpoint under the Countries category.

Please note that the compliance requirements for each country are subject to change, which will result in required and optional parameters being added and deleted without notice.

If you are using this endpoint to build an integration, make sure you are dynamically collecting or displaying the latest parameters for each country by querying the “Show form schema” endpoint.

For more information on JSON Schemas, see the How JSON Schemas work documentation.

To learn how you can dynamically generate forms to display in your UI, see the documentation for the json-schema-form tool.

Please contact Remote if you need to update contractors via API since it’s currently not supported.

Parameters:

employment_id: &'astr: Employment ID (required)

async fn example_employments_patch_update_2() -> anyhow::Result<()> {
    let client = remote_api::Client::new_from_env();
    let result: remote_api::types::EmploymentResponse = client
        .employments()
        .patch_update_2(
            "some-string",
            &remote_api::types::EmploymentFullParams {
                address_details: Some(serde_json::Value::String("some-string".to_string())),
                administrative_details: Some(serde_json::Value::String("some-string".to_string())),
                bank_account_details: Some(serde_json::Value::String("some-string".to_string())),
                billing_address_details: Some(serde_json::Value::String("some-string".to_string())),
                company_id: "some-string".to_string(),
                contract_details: Some(serde_json::Value::String("some-string".to_string())),
                country: Some(remote_api::types::Country {
                    code: "some-string".to_string(),
                    country_subdivisions: Some(vec![remote_api::types::CountrySubdivision {
                        code: Some("some-string".to_string()),
                        name: "some-string".to_string(),
                        subdivision_type: Some("some-string".to_string()),
                    }]),
                    name: "some-string".to_string(),
                }),
                emergency_contact_details: Some(serde_json::Value::String(
                    "some-string".to_string(),
                )),
                full_name: "some-string".to_string(),
                job_title: Some("some-string".to_string()),
                manager_id: Some("some-string".to_string()),
                personal_details: Some(serde_json::Value::String("some-string".to_string())),
                personal_email: "some-string".to_string(),
                pricing_plan_details: Some(remote_api::types::PricingPlanDetails {
                    frequency: "some-string".to_string(),
                }),
                provisional_start_date: Some(chrono::Utc::now().date_naive()),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

Source

pub async fn patch_update<'a>( &'a self, employment_id: &'a str, body: &EmploymentFullParams, ) -> Result<EmploymentResponse, Error>