Skip to content

Commit 7004862

Browse files
chore: generate Open API types
1 parent 2757b96 commit 7004862

File tree

2 files changed

+293
-45
lines changed

2 files changed

+293
-45
lines changed

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

Lines changed: 127 additions & 18 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.
@@ -1484,20 +1502,19 @@ export interface components {
14841502
LearnerAcademyResponse: {
14851503
errors?: components["schemas"]["Error"][];
14861504
warnings?: components["schemas"]["Warning"][];
1505+
enterprise_features?: {
1506+
[key: string]: unknown;
1507+
};
14871508
enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
14881509
all_linked_enterprise_customer_users?: components["schemas"]["EnterpriseCustomerUser"][];
14891510
active_enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
14901511
staff_enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
14911512
should_update_active_enterprise_customer_user: boolean;
1492-
secured_algolia_api_key?: string | null;
14931513
/** @description Mapping of catalog UUIDs to catalog query UUIDs. */
14941514
catalog_uuids_to_catalog_query_uuids: {
14951515
[key: string]: string;
14961516
};
14971517
algolia?: components["schemas"]["SecuredAlgoliaMetadata"] | null;
1498-
enterprise_features?: {
1499-
[key: string]: unknown;
1500-
};
15011518
enterprise_customer_user_subsidies: components["schemas"]["EnterpriseCustomerUserSubsidies"];
15021519
};
15031520
/** @description A read-only Serializer for responding to requests for ``LearnerContentAssignmentAction`` records. */
@@ -1834,6 +1851,39 @@ export interface components {
18341851
/** @description Cost of the content in USD Cents. */
18351852
course_price?: number | null;
18361853
latest_action: string;
1854+
/** @description Computed state based on action status and error conditions. Returns 'waiting' for approved/reminded actions without errors, 'failed' for actions with error_reason, or the actual status otherwise */
1855+
learner_request_state: string;
1856+
};
1857+
/**
1858+
* @description Request Serializer to validate subsidy-request ``approve`` endpoint POST data.
1859+
*
1860+
* For view: LearnerCreditRequestViewSet.approve
1861+
*/
1862+
LearnerCreditRequestApproveRequest: {
1863+
/**
1864+
* Format: uuid
1865+
* @description The UUID of the policy to which the request belongs.
1866+
*/
1867+
policy_uuid: string;
1868+
/**
1869+
* Format: uuid
1870+
* @description The UUID of the Enterprise Customer.
1871+
*/
1872+
enterprise_customer_uuid: string;
1873+
/**
1874+
* Format: uuid
1875+
* @description The UUID of the LearnerCreditRequest to be approved.
1876+
*/
1877+
learner_credit_request_uuid: string;
1878+
};
1879+
/**
1880+
* @description Request serializer to validate cancel endpoint query params.
1881+
*
1882+
* For view: LearnerCreditRequestViewSet.cancel
1883+
*/
1884+
LearnerCreditRequestCancel: {
1885+
/** Format: uuid */
1886+
request_uuid: string;
18371887
};
18381888
/** @description Serializer for declining a learner credit request. */
18391889
LearnerCreditRequestDecline: {
@@ -1867,20 +1917,19 @@ export interface components {
18671917
LearnerDashboardResponse: {
18681918
errors?: components["schemas"]["Error"][];
18691919
warnings?: components["schemas"]["Warning"][];
1920+
enterprise_features?: {
1921+
[key: string]: unknown;
1922+
};
18701923
enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
18711924
all_linked_enterprise_customer_users?: components["schemas"]["EnterpriseCustomerUser"][];
18721925
active_enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
18731926
staff_enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
18741927
should_update_active_enterprise_customer_user: boolean;
1875-
secured_algolia_api_key?: string | null;
18761928
/** @description Mapping of catalog UUIDs to catalog query UUIDs. */
18771929
catalog_uuids_to_catalog_query_uuids: {
18781930
[key: string]: string;
18791931
};
18801932
algolia?: components["schemas"]["SecuredAlgoliaMetadata"] | null;
1881-
enterprise_features?: {
1882-
[key: string]: unknown;
1883-
};
18841933
enterprise_customer_user_subsidies: components["schemas"]["EnterpriseCustomerUserSubsidies"];
18851934
enterprise_course_enrollments: components["schemas"]["EnterpriseCourseEnrollment"][];
18861935
all_enrollments_by_status: components["schemas"]["LearnerEnrollmentsByStatus"];
@@ -1907,20 +1956,19 @@ export interface components {
19071956
LearnerSearchResponse: {
19081957
errors?: components["schemas"]["Error"][];
19091958
warnings?: components["schemas"]["Warning"][];
1959+
enterprise_features?: {
1960+
[key: string]: unknown;
1961+
};
19101962
enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
19111963
all_linked_enterprise_customer_users?: components["schemas"]["EnterpriseCustomerUser"][];
19121964
active_enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
19131965
staff_enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
19141966
should_update_active_enterprise_customer_user: boolean;
1915-
secured_algolia_api_key?: string | null;
19161967
/** @description Mapping of catalog UUIDs to catalog query UUIDs. */
19171968
catalog_uuids_to_catalog_query_uuids: {
19181969
[key: string]: string;
19191970
};
19201971
algolia?: components["schemas"]["SecuredAlgoliaMetadata"] | null;
1921-
enterprise_features?: {
1922-
[key: string]: unknown;
1923-
};
19241972
enterprise_customer_user_subsidies: components["schemas"]["EnterpriseCustomerUserSubsidies"];
19251973
};
19261974
/** @description Serializer for the learner skills quiz request. */
@@ -1937,20 +1985,19 @@ export interface components {
19371985
LearnerSkillsQuizResponse: {
19381986
errors?: components["schemas"]["Error"][];
19391987
warnings?: components["schemas"]["Warning"][];
1988+
enterprise_features?: {
1989+
[key: string]: unknown;
1990+
};
19401991
enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
19411992
all_linked_enterprise_customer_users?: components["schemas"]["EnterpriseCustomerUser"][];
19421993
active_enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
19431994
staff_enterprise_customer?: components["schemas"]["EnterpriseCustomer"] | null;
19441995
should_update_active_enterprise_customer_user: boolean;
1945-
secured_algolia_api_key?: string | null;
19461996
/** @description Mapping of catalog UUIDs to catalog query UUIDs. */
19471997
catalog_uuids_to_catalog_query_uuids: {
19481998
[key: string]: string;
19491999
};
19502000
algolia?: components["schemas"]["SecuredAlgoliaMetadata"] | null;
1951-
enterprise_features?: {
1952-
[key: string]: unknown;
1953-
};
19542001
enterprise_customer_user_subsidies: components["schemas"]["EnterpriseCustomerUserSubsidies"];
19552002
};
19562003
/**
@@ -2551,11 +2598,11 @@ export interface components {
25512598
* @description Total Amount redeemed for policy, in USD.
25522599
*/
25532600
amount_redeemed_usd: number;
2554-
/** @description Total amount allocated for policies of type AssignedLearnerCreditAccessPolicy (0 otherwise), in positive USD cents. */
2601+
/** @description Total amount allocated for policies of type AssignedLearnerCreditAccessPolicy or {PolicyTypes.PER_LEARNER_SPEND_CREDIT} (0 otherwise), in positive USD cents. */
25552602
amount_allocated_usd_cents: number;
25562603
/**
25572604
* Format: double
2558-
* @description ('Total amount allocated for policies of type AssignedLearnerCreditAccessPolicy (0 otherwise), in USD.',)
2605+
* @description ('Total amount allocated for policies of type AssignedLearnerCreditAccessPolicy or ', '{PolicyTypes.PER_LEARNER_SPEND_CREDIT} (0 otherwise), in USD.')
25592606
*/
25602607
amount_allocated_usd: number;
25612608
/** @description Total Amount of available spend for policy, in positive USD cents. */
@@ -4046,12 +4093,17 @@ export interface operations {
40464093
query?: {
40474094
course_id?: string;
40484095
enterprise_customer_uuid?: string;
4096+
/** @description Choose from the following valid action statuses: requested, pending, approved, declined, error, accepted, cancelled, expired, reversed, reminded */
4097+
latest_action_status?: string;
4098+
/** @description Choose from the following valid action statuses: requested, pending, approved, declined, error, accepted, cancelled, expired, reversed, reminded */
4099+
latest_action_status__in?: string[];
40494100
/** @description Which field to use when ordering the results. */
40504101
ordering?: string;
40514102
/** @description A page number within the paginated result set. */
40524103
page?: number;
40534104
/** @description Number of results to return per page. */
40544105
page_size?: number;
4106+
policy_uuid?: string;
40554107
/** @description A search term. */
40564108
search?: string;
40574109
user__email?: string;
@@ -4105,6 +4157,46 @@ export interface operations {
41054157
};
41064158
};
41074159
};
4160+
/**
4161+
* Approve a learner credit request.
4162+
* @description Approve a learner credit request.
4163+
*/
4164+
api_v1_learner_credit_requests_approve_create: {
4165+
requestBody: {
4166+
content: {
4167+
"application/json": components["schemas"]["LearnerCreditRequestApproveRequest"];
4168+
"application/x-www-form-urlencoded": components["schemas"]["LearnerCreditRequestApproveRequest"];
4169+
"multipart/form-data": components["schemas"]["LearnerCreditRequestApproveRequest"];
4170+
};
4171+
};
4172+
responses: {
4173+
200: {
4174+
content: {
4175+
"application/json": components["schemas"]["LearnerCreditRequest"];
4176+
};
4177+
};
4178+
};
4179+
};
4180+
/**
4181+
* Learner credit request cancel endpoint.
4182+
* @description Cancel a learner credit request.
4183+
*/
4184+
api_v1_learner_credit_requests_cancel_create: {
4185+
requestBody: {
4186+
content: {
4187+
"application/json": components["schemas"]["LearnerCreditRequestCancel"];
4188+
"application/x-www-form-urlencoded": components["schemas"]["LearnerCreditRequestCancel"];
4189+
"multipart/form-data": components["schemas"]["LearnerCreditRequestCancel"];
4190+
};
4191+
};
4192+
responses: {
4193+
200: {
4194+
content: {
4195+
"application/json": components["schemas"]["LearnerCreditRequestCancel"];
4196+
};
4197+
};
4198+
};
4199+
};
41084200
/**
41094201
* Decline a learner credit request.
41104202
* @description Action of declining a Learner Credit Subsidy Request
@@ -4138,6 +4230,23 @@ export interface operations {
41384230
};
41394231
};
41404232
};
4233+
/** @description Remind a Learner that their LearnerCreditRequest is Approved and waiting for their action. */
4234+
api_v1_learner_credit_requests_remind_create: {
4235+
requestBody: {
4236+
content: {
4237+
"application/json": components["schemas"]["LearnerCreditRequest"];
4238+
"application/x-www-form-urlencoded": components["schemas"]["LearnerCreditRequest"];
4239+
"multipart/form-data": components["schemas"]["LearnerCreditRequest"];
4240+
};
4241+
};
4242+
responses: {
4243+
200: {
4244+
content: {
4245+
"application/json": components["schemas"]["LearnerCreditRequest"];
4246+
};
4247+
};
4248+
};
4249+
};
41414250
/**
41424251
* License request list.
41434252
* @description Viewset for license requests

0 commit comments

Comments
 (0)