@aws-sdk/client-wickr 3.956.0

package/dist-types/ts3.4/models/models_0.d.ts

@@ -0,0 +1,714 @@
+import {
+  AccessLevel,
+  BotStatus,
+  DataRetentionActionType,
+  SortDirection,
+  Status,
+  UserStatus,
+} from "./enums";
+export interface BasicDeviceObject {
+  appId?: string | undefined;
+  created?: string | undefined;
+  lastLogin?: string | undefined;
+  statusText?: string | undefined;
+  suspend?: boolean | undefined;
+  type?: string | undefined;
+}
+export interface BatchCreateUserRequestItem {
+  firstName?: string | undefined;
+  lastName?: string | undefined;
+  securityGroupIds: string[] | undefined;
+  username: string | undefined;
+  inviteCode?: string | undefined;
+  inviteCodeTtl?: number | undefined;
+  codeValidation?: boolean | undefined;
+}
+export interface BatchCreateUserRequest {
+  networkId: string | undefined;
+  users: BatchCreateUserRequestItem[] | undefined;
+  clientToken?: string | undefined;
+}
+export interface BatchUserErrorResponseItem {
+  field?: string | undefined;
+  reason?: string | undefined;
+  userId: string | undefined;
+}
+export interface User {
+  userId?: string | undefined;
+  firstName?: string | undefined;
+  lastName?: string | undefined;
+  username?: string | undefined;
+  securityGroups?: string[] | undefined;
+  isAdmin?: boolean | undefined;
+  suspended?: boolean | undefined;
+  status?: number | undefined;
+  otpEnabled?: boolean | undefined;
+  scimId?: string | undefined;
+  type?: string | undefined;
+  cell?: string | undefined;
+  countryCode?: string | undefined;
+  challengeFailures?: number | undefined;
+  isInviteExpired?: boolean | undefined;
+  isUser?: boolean | undefined;
+  inviteCode?: string | undefined;
+  codeValidation?: boolean | undefined;
+  uname?: string | undefined;
+}
+export interface BatchCreateUserResponse {
+  message?: string | undefined;
+  successful?: User[] | undefined;
+  failed?: BatchUserErrorResponseItem[] | undefined;
+}
+export interface ErrorDetail {
+  field?: string | undefined;
+  reason?: string | undefined;
+}
+export interface BatchDeleteUserRequest {
+  networkId: string | undefined;
+  userIds: string[] | undefined;
+  clientToken?: string | undefined;
+}
+export interface BatchUserSuccessResponseItem {
+  userId: string | undefined;
+}
+export interface BatchDeleteUserResponse {
+  message?: string | undefined;
+  successful?: BatchUserSuccessResponseItem[] | undefined;
+  failed?: BatchUserErrorResponseItem[] | undefined;
+}
+export interface BatchDeviceErrorResponseItem {
+  field?: string | undefined;
+  reason?: string | undefined;
+  appId: string | undefined;
+}
+export interface BatchDeviceSuccessResponseItem {
+  appId: string | undefined;
+}
+export interface BatchLookupUserUnameRequest {
+  networkId: string | undefined;
+  unames: string[] | undefined;
+  clientToken?: string | undefined;
+}
+export interface BatchUnameErrorResponseItem {
+  field?: string | undefined;
+  reason?: string | undefined;
+  uname: string | undefined;
+}
+export interface BatchUnameSuccessResponseItem {
+  uname: string | undefined;
+  username: string | undefined;
+}
+export interface BatchLookupUserUnameResponse {
+  message?: string | undefined;
+  successful?: BatchUnameSuccessResponseItem[] | undefined;
+  failed?: BatchUnameErrorResponseItem[] | undefined;
+}
+export interface BatchReinviteUserRequest {
+  networkId: string | undefined;
+  userIds: string[] | undefined;
+  clientToken?: string | undefined;
+}
+export interface BatchReinviteUserResponse {
+  message?: string | undefined;
+  successful?: BatchUserSuccessResponseItem[] | undefined;
+  failed?: BatchUserErrorResponseItem[] | undefined;
+}
+export interface BatchResetDevicesForUserRequest {
+  networkId: string | undefined;
+  userId: string | undefined;
+  appIds: string[] | undefined;
+  clientToken?: string | undefined;
+}
+export interface BatchResetDevicesForUserResponse {
+  message?: string | undefined;
+  successful?: BatchDeviceSuccessResponseItem[] | undefined;
+  failed?: BatchDeviceErrorResponseItem[] | undefined;
+}
+export interface BatchToggleUserSuspendStatusRequest {
+  networkId: string | undefined;
+  suspend: boolean | undefined;
+  userIds: string[] | undefined;
+  clientToken?: string | undefined;
+}
+export interface BatchToggleUserSuspendStatusResponse {
+  message?: string | undefined;
+  successful?: BatchUserSuccessResponseItem[] | undefined;
+  failed?: BatchUserErrorResponseItem[] | undefined;
+}
+export interface BlockedGuestUser {
+  username: string | undefined;
+  admin: string | undefined;
+  modified: string | undefined;
+  usernameHash: string | undefined;
+}
+export interface Bot {
+  botId?: string | undefined;
+  displayName?: string | undefined;
+  username?: string | undefined;
+  uname?: string | undefined;
+  pubkey?: string | undefined;
+  status?: BotStatus | undefined;
+  groupId?: string | undefined;
+  hasChallenge?: boolean | undefined;
+  suspended?: boolean | undefined;
+  lastLogin?: string | undefined;
+}
+export interface CallingSettings {
+  canStart11Call?: boolean | undefined;
+  canVideoCall?: boolean | undefined;
+  forceTcpCall?: boolean | undefined;
+}
+export interface CreateBotRequest {
+  networkId: string | undefined;
+  username: string | undefined;
+  displayName?: string | undefined;
+  groupId: string | undefined;
+  challenge: string | undefined;
+}
+export interface CreateBotResponse {
+  message?: string | undefined;
+  botId: string | undefined;
+  networkId?: string | undefined;
+  username?: string | undefined;
+  displayName?: string | undefined;
+  groupId?: string | undefined;
+}
+export interface CreateDataRetentionBotRequest {
+  networkId: string | undefined;
+}
+export interface CreateDataRetentionBotResponse {
+  message?: string | undefined;
+}
+export interface CreateDataRetentionBotChallengeRequest {
+  networkId: string | undefined;
+}
+export interface CreateDataRetentionBotChallengeResponse {
+  challenge: string | undefined;
+}
+export interface CreateNetworkRequest {
+  networkName: string | undefined;
+  accessLevel: AccessLevel | undefined;
+  enablePremiumFreeTrial?: boolean | undefined;
+  encryptionKeyArn?: string | undefined;
+}
+export interface CreateNetworkResponse {
+  networkId?: string | undefined;
+  networkName?: string | undefined;
+  encryptionKeyArn?: string | undefined;
+}
+export interface WickrAwsNetworks {
+  region: string | undefined;
+  networkId: string | undefined;
+}
+export interface PermittedWickrEnterpriseNetwork {
+  domain: string | undefined;
+  networkId: string | undefined;
+}
+export interface SecurityGroupSettingsRequest {
+  lockoutThreshold?: number | undefined;
+  permittedNetworks?: string[] | undefined;
+  enableGuestFederation?: boolean | undefined;
+  globalFederation?: boolean | undefined;
+  federationMode?: number | undefined;
+  enableRestrictedGlobalFederation?: boolean | undefined;
+  permittedWickrAwsNetworks?: WickrAwsNetworks[] | undefined;
+  permittedWickrEnterpriseNetworks?:
+    | PermittedWickrEnterpriseNetwork[]
+    | undefined;
+}
+export interface CreateSecurityGroupRequest {
+  networkId: string | undefined;
+  name: string | undefined;
+  securityGroupSettings: SecurityGroupSettingsRequest | undefined;
+  clientToken?: string | undefined;
+}
+export interface PasswordRequirements {
+  lowercase?: number | undefined;
+  minLength?: number | undefined;
+  numbers?: number | undefined;
+  symbols?: number | undefined;
+  uppercase?: number | undefined;
+}
+export interface ShredderSettings {
+  canProcessManually?: boolean | undefined;
+  intensity?: number | undefined;
+}
+export interface SecurityGroupSettings {
+  alwaysReauthenticate?: boolean | undefined;
+  atakPackageValues?: string[] | undefined;
+  calling?: CallingSettings | undefined;
+  checkForUpdates?: boolean | undefined;
+  enableAtak?: boolean | undefined;
+  enableCrashReports?: boolean | undefined;
+  enableFileDownload?: boolean | undefined;
+  enableGuestFederation?: boolean | undefined;
+  enableNotificationPreview?: boolean | undefined;
+  enableOpenAccessOption?: boolean | undefined;
+  enableRestrictedGlobalFederation?: boolean | undefined;
+  filesEnabled?: boolean | undefined;
+  forceDeviceLockout?: number | undefined;
+  forceOpenAccess?: boolean | undefined;
+  forceReadReceipts?: boolean | undefined;
+  globalFederation?: boolean | undefined;
+  isAtoEnabled?: boolean | undefined;
+  isLinkPreviewEnabled?: boolean | undefined;
+  locationAllowMaps?: boolean | undefined;
+  locationEnabled?: boolean | undefined;
+  maxAutoDownloadSize?: number | undefined;
+  maxBor?: number | undefined;
+  maxTtl?: number | undefined;
+  messageForwardingEnabled?: boolean | undefined;
+  passwordRequirements?: PasswordRequirements | undefined;
+  presenceEnabled?: boolean | undefined;
+  quickResponses?: string[] | undefined;
+  showMasterRecoveryKey?: boolean | undefined;
+  shredder?: ShredderSettings | undefined;
+  ssoMaxIdleMinutes?: number | undefined;
+  federationMode?: number | undefined;
+  lockoutThreshold?: number | undefined;
+  permittedNetworks?: string[] | undefined;
+  permittedWickrAwsNetworks?: WickrAwsNetworks[] | undefined;
+  permittedWickrEnterpriseNetworks?:
+    | PermittedWickrEnterpriseNetwork[]
+    | undefined;
+}
+export interface SecurityGroup {
+  activeMembers: number | undefined;
+  botMembers: number | undefined;
+  activeDirectoryGuid?: string | undefined;
+  id: string | undefined;
+  isDefault: boolean | undefined;
+  name: string | undefined;
+  modified: number | undefined;
+  securityGroupSettings: SecurityGroupSettings | undefined;
+}
+export interface CreateSecurityGroupResponse {
+  securityGroup: SecurityGroup | undefined;
+}
+export interface DeleteBotRequest {
+  networkId: string | undefined;
+  botId: string | undefined;
+}
+export interface DeleteBotResponse {
+  message?: string | undefined;
+}
+export interface DeleteDataRetentionBotRequest {
+  networkId: string | undefined;
+}
+export interface DeleteDataRetentionBotResponse {
+  message?: string | undefined;
+}
+export interface DeleteNetworkRequest {
+  networkId: string | undefined;
+  clientToken?: string | undefined;
+}
+export interface DeleteNetworkResponse {
+  message?: string | undefined;
+}
+export interface DeleteSecurityGroupRequest {
+  networkId: string | undefined;
+  groupId: string | undefined;
+}
+export interface DeleteSecurityGroupResponse {
+  message?: string | undefined;
+  networkId?: string | undefined;
+  groupId?: string | undefined;
+}
+export interface GetBotRequest {
+  networkId: string | undefined;
+  botId: string | undefined;
+}
+export interface GetBotResponse {
+  botId?: string | undefined;
+  displayName?: string | undefined;
+  username?: string | undefined;
+  uname?: string | undefined;
+  pubkey?: string | undefined;
+  status?: BotStatus | undefined;
+  groupId?: string | undefined;
+  hasChallenge?: boolean | undefined;
+  suspended?: boolean | undefined;
+  lastLogin?: string | undefined;
+}
+export interface GetBotsCountRequest {
+  networkId: string | undefined;
+}
+export interface GetBotsCountResponse {
+  pending: number | undefined;
+  active: number | undefined;
+  total: number | undefined;
+}
+export interface GetDataRetentionBotRequest {
+  networkId: string | undefined;
+}
+export interface GetDataRetentionBotResponse {
+  botName?: string | undefined;
+  botExists?: boolean | undefined;
+  isBotActive?: boolean | undefined;
+  isDataRetentionBotRegistered?: boolean | undefined;
+  isDataRetentionServiceEnabled?: boolean | undefined;
+  isPubkeyMsgAcked?: boolean | undefined;
+}
+export interface GetGuestUserHistoryCountRequest {
+  networkId: string | undefined;
+}
+export interface GuestUserHistoryCount {
+  month: string | undefined;
+  count: string | undefined;
+}
+export interface GetGuestUserHistoryCountResponse {
+  history: GuestUserHistoryCount[] | undefined;
+}
+export interface GetNetworkRequest {
+  networkId: string | undefined;
+}
+export interface GetNetworkResponse {
+  networkId: string | undefined;
+  networkName: string | undefined;
+  accessLevel: AccessLevel | undefined;
+  awsAccountId: string | undefined;
+  networkArn: string | undefined;
+  standing?: number | undefined;
+  freeTrialExpiration?: string | undefined;
+  migrationState?: number | undefined;
+  encryptionKeyArn?: string | undefined;
+}
+export interface GetNetworkSettingsRequest {
+  networkId: string | undefined;
+}
+export interface Setting {
+  optionName: string | undefined;
+  value: string | undefined;
+  type: string | undefined;
+}
+export interface GetNetworkSettingsResponse {
+  settings: Setting[] | undefined;
+}
+export interface GetOidcInfoRequest {
+  networkId: string | undefined;
+  clientId?: string | undefined;
+  code?: string | undefined;
+  grantType?: string | undefined;
+  redirectUri?: string | undefined;
+  url?: string | undefined;
+  clientSecret?: string | undefined;
+  codeVerifier?: string | undefined;
+  certificate?: string | undefined;
+}
+export interface OidcConfigInfo {
+  applicationName?: string | undefined;
+  clientId?: string | undefined;
+  companyId: string | undefined;
+  scopes: string | undefined;
+  issuer: string | undefined;
+  clientSecret?: string | undefined;
+  secret?: string | undefined;
+  redirectUrl?: string | undefined;
+  userId?: string | undefined;
+  customUsername?: string | undefined;
+  caCertificate?: string | undefined;
+  applicationId?: number | undefined;
+  ssoTokenBufferMinutes?: number | undefined;
+  extraAuthParams?: string | undefined;
+}
+export interface OidcTokenInfo {
+  codeVerifier?: string | undefined;
+  codeChallenge?: string | undefined;
+  accessToken?: string | undefined;
+  idToken?: string | undefined;
+  refreshToken?: string | undefined;
+  tokenType?: string | undefined;
+  expiresIn?: number | undefined;
+}
+export interface GetOidcInfoResponse {
+  openidConnectInfo?: OidcConfigInfo | undefined;
+  tokenInfo?: OidcTokenInfo | undefined;
+}
+export interface GetSecurityGroupRequest {
+  networkId: string | undefined;
+  groupId: string | undefined;
+}
+export interface GetSecurityGroupResponse {
+  securityGroup: SecurityGroup | undefined;
+}
+export interface GetUserRequest {
+  networkId: string | undefined;
+  userId: string | undefined;
+  startTime?: Date | undefined;
+  endTime?: Date | undefined;
+}
+export interface GetUserResponse {
+  userId: string | undefined;
+  firstName?: string | undefined;
+  lastName?: string | undefined;
+  username?: string | undefined;
+  isAdmin?: boolean | undefined;
+  suspended?: boolean | undefined;
+  status?: number | undefined;
+  lastActivity?: number | undefined;
+  lastLogin?: number | undefined;
+  securityGroupIds?: string[] | undefined;
+}
+export interface GetUsersCountRequest {
+  networkId: string | undefined;
+}
+export interface GetUsersCountResponse {
+  pending: number | undefined;
+  active: number | undefined;
+  rejected: number | undefined;
+  remaining: number | undefined;
+  total: number | undefined;
+}
+export interface GuestUser {
+  billingPeriod: string | undefined;
+  username: string | undefined;
+  usernameHash: string | undefined;
+}
+export interface ListBlockedGuestUsersRequest {
+  networkId: string | undefined;
+  maxResults?: number | undefined;
+  sortDirection?: SortDirection | undefined;
+  sortFields?: string | undefined;
+  username?: string | undefined;
+  admin?: string | undefined;
+  nextToken?: string | undefined;
+}
+export interface ListBlockedGuestUsersResponse {
+  nextToken?: string | undefined;
+  blocklist: BlockedGuestUser[] | undefined;
+}
+export interface ListBotsRequest {
+  networkId: string | undefined;
+  nextToken?: string | undefined;
+  maxResults?: number | undefined;
+  sortFields?: string | undefined;
+  sortDirection?: SortDirection | undefined;
+  displayName?: string | undefined;
+  username?: string | undefined;
+  status?: BotStatus | undefined;
+  groupId?: string | undefined;
+}
+export interface ListBotsResponse {
+  bots: Bot[] | undefined;
+  nextToken?: string | undefined;
+}
+export interface ListDevicesForUserRequest {
+  networkId: string | undefined;
+  userId: string | undefined;
+  nextToken?: string | undefined;
+  maxResults?: number | undefined;
+  sortFields?: string | undefined;
+  sortDirection?: SortDirection | undefined;
+}
+export interface ListDevicesForUserResponse {
+  nextToken?: string | undefined;
+  devices: BasicDeviceObject[] | undefined;
+}
+export interface ListGuestUsersRequest {
+  networkId: string | undefined;
+  maxResults?: number | undefined;
+  sortDirection?: SortDirection | undefined;
+  sortFields?: string | undefined;
+  username?: string | undefined;
+  billingPeriod?: string | undefined;
+  nextToken?: string | undefined;
+}
+export interface ListGuestUsersResponse {
+  nextToken?: string | undefined;
+  guestlist: GuestUser[] | undefined;
+}
+export interface ListNetworksRequest {
+  maxResults?: number | undefined;
+  sortFields?: string | undefined;
+  sortDirection?: SortDirection | undefined;
+  nextToken?: string | undefined;
+}
+export interface Network {
+  networkId: string | undefined;
+  networkName: string | undefined;
+  accessLevel: AccessLevel | undefined;
+  awsAccountId: string | undefined;
+  networkArn: string | undefined;
+  standing?: number | undefined;
+  freeTrialExpiration?: string | undefined;
+  migrationState?: number | undefined;
+  encryptionKeyArn?: string | undefined;
+}
+export interface ListNetworksResponse {
+  networks: Network[] | undefined;
+  nextToken?: string | undefined;
+}
+export interface ListSecurityGroupsRequest {
+  networkId: string | undefined;
+  nextToken?: string | undefined;
+  maxResults?: number | undefined;
+  sortFields?: string | undefined;
+  sortDirection?: SortDirection | undefined;
+}
+export interface ListSecurityGroupsResponse {
+  securityGroups?: SecurityGroup[] | undefined;
+  nextToken?: string | undefined;
+}
+export interface ListSecurityGroupUsersRequest {
+  networkId: string | undefined;
+  groupId: string | undefined;
+  nextToken?: string | undefined;
+  maxResults?: number | undefined;
+  sortFields?: string | undefined;
+  sortDirection?: SortDirection | undefined;
+}
+export interface ListSecurityGroupUsersResponse {
+  users: User[] | undefined;
+  nextToken?: string | undefined;
+}
+export interface ListUsersRequest {
+  networkId: string | undefined;
+  nextToken?: string | undefined;
+  maxResults?: number | undefined;
+  sortFields?: string | undefined;
+  sortDirection?: SortDirection | undefined;
+  firstName?: string | undefined;
+  lastName?: string | undefined;
+  username?: string | undefined;
+  status?: UserStatus | undefined;
+  groupId?: string | undefined;
+}
+export interface ListUsersResponse {
+  nextToken?: string | undefined;
+  users?: User[] | undefined;
+}
+export interface ReadReceiptConfig {
+  status?: Status | undefined;
+}
+export interface NetworkSettings {
+  enableClientMetrics?: boolean | undefined;
+  readReceiptConfig?: ReadReceiptConfig | undefined;
+  dataRetention?: boolean | undefined;
+}
+export interface RegisterOidcConfigRequest {
+  networkId: string | undefined;
+  companyId: string | undefined;
+  customUsername?: string | undefined;
+  extraAuthParams?: string | undefined;
+  issuer: string | undefined;
+  scopes: string | undefined;
+  secret?: string | undefined;
+  ssoTokenBufferMinutes?: number | undefined;
+  userId?: string | undefined;
+}
+export interface RegisterOidcConfigResponse {
+  applicationName?: string | undefined;
+  clientId?: string | undefined;
+  companyId: string | undefined;
+  scopes: string | undefined;
+  issuer: string | undefined;
+  clientSecret?: string | undefined;
+  secret?: string | undefined;
+  redirectUrl?: string | undefined;
+  userId?: string | undefined;
+  customUsername?: string | undefined;
+  caCertificate?: string | undefined;
+  applicationId?: number | undefined;
+  ssoTokenBufferMinutes?: number | undefined;
+  extraAuthParams?: string | undefined;
+}
+export interface RegisterOidcConfigTestRequest {
+  networkId: string | undefined;
+  extraAuthParams?: string | undefined;
+  issuer: string | undefined;
+  scopes: string | undefined;
+  certificate?: string | undefined;
+}
+export interface RegisterOidcConfigTestResponse {
+  tokenEndpoint?: string | undefined;
+  userinfoEndpoint?: string | undefined;
+  responseTypesSupported?: string[] | undefined;
+  scopesSupported?: string[] | undefined;
+  issuer?: string | undefined;
+  authorizationEndpoint?: string | undefined;
+  endSessionEndpoint?: string | undefined;
+  logoutEndpoint?: string | undefined;
+  grantTypesSupported?: string[] | undefined;
+  revocationEndpoint?: string | undefined;
+  tokenEndpointAuthMethodsSupported?: string[] | undefined;
+  microsoftMultiRefreshToken?: boolean | undefined;
+}
+export interface UpdateBotRequest {
+  networkId: string | undefined;
+  botId: string | undefined;
+  displayName?: string | undefined;
+  groupId?: string | undefined;
+  challenge?: string | undefined;
+  suspend?: boolean | undefined;
+}
+export interface UpdateBotResponse {
+  message?: string | undefined;
+}
+export interface UpdateDataRetentionRequest {
+  networkId: string | undefined;
+  actionType: DataRetentionActionType | undefined;
+}
+export interface UpdateDataRetentionResponse {
+  message?: string | undefined;
+}
+export interface UpdateGuestUserRequest {
+  networkId: string | undefined;
+  usernameHash: string | undefined;
+  block: boolean | undefined;
+}
+export interface UpdateGuestUserResponse {
+  message?: string | undefined;
+}
+export interface UpdateNetworkRequest {
+  networkId: string | undefined;
+  networkName: string | undefined;
+  clientToken?: string | undefined;
+  encryptionKeyArn?: string | undefined;
+}
+export interface UpdateNetworkResponse {
+  message?: string | undefined;
+}
+export interface UpdateNetworkSettingsRequest {
+  networkId: string | undefined;
+  settings: NetworkSettings | undefined;
+}
+export interface UpdateNetworkSettingsResponse {
+  settings: Setting[] | undefined;
+}
+export interface UpdateSecurityGroupRequest {
+  networkId: string | undefined;
+  groupId: string | undefined;
+  name?: string | undefined;
+  securityGroupSettings?: SecurityGroupSettings | undefined;
+}
+export interface UpdateSecurityGroupResponse {
+  securityGroup: SecurityGroup | undefined;
+}
+export interface UpdateUserDetails {
+  firstName?: string | undefined;
+  lastName?: string | undefined;
+  username?: string | undefined;
+  securityGroupIds?: string[] | undefined;
+  inviteCode?: string | undefined;
+  inviteCodeTtl?: number | undefined;
+  codeValidation?: boolean | undefined;
+}
+export interface UpdateUserRequest {
+  networkId: string | undefined;
+  userId: string | undefined;
+  userDetails?: UpdateUserDetails | undefined;
+}
+export interface UpdateUserResponse {
+  userId: string | undefined;
+  networkId: string | undefined;
+  securityGroupIds?: string[] | undefined;
+  firstName?: string | undefined;
+  lastName?: string | undefined;
+  middleName?: string | undefined;
+  suspended: boolean | undefined;
+  modified?: number | undefined;
+  status?: number | undefined;
+  inviteCode?: string | undefined;
+  inviteExpiration?: number | undefined;
+  codeValidation?: boolean | undefined;
+}

package/dist-types/ts3.4/pagination/Interfaces.d.ts

@@ -0,0 +1,5 @@
+import { PaginationConfiguration } from "@smithy/types";
+import { WickrClient } from "../WickrClient";
+export interface WickrPaginationConfiguration extends PaginationConfiguration {
+  client: WickrClient;
+}