@pitcher/js-api 1.22.0-alpha.1 → 1.22.0-alpha.2

package/types/types/openapi/models/Organization.d.ts

@@ -1,10 +0,0 @@
-import { OrganizationBranding } from './OrganizationBranding';
-
-export type Organization = {
-    readonly id: string;
-    readonly name: string;
-    readonly display_name: string;
-    readonly branding: OrganizationBranding;
-    readonly metadata: Record<string, any>;
-    readonly settings: Record<string, any>;
-};

package/types/types/openapi/models/OrganizationAnalytics.d.ts

@@ -1,16 +0,0 @@
-import { OrganizationAnalyticsCurrentPeriod } from './OrganizationAnalyticsCurrentPeriod';
-import { OrganizationAnalyticsLoginResult } from './OrganizationAnalyticsLoginResult';
-import { OrganizationChangePercentages } from './OrganizationChangePercentages';
-
-export type OrganizationAnalytics = {
-    readonly current_period: OrganizationAnalyticsCurrentPeriod;
-    readonly logins_results: Array<OrganizationAnalyticsLoginResult>;
-    readonly percentages: OrganizationChangePercentages;
-    /**
-     * Total storage in bytes
-     */
-    readonly total_storage: number;
-    readonly total_instances: number;
-    readonly total_files: number;
-    readonly total_users: number;
-};

package/types/types/openapi/models/OrganizationAnalyticsCurrentPeriod.d.ts

@@ -1,13 +0,0 @@
-import { OrganizationAnalyticsInactiveUsers } from './OrganizationAnalyticsInactiveUsers';
-import { OrganizationAnalyticsInstance } from './OrganizationAnalyticsInstance';
-import { OrganizationAnalyticsTop3Instances } from './OrganizationAnalyticsTop3Instances';
-
-export type OrganizationAnalyticsCurrentPeriod = {
-    readonly org_unique_total_logins: number;
-    readonly total_logins: number;
-    readonly total_inactive_instances: number;
-    readonly total_inactive_users: number;
-    readonly top3_instances: Array<OrganizationAnalyticsTop3Instances>;
-    readonly inactive_instances: Array<OrganizationAnalyticsInstance>;
-    readonly inactive_users: Array<OrganizationAnalyticsInactiveUsers>;
-};

package/types/types/openapi/models/OrganizationAnalyticsInactiveUsers.d.ts

@@ -1,5 +0,0 @@
-export type OrganizationAnalyticsInactiveUsers = {
-    id: number;
-    name: string;
-    readonly last_login: string;
-};

package/types/types/openapi/models/OrganizationAnalyticsInactiveUsersRequest.d.ts

@@ -1,4 +0,0 @@
-export type OrganizationAnalyticsInactiveUsersRequest = {
-    id: number;
-    name: string;
-};

package/types/types/openapi/models/OrganizationAnalyticsInstance.d.ts

@@ -1,10 +0,0 @@
-import { MiniEnvironment } from './MiniEnvironment';
-import { MiniRegion } from './MiniRegion';
-
-export type OrganizationAnalyticsInstance = {
-    readonly id: string;
-    readonly name: string;
-    readonly region: MiniRegion;
-    readonly environment: MiniEnvironment;
-    readonly last_login: string;
-};

package/types/types/openapi/models/OrganizationAnalyticsLoginResult.d.ts

@@ -1,5 +0,0 @@
-export type OrganizationAnalyticsLoginResult = {
-    readonly date: string;
-    readonly logins_current_period: number;
-    readonly logins_previous_period: number;
-};

package/types/types/openapi/models/OrganizationAnalyticsTop3Instances.d.ts

@@ -1,13 +0,0 @@
-import { MiniEnvironment } from './MiniEnvironment';
-import { MiniRegion } from './MiniRegion';
-
-export type OrganizationAnalyticsTop3Instances = {
-    readonly id: string;
-    readonly name: string;
-    readonly region: MiniRegion;
-    readonly environment: MiniEnvironment;
-    readonly last_login: string;
-    readonly current_login_rate: number;
-    readonly percentage_login_rate: number;
-    readonly total_users: number;
-};

package/types/types/openapi/models/OrganizationBranding.d.ts

