Skip to content

Commit 558c2e6

Browse files
chore: generate Open API types
1 parent 00ddf20 commit 558c2e6

File tree

4 files changed

+238
-21
lines changed

4 files changed

+238
-21
lines changed

src/types/enterprise-access.openapi.d.ts

Lines changed: 109 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,20 @@ export interface paths {
295295
*/
296296
get: operations["api_v1_learner_credit_requests_retrieve"];
297297
};
298+
"/api/v1/learner-credit-requests/approve/": {
299+
/**
300+
* Approve a learner credit request.
301+
* @description Approve a learner credit request.
302+
*/
303+
post: operations["api_v1_learner_credit_requests_approve_create"];
304+
};
305+
"/api/v1/learner-credit-requests/cancel/": {
306+
/**
307+
* Learner credit request cancel endpoint.
308+
* @description Cancel a learner credit request.
309+
*/
310+
post: operations["api_v1_learner_credit_requests_cancel_create"];
311+
};
298312
"/api/v1/learner-credit-requests/decline/": {
299313
/**
300314
* Decline a learner credit request.
@@ -309,6 +323,10 @@ export interface paths {
309323
*/
310324
get: operations["api_v1_learner_credit_requests_overview_retrieve"];
311325
};
326+
"/api/v1/learner-credit-requests/remind/": {
327+
/** @description Remind a Learner that their LearnerCreditRequest is Approved and waiting for their action. */
328+
post: operations["api_v1_learner_credit_requests_remind_create"];
329+
};
312330
"/api/v1/license-requests/": {
313331
/**
314332
* License request list.
@@ -1489,7 +1507,6 @@ export interface components {
14891507
active_enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
14901508
staff_enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
14911509
should_update_active_enterprise_customer_user: boolean;
1492-
secured_algolia_api_key?: string | null;
14931510
/** @description Mapping of catalog UUIDs to catalog query UUIDs. */
14941511
catalog_uuids_to_catalog_query_uuids: {
14951512
[key: string]: string;
@@ -1835,6 +1852,37 @@ export interface components {
18351852
course_price?: number | null;
18361853
latest_action: string;
18371854
};
1855+
/**
1856+
* @description Request Serializer to validate subsidy-request ``approve`` endpoint POST data.
1857+
*
1858+
* For view: LearnerCreditRequestViewSet.approve
1859+
*/
1860+
LearnerCreditRequestApproveRequest: {
1861+
/**
1862+
* Format: uuid
1863+
* @description The UUID of the policy to which the request belongs.
1864+
*/
1865+
policy_uuid: string;
1866+
/**
1867+
* Format: uuid
1868+
* @description The UUID of the Enterprise Customer.
1869+
*/
1870+
enterprise_customer_uuid: string;
1871+
/**
1872+
* Format: uuid
1873+
* @description The UUID of the LearnerCreditRequest to be approved.
1874+
*/
1875+
learner_credit_request_uuid: string;
1876+
};
1877+
/**
1878+
* @description Request serializer to validate cancel endpoint query params.
1879+
*
1880+
* For view: LearnerCreditRequestViewSet.cancel
1881+
*/
1882+
LearnerCreditRequestCancel: {
1883+
/** Format: uuid */
1884+
request_uuid: string;
1885+
};
18381886
/** @description Serializer for declining a learner credit request. */
18391887
LearnerCreditRequestDecline: {
18401888
/**
@@ -1872,7 +1920,6 @@ export interface components {
18721920
active_enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
18731921
staff_enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
18741922
should_update_active_enterprise_customer_user: boolean;
1875-
secured_algolia_api_key?: string | null;
18761923
/** @description Mapping of catalog UUIDs to catalog query UUIDs. */
18771924
catalog_uuids_to_catalog_query_uuids: {
18781925
[key: string]: string;
@@ -1912,7 +1959,6 @@ export interface components {
19121959
active_enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
19131960
staff_enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
19141961
should_update_active_enterprise_customer_user: boolean;
1915-
secured_algolia_api_key?: string | null;
19161962
/** @description Mapping of catalog UUIDs to catalog query UUIDs. */
19171963
catalog_uuids_to_catalog_query_uuids: {
19181964
[key: string]: string;
@@ -1942,7 +1988,6 @@ export interface components {
19421988
active_enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
19431989
staff_enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
19441990
should_update_active_enterprise_customer_user: boolean;
1945-
secured_algolia_api_key?: string | null;
19461991
/** @description Mapping of catalog UUIDs to catalog query UUIDs. */
19471992
catalog_uuids_to_catalog_query_uuids: {
19481993
[key: string]: string;
@@ -2551,11 +2596,11 @@ export interface components {
25512596
* @description Total Amount redeemed for policy, in USD.
25522597
*/
25532598
amount_redeemed_usd: number;
2554-
/** @description Total amount allocated for policies of type AssignedLearnerCreditAccessPolicy (0 otherwise), in positive USD cents. */
2599+
/** @description Total amount allocated for policies of type AssignedLearnerCreditAccessPolicy or {PolicyTypes.PER_LEARNER_SPEND_CREDIT} (0 otherwise), in positive USD cents. */
25552600
amount_allocated_usd_cents: number;
25562601
/**
25572602
* Format: double
2558-
* @description ('Total amount allocated for policies of type AssignedLearnerCreditAccessPolicy (0 otherwise), in USD.',)
2603+
* @description ('Total amount allocated for policies of type AssignedLearnerCreditAccessPolicy or ', '{PolicyTypes.PER_LEARNER_SPEND_CREDIT} (0 otherwise), in USD.')
25592604
*/
25602605
amount_allocated_usd: number;
25612606
/** @description Total Amount of available spend for policy, in positive USD cents. */
@@ -4052,6 +4097,7 @@ export interface operations {
40524097
page?: number;
40534098
/** @description Number of results to return per page. */
40544099
page_size?: number;
4100+
policy_uuid?: string;
40554101
/** @description A search term. */
40564102
search?: string;
40574103
user__email?: string;
@@ -4105,6 +4151,46 @@ export interface operations {
41054151
};
41064152
};
41074153
};
4154+
/**
4155+
* Approve a learner credit request.
4156+
* @description Approve a learner credit request.
4157+
*/
4158+
api_v1_learner_credit_requests_approve_create: {
4159+
requestBody: {
4160+
content: {
4161+
"application/json": components["schemas"]["LearnerCreditRequestApproveRequest"];
4162+
"application/x-www-form-urlencoded": components["schemas"]["LearnerCreditRequestApproveRequest"];
4163+
"multipart/form-data": components["schemas"]["LearnerCreditRequestApproveRequest"];
4164+
};
4165+
};
4166+
responses: {
4167+
200: {
4168+
content: {
4169+
"application/json": components["schemas"]["LearnerCreditRequest"];
4170+
};
4171+
};
4172+
};
4173+
};
4174+
/**
4175+
* Learner credit request cancel endpoint.
4176+
* @description Cancel a learner credit request.
4177+
*/
4178+
api_v1_learner_credit_requests_cancel_create: {
4179+
requestBody: {
4180+
content: {
4181+
"application/json": components["schemas"]["LearnerCreditRequestCancel"];
4182+
"application/x-www-form-urlencoded": components["schemas"]["LearnerCreditRequestCancel"];
4183+
"multipart/form-data": components["schemas"]["LearnerCreditRequestCancel"];
4184+
};
4185+
};
4186+
responses: {
4187+
200: {
4188+
content: {
4189+
"application/json": components["schemas"]["LearnerCreditRequestCancel"];
4190+
};
4191+
};
4192+
};
4193+
};
41084194
/**
41094195
* Decline a learner credit request.
41104196
* @description Action of declining a Learner Credit Subsidy Request
@@ -4138,6 +4224,23 @@ export interface operations {
41384224
};
41394225
};
41404226
};
4227+
/** @description Remind a Learner that their LearnerCreditRequest is Approved and waiting for their action. */
4228+
api_v1_learner_credit_requests_remind_create: {
4229+
requestBody: {
4230+
content: {
4231+
"application/json": components["schemas"]["LearnerCreditRequest"];
4232+
"application/x-www-form-urlencoded": components["schemas"]["LearnerCreditRequest"];
4233+
"multipart/form-data": components["schemas"]["LearnerCreditRequest"];
4234+
};
4235+
};
4236+
responses: {
4237+
200: {
4238+
content: {
4239+
"application/json": components["schemas"]["LearnerCreditRequest"];
4240+
};
4241+
};
4242+
};
4243+
};
41414244
/**
41424245
* License request list.
41434246
* @description Viewset for license requests

src/types/enterprise-subsidy.openapi.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -954,6 +954,7 @@ export interface operations {
954954
subsidy_access_policy_uuid?: string;
955955
};
956956
path: {
957+
/** @description A UUID string identifying this Subsidy. */
957958
uuid: string;
958959
};
959960
};

0 commit comments

Comments
 (0)