@spec all_contact_addresses(Deputy.t()) :: {:ok, [map()]} | {:error, Deputy.Error.t()}

Get all the authenticated user's addresses including emergency contacts.

Examples

client = Deputy.new(base_url: "https://test.deputy.com", api_key: "test-key")
Deputy.My.all_contact_addresses(client)
# => {:ok, [%{"Street1" => "123 Main St", "City" => "New York"}]}

@spec all_contact_addresses!(Deputy.t()) :: [map()]

Same as all_contact_addresses/1 but raises on error.

@spec colleagues(Deputy.t()) :: {:ok, [map()]} | {:error, Deputy.Error.t()}

Get the authenticated user's colleagues.

Examples

client = Deputy.new(base_url: "https://test.deputy.com", api_key: "test-key")
Deputy.My.colleagues(client)
# => {:ok, [%{"Id" => 2, "FirstName" => "Jane", "LastName" => "Smith"}]}

@spec colleagues!(Deputy.t()) :: [map()]

Same as colleagues/1 but raises on error.

@spec complete_task(Deputy.t(), integer()) ::
  {:ok, map()} | {:error, Deputy.Error.t()}

Complete a task.

Parameters

• client: A Deputy client.
• id: The ID of the task to complete.

Examples

client = Deputy.new(base_url: "https://test.deputy.com", api_key: "test-key")
Deputy.My.complete_task(client, 1)
# => {:ok, %{"success" => true}}

@spec complete_task!(Deputy.t(), integer()) :: map()

Same as complete_task/2 but raises on error.

@spec contact_address(Deputy.t()) :: {:ok, map()} | {:error, Deputy.Error.t()}

Get the authenticated user's address.

Examples

client = Deputy.new(base_url: "https://test.deputy.com", api_key: "test-key")
Deputy.My.contact_address(client)
# => {:ok, %{"Street1" => "123 Main St", "City" => "New York"}}

@spec contact_address!(Deputy.t()) :: map()

Same as contact_address/1 but raises on error.

@spec leave(Deputy.t()) :: {:ok, [map()]} | {:error, Deputy.Error.t()}

Get the authenticated user's leave requests.

Examples

client = Deputy.new(base_url: "https://test.deputy.com", api_key: "test-key")
Deputy.My.leave(client)
# => {:ok, [%{"Id" => 1, "DateStart" => "2023-01-01", "DateEnd" => "2023-01-05"}]}

@spec leave!(Deputy.t()) :: [map()]

Same as leave/1 but raises on error.

@spec location(Deputy.t(), integer()) :: {:ok, map()} | {:error, Deputy.Error.t()}

Get a specific location.

Parameters

• client: A Deputy client.
• id: The ID of the location.

Examples

client = Deputy.new(base_url: "https://test.deputy.com", api_key: "test-key")
Deputy.My.location(client, 1)
# => {:ok, %{"Id" => 1, "Name" => "Main Office"}}

@spec location!(Deputy.t(), integer()) :: map()

Same as location/2 but raises on error.

@spec locations(Deputy.t()) :: {:ok, [map()]} | {:error, Deputy.Error.t()}

Get locations where the authenticated user can work.

Examples

client = Deputy.new(base_url: "https://test.deputy.com", api_key: "test-key")
Deputy.My.locations(client)
# => {:ok, [%{"Id" => 1, "Name" => "Main Office"}]}

@spec locations!(Deputy.t()) :: [map()]

Same as locations/1 but raises on error.

@spec me(Deputy.t()) :: {:ok, map()} | {:error, Deputy.Error.t()}

Get information about the authenticated user.

Examples

client = Deputy.new(base_url: "https://test.deputy.com", api_key: "test-key")
Deputy.My.me(client)
# => {:ok, %{"Id" => 1, "FirstName" => "John", "LastName" => "Doe"}}

@spec me!(Deputy.t()) :: map()

Same as me/1 but raises on error.

@spec memos(Deputy.t()) :: {:ok, [map()]} | {:error, Deputy.Error.t()}

Get the authenticated user's memos (newsfeed).

Examples

client = Deputy.new(base_url: "https://test.deputy.com", api_key: "test-key")
Deputy.My.memos(client)
# => {:ok, [%{"Id" => 1, "Content" => "Welcome to Deputy"}]}

@spec memos!(Deputy.t()) :: [map()]

Same as memos/1 but raises on error.

@spec notifications(Deputy.t()) :: {:ok, [map()]} | {:error, Deputy.Error.t()}

Get the authenticated user's notifications.

Examples

