跳转至

Share类

Share 类

Share

Source code in src/cpan123/Share.py 
 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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
class Share:
    def __init__(self, auth: Auth, userinfo: UserInfoModel | None = None) -> None:
        self.auth = auth
        self.userinfo = userinfo

    @validate_call
    def share_create(
        self,
        shareName: str,
        shareExpire: Literal[0, 1, 7, 30],
        fileIDList: str,
        sharePwd: Optional[str] = None,
        trafficSwitch: Literal[1, 2, 3, 4] | None = 1,
        trafficLimitSwitch: Literal[1, 2] | None = 1,
        trafficLimit: int | None = 1 * (1024**3),
    ) -> dict:
        """
        创建免费分享链接

        Args:
            shareName: 分享链接名称,链接名要小于35个字符且不能包含特殊字符
            shareExpire: 分享链接有效期天数,该值为枚举, 固定只能填写:1、7、30、0, 填写0时代表永久分享
            fileIDList: 分享文件ID列表,以逗号分割,最大只支持拼接100个文件ID,示例:1,2,3
            sharePwd: 设置分享链接提取码
            trafficSwitch:分享提取流量包

                1 全部关闭
                2 打开游客免登录提取
                3 打开超流量用户提取
                4 全部开启

            trafficLimitSwitch: 分享提取流量包流量限制开关.   1 关闭限制, 2 打开限制
            trafficLimit: 分享提取流量包限制流量, 单位：字节

        """
        if fileIDList.count(",") + 1 > 100:
            raise ValueError("fileIDList 参数最多只支持100个文件ID,请修改后重试")

        data = {
            "shareName": shareName,
            "shareExpire": shareExpire,
            "fileIDList": fileIDList,
            "sharePwd": sharePwd,
            "trafficSwitch": trafficSwitch,
            "trafficLimitSwitch": trafficLimitSwitch,
            "trafficLimit": trafficLimit,
        }
        return self.auth.request_json("POST", API.SharePath.CREATE, json=data)

    @validate_call
    def share_list(
        self,
        limit: int = Field(gt=0, le=100),
        lastShareId: int = 0,
    ) -> dict:
        """
        获取分享链接列表

        Args:
            limit: 每页分享链接数量,最大不超过100
            lastShareId: 翻页查询时需要填写

        Returns:
            获取分享链接列表的响应数据

        """
        params = {
            "limit": limit,
            "lastShareId": lastShareId,
        }
        return self.auth.request_json("GET", API.SharePath.LIST, params=params)

    @validate_call
    def share_change(
        self,
        shareIdList: list[int],
        trafficSwitch: int = 1,
        trafficLimitSwitch: int = 1,
        trafficLimit: int = 10000**2,
    ) -> dict:
        """修改分享链接

        Args:
            shareIdList:  分享链接ID列表,数组长度最大为100
            trafficSwitch: 分享提取流量包
                - 1 全部关闭
                - 2 打开游客免登录提取
                - 3 打开超流量用户提取
                - 4 全部开启
            trafficLimitSwitch: 分享提取流量包流量限制开关.   1 关闭限制, 2 打开限制
            trafficLimit: 分享提取流量包限制流量, 单位：字节

        Returns:
            修改分享链接的响应数据
        """

        data = {
            "shareIdList": shareIdList,
            "trafficSwitch": trafficSwitch,
            "trafficLimitSwitch": trafficLimitSwitch,
            "trafficLimit": trafficLimit,
        }
        return self.auth.request_json("PUT", API.SharePath.INFO, json=data)

    @validate_call
    def payment_create(
        self,
        shareName: str = Field(max_length=35),
        fileIDList: str = Field(max_length=10000),
        payAmount: int = Field(gt=0, le=99),
        isReward: int = Field(default=0, ge=0, le=10),
        resourceDesc: str = Field(max_length=100, default=""),
        trafficSwitch: int | None = None,
        trafficLimitSwitch: int | None = None,
        trafficLimit: int | None = None,
    ) -> dict:
        """
        创建付费分享链接

        Args:
            shareName: 分享链接名称,链接名要小于35个字符且不能包含特殊字符
            fileIDList: 分享文件ID列表,以逗号分割,最大只支持拼接100个文件ID,示例:1,2,3
            payAmount: 请输入整数|最小金额1元|最大金额99元
            isReward: 是否打赏, 0 否, 1 是, 默认 0
            resourceDesc: 资源描述
            trafficSwitch: 分享提取流量包, 1 全部关闭, 2 打开游客免登录提取, 3 打开超流量用户提取, 4 全部开启
            trafficLimitSwitch: 分享提取流量包流量限制开关, 1 关闭限制, 2 打开限制
            trafficLimit: 分享提取流量包限制流量, 单位：字节, 分享提取流量包限制流量

        Returns:
            创建付费分享链接的响应数据

        """
        data = {
            "shareName": shareName,
            "fileIDList": fileIDList,
            "payAmount": payAmount,
            "isReward": isReward,
            "resourceDesc": resourceDesc,
            "trafficSwitch": trafficSwitch,
            "trafficLimitSwitch": trafficLimitSwitch,
            "trafficLimit": trafficLimit,
        }
        return self.auth.request_json("POST", API.SharePath.CONTENT_PAYMENT_CREATE, json=data)

    @validate_call
    def payment_list(
        self,
        limit: int = Field(gt=0, le=100),
        lastShareId: int = 0,
    ) -> dict:
        """
        获取付费分享链接列表

        Args:
            limit (int): 每页分享链接数量,最大不超过100
            lastShareId (int): 翻页查询时需要填写

        Returns:
            获取付费分享链接列表的响应数据
        """
        params = {
            "limit": limit,
            "lastShareId": lastShareId,
        }
        return self.auth.request_json("GET", API.SharePath.CONTENT_PAYMENT_LIST, params=params)

    @validate_call
    def payment_change(
        self,
        shareIdList: list[int],
        trafficSwitch: int = 1,
        trafficLimitSwitch: int = 1,
        trafficLimit: int = 10000**2,
    ) -> dict:
        """修改付费分享链接

        Args:
            shareIdList: 分享链接ID列表，数组长度最大为100
            trafficSwitch:  分享提取流量包
                        1 全部关闭
                        2 打开游客免登录提取
                        3 打开超流量用户提取
                        4 全部开启
            trafficLimitSwitch: 分享提取流量包流量限制开关.   1 关闭限制, 2 打开限制
            trafficLimit: 分享提取流量包限制流量, 单位：字节

        Returns:
            修改付费分享链接的响应数据
        """

        data = {
            "shareIdList": shareIdList,
            "trafficSwitch": trafficSwitch,
            "trafficLimitSwitch": trafficLimitSwitch,
            "trafficLimit": trafficLimit,
        }
        return self.auth.request_json("PUT", API.SharePath.CONTENT_PAYMENT_INFO, json=data)

