@newfold/huapi-js 2.1907.0 → 2.1908.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -10,7 +10,7 @@
10
10
  "tslib": "2.7.0"
11
11
  },
12
12
  "module": "dist/index.ts",
13
- "version": "2.1907.0",
13
+ "version": "2.1908.0",
14
14
  "sideEffects": false,
15
15
  "main": "./src/index.js",
16
16
  "types": "./src/index.d.ts",
package/src/index.d.ts CHANGED
@@ -738,9 +738,9 @@ export declare function useAddonsSitelockSso<TData = Awaited<ReturnType<typeof a
738
738
  * Returns a combined backup list with website commit ids and corresponding database commits
739
739
  * @summary backup list
740
740
  */
741
- export declare const xcitiumBackupList: (addonId: number, params: XcitiumBackupListParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<XcitiumBackupList200>>;
742
- export declare const getXcitiumBackupListQueryKey: (addonId: number, params: XcitiumBackupListParams) => readonly [`/v1/addons/xcitium/${number}/backups`, ...XcitiumBackupListParams[]];
743
- export declare const getXcitiumBackupListQueryOptions: <TData = AxiosResponse<XcitiumBackupList200, any>, TError = AxiosError<unknown, any>>(addonId: number, params: XcitiumBackupListParams, options?: {
741
+ export declare const xcitiumBackupList: (addonId: string, params: XcitiumBackupListParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<XcitiumBackupList200>>;
742
+ export declare const getXcitiumBackupListQueryKey: (addonId: string, params: XcitiumBackupListParams) => readonly [`/v1/addons/xcitium/${string}/backups`, ...XcitiumBackupListParams[]];
743
+ export declare const getXcitiumBackupListQueryOptions: <TData = AxiosResponse<XcitiumBackupList200, any>, TError = AxiosError<unknown, any>>(addonId: string, params: XcitiumBackupListParams, options?: {
744
744
  query?: Partial<UseQueryOptions<AxiosResponse<XcitiumBackupList200, any>, TError, TData, QueryKey>> | undefined;
745
745
  axios?: AxiosRequestConfig<any> | undefined;
746
746
  } | undefined) => UseQueryOptions<AxiosResponse<XcitiumBackupList200, any>, TError, TData, QueryKey> & {
@@ -748,19 +748,19 @@ export declare const getXcitiumBackupListQueryOptions: <TData = AxiosResponse<Xc
748
748
  };
749
749
  export declare type XcitiumBackupListQueryResult = NonNullable<Awaited<ReturnType<typeof xcitiumBackupList>>>;
750
750
  export declare type XcitiumBackupListQueryError = AxiosError<unknown>;
751
- export declare function useXcitiumBackupList<TData = Awaited<ReturnType<typeof xcitiumBackupList>>, TError = AxiosError<unknown>>(addonId: number, params: XcitiumBackupListParams, options: {
751
+ export declare function useXcitiumBackupList<TData = Awaited<ReturnType<typeof xcitiumBackupList>>, TError = AxiosError<unknown>>(addonId: string, params: XcitiumBackupListParams, options: {
752
752
  query: Partial<UseQueryOptions<Awaited<ReturnType<typeof xcitiumBackupList>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof xcitiumBackupList>>, TError, TData>, 'initialData'>;
753
753
  axios?: AxiosRequestConfig;
754
754
  }): DefinedUseQueryResult<TData, TError> & {
755
755
  queryKey: QueryKey;
756
756
  };
757
- export declare function useXcitiumBackupList<TData = Awaited<ReturnType<typeof xcitiumBackupList>>, TError = AxiosError<unknown>>(addonId: number, params: XcitiumBackupListParams, options?: {
757
+ export declare function useXcitiumBackupList<TData = Awaited<ReturnType<typeof xcitiumBackupList>>, TError = AxiosError<unknown>>(addonId: string, params: XcitiumBackupListParams, options?: {
758
758
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof xcitiumBackupList>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof xcitiumBackupList>>, TError, TData>, 'initialData'>;
759
759
  axios?: AxiosRequestConfig;
760
760
  }): UseQueryResult<TData, TError> & {
761
761
  queryKey: QueryKey;
762
762
  };
763
- export declare function useXcitiumBackupList<TData = Awaited<ReturnType<typeof xcitiumBackupList>>, TError = AxiosError<unknown>>(addonId: number, params: XcitiumBackupListParams, options?: {
763
+ export declare function useXcitiumBackupList<TData = Awaited<ReturnType<typeof xcitiumBackupList>>, TError = AxiosError<unknown>>(addonId: string, params: XcitiumBackupListParams, options?: {
764
764
  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof xcitiumBackupList>>, TError, TData>>;
765
765
  axios?: AxiosRequestConfig;
766
766
  }): UseQueryResult<TData, TError> & {
package/src/index.js CHANGED
@@ -3,7 +3,7 @@
3
3
  * Do not edit manually.
4
4
  * Hosting UAPI
5
5
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
6
- * OpenAPI spec version: 1.1907.0
6
+ * OpenAPI spec version: 1.1908.0
7
7
  */
8
8
  import { useInfiniteQuery, useMutation, useQuery } from '@tanstack/react-query';
9
9
  import axios from 'axios';
package/src/index.msw.js CHANGED
@@ -4,7 +4,7 @@ import { __awaiter } from "tslib";
4
4
  * Do not edit manually.
5
5
  * Hosting UAPI
6
6
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
7
- * OpenAPI spec version: 1.1907.0
7
+ * OpenAPI spec version: 1.1908.0
8
8
  */
9
9
  import { faker } from '@faker-js/faker';
10
10
  import { HttpResponse, delay, http } from 'msw';
@@ -32,7 +32,7 @@ export const getCodeguardWebsiteBackupListResponseMock = (overrideResponse = {})
32
32
  export const getCodeguardWebsiteBackupCreateResponseMock = (overrideResponse = {}) => (Object.assign({ status: faker.helpers.arrayElement([faker.word.sample(), undefined]) }, overrideResponse));
33
33
  export const getCodeguardWebsiteBackupRestoreResponseMock = (overrideResponse = {}) => (Object.assign({ status: faker.helpers.arrayElement([faker.word.sample(), undefined]) }, overrideResponse));
34
34
  export const getAddonsSitelockSsoResponseMock = (overrideResponse = {}) => (Object.assign({ site_url: faker.helpers.arrayElement([faker.word.sample(), undefined]), sitelock_id: faker.helpers.arrayElement([faker.word.sample(), undefined]), url: faker.helpers.arrayElement([faker.word.sample(), undefined]) }, overrideResponse));
35
- export const getXcitiumBackupListResponseMock = (overrideResponse = {}) => (Object.assign({ backups: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ database_backups: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ commit_id: faker.helpers.arrayElement([faker.word.sample(), undefined]), event_time: faker.helpers.arrayElement([faker.word.sample(), undefined]), id: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]), recommended: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) })), undefined]), event_time: faker.helpers.arrayElement([faker.word.sample(), undefined]), website_commit_id: faker.helpers.arrayElement([faker.word.sample(), undefined]) })), undefined]) }, overrideResponse));
35
+ export const getXcitiumBackupListResponseMock = (overrideResponse = {}) => (Object.assign({ backups: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ backup_id: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), backup_type: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), end_time: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), files_added: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), files_deleted: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), files_modified: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), files_total: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), request_type: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), start_time: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), status: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), website_id: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]) })), undefined]) }, overrideResponse));
36
36
  export const getXcitiumBackupCreateResponseMock = (overrideResponse = {}) => (Object.assign({ database_success: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]), website_success: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]) }, overrideResponse));