client = Deputy.new(base_url: "https://test.deputy.com", api_key: "test-key")
Deputy.My.notifications(client)
# => {:ok, [%{"Id" => 1, "Message" => "You have a new roster"}]}

@spec notifications!(Deputy.t()) :: [map()]

Same as notifications/1 but raises on error.

@spec rosters(Deputy.t()) :: {:ok, [map()]} | {:error, Deputy.Error.t()}

Get the authenticated user's rosters.

Examples

client = Deputy.new(base_url: "https://test.deputy.com", api_key: "test-key")
Deputy.My.rosters(client)
# => {:ok, [%{"Id" => 1, "StartTime" => "2023-01-01T09:00:00"}]}

@spec rosters!(Deputy.t()) :: [map()]

Same as rosters/1 but raises on error.

@spec setup(Deputy.t()) :: {:ok, map()} | {:error, Deputy.Error.t()}

Get setup information for the authenticated user.

Examples

client = Deputy.new(base_url: "https://test.deputy.com", api_key: "test-key")
Deputy.My.setup(client)
# => {:ok, %{"locations" => [%{"Id" => 1, "Name" => "Main Office"}]}}

@spec setup!(Deputy.t()) :: map()

Same as setup/1 but raises on error.

@spec tasks(Deputy.t()) :: {:ok, [map()]} | {:error, Deputy.Error.t()}

Get the authenticated user's tasks.

Examples

client = Deputy.new(base_url: "https://test.deputy.com", api_key: "test-key")
Deputy.My.tasks(client)
# => {:ok, [%{"Id" => 1, "TaskName" => "Complete training"}]}

@spec tasks!(Deputy.t()) :: [map()]

Same as tasks/1 but raises on error.

@spec timesheet_detail(Deputy.t(), integer()) ::
  {:ok, map()} | {:error, Deputy.Error.t()}

Get details for a specific timesheet.

Parameters

• client: A Deputy client.
• id: The ID of the timesheet.

Examples

client = Deputy.new(base_url: "https://test.deputy.com", api_key: "test-key")
Deputy.My.timesheet_detail(client, 1)
# => {:ok, %{"Id" => 1, "StartTime" => "2023-01-01T09:00:00"}}

@spec timesheet_detail!(Deputy.t(), integer()) :: map()

Same as timesheet_detail/2 but raises on error.

@spec timesheets(Deputy.t()) :: {:ok, [map()]} | {:error, Deputy.Error.t()}

Get the authenticated user's timesheets.

Examples

client = Deputy.new(base_url: "https://test.deputy.com", api_key: "test-key")
Deputy.My.timesheets(client)
# => {:ok, [%{"Id" => 1, "StartTime" => "2023-01-01T09:00:00"}]}

@spec timesheets!(Deputy.t()) :: [map()]

Same as timesheets/1 but raises on error.

@spec training(Deputy.t()) :: {:ok, [map()]} | {:error, Deputy.Error.t()}

Get the authenticated user's training.

Examples

client = Deputy.new(base_url: "https://test.deputy.com", api_key: "test-key")
Deputy.My.training(client)
# => {:ok, [%{"Id" => 1, "Name" => "Safety Training"}]}

@spec training!(Deputy.t()) :: [map()]

Same as training/1 but raises on error.

@spec unavailability(Deputy.t()) :: {:ok, [map()]} | {:error, Deputy.Error.t()}

Get the authenticated user's unavailability.

Examples

client = Deputy.new(base_url: "https://test.deputy.com", api_key: "test-key")
Deputy.My.unavailability(client)
# => {:ok, [%{"Id" => 1, "Start" => %{"timestamp" => 1657001675}}]}

@spec unavailability!(Deputy.t()) :: [map()]

Same as unavailability/1 but raises on error.

@spec update_contact_address(Deputy.t(), map()) ::
  {:ok, map()} | {:error, Deputy.Error.t()}

Update the authenticated user's address.

Parameters

• client: A Deputy client.
• attrs: A map containing the address details.

Address parameters

• ContactName: Name for the contact.
• UnitNo: Unit number.
• Street1: Street address.
• City: City.
• State: State code.
• Postcode: Postal code.
• Country: Country ID.
• Notes: Optional notes.

Examples

client = Deputy.new(base_url: "https://test.deputy.com", api_key: "test-key")
attrs = %{
  ContactName: "John Doe",
  UnitNo: "2",
  Street1: "123 Main St",
  City: "New York",
  State: "NY",
  Postcode: "10001",
  Country: 1
}
Deputy.My.update_contact_address(client, attrs)
# => {:ok, %{"success" => true}}

@spec update_contact_address!(Deputy.t(), map()) :: map()

Same as update_contact_address/2 but raises on error.