@@ -1,6 +0,0 @@
-import { OrganizationBrandingColors } from './OrganizationBrandingColors';
-
-export type OrganizationBranding = {
-    logo_url?: string;
-    colors?: OrganizationBrandingColors | null;
-};

package/types/types/openapi/models/OrganizationBrandingColors.d.ts

@@ -1,4 +0,0 @@
-export type OrganizationBrandingColors = {
-    primary?: string;
-    page_background?: string;
-};

package/types/types/openapi/models/OrganizationChangePercentages.d.ts

@@ -1,6 +0,0 @@
-export type OrganizationChangePercentages = {
-    readonly org_unique_logins_change: number;
-    readonly inactive_instances_change: number;
-    readonly logins_change: number;
-    readonly inactive_users_change: number;
-};

package/types/types/openapi/models/OrganizationUpdate.d.ts

@@ -1,8 +0,0 @@
-export type OrganizationUpdate = {
-    name?: string;
-    display_name?: string;
-    logo_url?: string;
-    primary_color?: string;
-    page_background_color?: string;
-    settings?: Record<string, any> | null;
-};

package/types/types/openapi/models/OrganizationUpdateRequest.d.ts

@@ -1,8 +0,0 @@
-export type OrganizationUpdateRequest = {
-    name?: string;
-    display_name?: string;
-    logo_url?: string;
-    primary_color?: string;
-    page_background_color?: string;
-    settings?: Record<string, any> | null;
-};

package/types/types/openapi/models/PSPDFKitAuthPayload.d.ts

@@ -1,3 +0,0 @@
-export type PSPDFKitAuthPayload = {
-    jwt: string;
-};

package/types/types/openapi/models/PSPDFKitAuthPayloadRequest.d.ts

@@ -1,3 +0,0 @@
-export type PSPDFKitAuthPayloadRequest = {
-    jwt: string;
-};

package/types/types/openapi/models/PSPDFKitToken.d.ts

@@ -1,7 +0,0 @@
-import { PSPDFKitAuthPayload } from './PSPDFKitAuthPayload';
-
-export type PSPDFKitToken = {
-    readonly documentId: string;
-    readonly authPayload: PSPDFKitAuthPayload;
-    readonly instant: boolean;
-};

package/types/types/openapi/models/PSPDFKitTokenRequest.d.ts

@@ -1,3 +0,0 @@
-export type PSPDFKitTokenRequest = {
-    file_id: string;
-};

package/types/types/openapi/models/PaginatedAppList.d.ts

@@ -1,8 +0,0 @@
-import { App } from './App';
-
-export type PaginatedAppList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<App>;
-};

package/types/types/openapi/models/PaginatedAppReleaseList.d.ts

@@ -1,8 +0,0 @@
-import { AppRelease } from './AppRelease';
-
-export type PaginatedAppReleaseList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<AppRelease>;
-};

package/types/types/openapi/models/PaginatedAuthTokenList.d.ts

@@ -1,8 +0,0 @@
-import { AuthToken } from './AuthToken';
-
-export type PaginatedAuthTokenList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<AuthToken>;
-};

package/types/types/openapi/models/PaginatedCanvasListList.d.ts

@@ -1,8 +0,0 @@
-import { CanvasList } from './CanvasList';
-
-export type PaginatedCanvasListList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<CanvasList>;
-};

package/types/types/openapi/models/PaginatedCollaborationList.d.ts

@@ -1,8 +0,0 @@
-import { Collaboration } from './Collaboration';
-
-export type PaginatedCollaborationList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<Collaboration>;
-};

package/types/types/openapi/models/PaginatedContentDistributionGroupList.d.ts

@@ -1,8 +0,0 @@
-import { ContentDistributionGroup } from './ContentDistributionGroup';
-
-export type PaginatedContentDistributionGroupList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<ContentDistributionGroup>;
-};

package/types/types/openapi/models/PaginatedContentDistributionGroupMembershipList.d.ts

@@ -1,8 +0,0 @@
-import { ContentDistributionGroupMembership } from './ContentDistributionGroupMembership';
-
-export type PaginatedContentDistributionGroupMembershipList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<ContentDistributionGroupMembership>;
-};

package/types/types/openapi/models/PaginatedEnvironmentList.d.ts

@@ -1,8 +0,0 @@
-import { Environment } from './Environment';
-
-export type PaginatedEnvironmentList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<Environment>;
-};

