@whop/sdk 0.0.3 → 0.0.5

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.
Files changed (165) hide show
  1. package/CHANGELOG.md +64 -0
  2. package/client.d.mts +14 -8
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +14 -8
  5. package/client.d.ts.map +1 -1
  6. package/client.js +6 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +8 -2
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/access-tokens.d.mts +58 -0
  12. package/resources/access-tokens.d.mts.map +1 -0
  13. package/resources/access-tokens.d.ts +58 -0
  14. package/resources/access-tokens.d.ts.map +1 -0
  15. package/resources/access-tokens.js +25 -0
  16. package/resources/access-tokens.js.map +1 -0
  17. package/resources/access-tokens.mjs +21 -0
  18. package/resources/access-tokens.mjs.map +1 -0
  19. package/resources/app-builds.d.mts +16 -13
  20. package/resources/app-builds.d.mts.map +1 -1
  21. package/resources/app-builds.d.ts +16 -13
  22. package/resources/app-builds.d.ts.map +1 -1
  23. package/resources/app-builds.js +1 -1
  24. package/resources/app-builds.mjs +1 -1
  25. package/resources/apps.d.mts +15 -10
  26. package/resources/apps.d.mts.map +1 -1
  27. package/resources/apps.d.ts +15 -10
  28. package/resources/apps.d.ts.map +1 -1
  29. package/resources/checkout-configurations.d.mts +221 -183
  30. package/resources/checkout-configurations.d.mts.map +1 -1
  31. package/resources/checkout-configurations.d.ts +221 -183
  32. package/resources/checkout-configurations.d.ts.map +1 -1
  33. package/resources/checkout-configurations.js +4 -20
  34. package/resources/checkout-configurations.js.map +1 -1
  35. package/resources/checkout-configurations.mjs +4 -20
  36. package/resources/checkout-configurations.mjs.map +1 -1
  37. package/resources/companies.d.mts +157 -0
  38. package/resources/companies.d.mts.map +1 -1
  39. package/resources/companies.d.ts +157 -0
  40. package/resources/companies.d.ts.map +1 -1
  41. package/resources/companies.js +22 -0
  42. package/resources/companies.js.map +1 -1
  43. package/resources/companies.mjs +22 -0
  44. package/resources/companies.mjs.map +1 -1
  45. package/resources/course-lesson-interactions.d.mts +2 -2
  46. package/resources/course-lesson-interactions.d.ts +2 -2
  47. package/resources/course-lesson-interactions.js +2 -2
  48. package/resources/course-lesson-interactions.mjs +2 -2
  49. package/resources/course-lessons.d.mts +184 -24
  50. package/resources/course-lessons.d.mts.map +1 -1
  51. package/resources/course-lessons.d.ts +184 -24
  52. package/resources/course-lessons.d.ts.map +1 -1
  53. package/resources/course-students.d.mts +187 -0
  54. package/resources/course-students.d.mts.map +1 -0
  55. package/resources/course-students.d.ts +187 -0
  56. package/resources/course-students.d.ts.map +1 -0
  57. package/resources/course-students.js +36 -0
  58. package/resources/course-students.js.map +1 -0
  59. package/resources/course-students.mjs +32 -0
  60. package/resources/course-students.mjs.map +1 -0
  61. package/resources/courses.d.mts +85 -21
  62. package/resources/courses.d.mts.map +1 -1
  63. package/resources/courses.d.ts +85 -21
  64. package/resources/courses.d.ts.map +1 -1
  65. package/resources/entries.d.mts +2 -2
  66. package/resources/entries.d.ts +2 -2
  67. package/resources/experiences.d.mts +15 -10
  68. package/resources/experiences.d.mts.map +1 -1
  69. package/resources/experiences.d.ts +15 -10
  70. package/resources/experiences.d.ts.map +1 -1
  71. package/resources/forum-posts.d.mts +29 -19
  72. package/resources/forum-posts.d.mts.map +1 -1
  73. package/resources/forum-posts.d.ts +29 -19
  74. package/resources/forum-posts.d.ts.map +1 -1
  75. package/resources/index.d.mts +6 -4
  76. package/resources/index.d.mts.map +1 -1
  77. package/resources/index.d.ts +6 -4
  78. package/resources/index.d.ts.map +1 -1
  79. package/resources/index.js +5 -1
  80. package/resources/index.js.map +1 -1
  81. package/resources/index.mjs +3 -1
  82. package/resources/index.mjs.map +1 -1
  83. package/resources/invoices.d.mts +539 -167
  84. package/resources/invoices.d.mts.map +1 -1
  85. package/resources/invoices.d.ts +539 -167
  86. package/resources/invoices.d.ts.map +1 -1
  87. package/resources/invoices.js +2 -24
  88. package/resources/invoices.js.map +1 -1
  89. package/resources/invoices.mjs +2 -24
  90. package/resources/invoices.mjs.map +1 -1
  91. package/resources/ledger-accounts.d.mts +1 -1
  92. package/resources/ledger-accounts.d.ts +1 -1
  93. package/resources/ledger-accounts.js +1 -1
  94. package/resources/ledger-accounts.mjs +1 -1
  95. package/resources/members.d.mts +11 -11
  96. package/resources/members.d.mts.map +1 -1
  97. package/resources/members.d.ts +11 -11
  98. package/resources/members.d.ts.map +1 -1
  99. package/resources/memberships.d.mts +4 -4
  100. package/resources/memberships.d.mts.map +1 -1
  101. package/resources/memberships.d.ts +4 -4
  102. package/resources/memberships.d.ts.map +1 -1
  103. package/resources/messages.d.mts +29 -19
  104. package/resources/messages.d.mts.map +1 -1
  105. package/resources/messages.d.ts +29 -19
  106. package/resources/messages.d.ts.map +1 -1
  107. package/resources/payments.d.mts +10 -3
  108. package/resources/payments.d.mts.map +1 -1
  109. package/resources/payments.d.ts +10 -3
  110. package/resources/payments.d.ts.map +1 -1
  111. package/resources/plans.d.mts +118 -20
  112. package/resources/plans.d.mts.map +1 -1
  113. package/resources/plans.d.ts +118 -20
  114. package/resources/plans.d.ts.map +1 -1
  115. package/resources/plans.js.map +1 -1
  116. package/resources/plans.mjs.map +1 -1
  117. package/resources/products.d.mts +20 -15
  118. package/resources/products.d.mts.map +1 -1
  119. package/resources/products.d.ts +20 -15
  120. package/resources/products.d.ts.map +1 -1
  121. package/resources/promo-codes.d.mts +4 -4
  122. package/resources/promo-codes.d.ts +4 -4
  123. package/resources/shared.d.mts +69 -20
  124. package/resources/shared.d.mts.map +1 -1
  125. package/resources/shared.d.ts +69 -20
  126. package/resources/shared.d.ts.map +1 -1
  127. package/resources/transfers.d.mts +12 -0
  128. package/resources/transfers.d.mts.map +1 -1
  129. package/resources/transfers.d.ts +12 -0
  130. package/resources/transfers.d.ts.map +1 -1
  131. package/resources/users.d.mts +3 -0
  132. package/resources/users.d.mts.map +1 -1
  133. package/resources/users.d.ts +3 -0
  134. package/resources/users.d.ts.map +1 -1
  135. package/src/client.ts +45 -10
  136. package/src/resources/access-tokens.ts +72 -0
  137. package/src/resources/app-builds.ts +19 -14
  138. package/src/resources/apps.ts +16 -11
  139. package/src/resources/checkout-configurations.ts +245 -199
  140. package/src/resources/companies.ts +196 -0
  141. package/src/resources/course-lesson-interactions.ts +2 -2
  142. package/src/resources/course-lessons.ts +223 -24
  143. package/src/resources/course-students.ts +238 -0
  144. package/src/resources/courses.ts +104 -22
  145. package/src/resources/entries.ts +2 -2
  146. package/src/resources/experiences.ts +19 -11
  147. package/src/resources/forum-posts.ts +35 -21
  148. package/src/resources/index.ts +17 -2
  149. package/src/resources/invoices.ts +630 -171
  150. package/src/resources/ledger-accounts.ts +1 -1
  151. package/src/resources/members.ts +12 -12
  152. package/src/resources/memberships.ts +5 -5
  153. package/src/resources/messages.ts +35 -21
  154. package/src/resources/payments.ts +10 -3
  155. package/src/resources/plans.ts +130 -20
  156. package/src/resources/products.ts +24 -16
  157. package/src/resources/promo-codes.ts +4 -4
  158. package/src/resources/shared.ts +70 -20
  159. package/src/resources/transfers.ts +10 -0
  160. package/src/resources/users.ts +3 -0
  161. package/src/version.ts +1 -1
  162. package/version.d.mts +1 -1
  163. package/version.d.ts +1 -1
  164. package/version.js +1 -1
  165. 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;CAG3E"}
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"}
@@ -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;CAG3E"}
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"}
@@ -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;AAI/C,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;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;CACF;AAXD,8BAWC"}
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"}
@@ -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;OAIf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;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;CACF"}
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"}
@@ -10,8 +10,8 @@ export declare class CourseLessonInteractions extends APIResource {
10
10
  *
11
11
  * Required permissions:
12
12
  *
13
- * - `course_lesson_interaction:read`
14
13
  * - `courses:read`
14
+ * - `course_analytics:read`
15
15
  */
16
16
  retrieve(id: string, options?: RequestOptions): APIPromise<Shared.CourseLessonInteraction>;
17
17
  /**
@@ -19,8 +19,8 @@ export declare class CourseLessonInteractions extends APIResource {
19
19
  *
20
20
  * Required permissions:
21
21
  *
22
- * - `course_lesson_interaction:read`
23
22
  * - `courses:read`
23
+ * - `course_analytics:read`
24
24
  */
25
25
  list(query?: CourseLessonInteractionListParams | null | undefined, options?: RequestOptions): PagePromise<CourseLessonInteractionListItemsCursorPage, Shared.CourseLessonInteractionListItem>;
26
26
  }