37
37
  export const getXcitiumBackupDownloadResponseMock = (overrideResponse = {}) => (Object.assign({ database_success: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]), website_success: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]) }, overrideResponse));
38
38
  export const getXcitiumBackupRestoreResponseMock = (overrideResponse = {}) => (Object.assign({ database_success: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), website_success: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) }, overrideResponse));
@@ -3,7 +3,7 @@
3
3
  * Do not edit manually.
4
4
  * Hosting UAPI
5
5
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
6
- * OpenAPI spec version: 1.1907.0
6
+ * OpenAPI spec version: 1.1908.0
7
7
  */
8
8
  export declare type SshKeyListV4200RowsItem = {
9
9
  authorize?: boolean;
@@ -342,13 +342,6 @@ export declare type SiteMalwareStatusV2200 = {
342
342
  */
343
343
  scanner_state?: string | null;
344
344
  };
345
- /**
346
- * Most recent errors logged during domain ssl validation. Remains set if validation tries run out. Gets reset by new validation job.
347
- * @nullable
348
- */
349
- export declare type SitesDomainsV2200DomainsItemSetupProgressValidateSslErrorTable = {
350
- [key: string]: unknown;
351
- } | null;
352
345
  /**
353
346
  * @nullable
354
347
  */
@@ -477,6 +470,13 @@ export declare type SitesDomainsV2200 = {
477
470
  page?: number;
478
471
  total?: number;
479
472
  };
473
+ /**
474
+ * Most recent errors logged during domain ssl validation. Remains set if validation tries run out. Gets reset by new validation job.
475
+ * @nullable
476
+ */
477
+ export declare type SitesDomainsV2200DomainsItemSetupProgressValidateSslErrorTable = {
478
+ [key: string]: unknown;
479
+ } | null;
480
480
  /**
481
481
  * Job ids and names currently running on the domain
482
482
  * @nullable
@@ -6867,22 +6867,68 @@ export declare type XcitiumBackupCreateBody = {
6867
6867
  /** The id of the website the given database is associated with. */
6868
6868
  website_id?: number;
6869
6869
  };
