11723740536

Committed 07 Nov 2024 01:14PM UTC coverage: 41.685% (+0.002%) from 41.683%

Build # 11723740536

Build Type

push

github

Committed by

web-flow

Commit Message

chore: Add stale bot (box/box-codegen#600) (#409)

Run Details

4051 of 16844 branches covered (24.05%)

Branch coverage included in aggregate %.

61 of 171 new or added lines in 89 files covered. (35.67%)

31 existing lines in 21 files now uncovered.

13378 of 24967 relevant lines covered (53.58%)

76.55 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

30.97

/src/schemas/zipDownload.generated.ts

import { serializeDateTime } from '../internal/utils.js';
import { deserializeDateTime } from '../internal/utils.js';
import { DateTime } from '../internal/utils.js';
import { BoxSdkError } from '../box/errors.js';
import { SerializedData } from '../serialization/json.js';
import { sdIsEmpty } from '../serialization/json.js';
import { sdIsBoolean } from '../serialization/json.js';
import { sdIsNumber } from '../serialization/json.js';
import { sdIsString } from '../serialization/json.js';
import { sdIsList } from '../serialization/json.js';
import { sdIsMap } from '../serialization/json.js';
export type ZipDownloadNameConflictsTypeField = 'file' | 'folder';
export interface ZipDownloadNameConflictsField {
  /**
   * The identifier of the item */
  readonly id?: string;
  /**
   * The type of this item */
  readonly type?: ZipDownloadNameConflictsTypeField;
  /**
   * The original name of this item */
  readonly originalName?: string;
  /**
   * The new name of this item as it will appear in the
   * downloaded `zip` archive. */
  readonly downloadName?: string;
  readonly rawData?: SerializedData;
}
export interface ZipDownload {
  /**
   * The URL that can be used to download the `zip` archive. A `Get` request to
   * this URL will start streaming the items requested. By default, this URL
   * is only valid for a few seconds, until the `expires_at` time, unless a
   * download is started after which it is valid for the duration of the
   * download.
   *
   * It is important to note that the domain and path of this URL might change
   * between API calls, and therefore it's important to use this URL as-is. */
  readonly downloadUrl?: string;
  /**
   * The URL that can be used to get the status of the `zip` archive being
   * downloaded. A `Get` request to this URL will return the number of files
   * in the archive as well as the number of items already downloaded or
   * skipped. By default, this URL is only valid for a few seconds, until the
   * `expires_at` time, unless a download is started after which the URL is
   * valid for 12 hours from the start of the download.
   *
   * It is important to note that the domain and path of this URL might change
   * between API calls, and therefore it's important to use this URL as-is. */
  readonly statusUrl?: string;
  /**
   * The time and date when this archive will expire. After this time the
   * `status_url` and `download_url` will return an error.
   *
   * By default, these URLs are only valid for a few seconds, unless a download
   * is started after which the `download_url` is valid for the duration of the
   * download, and the `status_url` is valid for 12 hours from the start of the
   * download. */
  readonly expiresAt?: DateTime;
  /**
   * A list of conflicts that occurred when trying to create the archive. This
   * would occur when multiple items have been requested with the
   * same name.
   *
   * To solve these conflicts, the API will automatically rename an item
   * and return a mapping between the original item's name and its new
   * name.
   *
   * For every conflict, both files will be renamed and therefore this list
   * will always be a multiple of 2. */
  readonly nameConflicts?: readonly (readonly ZipDownloadNameConflictsField[])[];
  readonly rawData?: SerializedData;
}
export function serializeZipDownloadNameConflictsTypeField(
  val: ZipDownloadNameConflictsTypeField,
): SerializedData {
  return val;
}
export function deserializeZipDownloadNameConflictsTypeField(
  val: SerializedData,
): ZipDownloadNameConflictsTypeField {
  if (val == 'file') {
    return val;
  }
  if (val == 'folder') {
    return val;
  }
  throw new BoxSdkError({
    message: "Can't deserialize ZipDownloadNameConflictsTypeField",
  });
}
export function serializeZipDownloadNameConflictsField(
  val: ZipDownloadNameConflictsField,
): SerializedData {
  return {
    ['id']: val.id == void 0 ? void 0 : val.id,
    ['type']:
      val.type == void 0
        ? void 0
        : serializeZipDownloadNameConflictsTypeField(val.type),
    ['original_name']: val.originalName == void 0 ? void 0 : val.originalName,
    ['download_name']: val.downloadName == void 0 ? void 0 : val.downloadName,
  };
}
export function deserializeZipDownloadNameConflictsField(
  val: SerializedData,
): ZipDownloadNameConflictsField {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({
      message: 'Expecting a map for "ZipDownloadNameConflictsField"',
    });
  }
  if (!(val.id == void 0) && !sdIsString(val.id)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "id" of type "ZipDownloadNameConflictsField"',
    });
  }
  const id: undefined | string = val.id == void 0 ? void 0 : val.id;
  const type: undefined | ZipDownloadNameConflictsTypeField =
    val.type == void 0
      ? void 0
      : deserializeZipDownloadNameConflictsTypeField(val.type);
  if (!(val.original_name == void 0) && !sdIsString(val.original_name)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "original_name" of type "ZipDownloadNameConflictsField"',
    });
  }
  const originalName: undefined | string =
    val.original_name == void 0 ? void 0 : val.original_name;
  if (!(val.download_name == void 0) && !sdIsString(val.download_name)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "download_name" of type "ZipDownloadNameConflictsField"',
    });
  }
  const downloadName: undefined | string =
    val.download_name == void 0 ? void 0 : val.download_name;
  return {
    id: id,
    type: type,
    originalName: originalName,
    downloadName: downloadName,
  } satisfies ZipDownloadNameConflictsField;
}
export function serializeZipDownload(val: ZipDownload): SerializedData {
  return {
    ['download_url']: val.downloadUrl == void 0 ? void 0 : val.downloadUrl,
    ['status_url']: val.statusUrl == void 0 ? void 0 : val.statusUrl,
    ['expires_at']:
      val.expiresAt == void 0 ? void 0 : serializeDateTime(val.expiresAt),
    ['name_conflicts']:
      val.nameConflicts == void 0
        ? void 0
        : (val.nameConflicts.map(function (
            item: readonly ZipDownloadNameConflictsField[],
          ): SerializedData {
            return item.map(function (
              item: ZipDownloadNameConflictsField,
            ): SerializedData {
              return serializeZipDownloadNameConflictsField(item);
            }) as readonly any[];
          }) as readonly any[]),
  };
}
export function deserializeZipDownload(val: SerializedData): ZipDownload {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({ message: 'Expecting a map for "ZipDownload"' });
  }
  if (!(val.download_url == void 0) && !sdIsString(val.download_url)) {
    throw new BoxSdkError({
      message: 'Expecting string for "download_url" of type "ZipDownload"',
    });
  }
  const downloadUrl: undefined | string =
    val.download_url == void 0 ? void 0 : val.download_url;
  if (!(val.status_url == void 0) && !sdIsString(val.status_url)) {
    throw new BoxSdkError({
      message: 'Expecting string for "status_url" of type "ZipDownload"',
    });
  }
  const statusUrl: undefined | string =
    val.status_url == void 0 ? void 0 : val.status_url;
  if (!(val.expires_at == void 0) && !sdIsString(val.expires_at)) {
    throw new BoxSdkError({
      message: 'Expecting string for "expires_at" of type "ZipDownload"',
    });
  }
  const expiresAt: undefined | DateTime =
    val.expires_at == void 0 ? void 0 : deserializeDateTime(val.expires_at);
  if (!(val.name_conflicts == void 0) && !sdIsList(val.name_conflicts)) {
    throw new BoxSdkError({
      message: 'Expecting array for "name_conflicts" of type "ZipDownload"',
    });
  }
  const nameConflicts:
    | undefined
    | readonly (readonly ZipDownloadNameConflictsField[])[] =
    val.name_conflicts == void 0
      ? void 0
      : sdIsList(val.name_conflicts)
        ? (val.name_conflicts.map(function (
            itm: SerializedData,
          ): readonly ZipDownloadNameConflictsField[] {
            return sdIsList(itm)
              ? (itm.map(function (
                  itm: SerializedData,
                ): ZipDownloadNameConflictsField {
                  return deserializeZipDownloadNameConflictsField(itm);
                }) as readonly any[])
              : [];
          }) as readonly any[])
        : [];
  return {
    downloadUrl: downloadUrl,
    statusUrl: statusUrl,
    expiresAt: expiresAt,
    nameConflicts: nameConflicts,
  } satisfies ZipDownload;
}