share_create 

share_create(
    shareName: str,
    shareExpire: Literal[0, 1, 7, 30],
    fileIDList: str,
    sharePwd: Optional[str] = None,
    trafficSwitch: Literal[1, 2, 3, 4] | None = 1,
    trafficLimitSwitch: Literal[1, 2] | None = 1,
    trafficLimit: int | None = 1 * 1024**3,
) -> dict

创建免费分享链接

Parameters:

Name Type Description Default
shareName str

分享链接名称,链接名要小于35个字符且不能包含特殊字符

 required
shareExpire Literal[0, 1, 7, 30]

分享链接有效期天数,该值为枚举, 固定只能填写:1、7、30、0, 填写0时代表永久分享

 required
fileIDList str

分享文件ID列表,以逗号分割,最大只支持拼接100个文件ID,示例:1,2,3

 required
sharePwd Optional[str]

设置分享链接提取码

 None
trafficSwitch Literal[1, 2, 3, 4] | None

分享提取流量包

1 全部关闭 2 打开游客免登录提取 3 打开超流量用户提取 4 全部开启

 1
trafficLimitSwitch Literal[1, 2] | None

分享提取流量包流量限制开关. 1 关闭限制, 2 打开限制

 1
trafficLimit int | None

分享提取流量包限制流量, 单位：字节

 1 * 1024 ** 3
Source code in src/cpan123/Share.py 
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
@validate_call
def share_create(
    self,
    shareName: str,
    shareExpire: Literal[0, 1, 7, 30],
    fileIDList: str,
    sharePwd: Optional[str] = None,
    trafficSwitch: Literal[1, 2, 3, 4] | None = 1,
    trafficLimitSwitch: Literal[1, 2] | None = 1,
    trafficLimit: int | None = 1 * (1024**3),
) -> dict:
    """
    创建免费分享链接

    Args:
        shareName: 分享链接名称,链接名要小于35个字符且不能包含特殊字符
        shareExpire: 分享链接有效期天数,该值为枚举, 固定只能填写:1、7、30、0, 填写0时代表永久分享
        fileIDList: 分享文件ID列表,以逗号分割,最大只支持拼接100个文件ID,示例:1,2,3
        sharePwd: 设置分享链接提取码
        trafficSwitch:分享提取流量包

            1 全部关闭
            2 打开游客免登录提取
            3 打开超流量用户提取
            4 全部开启

        trafficLimitSwitch: 分享提取流量包流量限制开关.   1 关闭限制, 2 打开限制
        trafficLimit: 分享提取流量包限制流量, 单位：字节

    """
    if fileIDList.count(",") + 1 > 100:
        raise ValueError("fileIDList 参数最多只支持100个文件ID,请修改后重试")

    data = {
        "shareName": shareName,
        "shareExpire": shareExpire,
        "fileIDList": fileIDList,
        "sharePwd": sharePwd,
        "trafficSwitch": trafficSwitch,
        "trafficLimitSwitch": trafficLimitSwitch,
        "trafficLimit": trafficLimit,
    }
    return self.auth.request_json("POST", API.SharePath.CREATE, json=data)