package/types/types/openapi/models/PaginatedEventList.d.ts

@@ -1,8 +0,0 @@
-import { Event } from './Event';
-
-export type PaginatedEventList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<Event>;
-};

package/types/types/openapi/models/PaginatedFavoriteList.d.ts

@@ -1,8 +0,0 @@
-import { Favorite } from './Favorite';
-
-export type PaginatedFavoriteList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<Favorite>;
-};

package/types/types/openapi/models/PaginatedFileList.d.ts

@@ -1,8 +0,0 @@
-import { File } from './File';
-
-export type PaginatedFileList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<File>;
-};

package/types/types/openapi/models/PaginatedFolderList.d.ts

@@ -1,8 +0,0 @@
-import { Folder } from './Folder';
-
-export type PaginatedFolderList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<Folder>;
-};

package/types/types/openapi/models/PaginatedInstanceAssignmentGroupList.d.ts

@@ -1,8 +0,0 @@
-import { InstanceAssignmentGroup } from './InstanceAssignmentGroup';
-
-export type PaginatedInstanceAssignmentGroupList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<InstanceAssignmentGroup>;
-};

package/types/types/openapi/models/PaginatedInstanceAssignmentGroupMembershipList.d.ts

@@ -1,8 +0,0 @@
-import { InstanceAssignmentGroupMembership } from './InstanceAssignmentGroupMembership';
-
-export type PaginatedInstanceAssignmentGroupMembershipList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<InstanceAssignmentGroupMembership>;
-};

package/types/types/openapi/models/PaginatedInstanceList.d.ts

@@ -1,8 +0,0 @@
-import { Instance } from './Instance';
-
-export type PaginatedInstanceList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<Instance>;
-};

package/types/types/openapi/models/PaginatedInstanceMembershipList.d.ts

@@ -1,8 +0,0 @@
-import { InstanceMembership } from './InstanceMembership';
-
-export type PaginatedInstanceMembershipList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<InstanceMembership>;
-};

package/types/types/openapi/models/PaginatedInvitationList.d.ts

@@ -1,8 +0,0 @@
-import { Invitation } from './Invitation';
-
-export type PaginatedInvitationList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<Invitation>;
-};

package/types/types/openapi/models/PaginatedMetadataTemplateList.d.ts

@@ -1,8 +0,0 @@
-import { MetadataTemplate } from './MetadataTemplate';
-
-export type PaginatedMetadataTemplateList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<MetadataTemplate>;
-};

package/types/types/openapi/models/PaginatedRegionList.d.ts

@@ -1,8 +0,0 @@
-import { Region } from './Region';
-
-export type PaginatedRegionList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<Region>;
-};

package/types/types/openapi/models/PaginatedRevisionList.d.ts

@@ -1,8 +0,0 @@
-import { Revision } from './Revision';
-
-export type PaginatedRevisionList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<Revision>;
-};

package/types/types/openapi/models/PaginatedSearchResultList.d.ts

@@ -1,9 +0,0 @@
-import { SearchResult } from './SearchResult';
-
-export type PaginatedSearchResultList = {
-    highest_count?: number;
-    overall_total?: number;
-    next?: string;
-    previous?: string;
-    results?: Array<SearchResult>;
-};

package/types/types/openapi/models/PaginatedStorageRegionList.d.ts

@@ -1,8 +0,0 @@
-import { StorageRegion } from './StorageRegion';
-
-export type PaginatedStorageRegionList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<StorageRegion>;
-};

package/types/types/openapi/models/PaginatedUserList.d.ts

@@ -1,8 +0,0 @@
-import { User } from './User';
-
-export type PaginatedUserList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<User>;
-};

package/types/types/openapi/models/PatchedAppRequest.d.ts

@@ -1,9 +0,0 @@
-import { AppTypeEnum } from './AppTypeEnum';
-
-export type PatchedAppRequest = {
-    name?: string;
-    type?: AppTypeEnum;
-    description?: string | null;
-    display_name?: string | null;
-    logo?: Blob | null;
-};

package/types/types/openapi/models/PatchedCanvasUpdateRequest.d.ts

