sift_science 0.5.0

A rust Sift Science client
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109

//! The Labels API is a way to tell Sift which transactions or events are fraudulent or legitimate.
//!
//! By telling us this information, Sift can identify abuse patterns unique to your business.
//! Labels are used by the platform to generate the risk scores you within your application to
//! automate your fraud fighting.
//!
//! Labels API is no longer recommended for new customers. Decisions are now the recommended
//! integration, they enable you to send more granular and powerful feedback to our machine
//! learning system. Learn more about Decisions.
//!
//! For customers already using Labels API, don't worry! It is still a supported integration
//! method. If you are interested in migrating to Decisions, please contact your account manager or
//! support@sift.com and we can help.

use crate::{
    events::{self, ApiVersion, Event, EventOptions},
    AbuseType,
};
use std::time::Duration;

/// Details of the label
#[derive(Debug)]
pub struct LabelProperties {
    /// Indicates whether a user is engaging in behavior deemed harmful to your business.
    ///
    /// Set to true if the user is engaging in abusive activity. Set to false if the user is
    /// engaging in valid activity.
    pub is_fraud: bool,

    /// The type of abuse for which you want to send a label.
    ///
    /// It's important to send a label specific to the type of abuse the user is committing so that
    /// Sift can learn about specific patterns of behavior. You'll end up with more accurate
    /// results this way.
    pub abuse_type: AbuseType,

    /// Freeform text description of the user and/or incident triggering the label.
    ///
    /// Useful as annotation on why the label was added.
    pub description: Option<String>,

    /// Describes the original source of the label information.
    ///
    /// e.g. payment gateway, manual review, etc.
    pub source: Option<String>,

    /// Unique identifier (e.g. email address) of the analyst who applied the label.
    ///
    /// Useful for tracking purposes after the fact.
    pub analyst: Option<String>,

    /// Any extra non-reserved fields to be recorded with label.
    pub extra: Option<serde_json::Value>,
}

impl From<LabelProperties> for Event {
    fn from(props: LabelProperties) -> Self {
        let LabelProperties {
            is_fraud,
            abuse_type,
            description,
            source,
            analyst,
            extra,
        } = props;

        Event::Label {
            is_fraud,
            abuse_type,
            properties: events::LabelProperties {
                description,
                source,
                analyst,
                extra,
            },
        }
    }
}

/// Optional parameters for the label request
#[derive(Debug, Default)]
pub struct LabelOptions {
    /// Overrides the timeout for this call.
    pub timeout: Option<Duration>,

    /// Overrides the API key for this call.
    pub api_key: Option<String>,

    /// Overrides the version of the Events API to call.
    pub version: Option<ApiVersion>,
}

impl From<(LabelOptions, &str)> for EventOptions {
    fn from((opts, user_id): (LabelOptions, &str)) -> Self {
        let LabelOptions {
            api_key,
            timeout,
            version,
        } = opts;

        EventOptions {
            api_key,
            timeout,
            version,
            path: Some(format!("users/{}/labels", user_id).into()),
            ..Default::default()
        }
    }
}