6870
- export declare type XcitiumBackupList200BackupsItemDatabaseBackupsItem = {
6871
- commit_id?: string;
6872
- event_time?: string;
6873
- id?: number;
6874
- recommended?: boolean;
6875
- };
6876
6870
  export declare type XcitiumBackupList200BackupsItem = {
6877
- database_backups?: XcitiumBackupList200BackupsItemDatabaseBackupsItem[];
6878
- event_time?: string;
6879
- website_commit_id?: string;
6871
+ /**
6872
+ * The id of the backup
6873
+ * @nullable
6874
+ */
6875
+ backup_id?: string | null;
6876
+ /**
6877
+ * The type of backup that was made
6878
+ * @nullable
6879
+ */
6880
+ backup_type?: string | null;
6881
+ /**
6882
+ * The timestamp at which the backup completed
6883
+ * @nullable
6884
+ */
6885
+ end_time?: string | null;
6886
+ /**
6887
+ * The number of files that were added with this backup
6888
+ * @nullable
6889
+ */
6890
+ files_added?: string | null;
6891
+ /**
6892
+ * The number of files that were deleted with this backup
6893
+ * @nullable
6894
+ */
6895
+ files_deleted?: string | null;
6896
+ /**
6897
+ * The number of files that were changed with this backup
6898
+ * @nullable
6899
+ */
6900
+ files_modified?: string | null;
6901
+ /**
6902
+ * The number of files included in this backup
6903
+ * @nullable
6904
+ */
6905
+ files_total?: string | null;
6906
+ /**
6907
+ * The method by which this backup was requested
6908
+ * @nullable
6909
+ */
6910
+ request_type?: string | null;
6911
+ /**
6912
+ * The timestamp at which the backup began
6913
+ * @nullable
6914
+ */
6915
+ start_time?: string | null;
6916
+ /**
6917
+ * The current status of the backup
6918
+ * @nullable
6919
+ */
6920
+ status?: string | null;
6921
+ /**
6922
+ * The Xcitium id for the website that this backup belongs to
6923
+ * @nullable
6924
+ */
6925
+ website_id?: string | null;
6880
6926
  };
6881
6927
  export declare type XcitiumBackupList200 = {
6882
6928
  backups?: XcitiumBackupList200BackupsItem[];
6883
6929
  };
6884
6930
  export declare type XcitiumBackupListParams = {
6885
- website_id: number;
6931
+ site_id: string;
6886
6932
  };
6887
6933
  export declare type AddonsSitelockSso200 = {
6888
6934
  site_url?: string;