@@ -1,22 +0,0 @@
-import { AccessTypeEnum } from './AccessTypeEnum';
-import { AccountRequest } from './AccountRequest';
-
-export type PatchedCanvasUpdateRequest = {
-    name?: string;
-    is_draft?: boolean;
-    is_template?: boolean;
-    is_section?: boolean;
-    is_editable?: boolean;
-    is_default?: boolean;
-    account?: AccountRequest | null;
-    metadata?: Record<string, any>;
-    tags?: Array<string>;
-    start_at?: string | null;
-    expires_at?: string | null;
-    access_type?: AccessTypeEnum;
-    thumbnail_url?: string | null;
-    content?: any;
-    context?: any;
-    theme?: any;
-    owned_by_id?: number | null;
-};

package/types/types/openapi/models/PatchedCollaborationRequest.d.ts

@@ -1,5 +0,0 @@
-import { CollaborationRoleEnum } from './CollaborationRoleEnum';
-
-export type PatchedCollaborationRequest = {
-    role?: CollaborationRoleEnum;
-};

package/types/types/openapi/models/PatchedContentDistributionGroupRequest.d.ts

@@ -1,4 +0,0 @@
-export type PatchedContentDistributionGroupRequest = {
-    name?: string;
-    auto_add_new_users?: boolean;
-};

package/types/types/openapi/models/PatchedEnvironmentRequest.d.ts

@@ -1,5 +0,0 @@
-export type PatchedEnvironmentRequest = {
-    name?: string;
-    next_environment_ids?: Array<number>;
-    color?: string | null;
-};

package/types/types/openapi/models/PatchedEventRequest.d.ts

@@ -1,17 +0,0 @@
-import { EventAttendeeRequest } from './EventAttendeeRequest';
-import { EventExternalObjectRequest } from './EventExternalObjectRequest';
-import { EventStatusEnum } from './EventStatusEnum';
-
-export type PatchedEventRequest = {
-    id?: string;
-    status?: EventStatusEnum;
-    start_at?: string;
-    end_at?: string;
-    canvas_id?: string;
-    external_objects?: Array<EventExternalObjectRequest>;
-    location?: string;
-    subject?: string;
-    description?: string;
-    metadata?: any;
-    attendees?: Array<EventAttendeeRequest>;
-};

package/types/types/openapi/models/PatchedFavoriteUpdateRequest.d.ts

@@ -1,6 +0,0 @@
-export type PatchedFavoriteUpdateRequest = {
-    name?: string;
-    file_id?: string;
-    page_index?: number;
-    folder_id?: string;
-};

package/types/types/openapi/models/PatchedFileRequest.d.ts

@@ -1,13 +0,0 @@
-import { AccessTypeEnum } from './AccessTypeEnum';
-import { DownloadTypeEnum } from './DownloadTypeEnum';
-
-export type PatchedFileRequest = {
-    name?: string;
-    download_type?: DownloadTypeEnum;
-    access_type?: AccessTypeEnum;
-    metadata?: Record<string, any>;
-    app_metadata?: Record<string, any>;
-    tags?: Array<string>;
-    expires_at?: string | null;
-    folder_id?: string;
-};

package/types/types/openapi/models/PatchedFileUpdateRequest.d.ts

@@ -1,17 +0,0 @@
-import { AccessTypeEnum } from './AccessTypeEnum';
-import { DownloadTypeEnum } from './DownloadTypeEnum';
-
-export type PatchedFileUpdateRequest = {
-    name?: string;
-    content?: Blob;
-    content_upload_id?: string;
-    thumbnail?: Blob;
-    thumbnail_upload_id?: string;
-    download_type?: DownloadTypeEnum;
-    access_type?: AccessTypeEnum;
-    metadata?: Record<string, any>;
-    app_metadata?: Record<string, any>;
-    tags?: Array<string>;
-    expires_at?: string | null;
-    folder_id?: string;
-};

package/types/types/openapi/models/PatchedFolderUpdateRequest.d.ts

@@ -1,15 +0,0 @@
-import { AccessTypeEnum } from './AccessTypeEnum';
-
-/**
- * Serializer class for updating folder records.
- * Available fields to update:
- * - name
- * - access_type
- * - parent_folder_id
- */
-export type PatchedFolderUpdateRequest = {
-    name?: string;
-    access_type?: AccessTypeEnum;
-    parent_folder_id?: string;
-    thumbnail_id?: string;
-};