share_list 

share_list(
    limit: int = Field(gt=0, le=100), lastShareId: int = 0
) -> dict

获取分享链接列表

Parameters:

Name Type Description Default
limit int

每页分享链接数量,最大不超过100

 Field(gt=0, le=100)
lastShareId int

翻页查询时需要填写

 0

Returns:

Type Description
dict

获取分享链接列表的响应数据
Source code in src/cpan123/Share.py 
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
@validate_call
def share_list(
    self,
    limit: int = Field(gt=0, le=100),
    lastShareId: int = 0,
) -> dict:
    """
    获取分享链接列表

    Args:
        limit: 每页分享链接数量,最大不超过100
        lastShareId: 翻页查询时需要填写

    Returns:
        获取分享链接列表的响应数据

    """
    params = {
        "limit": limit,
        "lastShareId": lastShareId,
    }
    return self.auth.request_json("GET", API.SharePath.LIST, params=params)

share_change 

share_change(
    shareIdList: list[int],
    trafficSwitch: int = 1,
    trafficLimitSwitch: int = 1,
    trafficLimit: int = 10000**2,
) -> dict

修改分享链接

Parameters:

Name Type Description Default
shareIdList list[int]

分享链接ID列表,数组长度最大为100

 required
trafficSwitch int

分享提取流量包 - 1 全部关闭 - 2 打开游客免登录提取 - 3 打开超流量用户提取 - 4 全部开启

 1
trafficLimitSwitch int

分享提取流量包流量限制开关. 1 关闭限制, 2 打开限制

 1
trafficLimit int

分享提取流量包限制流量, 单位：字节

 10000 ** 2

Returns:

Type Description
dict

修改分享链接的响应数据
Source code in src/cpan123/Share.py 
 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
110
111
112
113
114
@validate_call
def share_change(
    self,
    shareIdList: list[int],
    trafficSwitch: int = 1,
    trafficLimitSwitch: int = 1,
    trafficLimit: int = 10000**2,
) -> dict:
    """修改分享链接

    Args:
        shareIdList:  分享链接ID列表,数组长度最大为100
        trafficSwitch: 分享提取流量包
            - 1 全部关闭
            - 2 打开游客免登录提取
            - 3 打开超流量用户提取
            - 4 全部开启
        trafficLimitSwitch: 分享提取流量包流量限制开关.   1 关闭限制, 2 打开限制
        trafficLimit: 分享提取流量包限制流量, 单位：字节

    Returns:
        修改分享链接的响应数据
    """

    data = {
        "shareIdList": shareIdList,
        "trafficSwitch": trafficSwitch,
        "trafficLimitSwitch": trafficLimitSwitch,
        "trafficLimit": trafficLimit,
    }
    return self.auth.request_json("PUT", API.SharePath.INFO, json=data)

payment_create 

payment_create(
    shareName: str = Field(max_length=35),
    fileIDList: str = Field(max_length=10000),
    payAmount: int = Field(gt=0, le=99),
    isReward: int = Field(default=0, ge=0, le=10),
    resourceDesc: str = Field(max_length=100, default=""),
    trafficSwitch: int | None = None,
    trafficLimitSwitch: int | None = None,
    trafficLimit: int | None = None,
) -> dict

创建付费分享链接

Parameters:

Name Type Description Default
shareName str

分享链接名称,链接名要小于35个字符且不能包含特殊字符

 Field(max_length=35)
fileIDList str

分享文件ID列表,以逗号分割,最大只支持拼接100个文件ID,示例:1,2,3

 Field(max_length=10000)
payAmount int

请输入整数|最小金额1元|最大金额99元

 Field(gt=0, le=99)
isReward int

是否打赏, 0 否, 1 是, 默认 0

 Field(default=0, ge=0, le=10)
resourceDesc str

资源描述

 Field(max_length=100, default='')
trafficSwitch int | None

分享提取流量包, 1 全部关闭, 2 打开游客免登录提取, 3 打开超流量用户提取, 4 全部开启

 None
trafficLimitSwitch int | None

分享提取流量包流量限制开关, 1 关闭限制, 2 打开限制

 None
trafficLimit int | None

分享提取流量包限制流量, 单位：字节, 分享提取流量包限制流量

 None