1	import { serializeDateTime } from '../internal/utils.js';	140✔
2	import { deserializeDateTime } from '../internal/utils.js';	140✔
3	import { DateTime } from '../internal/utils.js';
4	import { BoxSdkError } from '../box/errors.js';	140✔
5	import { SerializedData } from '../serialization/json.js';
6	import { sdIsEmpty } from '../serialization/json.js';
7	import { sdIsBoolean } from '../serialization/json.js';
8	import { sdIsNumber } from '../serialization/json.js';
9	import { sdIsString } from '../serialization/json.js';	140✔
10	import { sdIsList } from '../serialization/json.js';	140✔
11	import { sdIsMap } from '../serialization/json.js';	140✔
12	export type ZipDownloadNameConflictsTypeField = 'file' \| 'folder';
13	export interface ZipDownloadNameConflictsField {
14	/**
15	* The identifier of the item */
16	readonly id?: string;
17	/**
18	* The type of this item */
19	readonly type?: ZipDownloadNameConflictsTypeField;
20	/**
21	* The original name of this item */
22	readonly originalName?: string;
23	/**
24	* The new name of this item as it will appear in the
25	* downloaded `zip` archive. */
26	readonly downloadName?: string;
27	readonly rawData?: SerializedData;
28	}
29	export interface ZipDownload {
30	/**
31	* The URL that can be used to download the `zip` archive. A `Get` request to
32	* this URL will start streaming the items requested. By default, this URL
33	* is only valid for a few seconds, until the `expires_at` time, unless a
34	* download is started after which it is valid for the duration of the
35	* download.
36	*
37	* It is important to note that the domain and path of this URL might change
38	* between API calls, and therefore it's important to use this URL as-is. */
39	readonly downloadUrl?: string;
40	/**
41	* The URL that can be used to get the status of the `zip` archive being
42	* downloaded. A `Get` request to this URL will return the number of files
43	* in the archive as well as the number of items already downloaded or
44	* skipped. By default, this URL is only valid for a few seconds, until the
45	* `expires_at` time, unless a download is started after which the URL is
46	* valid for 12 hours from the start of the download.
47	*
48	* It is important to note that the domain and path of this URL might change
49	* between API calls, and therefore it's important to use this URL as-is. */
50	readonly statusUrl?: string;
51	/**
52	* The time and date when this archive will expire. After this time the
53	* `status_url` and `download_url` will return an error.
54	*
55	* By default, these URLs are only valid for a few seconds, unless a download
56	* is started after which the `download_url` is valid for the duration of the
57	* download, and the `status_url` is valid for 12 hours from the start of the
58	* download. */
59	readonly expiresAt?: DateTime;
60	/**
61	* A list of conflicts that occurred when trying to create the archive. This
62	* would occur when multiple items have been requested with the
63	* same name.
64	*
65	* To solve these conflicts, the API will automatically rename an item
66	* and return a mapping between the original item's name and its new
67	* name.
68	*
69	* For every conflict, both files will be renamed and therefore this list
70	* will always be a multiple of 2. */
71	readonly nameConflicts?: readonly (readonly ZipDownloadNameConflictsField[])[];
72	readonly rawData?: SerializedData;
73	}
74	export function serializeZipDownloadNameConflictsTypeField(	140✔
75	val: ZipDownloadNameConflictsTypeField,
76	): SerializedData {
77	return val;	×
78	}
79	export function deserializeZipDownloadNameConflictsTypeField(	140✔
80	val: SerializedData,
81	): ZipDownloadNameConflictsTypeField {
82	if (val == 'file') {	×
83	return val;	×
84	}
85	if (val == 'folder') {	×
86	return val;	×
87	}
88	throw new BoxSdkError({	×
89	message: "Can't deserialize ZipDownloadNameConflictsTypeField",
90	});
91	}
92	export function serializeZipDownloadNameConflictsField(	140✔
93	val: ZipDownloadNameConflictsField,
94	): SerializedData {
95	return {	×
96	['id']: val.id == void 0 ? void 0 : val.id,	×
97	['type']:
98	val.type == void 0	×
99	? void 0
100	: serializeZipDownloadNameConflictsTypeField(val.type),
101	['original_name']: val.originalName == void 0 ? void 0 : val.originalName,	×
102	['download_name']: val.downloadName == void 0 ? void 0 : val.downloadName,	×
103	};
104	}
105	export function deserializeZipDownloadNameConflictsField(	140✔
106	val: SerializedData,
107	): ZipDownloadNameConflictsField {
108	if (!sdIsMap(val)) {	×
109	throw new BoxSdkError({	×
110	message: 'Expecting a map for "ZipDownloadNameConflictsField"',
111	});
112	}
113	if (!(val.id == void 0) && !sdIsString(val.id)) {	×
114	throw new BoxSdkError({	×
115	message:
116	'Expecting string for "id" of type "ZipDownloadNameConflictsField"',
117	});
118	}
119	const id: undefined \| string = val.id == void 0 ? void 0 : val.id;	×
120	const type: undefined \| ZipDownloadNameConflictsTypeField =
121	val.type == void 0	×
122	? void 0
123	: deserializeZipDownloadNameConflictsTypeField(val.type);
124	if (!(val.original_name == void 0) && !sdIsString(val.original_name)) {	×
125	throw new BoxSdkError({	×
126	message:
127	'Expecting string for "original_name" of type "ZipDownloadNameConflictsField"',
128	});
129	}
130	const originalName: undefined \| string =
131	val.original_name == void 0 ? void 0 : val.original_name;	×
132	if (!(val.download_name == void 0) && !sdIsString(val.download_name)) {	×
133	throw new BoxSdkError({	×
134	message:
135	'Expecting string for "download_name" of type "ZipDownloadNameConflictsField"',
136	});
137	}
138	const downloadName: undefined \| string =
139	val.download_name == void 0 ? void 0 : val.download_name;	×
140	return {	×
141	id: id,
142	type: type,
143	originalName: originalName,
144	downloadName: downloadName,
145	} satisfies ZipDownloadNameConflictsField;
146	}
147	export function serializeZipDownload(val: ZipDownload): SerializedData {	140✔
148	return {	×
149	['download_url']: val.downloadUrl == void 0 ? void 0 : val.downloadUrl,	×
150	['status_url']: val.statusUrl == void 0 ? void 0 : val.statusUrl,	×
151	['expires_at']:
152	val.expiresAt == void 0 ? void 0 : serializeDateTime(val.expiresAt),	×
153	['name_conflicts']:
154	val.nameConflicts == void 0	×
155	? void 0
156	: (val.nameConflicts.map(function (
157	item: readonly ZipDownloadNameConflictsField[],
158	): SerializedData {
159	return item.map(function (	×
160	item: ZipDownloadNameConflictsField,
161	): SerializedData {
162	return serializeZipDownloadNameConflictsField(item);	×
163	}) as readonly any[];
164	}) as readonly any[]),
165	};
166	}
167	export function deserializeZipDownload(val: SerializedData): ZipDownload {	140✔
168	if (!sdIsMap(val)) {	4!
169	throw new BoxSdkError({ message: 'Expecting a map for "ZipDownload"' });	×
170	}
171	if (!(val.download_url == void 0) && !sdIsString(val.download_url)) {	4!
172	throw new BoxSdkError({	×
173	message: 'Expecting string for "download_url" of type "ZipDownload"',
174	});
175	}
176	const downloadUrl: undefined \| string =
177	val.download_url == void 0 ? void 0 : val.download_url;	4!
178	if (!(val.status_url == void 0) && !sdIsString(val.status_url)) {	4!
179	throw new BoxSdkError({	×
180	message: 'Expecting string for "status_url" of type "ZipDownload"',
181	});
182	}
183	const statusUrl: undefined \| string =
184	val.status_url == void 0 ? void 0 : val.status_url;	4!
185	if (!(val.expires_at == void 0) && !sdIsString(val.expires_at)) {	4!
186	throw new BoxSdkError({	×
187	message: 'Expecting string for "expires_at" of type "ZipDownload"',
188	});
189	}
190	const expiresAt: undefined \| DateTime =
191	val.expires_at == void 0 ? void 0 : deserializeDateTime(val.expires_at);	4!
192	if (!(val.name_conflicts == void 0) && !sdIsList(val.name_conflicts)) {	4!
193	throw new BoxSdkError({	×
194	message: 'Expecting array for "name_conflicts" of type "ZipDownload"',
195	});
196	}
197	const nameConflicts:
198	\| undefined
199	\| readonly (readonly ZipDownloadNameConflictsField[])[] =
200	val.name_conflicts == void 0	4!
201	? void 0
202	: sdIsList(val.name_conflicts)	4!
203	? (val.name_conflicts.map(function (
204	itm: SerializedData,
205	): readonly ZipDownloadNameConflictsField[] {
NEW 206	return sdIsList(itm)	×
207	? (itm.map(function (
208	itm: SerializedData,
209	): ZipDownloadNameConflictsField {
NEW 210	return deserializeZipDownloadNameConflictsField(itm);	×
211	}) as readonly any[])
212	: [];
213	}) as readonly any[])
214	: [];
215	return {	4✔
216	downloadUrl: downloadUrl,
217	statusUrl: statusUrl,
218	expiresAt: expiresAt,
219	nameConflicts: nameConflicts,
220	} satisfies ZipDownload;
221	}

box / box-typescript-sdk-gen / 11723740536

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous