@goauthentik/api 2024.6.3-1722881330 → 2024.6.3-1723032607

package/src/models/GeoIPPolicy.ts

@@ -0,0 +1,160 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.6.3
+ * Contact: hello@goauthentik.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import type { CountryCodeEnum } from './CountryCodeEnum';
+import {
+    CountryCodeEnumFromJSON,
+    CountryCodeEnumFromJSONTyped,
+    CountryCodeEnumToJSON,
+} from './CountryCodeEnum';
+import type { DetailedCountryField } from './DetailedCountryField';
+import {
+    DetailedCountryFieldFromJSON,
+    DetailedCountryFieldFromJSONTyped,
+    DetailedCountryFieldToJSON,
+} from './DetailedCountryField';
+
+/**
+ * GeoIP Policy Serializer
+ * @export
+ * @interface GeoIPPolicy
+ */
+export interface GeoIPPolicy {
+    /**
+     * 
+     * @type {string}
+     * @memberof GeoIPPolicy
+     */
+    readonly pk: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GeoIPPolicy
+     */
+    name: string;
+    /**
+     * When this option is enabled, all executions of this policy will be logged. By default, only execution errors are logged.
+     * @type {boolean}
+     * @memberof GeoIPPolicy
+     */
+    executionLogging?: boolean;
+    /**
+     * Get object component so that we know how to edit the object
+     * @type {string}
+     * @memberof GeoIPPolicy
+     */
+    readonly component: string;
+    /**
+     * Return object's verbose_name
+     * @type {string}
+     * @memberof GeoIPPolicy
+     */
+    readonly verboseName: string;
+    /**
+     * Return object's plural verbose_name
+     * @type {string}
+     * @memberof GeoIPPolicy
+     */
+    readonly verboseNamePlural: string;
+    /**
+     * Return internal model name
+     * @type {string}
+     * @memberof GeoIPPolicy
+     */
+    readonly metaModelName: string;
+    /**
+     * Return objects policy is bound to
+     * @type {number}
+     * @memberof GeoIPPolicy
+     */
+    readonly boundTo: number;
+    /**
+     * 
+     * @type {Array<number>}
+     * @memberof GeoIPPolicy
+     */
+    asns?: Array<number>;
+    /**
+     * 
+     * @type {Array<CountryCodeEnum>}
+     * @memberof GeoIPPolicy
+     */
+    countries: Array<CountryCodeEnum>;
+    /**
+     * 
+     * @type {Array<DetailedCountryField>}
+     * @memberof GeoIPPolicy
+     */
+    readonly countriesObj: Array<DetailedCountryField>;
+}
+
+/**
+ * Check if a given object implements the GeoIPPolicy interface.
+ */
+export function instanceOfGeoIPPolicy(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "pk" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "component" in value;
+    isInstance = isInstance && "verboseName" in value;
+    isInstance = isInstance && "verboseNamePlural" in value;
+    isInstance = isInstance && "metaModelName" in value;
+    isInstance = isInstance && "boundTo" in value;
+    isInstance = isInstance && "countries" in value;
+    isInstance = isInstance && "countriesObj" in value;
+
+    return isInstance;
+}
+
+export function GeoIPPolicyFromJSON(json: any): GeoIPPolicy {
+    return GeoIPPolicyFromJSONTyped(json, false);
+}
+
+export function GeoIPPolicyFromJSONTyped(json: any, ignoreDiscriminator: boolean): GeoIPPolicy {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'pk': json['pk'],
+        'name': json['name'],
+        'executionLogging': !exists(json, 'execution_logging') ? undefined : json['execution_logging'],
+        'component': json['component'],
+        'verboseName': json['verbose_name'],
+        'verboseNamePlural': json['verbose_name_plural'],
+        'metaModelName': json['meta_model_name'],
+        'boundTo': json['bound_to'],
+        'asns': !exists(json, 'asns') ? undefined : json['asns'],
+        'countries': ((json['countries'] as Array<any>).map(CountryCodeEnumFromJSON)),
+        'countriesObj': ((json['countries_obj'] as Array<any>).map(DetailedCountryFieldFromJSON)),
+    };
+}
+
+export function GeoIPPolicyToJSON(value?: GeoIPPolicy | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'execution_logging': value.executionLogging,
+        'asns': value.asns,
+        'countries': ((value.countries as Array<any>).map(CountryCodeEnumToJSON)),
+    };
+}
+

package/src/models/GeoIPPolicyRequest.ts

