fizzy-sdk 0.2.4

Official Fizzy API client, generated from the Smithy model in spec/
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

// Generated by fizzy-sdk-generator from openapi.json and behavior-model.json. DO NOT EDIT.

use crate::client::Scope;
use crate::error::Error;
use crate::generated::routes;
use crate::generated::types::*;

/// The `Steps` operations.
pub struct StepsService<'a> {
    scope: Scope<'a>,
}

impl<'a> StepsService<'a> {
    pub(crate) fn new(scope: Scope<'a>) -> Self {
        Self { scope }
    }

    /// The client and account these operations send through.
    pub fn scope(&self) -> &Scope<'a> {
        &self.scope
    }

    /// `CreateStep` — `POST /{accountId}/cards/{cardNumber}/steps.json`.
    ///
    /// Sent once and never resent.
    pub async fn create(
        &self,
        card_number: i32,
        body: &CreateStepRequestContent,
    ) -> Result<Step, Error> {
        let mut operation = self
            .scope
            .operation(&routes::CREATE_STEP, &[&card_number])?;
        operation.resource_id(card_number);
        operation.json(body)?;
        self.scope.client().send(operation).await
    }

    /// `DeleteStep` — `DELETE /{accountId}/cards/{cardNumber}/steps/{stepId}`.
    ///
    /// Sent up to 3 times, backing off from 1000 ms, when the answer is 429, 500 or 503.
    pub async fn delete(&self, card_number: i32, step_id: &str) -> Result<(), Error> {
        let mut operation = self
            .scope
            .operation(&routes::DELETE_STEP, &[&card_number, &step_id])?;
        operation.resource_id(step_id);
        self.scope.client().send_unit(operation).await
    }

    /// `GetStep` — `GET /{accountId}/cards/{cardNumber}/steps/{stepId}`.
    ///
    /// Sent up to 3 times, backing off from 1000 ms, when the answer is 429, 500 or 503.
    pub async fn get(&self, card_number: i32, step_id: &str) -> Result<Step, Error> {
        let mut operation = self
            .scope
            .operation(&routes::GET_STEP, &[&card_number, &step_id])?;
        operation.resource_id(step_id);
        self.scope.client().send(operation).await
    }

    /// `ListSteps` — `GET /{accountId}/cards/{cardNumber}/steps.json`.
    ///
    /// Sent up to 3 times, backing off from 1000 ms, when the answer is 429, 500 or 503.
    pub async fn list(&self, card_number: i32) -> Result<Vec<Step>, Error> {
        let mut operation = self.scope.operation(&routes::LIST_STEPS, &[&card_number])?;
        operation.resource_id(card_number);
        self.scope.client().send(operation).await
    }

    /// `UpdateStep` — `PATCH /{accountId}/cards/{cardNumber}/steps/{stepId}`.
    ///
    /// Sent up to 3 times, backing off from 1000 ms, when the answer is 429, 500 or 503.
    pub async fn update(
        &self,
        card_number: i32,
        step_id: &str,
        body: &UpdateStepRequestContent,
    ) -> Result<Step, Error> {
        let mut operation = self
            .scope
            .operation(&routes::UPDATE_STEP, &[&card_number, &step_id])?;
        operation.resource_id(step_id);
        operation.json(body)?;
        self.scope.client().send(operation).await
    }
}