Returns:

Type Description
dict

创建付费分享链接的响应数据
Source code in src/cpan123/Share.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
@validate_call
def payment_create(
    self,
    shareName: str = Field(max_length=35),
    fileIDList: str = Field(max_length=10000),
    payAmount: int = Field(gt=0, le=99),
    isReward: int = Field(default=0, ge=0, le=10),
    resourceDesc: str = Field(max_length=100, default=""),
    trafficSwitch: int | None = None,
    trafficLimitSwitch: int | None = None,
    trafficLimit: int | None = None,
) -> dict:
    """
    创建付费分享链接

    Args:
        shareName: 分享链接名称,链接名要小于35个字符且不能包含特殊字符
        fileIDList: 分享文件ID列表,以逗号分割,最大只支持拼接100个文件ID,示例:1,2,3
        payAmount: 请输入整数|最小金额1元|最大金额99元
        isReward: 是否打赏, 0 否, 1 是, 默认 0
        resourceDesc: 资源描述
        trafficSwitch: 分享提取流量包, 1 全部关闭, 2 打开游客免登录提取, 3 打开超流量用户提取, 4 全部开启
        trafficLimitSwitch: 分享提取流量包流量限制开关, 1 关闭限制, 2 打开限制
        trafficLimit: 分享提取流量包限制流量, 单位：字节, 分享提取流量包限制流量

    Returns:
        创建付费分享链接的响应数据

    """
    data = {
        "shareName": shareName,
        "fileIDList": fileIDList,
        "payAmount": payAmount,
        "isReward": isReward,
        "resourceDesc": resourceDesc,
        "trafficSwitch": trafficSwitch,
        "trafficLimitSwitch": trafficLimitSwitch,
        "trafficLimit": trafficLimit,
    }
    return self.auth.request_json("POST", API.SharePath.CONTENT_PAYMENT_CREATE, json=data)

payment_list 

payment_list(
    limit: int = Field(gt=0, le=100), lastShareId: int = 0
) -> dict

获取付费分享链接列表

Parameters:

Name Type Description Default
limit int

每页分享链接数量,最大不超过100

 Field(gt=0, le=100)
lastShareId int

翻页查询时需要填写

 0

Returns:

Type Description
dict

获取付费分享链接列表的响应数据
Source code in src/cpan123/Share.py 
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
@validate_call
def payment_list(
    self,
    limit: int = Field(gt=0, le=100),
    lastShareId: int = 0,
) -> dict:
    """
    获取付费分享链接列表

    Args:
        limit (int): 每页分享链接数量,最大不超过100
        lastShareId (int): 翻页查询时需要填写

    Returns:
        获取付费分享链接列表的响应数据
    """
    params = {
        "limit": limit,
        "lastShareId": lastShareId,
    }
    return self.auth.request_json("GET", API.SharePath.CONTENT_PAYMENT_LIST, params=params)

payment_change 

payment_change(
    shareIdList: list[int],
    trafficSwitch: int = 1,
    trafficLimitSwitch: int = 1,
    trafficLimit: int = 10000**2,
) -> dict

修改付费分享链接

Parameters:

Name Type Description Default
shareIdList list[int]

分享链接ID列表，数组长度最大为100

 required
trafficSwitch int

分享提取流量包 1 全部关闭 2 打开游客免登录提取 3 打开超流量用户提取 4 全部开启

 1
trafficLimitSwitch int

分享提取流量包流量限制开关. 1 关闭限制, 2 打开限制

 1
trafficLimit int

分享提取流量包限制流量, 单位：字节

 10000 ** 2

Returns:

Type Description
dict

修改付费分享链接的响应数据
Source code in src/cpan123/Share.py 
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
@validate_call
def payment_change(
    self,
    shareIdList: list[int],
    trafficSwitch: int = 1,
    trafficLimitSwitch: int = 1,
    trafficLimit: int = 10000**2,
) -> dict:
    """修改付费分享链接

    Args:
        shareIdList: 分享链接ID列表，数组长度最大为100
        trafficSwitch:  分享提取流量包
                    1 全部关闭
                    2 打开游客免登录提取
                    3 打开超流量用户提取
                    4 全部开启
        trafficLimitSwitch: 分享提取流量包流量限制开关.   1 关闭限制, 2 打开限制
        trafficLimit: 分享提取流量包限制流量, 单位：字节

    Returns:
        修改付费分享链接的响应数据
    """

    data = {
        "shareIdList": shareIdList,
        "trafficSwitch": trafficSwitch,
        "trafficLimitSwitch": trafficLimitSwitch,
        "trafficLimit": trafficLimit,
    }
    return self.auth.request_json("PUT", API.SharePath.CONTENT_PAYMENT_INFO, json=data)