@@ -0,0 +1,98 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.6.3
+ * Contact: hello@goauthentik.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import type { CountryCodeEnum } from './CountryCodeEnum';
+import {
+    CountryCodeEnumFromJSON,
+    CountryCodeEnumFromJSONTyped,
+    CountryCodeEnumToJSON,
+} from './CountryCodeEnum';
+
+/**
+ * GeoIP Policy Serializer
+ * @export
+ * @interface GeoIPPolicyRequest
+ */
+export interface GeoIPPolicyRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof GeoIPPolicyRequest
+     */
+    name: string;
+    /**
+     * When this option is enabled, all executions of this policy will be logged. By default, only execution errors are logged.
+     * @type {boolean}
+     * @memberof GeoIPPolicyRequest
+     */
+    executionLogging?: boolean;
+    /**
+     * 
+     * @type {Array<number>}
+     * @memberof GeoIPPolicyRequest
+     */
+    asns?: Array<number>;
+    /**
+     * 
+     * @type {Array<CountryCodeEnum>}
+     * @memberof GeoIPPolicyRequest
+     */
+    countries: Array<CountryCodeEnum>;
+}
+
+/**
+ * Check if a given object implements the GeoIPPolicyRequest interface.
+ */
+export function instanceOfGeoIPPolicyRequest(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "countries" in value;
+
+    return isInstance;
+}
+
+export function GeoIPPolicyRequestFromJSON(json: any): GeoIPPolicyRequest {
+    return GeoIPPolicyRequestFromJSONTyped(json, false);
+}
+
+export function GeoIPPolicyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): GeoIPPolicyRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'executionLogging': !exists(json, 'execution_logging') ? undefined : json['execution_logging'],
+        'asns': !exists(json, 'asns') ? undefined : json['asns'],
+        'countries': ((json['countries'] as Array<any>).map(CountryCodeEnumFromJSON)),
+    };
+}
+
+export function GeoIPPolicyRequestToJSON(value?: GeoIPPolicyRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'execution_logging': value.executionLogging,
+        'asns': value.asns,
+        'countries': ((value.countries as Array<any>).map(CountryCodeEnumToJSON)),
+    };
+}
+

package/src/models/ModelEnum.ts

@@ -29,6 +29,7 @@ export const ModelEnum = {
     PoliciesEventMatcherEventmatcherpolicy: 'authentik_policies_event_matcher.eventmatcherpolicy',
     PoliciesExpiryPasswordexpirypolicy: 'authentik_policies_expiry.passwordexpirypolicy',
     PoliciesExpressionExpressionpolicy: 'authentik_policies_expression.expressionpolicy',
+    PoliciesGeoipGeoippolicy: 'authentik_policies_geoip.geoippolicy',
     PoliciesPasswordPasswordpolicy: 'authentik_policies_password.passwordpolicy',
     PoliciesReputationReputationpolicy: 'authentik_policies_reputation.reputationpolicy',
     PoliciesPolicybinding: 'authentik_policies.policybinding',

package/src/models/PaginatedGeoIPPolicyList.ts

@@ -0,0 +1,88 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.6.3
+ * Contact: hello@goauthentik.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import type { GeoIPPolicy } from './GeoIPPolicy';
+import {
+    GeoIPPolicyFromJSON,
+    GeoIPPolicyFromJSONTyped,
+    GeoIPPolicyToJSON,
+} from './GeoIPPolicy';
+import type { Pagination } from './Pagination';
+import {
+    PaginationFromJSON,
+    PaginationFromJSONTyped,
+    PaginationToJSON,
+} from './Pagination';
+
+/**
+ * 
+ * @export
+ * @interface PaginatedGeoIPPolicyList
+ */
+export interface PaginatedGeoIPPolicyList {
+    /**
+     * 
+     * @type {Pagination}
+     * @memberof PaginatedGeoIPPolicyList
+     */
+    pagination: Pagination;
+    /**
+     * 
+     * @type {Array<GeoIPPolicy>}
+     * @memberof PaginatedGeoIPPolicyList
+     */
+    results: Array<GeoIPPolicy>;
+}
+
+/**
+ * Check if a given object implements the PaginatedGeoIPPolicyList interface.
+ */
+export function instanceOfPaginatedGeoIPPolicyList(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "pagination" in value;
+    isInstance = isInstance && "results" in value;
+
+    return isInstance;
+}
+
+export function PaginatedGeoIPPolicyListFromJSON(json: any): PaginatedGeoIPPolicyList {
+    return PaginatedGeoIPPolicyListFromJSONTyped(json, false);
+}
+
+export function PaginatedGeoIPPolicyListFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedGeoIPPolicyList {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'pagination': PaginationFromJSON(json['pagination']),
+        'results': ((json['results'] as Array<any>).map(GeoIPPolicyFromJSON)),
+    };
+}
+
+export function PaginatedGeoIPPolicyListToJSON(value?: PaginatedGeoIPPolicyList | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'pagination': PaginationToJSON(value.pagination),
+        'results': ((value.results as Array<any>).map(GeoIPPolicyToJSON)),
+    };
+}
+

