Source: managers/shield-information-barriers.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 ShieldInformationBarrierManager {
  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 with specified ID
  16. 	 *
  17. 	 * Get shield information barrier based on provided ID.
  18. 	 * @param {object} options Options for the request
  19. 	 * @param {string} options.shield_information_barrier_id The ID of the shield information barrier.
  20. 	 * @param {Function} [callback] Passed the result if successful, error otherwise
  21. 	 * @returns {Promise<schemas.ShieldInformationBarrier>} 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.
  27. 			 */
  28. 			readonly shield_information_barrier_id: string;
  29. 		},
  30. 		callback?: Function
  31. 	): Promise<schemas.ShieldInformationBarrier> {
  32. 		const {
  33. 				shield_information_barrier_id: shieldInformationBarrierId,
  34. 				...queryParams
  35. 			} = options,
  36. 			apiPath = urlPath(
  37. 				'shield_information_barriers',
  38. 				shieldInformationBarrierId
  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 barriers
  51. 	 *
  52. 	 * Retrieves a list of shield information barrier objects
  53. 	 * for the enterprise of JWT.
  54. 	 * @param {object} [options] Options for the request
  55. 	 * @param {string} [options.marker] Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
  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.ShieldInformationBarriers>} A promise resolving to the result or rejecting with an error
  59. 	 */
  60. 	getAll(
  61. 		options?: {
  62. 			/**
  63. 			 * Defines the position marker at which to begin returning results. This is
  64. 			 * used when paginating using marker-based pagination.
  65. 			 */
  66. 			readonly marker?: string;
  67. 			/**
  68. 			 * The maximum number of items to return per page.
  69. 			 */
  70. 			readonly limit?: number;
  71. 		},
  72. 		callback?: Function
  73. 	): Promise<schemas.ShieldInformationBarriers> {
  74. 		const { ...queryParams } = options,
  75. 			apiPath = urlPath('shield_information_barriers'),
  76. 			params = {
  77. 				qs: queryParams,
  78. 			};
  79. 		return this.client.wrapWithDefaultHandler(this.client.get)(
  80. 			apiPath,
  81. 			params,
  82. 			callback
  83. 		);
  84. 	}
  85. 	/**
  86. 	 * Create shield information barrier
  87. 	 *
  88. 	 * Creates a shield information barrier to
  89. 	 * separate individuals/groups within the same
  90. 	 * firm and prevents confidential information passing between them.
  91. 	 * @param {object} body
  92. 	 * @param {object} [options] Options for the request
  93. 	 * @param {Function} [callback] Passed the result if successful, error otherwise
  94. 	 * @returns {Promise<schemas.ShieldInformationBarrier>} A promise resolving to the result or rejecting with an error
  95. 	 */
  96. 	create(
  97. 		body: {
  98. 			enterprise: {
  99. 				type: string;
  100. 				id: string;
  101. 			};
  102. 		},
  103. 		options?: {},
  104. 		callback?: Function
  105. 	): Promise<schemas.ShieldInformationBarrier> {
  106. 		const { ...queryParams } = options,
  107. 			apiPath = urlPath('shield_information_barriers'),
  108. 			params = {
  109. 				qs: queryParams,
  110. 				body: body,
  111. 			};
  112. 		return this.client.wrapWithDefaultHandler(this.client.post)(
  113. 			apiPath,
  114. 			params,
  115. 			callback
  116. 		);
  117. 	}
  118. 	/**
  119. 	 * Add changed status of shield information barrier with specified ID
  120. 	 *
  121. 	 * Change status of shield information barrier with the specified ID.
  122. 	 * @param {object} body
  123. 	 * @param {object} [options] Options for the request
  124. 	 * @param {Function} [callback] Passed the result if successful, error otherwise
  125. 	 * @returns {Promise<schemas.ShieldInformationBarrier>} A promise resolving to the result or rejecting with an error
  126. 	 */
  127. 	changeStatusById(
  128. 		body: {
  129. 			id: string;
  130. 			status: string;
  131. 		},
  132. 		options?: {},
  133. 		callback?: Function
  134. 	): Promise<schemas.ShieldInformationBarrier> {
  135. 		const { ...queryParams } = options,
  136. 			apiPath = urlPath('shield_information_barriers', 'change_status'),
  137. 			params = {
  138. 				qs: queryParams,
  139. 				body: body,
  140. 			};
  141. 		return this.client.wrapWithDefaultHandler(this.client.post)(
  142. 			apiPath,
  143. 			params,
  144. 			callback
  145. 		);
  146. 	}
  147. }
  148. export = ShieldInformationBarrierManager;