package/types/types/openapi/models/PatchedInstanceAssignmentGroupRequest.d.ts

@@ -1,4 +0,0 @@
-export type PatchedInstanceAssignmentGroupRequest = {
-    name?: string;
-    auto_add_new_users?: boolean;
-};

package/types/types/openapi/models/PatchedInstanceMembershipRequest.d.ts

@@ -1,5 +0,0 @@
-import { InstanceMembershipRoleEnum } from './InstanceMembershipRoleEnum';
-
-export type PatchedInstanceMembershipRequest = {
-    role?: InstanceMembershipRoleEnum;
-};

package/types/types/openapi/models/PatchedInstanceUpdateRequest.d.ts

@@ -1,8 +0,0 @@
-export type PatchedInstanceUpdateRequest = {
-    name?: string;
-    color?: string | null;
-    logo?: Blob | null;
-    environment_id?: number;
-    region_id?: number;
-    settings?: Record<string, any> | null;
-};

package/types/types/openapi/models/PatchedMetadataTemplateRequest.d.ts

@@ -1,7 +0,0 @@
-import { MetadataTemplateSectionRequest } from './MetadataTemplateSectionRequest';
-
-export type PatchedMetadataTemplateRequest = {
-    instance_id?: string;
-    file_id?: string;
-    sections?: Array<MetadataTemplateSectionRequest>;
-};

package/types/types/openapi/models/PatchedOrganizationUpdateRequest.d.ts

@@ -1,8 +0,0 @@
-export type PatchedOrganizationUpdateRequest = {
-    name?: string;
-    display_name?: string;
-    logo_url?: string;
-    primary_color?: string;
-    page_background_color?: string;
-    settings?: Record<string, any> | null;
-};

package/types/types/openapi/models/PatchedRegionRequest.d.ts

@@ -1,3 +0,0 @@
-export type PatchedRegionRequest = {
-    name?: string;
-};

package/types/types/openapi/models/PatchedUserRequest.d.ts

@@ -1,12 +0,0 @@
-import { InstanceMembershipRoleEnum } from './InstanceMembershipRoleEnum';
-import { LanguageEnum } from './LanguageEnum';
-
-export type PatchedUserRequest = {
-    first_name?: string;
-    last_name?: string;
-    role?: InstanceMembershipRoleEnum;
-    language?: LanguageEnum;
-    dark_mode?: boolean;
-    preferred_username?: string;
-    timezone?: string;
-};

package/types/types/openapi/models/Region.d.ts

@@ -1,10 +0,0 @@
-import { MiniUser } from './MiniUser';
-
-export type Region = {
-    readonly id: number;
-    name: string;
-    readonly created_at: string;
-    readonly created_by: MiniUser;
-    readonly modified_at: string;
-    readonly modified_by: MiniUser;
-};

package/types/types/openapi/models/RegionRequest.d.ts

@@ -1,3 +0,0 @@
-export type RegionRequest = {
-    name: string;
-};

package/types/types/openapi/models/Revision.d.ts

@@ -1,8 +0,0 @@
-import { MiniUser } from './MiniUser';
-
-export type Revision = {
-    readonly id: number;
-    readonly created_at: string;
-    readonly created_by: MiniUser;
-    name: string;
-};

package/types/types/openapi/models/RevisionRequest.d.ts

@@ -1,3 +0,0 @@
-export type RevisionRequest = {
-    name: string;
-};

package/types/types/openapi/models/SearchApp.d.ts

@@ -1,6 +0,0 @@
-export type SearchApp = {
-    readonly id: string;
-    name: string;
-    readonly picture_url: string;
-    app_metadata?: any;
-};

package/types/types/openapi/models/SearchCanvas.d.ts

@@ -1,5 +0,0 @@
-export type SearchCanvas = {
-    readonly id: string;
-    name: string;
-    readonly picture_url: string;
-};

package/types/types/openapi/models/SearchContentDistributionGroup.d.ts

@@ -1,11 +0,0 @@
-import { MiniUser } from './MiniUser';
-
-export type SearchContentDistributionGroup = {
-    readonly id: string;
-    name: string;
-    readonly size: number;
-    readonly created_by: MiniUser;
-    readonly created_at: string;
-    readonly modified_by: MiniUser;
-    readonly modified_at: string;
-};