package/src/models/PatchedGeoIPPolicyRequest.ts

@@ -0,0 +1,96 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * authentik
+ * Making authentication simple.
+ *
+ * The version of the OpenAPI document: 2024.6.3
+ * Contact: hello@goauthentik.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import type { CountryCodeEnum } from './CountryCodeEnum';
+import {
+    CountryCodeEnumFromJSON,
+    CountryCodeEnumFromJSONTyped,
+    CountryCodeEnumToJSON,
+} from './CountryCodeEnum';
+
+/**
+ * GeoIP Policy Serializer
+ * @export
+ * @interface PatchedGeoIPPolicyRequest
+ */
+export interface PatchedGeoIPPolicyRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedGeoIPPolicyRequest
+     */
+    name?: string;
+    /**
+     * When this option is enabled, all executions of this policy will be logged. By default, only execution errors are logged.
+     * @type {boolean}
+     * @memberof PatchedGeoIPPolicyRequest
+     */
+    executionLogging?: boolean;
+    /**
+     * 
+     * @type {Array<number>}
+     * @memberof PatchedGeoIPPolicyRequest
+     */
+    asns?: Array<number>;
+    /**
+     * 
+     * @type {Array<CountryCodeEnum>}
+     * @memberof PatchedGeoIPPolicyRequest
+     */
+    countries?: Array<CountryCodeEnum>;
+}
+
+/**
+ * Check if a given object implements the PatchedGeoIPPolicyRequest interface.
+ */
+export function instanceOfPatchedGeoIPPolicyRequest(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function PatchedGeoIPPolicyRequestFromJSON(json: any): PatchedGeoIPPolicyRequest {
+    return PatchedGeoIPPolicyRequestFromJSONTyped(json, false);
+}
+
+export function PatchedGeoIPPolicyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PatchedGeoIPPolicyRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': !exists(json, 'name') ? undefined : json['name'],
+        'executionLogging': !exists(json, 'execution_logging') ? undefined : json['execution_logging'],
+        'asns': !exists(json, 'asns') ? undefined : json['asns'],
+        'countries': !exists(json, 'countries') ? undefined : ((json['countries'] as Array<any>).map(CountryCodeEnumFromJSON)),
+    };
+}
+
+export function PatchedGeoIPPolicyRequestToJSON(value?: PatchedGeoIPPolicyRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'execution_logging': value.executionLogging,
+        'asns': value.asns,
+        'countries': value.countries === undefined ? undefined : ((value.countries as Array<any>).map(CountryCodeEnumToJSON)),
+    };
+}
+

package/src/models/index.ts

@@ -79,10 +79,14 @@ export * from './ConsentStageRequest';
 export * from './ContextualFlowInfo';
 export * from './ContextualFlowInfoLayoutEnum';
 export * from './Coordinate';
+export * from './CountryCodeEnum';
 export * from './CurrentBrand';
 export * from './DeniedActionEnum';
 export * from './DenyStage';
 export * from './DenyStageRequest';
+export * from './DetailedCountry';
+export * from './DetailedCountryField';
+export * from './DetailedCountryFieldRequest';
 export * from './Device';
 export * from './DeviceChallenge';
 export * from './DeviceChallengeRequest';
@@ -141,6 +145,8 @@ export * from './FlowStageBinding';
 export * from './FlowStageBindingRequest';
 export * from './FooterLink';
 export * from './GenericError';
+export * from './GeoIPPolicy';
+export * from './GeoIPPolicyRequest';
 export * from './GeoipBindingEnum';
 export * from './GoogleWorkspaceProvider';
 export * from './GoogleWorkspaceProviderGroup';
@@ -257,6 +263,7 @@ export * from './PaginatedExtraRoleObjectPermissionList';
 export * from './PaginatedExtraUserObjectPermissionList';
 export * from './PaginatedFlowList';
 export * from './PaginatedFlowStageBindingList';
+export * from './PaginatedGeoIPPolicyList';
 export * from './PaginatedGoogleWorkspaceProviderGroupList';
 export * from './PaginatedGoogleWorkspaceProviderList';
 export * from './PaginatedGoogleWorkspaceProviderMappingList';
@@ -377,6 +384,7 @@ export * from './PatchedExtraRoleObjectPermissionRequest';
 export * from './PatchedExtraUserObjectPermissionRequest';
 export * from './PatchedFlowRequest';
 export * from './PatchedFlowStageBindingRequest';
+export * from './PatchedGeoIPPolicyRequest';
 export * from './PatchedGoogleWorkspaceProviderMappingRequest';
 export * from './PatchedGoogleWorkspaceProviderRequest';
 export * from './PatchedGroupRequest';