@@ -10,8 +10,8 @@ export declare class CourseLessonInteractions extends APIResource {
10
10
  *
11
11
  * Required permissions:
12
12
  *
13
- * - `course_lesson_interaction:read`
14
13
  * - `courses:read`
14
+ * - `course_analytics:read`
15
15
  */
16
16
  retrieve(id: string, options?: RequestOptions): APIPromise<Shared.CourseLessonInteraction>;
17
17
  /**
@@ -19,8 +19,8 @@ export declare class CourseLessonInteractions extends APIResource {
19
19
  *
20
20
  * Required permissions:
21
21
  *
22
- * - `course_lesson_interaction:read`
23
22
  * - `courses:read`
23
+ * - `course_analytics:read`
24
24
  */
25
25
  list(query?: CourseLessonInteractionListParams | null | undefined, options?: RequestOptions): PagePromise<CourseLessonInteractionListItemsCursorPage, Shared.CourseLessonInteractionListItem>;
26
26
  }
@@ -11,8 +11,8 @@ class CourseLessonInteractions extends resource_1.APIResource {
11
11
  *
12
12
  * Required permissions:
13
13
  *
14
- * - `course_lesson_interaction:read`
15
14
  * - `courses:read`
15
+ * - `course_analytics:read`
16
16
  */
17
17
  retrieve(id, options) {
18
18
  return this._client.get((0, path_1.path) `/course_lesson_interactions/${id}`, options);
@@ -22,8 +22,8 @@ class CourseLessonInteractions extends resource_1.APIResource {
22
22
  *
23
23
  * Required permissions:
24
24
  *
25
- * - `course_lesson_interaction:read`
26
25
  * - `courses:read`
26
+ * - `course_analytics:read`
27
27
  */
28
28
  list(query = {}, options) {
29
29
  return this._client.getAPIList('/course_lesson_interactions', (pagination_1.CursorPage), { query, ...options });
@@ -8,8 +8,8 @@ export class CourseLessonInteractions extends APIResource {
8
8
  *
9
9
  * Required permissions:
10
10
  *
11
- * - `course_lesson_interaction:read`
12
11
  * - `courses:read`
12
+ * - `course_analytics:read`
13
13
  */
14
14
  retrieve(id, options) {
15
15
  return this._client.get(path `/course_lesson_interactions/${id}`, options);
@@ -19,8 +19,8 @@ export class CourseLessonInteractions extends APIResource {
19
19
  *
20
20
  * Required permissions:
21
21
  *
22
- * - `course_lesson_interaction:read`
23
22
  * - `courses:read`
23
+ * - `course_analytics:read`
24
24
  */
25
25
  list(query = {}, options) {
26
26
  return this._client.getAPIList('/course_lesson_interactions', (CursorPage), { query, ...options });