@whop/sdk 0.0.2 → 0.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +55 -0
- package/client.d.mts +30 -12
- package/client.d.mts.map +1 -1
- package/client.d.ts +30 -12
- package/client.d.ts.map +1 -1
- package/client.js +19 -1
- package/client.js.map +1 -1
- package/client.mjs +21 -3
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/app-builds.d.mts +16 -13
- package/resources/app-builds.d.mts.map +1 -1
- package/resources/app-builds.d.ts +16 -13
- package/resources/app-builds.d.ts.map +1 -1
- package/resources/app-builds.js +1 -1
- package/resources/app-builds.mjs +1 -1
- package/resources/apps.d.mts +15 -10
- package/resources/apps.d.mts.map +1 -1
- package/resources/apps.d.ts +15 -10
- package/resources/apps.d.ts.map +1 -1
- package/resources/checkout-configurations.d.mts +252 -140
- package/resources/checkout-configurations.d.mts.map +1 -1
- package/resources/checkout-configurations.d.ts +252 -140
- package/resources/checkout-configurations.d.ts.map +1 -1
- package/resources/checkout-configurations.js +6 -20
- package/resources/checkout-configurations.js.map +1 -1
- package/resources/checkout-configurations.mjs +6 -20
- package/resources/checkout-configurations.mjs.map +1 -1
- package/resources/companies.d.mts +157 -0
- package/resources/companies.d.mts.map +1 -1
- package/resources/companies.d.ts +157 -0
- package/resources/companies.d.ts.map +1 -1
- package/resources/companies.js +22 -0
- package/resources/companies.js.map +1 -1
- package/resources/companies.mjs +22 -0
- package/resources/companies.mjs.map +1 -1
- package/resources/course-chapters.d.mts +185 -0
- package/resources/course-chapters.d.mts.map +1 -0
- package/resources/course-chapters.d.ts +185 -0
- package/resources/course-chapters.d.ts.map +1 -0
- package/resources/course-chapters.js +103 -0
- package/resources/course-chapters.js.map +1 -0
- package/resources/course-chapters.mjs +99 -0
- package/resources/course-chapters.mjs.map +1 -0
- package/resources/course-lesson-interactions.d.mts +2 -2
- package/resources/course-lesson-interactions.d.ts +2 -2
- package/resources/course-lesson-interactions.js +2 -2
- package/resources/course-lesson-interactions.mjs +2 -2
- package/resources/course-lessons.d.mts +563 -0
- package/resources/course-lessons.d.mts.map +1 -0
- package/resources/course-lessons.d.ts +563 -0
- package/resources/course-lessons.d.ts.map +1 -0
- package/resources/course-lessons.js +101 -0
- package/resources/course-lessons.js.map +1 -0
- package/resources/course-lessons.mjs +97 -0
- package/resources/course-lessons.mjs.map +1 -0
- package/resources/course-students.d.mts +187 -0
- package/resources/course-students.d.mts.map +1 -0
- package/resources/course-students.d.ts +187 -0
- package/resources/course-students.d.ts.map +1 -0
- package/resources/course-students.js +36 -0
- package/resources/course-students.js.map +1 -0
- package/resources/course-students.mjs +32 -0
- package/resources/course-students.mjs.map +1 -0
- package/resources/courses.d.mts +485 -0
- package/resources/courses.d.mts.map +1 -0
- package/resources/courses.d.ts +485 -0
- package/resources/courses.d.ts.map +1 -0
- package/resources/courses.js +98 -0
- package/resources/courses.js.map +1 -0
- package/resources/courses.mjs +94 -0
- package/resources/courses.mjs.map +1 -0
- package/resources/experiences.d.mts +42 -11
- package/resources/experiences.d.mts.map +1 -1
- package/resources/experiences.d.ts +42 -11
- package/resources/experiences.d.ts.map +1 -1
- package/resources/experiences.js +22 -0
- package/resources/experiences.js.map +1 -1
- package/resources/experiences.mjs +22 -0
- package/resources/experiences.mjs.map +1 -1
- package/resources/forum-posts.d.mts +75 -10
- package/resources/forum-posts.d.mts.map +1 -1
- package/resources/forum-posts.d.ts +75 -10
- package/resources/forum-posts.d.ts.map +1 -1
- package/resources/forum-posts.js +11 -0
- package/resources/forum-posts.js.map +1 -1
- package/resources/forum-posts.mjs +11 -0
- package/resources/forum-posts.mjs.map +1 -1
- package/resources/index.d.mts +12 -6
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +12 -6
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +13 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +7 -1
- package/resources/index.mjs.map +1 -1
- package/resources/invoices.d.mts +529 -146
- package/resources/invoices.d.mts.map +1 -1
- package/resources/invoices.d.ts +529 -146
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js +2 -24
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs +2 -24
- package/resources/invoices.mjs.map +1 -1
- package/resources/ledger-accounts.d.mts +1 -1
- package/resources/ledger-accounts.d.mts.map +1 -1
- package/resources/ledger-accounts.d.ts +1 -1
- package/resources/ledger-accounts.d.ts.map +1 -1
- package/resources/members.d.mts +4 -0
- package/resources/members.d.mts.map +1 -1
- package/resources/members.d.ts +4 -0
- package/resources/members.d.ts.map +1 -1
- package/resources/memberships.d.mts +26 -5
- package/resources/memberships.d.mts.map +1 -1
- package/resources/memberships.d.ts +26 -5
- package/resources/memberships.d.ts.map +1 -1
- package/resources/memberships.js +1 -1
- package/resources/memberships.js.map +1 -1
- package/resources/memberships.mjs +1 -1
- package/resources/memberships.mjs.map +1 -1
- package/resources/messages.d.mts +57 -10
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +57 -10
- package/resources/messages.d.ts.map +1 -1
- package/resources/messages.js +6 -0
- package/resources/messages.js.map +1 -1
- package/resources/messages.mjs +6 -0
- package/resources/messages.mjs.map +1 -1
- package/resources/payments.d.mts +35 -13
- package/resources/payments.d.mts.map +1 -1
- package/resources/payments.d.ts +35 -13
- package/resources/payments.d.ts.map +1 -1
- package/resources/plans.d.mts +161 -17
- package/resources/plans.d.mts.map +1 -1
- package/resources/plans.d.ts +161 -17
- package/resources/plans.d.ts.map +1 -1
- package/resources/plans.js.map +1 -1
- package/resources/plans.mjs.map +1 -1
- package/resources/products.d.mts +30 -33
- package/resources/products.d.mts.map +1 -1
- package/resources/products.d.ts +30 -33
- package/resources/products.d.ts.map +1 -1
- package/resources/promo-codes.d.mts +394 -0
- package/resources/promo-codes.d.mts.map +1 -0
- package/resources/promo-codes.d.ts +394 -0
- package/resources/promo-codes.d.ts.map +1 -0
- package/resources/promo-codes.js +91 -0
- package/resources/promo-codes.js.map +1 -0
- package/resources/promo-codes.mjs +87 -0
- package/resources/promo-codes.mjs.map +1 -0
- package/resources/reviews.d.mts +277 -0
- package/resources/reviews.d.mts.map +1 -0
- package/resources/reviews.d.ts +277 -0
- package/resources/reviews.d.ts.map +1 -0
- package/resources/reviews.js +23 -0
- package/resources/reviews.js.map +1 -0
- package/resources/reviews.mjs +19 -0
- package/resources/reviews.mjs.map +1 -0
- package/resources/shared.d.mts +117 -14
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +117 -14
- package/resources/shared.d.ts.map +1 -1
- package/resources/transfers.d.mts +12 -0
- package/resources/transfers.d.mts.map +1 -1
- package/resources/transfers.d.ts +12 -0
- package/resources/transfers.d.ts.map +1 -1
- package/src/client.ts +166 -11
- package/src/resources/app-builds.ts +19 -14
- package/src/resources/apps.ts +16 -11
- package/src/resources/checkout-configurations.ts +278 -143
- package/src/resources/companies.ts +196 -0
- package/src/resources/course-chapters.ts +236 -0
- package/src/resources/course-lesson-interactions.ts +2 -2
- package/src/resources/course-lessons.ts +699 -0
- package/src/resources/course-students.ts +238 -0
- package/src/resources/courses.ts +622 -0
- package/src/resources/experiences.ts +54 -11
- package/src/resources/forum-posts.ts +95 -10
- package/src/resources/index.ts +73 -2
- package/src/resources/invoices.ts +620 -149
- package/src/resources/ledger-accounts.ts +13 -1
- package/src/resources/members.ts +5 -0
- package/src/resources/memberships.ts +31 -6
- package/src/resources/messages.ts +74 -10
- package/src/resources/payments.ts +146 -19
- package/src/resources/plans.ts +184 -17
- package/src/resources/products.ts +36 -37
- package/src/resources/promo-codes.ts +490 -0
- package/src/resources/reviews.ts +348 -0
- package/src/resources/shared.ts +128 -14
- package/src/resources/transfers.ts +10 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -1,8 +1,18 @@
|
|
|
1
1
|
import { APIResource } from "../core/resource.mjs";
|
|
2
2
|
import * as Shared from "./shared.mjs";
|
|
3
3
|
import { APIPromise } from "../core/api-promise.mjs";
|
|
4
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.mjs";
|
|
4
5
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
5
6
|
export declare class Companies extends APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Create a new sub company for your platform
|
|
9
|
+
*
|
|
10
|
+
* Required permissions:
|
|
11
|
+
*
|
|
12
|
+
* - `company:create_child`
|
|
13
|
+
* - `company:basic:read`
|
|
14
|
+
*/
|
|
15
|
+
create(body: CompanyCreateParams, options?: RequestOptions): APIPromise<Shared.Company>;
|
|
6
16
|
/**
|
|
7
17
|
* Retrieves an company by ID or its url route
|
|
8
18
|
*
|
|
@@ -11,5 +21,152 @@ export declare class Companies extends APIResource {
|
|
|
11
21
|
* - `company:basic:read`
|
|
12
22
|
*/
|
|
13
23
|
retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Company>;
|
|
24
|
+
/**
|
|
25
|
+
* Lists companies the current user has access to
|
|
26
|
+
*
|
|
27
|
+
* Required permissions:
|
|
28
|
+
*
|
|
29
|
+
* - `company:basic:read`
|
|
30
|
+
*/
|
|
31
|
+
list(query: CompanyListParams, options?: RequestOptions): PagePromise<CompanyListResponsesCursorPage, CompanyListResponse>;
|
|
32
|
+
}
|
|
33
|
+
export type CompanyListResponsesCursorPage = CursorPage<CompanyListResponse>;
|
|
34
|
+
/**
|
|
35
|
+
* An object representing a (sanitized) company.
|
|
36
|
+
*/
|
|
37
|
+
export interface CompanyListResponse {
|
|
38
|
+
/**
|
|
39
|
+
* The ID (tag) of the company.
|
|
40
|
+
*/
|
|
41
|
+
id: string;
|
|
42
|
+
/**
|
|
43
|
+
* The different business types a company can be.
|
|
44
|
+
*/
|
|
45
|
+
business_type: Shared.BusinessTypes | null;
|
|
46
|
+
/**
|
|
47
|
+
* When the company was created (signed up)
|
|
48
|
+
*/
|
|
49
|
+
created_at: string;
|
|
50
|
+
/**
|
|
51
|
+
* The creator pitch for the company.
|
|
52
|
+
*/
|
|
53
|
+
description: string | null;
|
|
54
|
+
/**
|
|
55
|
+
* The different industry types a company can be in.
|
|
56
|
+
*/
|
|
57
|
+
industry_type: Shared.IndustryTypes | null;
|
|
58
|
+
/**
|
|
59
|
+
* The company's logo.
|
|
60
|
+
*/
|
|
61
|
+
logo: CompanyListResponse.Logo | null;
|
|
62
|
+
/**
|
|
63
|
+
* The number of members in the company.
|
|
64
|
+
*/
|
|
65
|
+
member_count: number;
|
|
66
|
+
/**
|
|
67
|
+
* A key-value store of data for the account, created/updated by the platform that
|
|
68
|
+
* made the account.
|
|
69
|
+
*/
|
|
70
|
+
metadata: {
|
|
71
|
+
[key: string]: unknown;
|
|
72
|
+
} | null;
|
|
73
|
+
/**
|
|
74
|
+
* The user who owns this company
|
|
75
|
+
*/
|
|
76
|
+
owner_user: CompanyListResponse.OwnerUser;
|
|
77
|
+
/**
|
|
78
|
+
* The number of reviews that have been published for the company.
|
|
79
|
+
*/
|
|
80
|
+
published_reviews_count: number;
|
|
81
|
+
/**
|
|
82
|
+
* The slug/route of the company on the Whop site.
|
|
83
|
+
*/
|
|
84
|
+
route: string;
|
|
85
|
+
/**
|
|
86
|
+
* The title of the company.
|
|
87
|
+
*/
|
|
88
|
+
title: string;
|
|
89
|
+
/**
|
|
90
|
+
* The time the company was last updated.
|
|
91
|
+
*/
|
|
92
|
+
updated_at: string;
|
|
93
|
+
/**
|
|
94
|
+
* If the company is Whop Verified
|
|
95
|
+
*/
|
|
96
|
+
verified: boolean;
|
|
97
|
+
}
|
|
98
|
+
export declare namespace CompanyListResponse {
|
|
99
|
+
/**
|
|
100
|
+
* The company's logo.
|
|
101
|
+
*/
|
|
102
|
+
interface Logo {
|
|
103
|
+
/**
|
|
104
|
+
* This is the URL you use to render optimized attachments on the client. This
|
|
105
|
+
* should be used for apps.
|
|
106
|
+
*/
|
|
107
|
+
url: string | null;
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* The user who owns this company
|
|
111
|
+
*/
|
|
112
|
+
interface OwnerUser {
|
|
113
|
+
/**
|
|
114
|
+
* The internal ID of the user.
|
|
115
|
+
*/
|
|
116
|
+
id: string;
|
|
117
|
+
/**
|
|
118
|
+
* The name of the user from their Whop account.
|
|
119
|
+
*/
|
|
120
|
+
name: string | null;
|
|
121
|
+
/**
|
|
122
|
+
* The username of the user from their Whop account.
|
|
123
|
+
*/
|
|
124
|
+
username: string;
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
export interface CompanyCreateParams {
|
|
128
|
+
/**
|
|
129
|
+
* The email of the user who the company will belong to.
|
|
130
|
+
*/
|
|
131
|
+
email: string;
|
|
132
|
+
/**
|
|
133
|
+
* The company ID of the platform creating this company.
|
|
134
|
+
*/
|
|
135
|
+
parent_company_id: string;
|
|
136
|
+
/**
|
|
137
|
+
* The name of the company being created.
|
|
138
|
+
*/
|
|
139
|
+
title: string;
|
|
140
|
+
/**
|
|
141
|
+
* Additional metadata for the account
|
|
142
|
+
*/
|
|
143
|
+
metadata?: {
|
|
144
|
+
[key: string]: unknown;
|
|
145
|
+
} | null;
|
|
146
|
+
}
|
|
147
|
+
export interface CompanyListParams extends CursorPageParams {
|
|
148
|
+
/**
|
|
149
|
+
* The ID of the parent company to list sub companies for
|
|
150
|
+
*/
|
|
151
|
+
parent_company_id: string;
|
|
152
|
+
/**
|
|
153
|
+
* Returns the elements in the list that come before the specified cursor.
|
|
154
|
+
*/
|
|
155
|
+
before?: string | null;
|
|
156
|
+
/**
|
|
157
|
+
* The direction of the sort.
|
|
158
|
+
*/
|
|
159
|
+
direction?: Shared.Direction | null;
|
|
160
|
+
/**
|
|
161
|
+
* Returns the first _n_ elements from the list.
|
|
162
|
+
*/
|
|
163
|
+
first?: number | null;
|
|
164
|
+
/**
|
|
165
|
+
* Returns the last _n_ elements from the list.
|
|
166
|
+
*/
|
|
167
|
+
last?: number | null;
|
|
168
|
+
}
|
|
169
|
+
export declare namespace Companies {
|
|
170
|
+
export { type CompanyListResponse as CompanyListResponse, type CompanyListResponsesCursorPage as CompanyListResponsesCursorPage, type CompanyCreateParams as CompanyCreateParams, type CompanyListParams as CompanyListParams, };
|
|
14
171
|
}
|
|
15
172
|
//# sourceMappingURL=companies.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"companies.d.mts","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"companies.d.mts","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAIvF;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI1E;;;;;;OAMG;IACH,IAAI,CACF,KAAK,EAAE,iBAAiB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8BAA8B,EAAE,mBAAmB,CAAC;CAGpE;AAED,MAAM,MAAM,8BAA8B,GAAG,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAE7E;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,UAAU,EAAE,mBAAmB,CAAC,SAAS,CAAC;IAE1C;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
package/resources/companies.d.ts
CHANGED
|
@@ -1,8 +1,18 @@
|
|
|
1
1
|
import { APIResource } from "../core/resource.js";
|
|
2
2
|
import * as Shared from "./shared.js";
|
|
3
3
|
import { APIPromise } from "../core/api-promise.js";
|
|
4
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.js";
|
|
4
5
|
import { RequestOptions } from "../internal/request-options.js";
|
|
5
6
|
export declare class Companies extends APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Create a new sub company for your platform
|
|
9
|
+
*
|
|
10
|
+
* Required permissions:
|
|
11
|
+
*
|
|
12
|
+
* - `company:create_child`
|
|
13
|
+
* - `company:basic:read`
|
|
14
|
+
*/
|
|
15
|
+
create(body: CompanyCreateParams, options?: RequestOptions): APIPromise<Shared.Company>;
|
|
6
16
|
/**
|
|
7
17
|
* Retrieves an company by ID or its url route
|
|
8
18
|
*
|
|
@@ -11,5 +21,152 @@ export declare class Companies extends APIResource {
|
|
|
11
21
|
* - `company:basic:read`
|
|
12
22
|
*/
|
|
13
23
|
retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Company>;
|
|
24
|
+
/**
|
|
25
|
+
* Lists companies the current user has access to
|
|
26
|
+
*
|
|
27
|
+
* Required permissions:
|
|
28
|
+
*
|
|
29
|
+
* - `company:basic:read`
|
|
30
|
+
*/
|
|
31
|
+
list(query: CompanyListParams, options?: RequestOptions): PagePromise<CompanyListResponsesCursorPage, CompanyListResponse>;
|
|
32
|
+
}
|
|
33
|
+
export type CompanyListResponsesCursorPage = CursorPage<CompanyListResponse>;
|
|
34
|
+
/**
|
|
35
|
+
* An object representing a (sanitized) company.
|
|
36
|
+
*/
|
|
37
|
+
export interface CompanyListResponse {
|
|
38
|
+
/**
|
|
39
|
+
* The ID (tag) of the company.
|
|
40
|
+
*/
|
|
41
|
+
id: string;
|
|
42
|
+
/**
|
|
43
|
+
* The different business types a company can be.
|
|
44
|
+
*/
|
|
45
|
+
business_type: Shared.BusinessTypes | null;
|
|
46
|
+
/**
|
|
47
|
+
* When the company was created (signed up)
|
|
48
|
+
*/
|
|
49
|
+
created_at: string;
|
|
50
|
+
/**
|
|
51
|
+
* The creator pitch for the company.
|
|
52
|
+
*/
|
|
53
|
+
description: string | null;
|
|
54
|
+
/**
|
|
55
|
+
* The different industry types a company can be in.
|
|
56
|
+
*/
|
|
57
|
+
industry_type: Shared.IndustryTypes | null;
|
|
58
|
+
/**
|
|
59
|
+
* The company's logo.
|
|
60
|
+
*/
|
|
61
|
+
logo: CompanyListResponse.Logo | null;
|
|
62
|
+
/**
|
|
63
|
+
* The number of members in the company.
|
|
64
|
+
*/
|
|
65
|
+
member_count: number;
|
|
66
|
+
/**
|
|
67
|
+
* A key-value store of data for the account, created/updated by the platform that
|
|
68
|
+
* made the account.
|
|
69
|
+
*/
|
|
70
|
+
metadata: {
|
|
71
|
+
[key: string]: unknown;
|
|
72
|
+
} | null;
|
|
73
|
+
/**
|
|
74
|
+
* The user who owns this company
|
|
75
|
+
*/
|
|
76
|
+
owner_user: CompanyListResponse.OwnerUser;
|
|
77
|
+
/**
|
|
78
|
+
* The number of reviews that have been published for the company.
|
|
79
|
+
*/
|
|
80
|
+
published_reviews_count: number;
|
|
81
|
+
/**
|
|
82
|
+
* The slug/route of the company on the Whop site.
|
|
83
|
+
*/
|
|
84
|
+
route: string;
|
|
85
|
+
/**
|
|
86
|
+
* The title of the company.
|
|
87
|
+
*/
|
|
88
|
+
title: string;
|
|
89
|
+
/**
|
|
90
|
+
* The time the company was last updated.
|
|
91
|
+
*/
|
|
92
|
+
updated_at: string;
|
|
93
|
+
/**
|
|
94
|
+
* If the company is Whop Verified
|
|
95
|
+
*/
|
|
96
|
+
verified: boolean;
|
|
97
|
+
}
|
|
98
|
+
export declare namespace CompanyListResponse {
|
|
99
|
+
/**
|
|
100
|
+
* The company's logo.
|
|
101
|
+
*/
|
|
102
|
+
interface Logo {
|
|
103
|
+
/**
|
|
104
|
+
* This is the URL you use to render optimized attachments on the client. This
|
|
105
|
+
* should be used for apps.
|
|
106
|
+
*/
|
|
107
|
+
url: string | null;
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* The user who owns this company
|
|
111
|
+
*/
|
|
112
|
+
interface OwnerUser {
|
|
113
|
+
/**
|
|
114
|
+
* The internal ID of the user.
|
|
115
|
+
*/
|
|
116
|
+
id: string;
|
|
117
|
+
/**
|
|
118
|
+
* The name of the user from their Whop account.
|
|
119
|
+
*/
|
|
120
|
+
name: string | null;
|
|
121
|
+
/**
|
|
122
|
+
* The username of the user from their Whop account.
|
|
123
|
+
*/
|
|
124
|
+
username: string;
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
export interface CompanyCreateParams {
|
|
128
|
+
/**
|
|
129
|
+
* The email of the user who the company will belong to.
|
|
130
|
+
*/
|
|
131
|
+
email: string;
|
|
132
|
+
/**
|
|
133
|
+
* The company ID of the platform creating this company.
|
|
134
|
+
*/
|
|
135
|
+
parent_company_id: string;
|
|
136
|
+
/**
|
|
137
|
+
* The name of the company being created.
|
|
138
|
+
*/
|
|
139
|
+
title: string;
|
|
140
|
+
/**
|
|
141
|
+
* Additional metadata for the account
|
|
142
|
+
*/
|
|
143
|
+
metadata?: {
|
|
144
|
+
[key: string]: unknown;
|
|
145
|
+
} | null;
|
|
146
|
+
}
|
|
147
|
+
export interface CompanyListParams extends CursorPageParams {
|
|
148
|
+
/**
|
|
149
|
+
* The ID of the parent company to list sub companies for
|
|
150
|
+
*/
|
|
151
|
+
parent_company_id: string;
|
|
152
|
+
/**
|
|
153
|
+
* Returns the elements in the list that come before the specified cursor.
|
|
154
|
+
*/
|
|
155
|
+
before?: string | null;
|
|
156
|
+
/**
|
|
157
|
+
* The direction of the sort.
|
|
158
|
+
*/
|
|
159
|
+
direction?: Shared.Direction | null;
|
|
160
|
+
/**
|
|
161
|
+
* Returns the first _n_ elements from the list.
|
|
162
|
+
*/
|
|
163
|
+
first?: number | null;
|
|
164
|
+
/**
|
|
165
|
+
* Returns the last _n_ elements from the list.
|
|
166
|
+
*/
|
|
167
|
+
last?: number | null;
|
|
168
|
+
}
|
|
169
|
+
export declare namespace Companies {
|
|
170
|
+
export { type CompanyListResponse as CompanyListResponse, type CompanyListResponsesCursorPage as CompanyListResponsesCursorPage, type CompanyCreateParams as CompanyCreateParams, type CompanyListParams as CompanyListParams, };
|
|
14
171
|
}
|
|
15
172
|
//# sourceMappingURL=companies.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"companies.d.ts","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"companies.d.ts","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAIvF;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI1E;;;;;;OAMG;IACH,IAAI,CACF,KAAK,EAAE,iBAAiB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8BAA8B,EAAE,mBAAmB,CAAC;CAGpE;AAED,MAAM,MAAM,8BAA8B,GAAG,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAE7E;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,UAAU,EAAE,mBAAmB,CAAC,SAAS,CAAC;IAE1C;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
package/resources/companies.js
CHANGED
|
@@ -3,8 +3,20 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.Companies = void 0;
|
|
5
5
|
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const pagination_1 = require("../core/pagination.js");
|
|
6
7
|
const path_1 = require("../internal/utils/path.js");
|
|
7
8
|
class Companies extends resource_1.APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Create a new sub company for your platform
|
|
11
|
+
*
|
|
12
|
+
* Required permissions:
|
|
13
|
+
*
|
|
14
|
+
* - `company:create_child`
|
|
15
|
+
* - `company:basic:read`
|
|
16
|
+
*/
|
|
17
|
+
create(body, options) {
|
|
18
|
+
return this._client.post('/companies', { body, ...options });
|
|
19
|
+
}
|
|
8
20
|
/**
|
|
9
21
|
* Retrieves an company by ID or its url route
|
|
10
22
|
*
|
|
@@ -15,6 +27,16 @@ class Companies extends resource_1.APIResource {
|
|
|
15
27
|
retrieve(id, options) {
|
|
16
28
|
return this._client.get((0, path_1.path) `/companies/${id}`, options);
|
|
17
29
|
}
|
|
30
|
+
/**
|
|
31
|
+
* Lists companies the current user has access to
|
|
32
|
+
*
|
|
33
|
+
* Required permissions:
|
|
34
|
+
*
|
|
35
|
+
* - `company:basic:read`
|
|
36
|
+
*/
|
|
37
|
+
list(query, options) {
|
|
38
|
+
return this._client.getAPIList('/companies', (pagination_1.CursorPage), { query, ...options });
|
|
39
|
+
}
|
|
18
40
|
}
|
|
19
41
|
exports.Companies = Companies;
|
|
20
42
|
//# sourceMappingURL=companies.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"companies.js","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;
|
|
1
|
+
{"version":3,"file":"companies.js","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;OAOG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,KAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,uBAA+B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF;AArCD,8BAqCC"}
|
package/resources/companies.mjs
CHANGED
|
@@ -1,7 +1,19 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { CursorPage } from "../core/pagination.mjs";
|
|
3
4
|
import { path } from "../internal/utils/path.mjs";
|
|
4
5
|
export class Companies extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Create a new sub company for your platform
|
|
8
|
+
*
|
|
9
|
+
* Required permissions:
|
|
10
|
+
*
|
|
11
|
+
* - `company:create_child`
|
|
12
|
+
* - `company:basic:read`
|
|
13
|
+
*/
|
|
14
|
+
create(body, options) {
|
|
15
|
+
return this._client.post('/companies', { body, ...options });
|
|
16
|
+
}
|
|
5
17
|
/**
|
|
6
18
|
* Retrieves an company by ID or its url route
|
|
7
19
|
*
|
|
@@ -12,5 +24,15 @@ export class Companies extends APIResource {
|
|
|
12
24
|
retrieve(id, options) {
|
|
13
25
|
return this._client.get(path `/companies/${id}`, options);
|
|
14
26
|
}
|
|
27
|
+
/**
|
|
28
|
+
* Lists companies the current user has access to
|
|
29
|
+
*
|
|
30
|
+
* Required permissions:
|
|
31
|
+
*
|
|
32
|
+
* - `company:basic:read`
|
|
33
|
+
*/
|
|
34
|
+
list(query, options) {
|
|
35
|
+
return this._client.getAPIList('/companies', (CursorPage), { query, ...options });
|
|
36
|
+
}
|
|
15
37
|
}
|
|
16
38
|
//# sourceMappingURL=companies.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"companies.mjs","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;
|
|
1
|
+
{"version":3,"file":"companies.mjs","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;OAOG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,KAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,UAA+B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF"}
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.mjs";
|
|
4
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
5
|
+
export declare class CourseChapters extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Creates a new course chapter
|
|
8
|
+
*
|
|
9
|
+
* Required permissions:
|
|
10
|
+
*
|
|
11
|
+
* - `courses:update`
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* const courseChapter = await client.courseChapters.create({
|
|
16
|
+
* course_id: 'cors_xxxxxxxxxxxxx',
|
|
17
|
+
* });
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
create(body: CourseChapterCreateParams, options?: RequestOptions): APIPromise<CourseChapter>;
|
|
21
|
+
/**
|
|
22
|
+
* Retrieves a course chapter by ID
|
|
23
|
+
*
|
|
24
|
+
* Required permissions:
|
|
25
|
+
*
|
|
26
|
+
* - `courses:read`
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```ts
|
|
30
|
+
* const courseChapter = await client.courseChapters.retrieve(
|
|
31
|
+
* 'chap_xxxxxxxxxxxxx',
|
|
32
|
+
* );
|
|
33
|
+
* ```
|
|
34
|
+
*/
|
|
35
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<CourseChapter>;
|
|
36
|
+
/**
|
|
37
|
+
* Updates a course chapter
|
|
38
|
+
*
|
|
39
|
+
* Required permissions:
|
|
40
|
+
*
|
|
41
|
+
* - `courses:update`
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* ```ts
|
|
45
|
+
* const courseChapter = await client.courseChapters.update(
|
|
46
|
+
* 'chap_xxxxxxxxxxxxx',
|
|
47
|
+
* { title: 'title' },
|
|
48
|
+
* );
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
update(id: string, body: CourseChapterUpdateParams, options?: RequestOptions): APIPromise<CourseChapter>;
|
|
52
|
+
/**
|
|
53
|
+
* Lists chapters for a course
|
|
54
|
+
*
|
|
55
|
+
* Required permissions:
|
|
56
|
+
*
|
|
57
|
+
* - `courses:read`
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* ```ts
|
|
61
|
+
* // Automatically fetches more pages as needed.
|
|
62
|
+
* for await (const courseChapterListResponse of client.courseChapters.list(
|
|
63
|
+
* { course_id: 'cors_xxxxxxxxxxxxx' },
|
|
64
|
+
* )) {
|
|
65
|
+
* // ...
|
|
66
|
+
* }
|
|
67
|
+
* ```
|
|
68
|
+
*/
|
|
69
|
+
list(query: CourseChapterListParams, options?: RequestOptions): PagePromise<CourseChapterListResponsesCursorPage, CourseChapterListResponse>;
|
|
70
|
+
/**
|
|
71
|
+
* Deletes a course chapter
|
|
72
|
+
*
|
|
73
|
+
* Required permissions:
|
|
74
|
+
*
|
|
75
|
+
* - `courses:update`
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* ```ts
|
|
79
|
+
* const courseChapter = await client.courseChapters.delete(
|
|
80
|
+
* 'chap_xxxxxxxxxxxxx',
|
|
81
|
+
* );
|
|
82
|
+
* ```
|
|
83
|
+
*/
|
|
84
|
+
delete(id: string, options?: RequestOptions): APIPromise<CourseChapterDeleteResponse>;
|
|
85
|
+
}
|
|
86
|
+
export type CourseChapterListResponsesCursorPage = CursorPage<CourseChapterListResponse>;
|
|
87
|
+
/**
|
|
88
|
+
* A chapter from the courses app
|
|
89
|
+
*/
|
|
90
|
+
export interface CourseChapter {
|
|
91
|
+
/**
|
|
92
|
+
* The ID of the chapter. Looks like chap_XXX
|
|
93
|
+
*/
|
|
94
|
+
id: string;
|
|
95
|
+
/**
|
|
96
|
+
* The lessons in this chapter
|
|
97
|
+
*/
|
|
98
|
+
lessons: Array<CourseChapter.Lesson>;
|
|
99
|
+
/**
|
|
100
|
+
* The order of the chapter within its course
|
|
101
|
+
*/
|
|
102
|
+
order: number;
|
|
103
|
+
/**
|
|
104
|
+
* The title of the chapter
|
|
105
|
+
*/
|
|
106
|
+
title: string;
|
|
107
|
+
}
|
|
108
|
+
export declare namespace CourseChapter {
|
|
109
|
+
/**
|
|
110
|
+
* A lesson from the courses app
|
|
111
|
+
*/
|
|
112
|
+
interface Lesson {
|
|
113
|
+
/**
|
|
114
|
+
* The ID of the lesson
|
|
115
|
+
*/
|
|
116
|
+
id: string;
|
|
117
|
+
/**
|
|
118
|
+
* The order of the lesson within its chapter
|
|
119
|
+
*/
|
|
120
|
+
order: number;
|
|
121
|
+
/**
|
|
122
|
+
* The title of the lesson
|
|
123
|
+
*/
|
|
124
|
+
title: string;
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* A chapter from the courses app
|
|
129
|
+
*/
|
|
130
|
+
export interface CourseChapterListResponse {
|
|
131
|
+
/**
|
|
132
|
+
* The ID of the chapter. Looks like chap_XXX
|
|
133
|
+
*/
|
|
134
|
+
id: string;
|
|
135
|
+
/**
|
|
136
|
+
* The order of the chapter within its course
|
|
137
|
+
*/
|
|
138
|
+
order: number;
|
|
139
|
+
/**
|
|
140
|
+
* The title of the chapter
|
|
141
|
+
*/
|
|
142
|
+
title: string;
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* Represents `true` or `false` values.
|
|
146
|
+
*/
|
|
147
|
+
export type CourseChapterDeleteResponse = boolean;
|
|
148
|
+
export interface CourseChapterCreateParams {
|
|
149
|
+
/**
|
|
150
|
+
* The ID of the course to create the chapter in
|
|
151
|
+
*/
|
|
152
|
+
course_id: string;
|
|
153
|
+
/**
|
|
154
|
+
* The title of the chapter
|
|
155
|
+
*/
|
|
156
|
+
title?: string | null;
|
|
157
|
+
}
|
|
158
|
+
export interface CourseChapterUpdateParams {
|
|
159
|
+
/**
|
|
160
|
+
* The title of the chapter
|
|
161
|
+
*/
|
|
162
|
+
title: string;
|
|
163
|
+
}
|
|
164
|
+
export interface CourseChapterListParams extends CursorPageParams {
|
|
165
|
+
/**
|
|
166
|
+
* The ID of the course
|
|
167
|
+
*/
|
|
168
|
+
course_id: string;
|
|
169
|
+
/**
|
|
170
|
+
* Returns the elements in the list that come before the specified cursor.
|
|
171
|
+
*/
|
|
172
|
+
before?: string | null;
|
|
173
|
+
/**
|
|
174
|
+
* Returns the first _n_ elements from the list.
|
|
175
|
+
*/
|
|
176
|
+
first?: number | null;
|
|
177
|
+
/**
|
|
178
|
+
* Returns the last _n_ elements from the list.
|
|
179
|
+
*/
|
|
180
|
+
last?: number | null;
|
|
181
|
+
}
|
|
182
|
+
export declare namespace CourseChapters {
|
|
183
|
+
export { type CourseChapter as CourseChapter, type CourseChapterListResponse as CourseChapterListResponse, type CourseChapterDeleteResponse as CourseChapterDeleteResponse, type CourseChapterListResponsesCursorPage as CourseChapterListResponsesCursorPage, type CourseChapterCreateParams as CourseChapterCreateParams, type CourseChapterUpdateParams as CourseChapterUpdateParams, type CourseChapterListParams as CourseChapterListParams, };
|
|
184
|
+
}
|
|
185
|
+
//# sourceMappingURL=course-chapters.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"course-chapters.d.mts","sourceRoot":"","sources":["../src/resources/course-chapters.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAI5F;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAIzE;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAIxG;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,uBAAuB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,yBAAyB,CAAC;IAO/E;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAGtF;AAED,MAAM,MAAM,oCAAoC,GAAG,UAAU,CAAC,yBAAyB,CAAC,CAAC;AAEzF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAErC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,OAAO,CAAC;AAElD,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|