Source: managers/shield-information-barrier-reports.generated.ts

  1. import BoxClient from '../box-client';
  2. import urlPath from '../util/url-path';
  3. import * as schemas from '../schemas';
  4. /**
  5.  */
  6. class ShieldInformationBarrierReportsManager {
  7. 	client: BoxClient;
  8. 	/**
  9. 	 * @param {BoxClient} client The Box API Client that is responsible for making calls to the API
  10. 	 */
  11. 	constructor(client: BoxClient) {
  12. 		this.client = client;
  13. 	}
  14. 	/**
  15. 	 * Get shield information barrier report by ID
  16. 	 *
  17. 	 * Retrieves a shield information barrier report by its ID.
  18. 	 * @param {object} options Options for the request
  19. 	 * @param {string} options.shield_information_barrier_report_id The ID of the shield information barrier Report.
  20. 	 * @param {Function} [callback] Passed the result if successful, error otherwise
  21. 	 * @returns {Promise<schemas.ShieldInformationBarrierReport>} A promise resolving to the result or rejecting with an error
  22. 	 */
  23. 	getById(
  24. 		options: {
  25. 			/**
  26. 			 * The ID of the shield information barrier Report.
  27. 			 */
  28. 			readonly shield_information_barrier_report_id: string;
  29. 		},
  30. 		callback?: Function
  31. 	): Promise<schemas.ShieldInformationBarrierReport> {
  32. 		const {
  33. 				shield_information_barrier_report_id: shieldInformationBarrierReportId,
  34. 				...queryParams
  35. 			} = options,
  36. 			apiPath = urlPath(
  37. 				'shield_information_barrier_reports',
  38. 				shieldInformationBarrierReportId
  39. 			),
  40. 			params = {
  41. 				qs: queryParams,
  42. 			};
  43. 		return this.client.wrapWithDefaultHandler(this.client.get)(
  44. 			apiPath,
  45. 			params,
  46. 			callback
  47. 		);
  48. 	}
  49. 	/**
  50. 	 * List shield information barrier reports
  51. 	 *
  52. 	 * Lists shield information barrier reports.
  53. 	 * @param {object} options Options for the request
  54. 	 * @param {string} options.shield_information_barrier_id The ID of the shield information barrier.
  55. 	 * @param {string} [options.marker] Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
  56. 	 * @param {number} [options.limit] The maximum number of items to return per page.
  57. 	 * @param {Function} [callback] Passed the result if successful, error otherwise
  58. 	 * @returns {Promise<schemas.ShieldInformationBarrierReports>} A promise resolving to the result or rejecting with an error
  59. 	 */
  60. 	getAll(
  61. 		options: {
  62. 			/**
  63. 			 * The ID of the shield information barrier.
  64. 			 */
  65. 			readonly shield_information_barrier_id: string;
  66. 			/**
  67. 			 * Defines the position marker at which to begin returning results. This is
  68. 			 * used when paginating using marker-based pagination.
  69. 			 *
  70. 			 * This requires `usemarker` to be set to `true`.
  71. 			 */
  72. 			readonly marker?: string;
  73. 			/**
  74. 			 * The maximum number of items to return per page.
  75. 			 */
  76. 			readonly limit?: number;
  77. 		},
  78. 		callback?: Function
  79. 	): Promise<schemas.ShieldInformationBarrierReports> {
  80. 		const { ...queryParams } = options,
  81. 			apiPath = urlPath('shield_information_barrier_reports'),
  82. 			params = {
  83. 				qs: queryParams,
  84. 			};
  85. 		return this.client.wrapWithDefaultHandler(this.client.get)(
  86. 			apiPath,
  87. 			params,
  88. 			callback
  89. 		);
  90. 	}
  91. 	/**
  92. 	 * Create shield information barrier report
  93. 	 *
  94. 	 * Creates a shield information barrier report for a given barrier.
  95. 	 * @param {schemas.ShieldInformationBarrierReference} body
  96. 	 * @param {object} [options] Options for the request
  97. 	 * @param {Function} [callback] Passed the result if successful, error otherwise
  98. 	 * @returns {Promise<schemas.ShieldInformationBarrierReport>} A promise resolving to the result or rejecting with an error
  99. 	 */
  100. 	create(
  101. 		body: schemas.ShieldInformationBarrierReference,
  102. 		options?: {},
  103. 		callback?: Function
  104. 	): Promise<schemas.ShieldInformationBarrierReport> {
  105. 		const { ...queryParams } = options,
  106. 			apiPath = urlPath('shield_information_barrier_reports'),
  107. 			params = {
  108. 				qs: queryParams,
  109. 				body: body,
  110. 			};
  111. 		return this.client.wrapWithDefaultHandler(this.client.post)(
  112. 			apiPath,
  113. 			params,
  114. 			callback
  115. 		);
  116. 	}
  117. }
  118. export = ShieldInformationBarrierReportsManager;