shopify-client 1.1.0

Type-safe, async Rust client for the Shopify Admin and Storefront APIs
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

pub mod remote;

use crate::common::ServiceContext;

use std::sync::Arc;

use crate::{
    common::types::{APIError, RequestCallbacks},
    types::subscription::{
        ActiveSubscriptionsResp, CancelSubscriptionResp, CreateCombinedSubscriptionRequest,
        CreateRecurringSubscriptionRequest, CreateSubscriptionResp, CreateUsageRecordRequest,
        CreateUsageRecordResp, CreateUsageSubscriptionRequest, ExtendTrialResp, MoneyInput,
        UpdateCappedAmountResp,
    },
};

pub struct Subscription {
    pub(crate) ctx: ServiceContext,
}

impl Subscription {
    pub fn new(
        shop_url: Arc<String>,
        version: Arc<String>,
        access_token: Arc<String>,
        callbacks: Arc<RequestCallbacks>,
    ) -> Self {
        Self::with_ctx(ServiceContext::new(
            shop_url,
            version,
            access_token,
            callbacks,
        ))
    }

    /// Build the service from a shared `ServiceContext`. Cheaper than `new` at
    /// construction sites that already hold a context (one `Arc` clone per service).
    pub fn with_ctx(ctx: ServiceContext) -> Self {
        Self { ctx }
    }

    pub async fn create_recurring(
        &self,
        request: &CreateRecurringSubscriptionRequest,
    ) -> Result<CreateSubscriptionResp, APIError> {
        remote::create_recurring_subscription(&self.ctx, request).await
    }

    pub async fn create_usage(
        &self,
        request: &CreateUsageSubscriptionRequest,
    ) -> Result<CreateSubscriptionResp, APIError> {
        remote::create_usage_subscription(&self.ctx, request).await
    }

    pub async fn create_combined(
        &self,
        request: &CreateCombinedSubscriptionRequest,
    ) -> Result<CreateSubscriptionResp, APIError> {
        remote::create_combined_subscription(&self.ctx, request).await
    }

    pub async fn cancel(
        &self,
        subscription_id: &String,
        prorate: bool,
    ) -> Result<CancelSubscriptionResp, APIError> {
        remote::cancel_subscription(&self.ctx, subscription_id, prorate).await
    }

    pub async fn extend_trial(
        &self,
        subscription_id: &String,
        days: i32,
    ) -> Result<ExtendTrialResp, APIError> {
        remote::extend_trial(&self.ctx, subscription_id, days).await
    }

    pub async fn update_capped_amount(
        &self,
        line_item_id: &String,
        capped_amount: &MoneyInput,
    ) -> Result<UpdateCappedAmountResp, APIError> {
        remote::update_capped_amount(&self.ctx, line_item_id, capped_amount).await
    }

    pub async fn create_usage_record(
        &self,
        request: &CreateUsageRecordRequest,
    ) -> Result<CreateUsageRecordResp, APIError> {
        remote::create_usage_record(&self.ctx, request).await
    }

    pub async fn get_active_subscriptions(&self) -> Result<ActiveSubscriptionsResp, APIError> {
        remote::get_active_subscriptions(&self.ctx).await
    }
}