From de6bbfd010c9fef86cca285fe066cc8f23941d00 Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Tue, 28 Nov 2023 04:16:58 -0800 Subject: [PATCH 1/8] generated with codegen at box/box-codegen@ae2574fc and spec at box/box-openapi@180b710 --- docs/groups.md | 2 +- docs/sessionTermination.md | 17 +- .../shieldInformationBarrierSegmentMembers.md | 43 +++++- ...ldInformationBarrierSegmentRestrictions.md | 44 +++++- docs/trashedItems.md | 6 +- src/schemas.generated.ts | 140 +++++++++-------- src/test/sessionTermination.generated.test.ts | 70 +++++++++ ...ionBarrierSegmentMembers.generated.test.ts | 117 ++++++++++++++ ...rrierSegmentRestrictions.generated.test.ts | 145 ++++++++++++++++++ src/test/trashedItems.generated.test.ts | 26 ++++ 10 files changed, 533 insertions(+), 77 deletions(-) create mode 100644 src/test/sessionTermination.generated.test.ts create mode 100644 src/test/shieldInformationBarrierSegmentMembers.generated.test.ts create mode 100644 src/test/shieldInformationBarrierSegmentRestrictions.generated.test.ts create mode 100644 src/test/trashedItems.generated.test.ts diff --git a/docs/groups.md b/docs/groups.md index 6f883e66..fbe1b685 100644 --- a/docs/groups.md +++ b/docs/groups.md @@ -52,7 +52,7 @@ See the endpoint docs at ```ts await client.groups.createGroup({ - name: getUuid(), + name: groupName, } satisfies CreateGroupRequestBodyArg); ``` diff --git a/docs/sessionTermination.md b/docs/sessionTermination.md index 71dbc904..d83e952b 100644 --- a/docs/sessionTermination.md +++ b/docs/sessionTermination.md @@ -15,7 +15,14 @@ This operation is performed by calling function `createUserTerminateSession`. See the endpoint docs at [API Reference](https://developer.box.com/reference/post-users-terminate-sessions/). -_Currently we don't have an example for calling `createUserTerminateSession` in integration tests_ + + +```ts +await client.sessionTermination.createUserTerminateSession({ + userIds: [getEnvVar('USER_ID')], + userLogins: [user.login!], +} satisfies CreateUserTerminateSessionRequestBodyArg); +``` ### Arguments @@ -44,7 +51,13 @@ This operation is performed by calling function `createGroupTerminateSession`. See the endpoint docs at [API Reference](https://developer.box.com/reference/post-groups-terminate-sessions/). -_Currently we don't have an example for calling `createGroupTerminateSession` in integration tests_ + + +```ts +await client.sessionTermination.createGroupTerminateSession({ + groupIds: [group.id], +} satisfies CreateGroupTerminateSessionRequestBodyArg); +``` ### Arguments diff --git a/docs/shieldInformationBarrierSegmentMembers.md b/docs/shieldInformationBarrierSegmentMembers.md index a88a110c..bf8da812 100644 --- a/docs/shieldInformationBarrierSegmentMembers.md +++ b/docs/shieldInformationBarrierSegmentMembers.md @@ -15,7 +15,13 @@ This operation is performed by calling function `getShieldInformationBarrierSegm See the endpoint docs at [API Reference](https://developer.box.com/reference/get-shield-information-barrier-segment-members-id/). -_Currently we don't have an example for calling `getShieldInformationBarrierSegmentMemberById` in integration tests_ + + +```ts +await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMemberById( + segmentMember.id! +); +``` ### Arguments @@ -42,7 +48,13 @@ This operation is performed by calling function `deleteShieldInformationBarrierS See the endpoint docs at [API Reference](https://developer.box.com/reference/delete-shield-information-barrier-segment-members-id/). -_Currently we don't have an example for calling `deleteShieldInformationBarrierSegmentMemberById` in integration tests_ + + +```ts +await client.shieldInformationBarrierSegmentMembers.deleteShieldInformationBarrierSegmentMemberById( + segmentMember.id! +); +``` ### Arguments @@ -70,7 +82,15 @@ This operation is performed by calling function `getShieldInformationBarrierSegm See the endpoint docs at [API Reference](https://developer.box.com/reference/get-shield-information-barrier-segment-members/). -_Currently we don't have an example for calling `getShieldInformationBarrierSegmentMembers` in integration tests_ + + +```ts +await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMembers( + { + shieldInformationBarrierSegmentId: segment.id!, + } satisfies GetShieldInformationBarrierSegmentMembersQueryParamsArg +); +``` ### Arguments @@ -97,7 +117,22 @@ This operation is performed by calling function `createShieldInformationBarrierS See the endpoint docs at [API Reference](https://developer.box.com/reference/post-shield-information-barrier-segment-members/). -_Currently we don't have an example for calling `createShieldInformationBarrierSegmentMember` in integration tests_ + + +```ts +await client.shieldInformationBarrierSegmentMembers.createShieldInformationBarrierSegmentMember( + { + shieldInformationBarrierSegment: { + id: segment.id!, + type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField, + } satisfies CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField, + user: { + id: getEnvVar('USER_ID'), + type: 'user' as UserBaseTypeField, + } satisfies UserBase, + } satisfies CreateShieldInformationBarrierSegmentMemberRequestBodyArg +); +``` ### Arguments diff --git a/docs/shieldInformationBarrierSegmentRestrictions.md b/docs/shieldInformationBarrierSegmentRestrictions.md index 2206dda9..76addc22 100644 --- a/docs/shieldInformationBarrierSegmentRestrictions.md +++ b/docs/shieldInformationBarrierSegmentRestrictions.md @@ -15,7 +15,13 @@ This operation is performed by calling function `getShieldInformationBarrierSegm See the endpoint docs at [API Reference](https://developer.box.com/reference/get-shield-information-barrier-segment-restrictions-id/). -_Currently we don't have an example for calling `getShieldInformationBarrierSegmentRestrictionById` in integration tests_ + + +```ts +await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictionById( + segmentRestrictionId +); +``` ### Arguments @@ -43,7 +49,13 @@ This operation is performed by calling function `deleteShieldInformationBarrierS See the endpoint docs at [API Reference](https://developer.box.com/reference/delete-shield-information-barrier-segment-restrictions-id/). -_Currently we don't have an example for calling `deleteShieldInformationBarrierSegmentRestrictionById` in integration tests_ + + +```ts +await client.shieldInformationBarrierSegmentRestrictions.deleteShieldInformationBarrierSegmentRestrictionById( + segmentRestrictionId +); +``` ### Arguments @@ -70,7 +82,15 @@ This operation is performed by calling function `getShieldInformationBarrierSegm See the endpoint docs at [API Reference](https://developer.box.com/reference/get-shield-information-barrier-segment-restrictions/). -_Currently we don't have an example for calling `getShieldInformationBarrierSegmentRestrictions` in integration tests_ + + +```ts +await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictions( + { + shieldInformationBarrierSegmentId: segmentId, + } satisfies GetShieldInformationBarrierSegmentRestrictionsQueryParamsArg +); +``` ### Arguments @@ -98,7 +118,23 @@ This operation is performed by calling function `createShieldInformationBarrierS See the endpoint docs at [API Reference](https://developer.box.com/reference/post-shield-information-barrier-segment-restrictions/). -_Currently we don't have an example for calling `createShieldInformationBarrierSegmentRestriction` in integration tests_ + + +```ts +await client.shieldInformationBarrierSegmentRestrictions.createShieldInformationBarrierSegmentRestriction( + { + restrictedSegment: { + id: segmentToRestrictId, + type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField, + } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField, + shieldInformationBarrierSegment: { + id: segmentId, + type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField, + } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField, + type: 'shield_information_barrier_segment_restriction' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField, + } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyArg +); +``` ### Arguments diff --git a/docs/trashedItems.md b/docs/trashedItems.md index ad3c0a55..c6c319a2 100644 --- a/docs/trashedItems.md +++ b/docs/trashedItems.md @@ -19,7 +19,11 @@ This operation is performed by calling function `getFolderTrashItems`. See the endpoint docs at [API Reference](https://developer.box.com/reference/get-folders-trash-items/). -_Currently we don't have an example for calling `getFolderTrashItems` in integration tests_ + + +```ts +await client.trashedItems.getFolderTrashItems(); +``` ### Arguments diff --git a/src/schemas.generated.ts b/src/schemas.generated.ts index fdda114e..aa46a251 100644 --- a/src/schemas.generated.ts +++ b/src/schemas.generated.ts @@ -195,8 +195,8 @@ export interface CollaborationAllowlistEntry { } export interface CollaborationAllowlistEntries { readonly limit?: number; - readonly nextMarker?: number; - readonly prevMarker?: number; + readonly nextMarker?: string; + readonly prevMarker?: string; readonly entries?: readonly CollaborationAllowlistEntry[]; } export type CollectionTypeField = 'collection'; @@ -291,8 +291,8 @@ export interface AccessToken { } export interface FilesUnderRetention { readonly limit?: number; - readonly nextMarker?: number; - readonly prevMarker?: number; + readonly nextMarker?: string; + readonly prevMarker?: string; readonly entries?: readonly FileMini[]; } export type FileConflict = FileMini & {}; @@ -420,8 +420,8 @@ export interface MetadataCascadePolicy { } export interface MetadataCascadePolicies { readonly limit?: number; - readonly nextMarker?: number; - readonly prevMarker?: number; + readonly nextMarker?: string; + readonly prevMarker?: string; readonly entries?: readonly MetadataCascadePolicy[]; } export type MetadataQueryIndexStatusField = 'building' | 'active' | 'disabled'; @@ -474,8 +474,8 @@ export interface MetadataTemplate { } export interface MetadataTemplates { readonly limit?: number; - readonly nextMarker?: number; - readonly prevMarker?: number; + readonly nextMarker?: string; + readonly prevMarker?: string; readonly entries?: readonly MetadataTemplate[]; } export interface RealtimeServer { @@ -514,8 +514,8 @@ export interface FileVersionRetention { } export interface FileVersionRetentions { readonly limit?: number; - readonly nextMarker?: number; - readonly prevMarker?: number; + readonly nextMarker?: string; + readonly prevMarker?: string; readonly entries?: readonly FileVersionRetention[]; } export type RetentionPolicyAssignmentBaseTypeField = @@ -586,8 +586,8 @@ export interface StoragePolicyAssignment { } export interface StoragePolicyAssignments { readonly limit?: number; - readonly nextMarker?: number; - readonly prevMarker?: number; + readonly nextMarker?: string; + readonly prevMarker?: string; readonly entries?: readonly StoragePolicyAssignment[]; } export type StoragePolicy = StoragePolicyMini & { @@ -595,8 +595,8 @@ export type StoragePolicy = StoragePolicyMini & { }; export interface StoragePolicies { readonly limit?: number; - readonly nextMarker?: number; - readonly prevMarker?: number; + readonly nextMarker?: string; + readonly prevMarker?: string; readonly entries?: readonly StoragePolicy[]; } export type TermsOfServiceBaseTypeField = 'terms_of_service'; @@ -1067,8 +1067,8 @@ export type LegalHoldPolicy = LegalHoldPolicyMini & { }; export interface LegalHoldPolicies { readonly limit?: number; - readonly nextMarker?: number; - readonly prevMarker?: number; + readonly nextMarker?: string; + readonly prevMarker?: string; readonly entries?: readonly LegalHoldPolicy[]; } export type InviteTypeField = 'invite'; @@ -1396,8 +1396,8 @@ export interface CollaborationAllowlistExemptTarget { } export interface CollaborationAllowlistExemptTargets { readonly limit?: number; - readonly nextMarker?: number; - readonly prevMarker?: number; + readonly nextMarker?: string; + readonly prevMarker?: string; readonly entries?: readonly CollaborationAllowlistExemptTarget[]; } export type ShieldInformationBarrierSegmentRestriction = @@ -1493,10 +1493,9 @@ export interface FolderLock { readonly lockType?: string; } export interface FolderLocks { - readonly limit?: number; - readonly nextMarker?: number; - readonly prevMarker?: number; readonly entries?: readonly FolderLock[]; + readonly limit?: string; + readonly nextMarker?: string; } export interface WatermarkWatermarkField { readonly createdAt?: string; @@ -1518,8 +1517,8 @@ export interface WebhookMini { } export interface Webhooks { readonly limit?: number; - readonly nextMarker?: number; - readonly prevMarker?: number; + readonly nextMarker?: string; + readonly prevMarker?: string; readonly entries?: readonly WebhookMini[]; } export type WebhookTriggersField = @@ -1871,8 +1870,8 @@ export type LegalHoldPolicyAssignment = LegalHoldPolicyAssignmentBase & { }; export interface LegalHoldPolicyAssignments { readonly limit?: number; - readonly nextMarker?: number; - readonly prevMarker?: number; + readonly nextMarker?: string; + readonly prevMarker?: string; readonly entries?: readonly LegalHoldPolicyAssignment[]; } export type FileVersionLegalHoldTypeField = 'file_version_legal_hold'; @@ -1886,8 +1885,8 @@ export interface FileVersionLegalHold { } export interface FileVersionLegalHolds { readonly limit?: number; - readonly nextMarker?: number; - readonly prevMarker?: number; + readonly nextMarker?: string; + readonly prevMarker?: string; readonly entries?: readonly FileVersionLegalHold[]; } export type CollaborationTypeField = 'collaboration'; @@ -2265,8 +2264,8 @@ export type Workflow = WorkflowMini & { }; export interface Workflows { readonly limit?: number; - readonly nextMarker?: number; - readonly prevMarker?: number; + readonly nextMarker?: string; + readonly prevMarker?: string; readonly entries?: readonly Workflow[]; } export type WorkflowFull = Workflow & { @@ -2495,6 +2494,7 @@ export interface SignRequestCreateSigner { readonly loginRequired?: boolean; readonly verificationPhoneNumber?: string; readonly password?: string; + readonly signerGroupId?: string; } export interface SignRequestPrefillTag { readonly documentTagId?: string; @@ -2659,6 +2659,7 @@ export interface TemplateSigner { readonly role?: TemplateSignerRoleField; readonly isInPerson?: boolean; readonly order?: number; + readonly signerGroupId?: string; } export type SignTemplateTypeField = 'sign-template'; export type SignTemplateAdditionalInfoFieldNonEditableField = @@ -4002,9 +4003,9 @@ export function deserializeCollaborationAllowlistEntries( val: any ): CollaborationAllowlistEntries { const limit: undefined | number = val.limit == void 0 ? void 0 : val.limit; - const nextMarker: undefined | number = + const nextMarker: undefined | string = val.next_marker == void 0 ? void 0 : val.next_marker; - const prevMarker: undefined | number = + const prevMarker: undefined | string = val.prev_marker == void 0 ? void 0 : val.prev_marker; const entries: undefined | readonly CollaborationAllowlistEntry[] = val.entries == void 0 @@ -4576,9 +4577,9 @@ export function serializeFilesUnderRetention( } export function deserializeFilesUnderRetention(val: any): FilesUnderRetention { const limit: undefined | number = val.limit == void 0 ? void 0 : val.limit; - const nextMarker: undefined | number = + const nextMarker: undefined | string = val.next_marker == void 0 ? void 0 : val.next_marker; - const prevMarker: undefined | number = + const prevMarker: undefined | string = val.prev_marker == void 0 ? void 0 : val.prev_marker; const entries: undefined | readonly FileMini[] = val.entries == void 0 @@ -5545,9 +5546,9 @@ export function deserializeMetadataCascadePolicies( val: any ): MetadataCascadePolicies { const limit: undefined | number = val.limit == void 0 ? void 0 : val.limit; - const nextMarker: undefined | number = + const nextMarker: undefined | string = val.next_marker == void 0 ? void 0 : val.next_marker; - const prevMarker: undefined | number = + const prevMarker: undefined | string = val.prev_marker == void 0 ? void 0 : val.prev_marker; const entries: undefined | readonly MetadataCascadePolicy[] = val.entries == void 0 @@ -5887,9 +5888,9 @@ export function serializeMetadataTemplates( } export function deserializeMetadataTemplates(val: any): MetadataTemplates { const limit: undefined | number = val.limit == void 0 ? void 0 : val.limit; - const nextMarker: undefined | number = + const nextMarker: undefined | string = val.next_marker == void 0 ? void 0 : val.next_marker; - const prevMarker: undefined | number = + const prevMarker: undefined | string = val.prev_marker == void 0 ? void 0 : val.prev_marker; const entries: undefined | readonly MetadataTemplate[] = val.entries == void 0 @@ -6140,9 +6141,9 @@ export function deserializeFileVersionRetentions( val: any ): FileVersionRetentions { const limit: undefined | number = val.limit == void 0 ? void 0 : val.limit; - const nextMarker: undefined | number = + const nextMarker: undefined | string = val.next_marker == void 0 ? void 0 : val.next_marker; - const prevMarker: undefined | number = + const prevMarker: undefined | string = val.prev_marker == void 0 ? void 0 : val.prev_marker; const entries: undefined | readonly FileVersionRetention[] = val.entries == void 0 @@ -6627,9 +6628,9 @@ export function deserializeStoragePolicyAssignments( val: any ): StoragePolicyAssignments { const limit: undefined | number = val.limit == void 0 ? void 0 : val.limit; - const nextMarker: undefined | number = + const nextMarker: undefined | string = val.next_marker == void 0 ? void 0 : val.next_marker; - const prevMarker: undefined | number = + const prevMarker: undefined | string = val.prev_marker == void 0 ? void 0 : val.prev_marker; const entries: undefined | readonly StoragePolicyAssignment[] = val.entries == void 0 @@ -6677,9 +6678,9 @@ export function serializeStoragePolicies(val: StoragePolicies): SerializedData { } export function deserializeStoragePolicies(val: any): StoragePolicies { const limit: undefined | number = val.limit == void 0 ? void 0 : val.limit; - const nextMarker: undefined | number = + const nextMarker: undefined | string = val.next_marker == void 0 ? void 0 : val.next_marker; - const prevMarker: undefined | number = + const prevMarker: undefined | string = val.prev_marker == void 0 ? void 0 : val.prev_marker; const entries: undefined | readonly StoragePolicy[] = val.entries == void 0 @@ -9506,9 +9507,9 @@ export function serializeLegalHoldPolicies( } export function deserializeLegalHoldPolicies(val: any): LegalHoldPolicies { const limit: undefined | number = val.limit == void 0 ? void 0 : val.limit; - const nextMarker: undefined | number = + const nextMarker: undefined | string = val.next_marker == void 0 ? void 0 : val.next_marker; - const prevMarker: undefined | number = + const prevMarker: undefined | string = val.prev_marker == void 0 ? void 0 : val.prev_marker; const entries: undefined | readonly LegalHoldPolicy[] = val.entries == void 0 @@ -11697,9 +11698,9 @@ export function deserializeCollaborationAllowlistExemptTargets( val: any ): CollaborationAllowlistExemptTargets { const limit: undefined | number = val.limit == void 0 ? void 0 : val.limit; - const nextMarker: undefined | number = + const nextMarker: undefined | string = val.next_marker == void 0 ? void 0 : val.next_marker; - const prevMarker: undefined | number = + const prevMarker: undefined | string = val.prev_marker == void 0 ? void 0 : val.prev_marker; const entries: undefined | readonly CollaborationAllowlistExemptTarget[] = val.entries == void 0 @@ -12317,23 +12318,17 @@ export function deserializeFolderLock(val: any): FolderLock { } export function serializeFolderLocks(val: FolderLocks): SerializedData { return { - ['limit']: val.limit == void 0 ? void 0 : val.limit, - ['next_marker']: val.nextMarker == void 0 ? void 0 : val.nextMarker, - ['prev_marker']: val.prevMarker == void 0 ? void 0 : val.prevMarker, ['entries']: val.entries == void 0 ? void 0 : (val.entries.map(function (item: FolderLock): any { return serializeFolderLock(item); }) as readonly any[]), + ['limit']: val.limit == void 0 ? void 0 : val.limit, + ['next_marker']: val.nextMarker == void 0 ? void 0 : val.nextMarker, }; } export function deserializeFolderLocks(val: any): FolderLocks { - const limit: undefined | number = val.limit == void 0 ? void 0 : val.limit; - const nextMarker: undefined | number = - val.next_marker == void 0 ? void 0 : val.next_marker; - const prevMarker: undefined | number = - val.prev_marker == void 0 ? void 0 : val.prev_marker; const entries: undefined | readonly FolderLock[] = val.entries == void 0 ? void 0 @@ -12342,11 +12337,13 @@ export function deserializeFolderLocks(val: any): FolderLocks { return deserializeFolderLock(itm); }) as readonly any[]) : []; + const limit: undefined | string = val.limit == void 0 ? void 0 : val.limit; + const nextMarker: undefined | string = + val.next_marker == void 0 ? void 0 : val.next_marker; return { + entries: entries, limit: limit, nextMarker: nextMarker, - prevMarker: prevMarker, - entries: entries, } satisfies FolderLocks; } export function serializeWatermarkWatermarkField( @@ -12476,9 +12473,9 @@ export function serializeWebhooks(val: Webhooks): SerializedData { } export function deserializeWebhooks(val: any): Webhooks { const limit: undefined | number = val.limit == void 0 ? void 0 : val.limit; - const nextMarker: undefined | number = + const nextMarker: undefined | string = val.next_marker == void 0 ? void 0 : val.next_marker; - const prevMarker: undefined | number = + const prevMarker: undefined | string = val.prev_marker == void 0 ? void 0 : val.prev_marker; const entries: undefined | readonly WebhookMini[] = val.entries == void 0 @@ -14164,9 +14161,9 @@ export function deserializeLegalHoldPolicyAssignments( val: any ): LegalHoldPolicyAssignments { const limit: undefined | number = val.limit == void 0 ? void 0 : val.limit; - const nextMarker: undefined | number = + const nextMarker: undefined | string = val.next_marker == void 0 ? void 0 : val.next_marker; - const prevMarker: undefined | number = + const prevMarker: undefined | string = val.prev_marker == void 0 ? void 0 : val.prev_marker; const entries: undefined | readonly LegalHoldPolicyAssignment[] = val.entries == void 0 @@ -14280,9 +14277,9 @@ export function deserializeFileVersionLegalHolds( val: any ): FileVersionLegalHolds { const limit: undefined | number = val.limit == void 0 ? void 0 : val.limit; - const nextMarker: undefined | number = + const nextMarker: undefined | string = val.next_marker == void 0 ? void 0 : val.next_marker; - const prevMarker: undefined | number = + const prevMarker: undefined | string = val.prev_marker == void 0 ? void 0 : val.prev_marker; const entries: undefined | readonly FileVersionLegalHold[] = val.entries == void 0 @@ -16692,9 +16689,9 @@ export function serializeWorkflows(val: Workflows): SerializedData { } export function deserializeWorkflows(val: any): Workflows { const limit: undefined | number = val.limit == void 0 ? void 0 : val.limit; - const nextMarker: undefined | number = + const nextMarker: undefined | string = val.next_marker == void 0 ? void 0 : val.next_marker; - const prevMarker: undefined | number = + const prevMarker: undefined | string = val.prev_marker == void 0 ? void 0 : val.prev_marker; const entries: undefined | readonly Workflow[] = val.entries == void 0 @@ -18128,6 +18125,8 @@ export function serializeSignRequestCreateSigner( ? void 0 : val.verificationPhoneNumber, ['password']: val.password == void 0 ? void 0 : val.password, + ['signer_group_id']: + val.signerGroupId == void 0 ? void 0 : val.signerGroupId, }; } export function deserializeSignRequestCreateSigner( @@ -18157,6 +18156,8 @@ export function deserializeSignRequestCreateSigner( : val.verification_phone_number; const password: undefined | string = val.password == void 0 ? void 0 : val.password; + const signerGroupId: undefined | string = + val.signer_group_id == void 0 ? void 0 : val.signer_group_id; return { email: email, role: role, @@ -18168,6 +18169,7 @@ export function deserializeSignRequestCreateSigner( loginRequired: loginRequired, verificationPhoneNumber: verificationPhoneNumber, password: password, + signerGroupId: signerGroupId, } satisfies SignRequestCreateSigner; } export function serializeSignRequestPrefillTag( @@ -18461,6 +18463,8 @@ export function deserializeSignRequestSigner(val: any): SignRequestSigner { : val.verification_phone_number; const password: undefined | string = val.password == void 0 ? void 0 : val.password; + const signerGroupId: undefined | string = + val.signer_group_id == void 0 ? void 0 : val.signer_group_id; return { hasViewedDocument: hasViewedDocument, signerDecision: signerDecision, @@ -18477,6 +18481,7 @@ export function deserializeSignRequestSigner(val: any): SignRequestSigner { loginRequired: loginRequired, verificationPhoneNumber: verificationPhoneNumber, password: password, + signerGroupId: signerGroupId, } satisfies SignRequestSigner; } export function serializeSignRequestBase(val: SignRequestBase): SerializedData { @@ -19230,6 +19235,8 @@ export function serializeTemplateSigner(val: TemplateSigner): SerializedData { val.role == void 0 ? void 0 : serializeTemplateSignerRoleField(val.role), ['is_in_person']: val.isInPerson == void 0 ? void 0 : val.isInPerson, ['order']: val.order == void 0 ? void 0 : val.order, + ['signer_group_id']: + val.signerGroupId == void 0 ? void 0 : val.signerGroupId, }; } export function deserializeTemplateSigner(val: any): TemplateSigner { @@ -19247,12 +19254,15 @@ export function deserializeTemplateSigner(val: any): TemplateSigner { const isInPerson: undefined | boolean = val.is_in_person == void 0 ? void 0 : val.is_in_person; const order: undefined | number = val.order == void 0 ? void 0 : val.order; + const signerGroupId: undefined | string = + val.signer_group_id == void 0 ? void 0 : val.signer_group_id; return { inputs: inputs, email: email, role: role, isInPerson: isInPerson, order: order, + signerGroupId: signerGroupId, } satisfies TemplateSigner; } export function serializeSignTemplateTypeField( diff --git a/src/test/sessionTermination.generated.test.ts b/src/test/sessionTermination.generated.test.ts new file mode 100644 index 00000000..46877d7d --- /dev/null +++ b/src/test/sessionTermination.generated.test.ts @@ -0,0 +1,70 @@ +import { serializeUserFull } from '../schemas.generated.js'; +import { deserializeUserFull } from '../schemas.generated.js'; +import { serializeSessionTerminationMessage } from '../schemas.generated.js'; +import { deserializeSessionTerminationMessage } from '../schemas.generated.js'; +import { serializeCreateUserTerminateSessionRequestBodyArg } from '../managers/sessionTermination.generated.js'; +import { deserializeCreateUserTerminateSessionRequestBodyArg } from '../managers/sessionTermination.generated.js'; +import { serializeGroupFull } from '../schemas.generated.js'; +import { deserializeGroupFull } from '../schemas.generated.js'; +import { serializeCreateGroupRequestBodyArg } from '../managers/groups.generated.js'; +import { deserializeCreateGroupRequestBodyArg } from '../managers/groups.generated.js'; +import { serializeCreateGroupTerminateSessionRequestBodyArg } from '../managers/sessionTermination.generated.js'; +import { deserializeCreateGroupTerminateSessionRequestBodyArg } from '../managers/sessionTermination.generated.js'; +import { BoxClient } from '../client.generated.js'; +import { UserFull } from '../schemas.generated.js'; +import { SessionTerminationMessage } from '../schemas.generated.js'; +import { CreateUserTerminateSessionRequestBodyArg } from '../managers/sessionTermination.generated.js'; +import { GroupFull } from '../schemas.generated.js'; +import { CreateGroupRequestBodyArg } from '../managers/groups.generated.js'; +import { CreateGroupTerminateSessionRequestBodyArg } from '../managers/sessionTermination.generated.js'; +import { getUuid } from '../utils.js'; +import { getEnvVar } from '../utils.js'; +import { getDefaultClient } from './commons.generated.js'; +import { getDefaultClientAsUser } from './commons.generated.js'; +import { SerializedData } from '../json.js'; +import { sdIsEmpty } from '../json.js'; +import { sdIsBoolean } from '../json.js'; +import { sdIsNumber } from '../json.js'; +import { sdIsString } from '../json.js'; +import { sdIsList } from '../json.js'; +import { sdIsMap } from '../json.js'; +const client: BoxClient = getDefaultClient(); +test('testSessionTerminationUser', async function testSessionTerminationUser(): Promise { + const adminClient: BoxClient = await getDefaultClientAsUser( + getEnvVar('USER_ID') + ); + const user: UserFull = await adminClient.users.getUserMe(); + const result: SessionTerminationMessage = + await client.sessionTermination.createUserTerminateSession({ + userIds: [getEnvVar('USER_ID')], + userLogins: [user.login!], + } satisfies CreateUserTerminateSessionRequestBodyArg); + if ( + !( + result.message == + 'Request is successful, please check the admin events for the status of the job' + ) + ) { + throw 'Assertion failed'; + } +}); +test('testSessionTerminationGroup', async function testSessionTerminationGroup(): Promise { + const groupName: string = getUuid(); + const group: GroupFull = await client.groups.createGroup({ + name: groupName, + } satisfies CreateGroupRequestBodyArg); + const result: SessionTerminationMessage = + await client.sessionTermination.createGroupTerminateSession({ + groupIds: [group.id], + } satisfies CreateGroupTerminateSessionRequestBodyArg); + if ( + !( + result.message == + 'Request is successful, please check the admin events for the status of the job' + ) + ) { + throw 'Assertion failed'; + } + await client.groups.deleteGroupById(group.id); +}); +export {}; diff --git a/src/test/shieldInformationBarrierSegmentMembers.generated.test.ts b/src/test/shieldInformationBarrierSegmentMembers.generated.test.ts new file mode 100644 index 00000000..c92b1d56 --- /dev/null +++ b/src/test/shieldInformationBarrierSegmentMembers.generated.test.ts @@ -0,0 +1,117 @@ +import { serializeShieldInformationBarrier } from '../schemas.generated.js'; +import { deserializeShieldInformationBarrier } from '../schemas.generated.js'; +import { serializeShieldInformationBarrierSegment } from '../schemas.generated.js'; +import { deserializeShieldInformationBarrierSegment } from '../schemas.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentRequestBodyArg } from '../managers/shieldInformationBarrierSegments.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentRequestBodyArg } from '../managers/shieldInformationBarrierSegments.generated.js'; +import { serializeShieldInformationBarrierBase } from '../schemas.generated.js'; +import { deserializeShieldInformationBarrierBase } from '../schemas.generated.js'; +import { serializeShieldInformationBarrierBaseTypeField } from '../schemas.generated.js'; +import { deserializeShieldInformationBarrierBaseTypeField } from '../schemas.generated.js'; +import { serializeShieldInformationBarrierSegmentMember } from '../schemas.generated.js'; +import { deserializeShieldInformationBarrierSegmentMember } from '../schemas.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentMemberRequestBodyArg } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyArg } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { serializeUserBase } from '../schemas.generated.js'; +import { deserializeUserBase } from '../schemas.generated.js'; +import { serializeUserBaseTypeField } from '../schemas.generated.js'; +import { deserializeUserBaseTypeField } from '../schemas.generated.js'; +import { serializeShieldInformationBarrierSegmentMembers } from '../schemas.generated.js'; +import { deserializeShieldInformationBarrierSegmentMembers } from '../schemas.generated.js'; +import { BoxClient } from '../client.generated.js'; +import { ShieldInformationBarrier } from '../schemas.generated.js'; +import { ShieldInformationBarrierSegment } from '../schemas.generated.js'; +import { CreateShieldInformationBarrierSegmentRequestBodyArg } from '../managers/shieldInformationBarrierSegments.generated.js'; +import { ShieldInformationBarrierBase } from '../schemas.generated.js'; +import { ShieldInformationBarrierBaseTypeField } from '../schemas.generated.js'; +import { ShieldInformationBarrierSegmentMember } from '../schemas.generated.js'; +import { CreateShieldInformationBarrierSegmentMemberRequestBodyArg } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { UserBase } from '../schemas.generated.js'; +import { UserBaseTypeField } from '../schemas.generated.js'; +import { ShieldInformationBarrierSegmentMembers } from '../schemas.generated.js'; +import { GetShieldInformationBarrierSegmentMembersQueryParamsArg } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { getEnvVar } from '../utils.js'; +import { getUuid } from '../utils.js'; +import { getDefaultClientAsUser } from './commons.generated.js'; +import { getOrCreateShieldInformationBarrier } from './commons.generated.js'; +import { SerializedData } from '../json.js'; +import { sdIsEmpty } from '../json.js'; +import { sdIsBoolean } from '../json.js'; +import { sdIsNumber } from '../json.js'; +import { sdIsString } from '../json.js'; +import { sdIsList } from '../json.js'; +import { sdIsMap } from '../json.js'; +test('testShieldInformationBarrierSegmentMembers', async function testShieldInformationBarrierSegmentMembers(): Promise { + const client: BoxClient = await getDefaultClientAsUser(getEnvVar('USER_ID')); + const enterpriseId: string = getEnvVar('ENTERPRISE_ID'); + const barrier: ShieldInformationBarrier = + await getOrCreateShieldInformationBarrier(client, enterpriseId); + const barrierId: string = barrier.id!; + const segmentName: string = getUuid(); + const segment: ShieldInformationBarrierSegment = + await client.shieldInformationBarrierSegments.createShieldInformationBarrierSegment( + { + shieldInformationBarrier: { + id: barrierId, + type: 'shield_information_barrier' as ShieldInformationBarrierBaseTypeField, + } satisfies ShieldInformationBarrierBase, + name: segmentName, + } satisfies CreateShieldInformationBarrierSegmentRequestBodyArg + ); + if (!(segment.name! == segmentName)) { + throw 'Assertion failed'; + } + const segmentMember: ShieldInformationBarrierSegmentMember = + await client.shieldInformationBarrierSegmentMembers.createShieldInformationBarrierSegmentMember( + { + shieldInformationBarrierSegment: { + id: segment.id!, + type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField, + } satisfies CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField, + user: { + id: getEnvVar('USER_ID'), + type: 'user' as UserBaseTypeField, + } satisfies UserBase, + } satisfies CreateShieldInformationBarrierSegmentMemberRequestBodyArg + ); + if (!(segmentMember.user!.id == getEnvVar('USER_ID'))) { + throw 'Assertion failed'; + } + if (!(segmentMember.shieldInformationBarrierSegment!.id == segment.id!)) { + throw 'Assertion failed'; + } + const segmentMembers: ShieldInformationBarrierSegmentMembers = + await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMembers( + { + shieldInformationBarrierSegmentId: segment.id!, + } satisfies GetShieldInformationBarrierSegmentMembersQueryParamsArg + ); + if (!(segmentMembers.entries!.length > 0)) { + throw 'Assertion failed'; + } + const segmentMemberGet: ShieldInformationBarrierSegmentMember = + await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMemberById( + segmentMember.id! + ); + if (!(segmentMemberGet.id! == segmentMember.id!)) { + throw 'Assertion failed'; + } + await client.shieldInformationBarrierSegmentMembers.deleteShieldInformationBarrierSegmentMemberById( + segmentMember.id! + ); + expect(async () => { + await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMemberById( + segmentMember.id! + ); + }).rejects.toThrow(); + await client.shieldInformationBarrierSegments.deleteShieldInformationBarrierSegmentById( + segment.id! + ); +}); +export {}; diff --git a/src/test/shieldInformationBarrierSegmentRestrictions.generated.test.ts b/src/test/shieldInformationBarrierSegmentRestrictions.generated.test.ts new file mode 100644 index 00000000..9d5d5fc1 --- /dev/null +++ b/src/test/shieldInformationBarrierSegmentRestrictions.generated.test.ts @@ -0,0 +1,145 @@ +import { serializeShieldInformationBarrier } from '../schemas.generated.js'; +import { deserializeShieldInformationBarrier } from '../schemas.generated.js'; +import { serializeShieldInformationBarrierSegment } from '../schemas.generated.js'; +import { deserializeShieldInformationBarrierSegment } from '../schemas.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentRequestBodyArg } from '../managers/shieldInformationBarrierSegments.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentRequestBodyArg } from '../managers/shieldInformationBarrierSegments.generated.js'; +import { serializeShieldInformationBarrierBase } from '../schemas.generated.js'; +import { deserializeShieldInformationBarrierBase } from '../schemas.generated.js'; +import { serializeShieldInformationBarrierBaseTypeField } from '../schemas.generated.js'; +import { deserializeShieldInformationBarrierBaseTypeField } from '../schemas.generated.js'; +import { serializeShieldInformationBarrierSegmentRestriction } from '../schemas.generated.js'; +import { deserializeShieldInformationBarrierSegmentRestriction } from '../schemas.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArg } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArg } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { serializeShieldInformationBarrierSegmentRestrictions } from '../schemas.generated.js'; +import { deserializeShieldInformationBarrierSegmentRestrictions } from '../schemas.generated.js'; +import { BoxClient } from '../client.generated.js'; +import { ShieldInformationBarrier } from '../schemas.generated.js'; +import { ShieldInformationBarrierSegment } from '../schemas.generated.js'; +import { CreateShieldInformationBarrierSegmentRequestBodyArg } from '../managers/shieldInformationBarrierSegments.generated.js'; +import { ShieldInformationBarrierBase } from '../schemas.generated.js'; +import { ShieldInformationBarrierBaseTypeField } from '../schemas.generated.js'; +import { ShieldInformationBarrierSegmentRestriction } from '../schemas.generated.js'; +import { CreateShieldInformationBarrierSegmentRestrictionRequestBodyArg } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { ShieldInformationBarrierSegmentRestrictions } from '../schemas.generated.js'; +import { GetShieldInformationBarrierSegmentRestrictionsQueryParamsArg } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { getEnvVar } from '../utils.js'; +import { getUuid } from '../utils.js'; +import { getDefaultClientAsUser } from './commons.generated.js'; +import { getOrCreateShieldInformationBarrier } from './commons.generated.js'; +import { SerializedData } from '../json.js'; +import { sdIsEmpty } from '../json.js'; +import { sdIsBoolean } from '../json.js'; +import { sdIsNumber } from '../json.js'; +import { sdIsString } from '../json.js'; +import { sdIsList } from '../json.js'; +import { sdIsMap } from '../json.js'; +test('testShieldInformationBarrierSegmentRestrictions', async function testShieldInformationBarrierSegmentRestrictions(): Promise { + const client: BoxClient = await getDefaultClientAsUser(getEnvVar('USER_ID')); + const enterpriseId: string = getEnvVar('ENTERPRISE_ID'); + const barrier: ShieldInformationBarrier = + await getOrCreateShieldInformationBarrier(client, enterpriseId); + const barrierId: string = barrier.id!; + const segment: ShieldInformationBarrierSegment = + await client.shieldInformationBarrierSegments.createShieldInformationBarrierSegment( + { + shieldInformationBarrier: { + id: barrierId, + type: 'shield_information_barrier' as ShieldInformationBarrierBaseTypeField, + } satisfies ShieldInformationBarrierBase, + name: getUuid(), + description: 'barrier segment description', + } satisfies CreateShieldInformationBarrierSegmentRequestBodyArg + ); + const segmentId: string = segment.id!; + const segmentToRestrict: ShieldInformationBarrierSegment = + await client.shieldInformationBarrierSegments.createShieldInformationBarrierSegment( + { + shieldInformationBarrier: { + id: barrierId, + type: 'shield_information_barrier' as ShieldInformationBarrierBaseTypeField, + } satisfies ShieldInformationBarrierBase, + name: getUuid(), + description: 'barrier segment description', + } satisfies CreateShieldInformationBarrierSegmentRequestBodyArg + ); + const segmentToRestrictId: string = segmentToRestrict.id!; + const segmentRestriction: ShieldInformationBarrierSegmentRestriction = + await client.shieldInformationBarrierSegmentRestrictions.createShieldInformationBarrierSegmentRestriction( + { + restrictedSegment: { + id: segmentToRestrictId, + type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField, + } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField, + shieldInformationBarrierSegment: { + id: segmentId, + type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField, + } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField, + type: 'shield_information_barrier_segment_restriction' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField, + } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyArg + ); + const segmentRestrictionId: string = segmentRestriction.id!; + if (!(segmentRestriction.shieldInformationBarrierSegment.id == segmentId)) { + throw 'Assertion failed'; + } + const segmentRestrictions: ShieldInformationBarrierSegmentRestrictions = + await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictions( + { + shieldInformationBarrierSegmentId: segmentId, + } satisfies GetShieldInformationBarrierSegmentRestrictionsQueryParamsArg + ); + if (!(segmentRestrictions.entries!.length > 0)) { + throw 'Assertion failed'; + } + const segmentRestrictionFromApi: ShieldInformationBarrierSegmentRestriction = + await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictionById( + segmentRestrictionId + ); + if (!(segmentRestrictionFromApi.id! == segmentRestrictionId)) { + throw 'Assertion failed'; + } + if ( + !(segmentRestrictionFromApi.shieldInformationBarrierSegment.id == segmentId) + ) { + throw 'Assertion failed'; + } + if ( + !(segmentRestrictionFromApi.restrictedSegment.id == segmentToRestrictId) + ) { + throw 'Assertion failed'; + } + if (!(segmentRestrictionFromApi.shieldInformationBarrier!.id == barrierId)) { + throw 'Assertion failed'; + } + await client.shieldInformationBarrierSegmentRestrictions.deleteShieldInformationBarrierSegmentRestrictionById( + segmentRestrictionId + ); + expect(async () => { + await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictionById( + segmentRestrictionId + ); + }).rejects.toThrow(); + await client.shieldInformationBarrierSegments.deleteShieldInformationBarrierSegmentById( + segmentId + ); + await client.shieldInformationBarrierSegments.deleteShieldInformationBarrierSegmentById( + segmentToRestrictId + ); +}); +export {}; diff --git a/src/test/trashedItems.generated.test.ts b/src/test/trashedItems.generated.test.ts new file mode 100644 index 00000000..b5ed2f88 --- /dev/null +++ b/src/test/trashedItems.generated.test.ts @@ -0,0 +1,26 @@ +import { serializeFileFull } from '../schemas.generated.js'; +import { deserializeFileFull } from '../schemas.generated.js'; +import { serializeItems } from '../schemas.generated.js'; +import { deserializeItems } from '../schemas.generated.js'; +import { BoxClient } from '../client.generated.js'; +import { FileFull } from '../schemas.generated.js'; +import { Items } from '../schemas.generated.js'; +import { getDefaultClient } from './commons.generated.js'; +import { uploadNewFile } from './commons.generated.js'; +import { SerializedData } from '../json.js'; +import { sdIsEmpty } from '../json.js'; +import { sdIsBoolean } from '../json.js'; +import { sdIsNumber } from '../json.js'; +import { sdIsString } from '../json.js'; +import { sdIsList } from '../json.js'; +import { sdIsMap } from '../json.js'; +const client: BoxClient = getDefaultClient(); +test('testListTrashedItems', async function testListTrashedItems(): Promise { + const file: FileFull = await uploadNewFile(); + await client.files.deleteFileById(file.id); + const trashedItems: Items = await client.trashedItems.getFolderTrashItems(); + if (!(trashedItems.entries!.length > 0)) { + throw 'Assertion failed'; + } +}); +export {}; From beff24272e3c0a7d5d86aaf140d9a966bc4383f5 Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Tue, 28 Nov 2023 05:42:14 -0800 Subject: [PATCH 2/8] generated with codegen at box/box-codegen@ae2574fc and spec at box/box-openapi@5fed16f --- src/schemas.generated.ts | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/src/schemas.generated.ts b/src/schemas.generated.ts index aa46a251..9e5f1d54 100644 --- a/src/schemas.generated.ts +++ b/src/schemas.generated.ts @@ -2494,7 +2494,6 @@ export interface SignRequestCreateSigner { readonly loginRequired?: boolean; readonly verificationPhoneNumber?: string; readonly password?: string; - readonly signerGroupId?: string; } export interface SignRequestPrefillTag { readonly documentTagId?: string; @@ -2659,7 +2658,6 @@ export interface TemplateSigner { readonly role?: TemplateSignerRoleField; readonly isInPerson?: boolean; readonly order?: number; - readonly signerGroupId?: string; } export type SignTemplateTypeField = 'sign-template'; export type SignTemplateAdditionalInfoFieldNonEditableField = @@ -18125,8 +18123,6 @@ export function serializeSignRequestCreateSigner( ? void 0 : val.verificationPhoneNumber, ['password']: val.password == void 0 ? void 0 : val.password, - ['signer_group_id']: - val.signerGroupId == void 0 ? void 0 : val.signerGroupId, }; } export function deserializeSignRequestCreateSigner( @@ -18156,8 +18152,6 @@ export function deserializeSignRequestCreateSigner( : val.verification_phone_number; const password: undefined | string = val.password == void 0 ? void 0 : val.password; - const signerGroupId: undefined | string = - val.signer_group_id == void 0 ? void 0 : val.signer_group_id; return { email: email, role: role, @@ -18169,7 +18163,6 @@ export function deserializeSignRequestCreateSigner( loginRequired: loginRequired, verificationPhoneNumber: verificationPhoneNumber, password: password, - signerGroupId: signerGroupId, } satisfies SignRequestCreateSigner; } export function serializeSignRequestPrefillTag( @@ -18463,8 +18456,6 @@ export function deserializeSignRequestSigner(val: any): SignRequestSigner { : val.verification_phone_number; const password: undefined | string = val.password == void 0 ? void 0 : val.password; - const signerGroupId: undefined | string = - val.signer_group_id == void 0 ? void 0 : val.signer_group_id; return { hasViewedDocument: hasViewedDocument, signerDecision: signerDecision, @@ -18481,7 +18472,6 @@ export function deserializeSignRequestSigner(val: any): SignRequestSigner { loginRequired: loginRequired, verificationPhoneNumber: verificationPhoneNumber, password: password, - signerGroupId: signerGroupId, } satisfies SignRequestSigner; } export function serializeSignRequestBase(val: SignRequestBase): SerializedData { @@ -19235,8 +19225,6 @@ export function serializeTemplateSigner(val: TemplateSigner): SerializedData { val.role == void 0 ? void 0 : serializeTemplateSignerRoleField(val.role), ['is_in_person']: val.isInPerson == void 0 ? void 0 : val.isInPerson, ['order']: val.order == void 0 ? void 0 : val.order, - ['signer_group_id']: - val.signerGroupId == void 0 ? void 0 : val.signerGroupId, }; } export function deserializeTemplateSigner(val: any): TemplateSigner { @@ -19254,15 +19242,12 @@ export function deserializeTemplateSigner(val: any): TemplateSigner { const isInPerson: undefined | boolean = val.is_in_person == void 0 ? void 0 : val.is_in_person; const order: undefined | number = val.order == void 0 ? void 0 : val.order; - const signerGroupId: undefined | string = - val.signer_group_id == void 0 ? void 0 : val.signer_group_id; return { inputs: inputs, email: email, role: role, isInPerson: isInPerson, order: order, - signerGroupId: signerGroupId, } satisfies TemplateSigner; } export function serializeSignTemplateTypeField( From 80a23a94ab9f44a2eab198e1b486065f1d283820 Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Mon, 4 Dec 2023 01:09:10 -0800 Subject: [PATCH 3/8] generated with codegen at box/box-codegen@d81a45dd and spec at box/box-openapi@5fed16f --- docs/listCollaborations.md | 26 +++- docs/shieldInformationBarrierReports.md | 31 ++++- docs/userCollaborations.md | 2 +- src/test/listCollaborations.generated.test.ts | 122 ++++++++++++++++++ ...nformationBarrierReports.generated.test.ts | 94 ++++++++++++++ src/test/userCollaborations.generated.test.ts | 47 +++++++ 6 files changed, 314 insertions(+), 8 deletions(-) create mode 100644 src/test/listCollaborations.generated.test.ts create mode 100644 src/test/shieldInformationBarrierReports.generated.test.ts diff --git a/docs/listCollaborations.md b/docs/listCollaborations.md index 1dea9d78..7d3223c0 100644 --- a/docs/listCollaborations.md +++ b/docs/listCollaborations.md @@ -16,7 +16,11 @@ This operation is performed by calling function `getFileCollaborations`. See the endpoint docs at [API Reference](https://developer.box.com/reference/get-files-id-collaborations/). -_Currently we don't have an example for calling `getFileCollaborations` in integration tests_ + + +```ts +await client.listCollaborations.getFileCollaborations(file.id); +``` ### Arguments @@ -51,7 +55,11 @@ This operation is performed by calling function `getFolderCollaborations`. See the endpoint docs at [API Reference](https://developer.box.com/reference/get-folders-id-collaborations/). -_Currently we don't have an example for calling `getFolderCollaborations` in integration tests_ + + +```ts +await client.listCollaborations.getFolderCollaborations(folder.id); +``` ### Arguments @@ -84,7 +92,13 @@ This operation is performed by calling function `getCollaborations`. See the endpoint docs at [API Reference](https://developer.box.com/reference/get-collaborations/). -_Currently we don't have an example for calling `getCollaborations` in integration tests_ + + +```ts +await client.listCollaborations.getCollaborations({ + status: 'pending' as GetCollaborationsQueryParamsArgStatusField, +} satisfies GetCollaborationsQueryParamsArg); +``` ### Arguments @@ -117,7 +131,11 @@ This operation is performed by calling function `getGroupCollaborations`. See the endpoint docs at [API Reference](https://developer.box.com/reference/get-groups-id-collaborations/). -_Currently we don't have an example for calling `getGroupCollaborations` in integration tests_ + + +```ts +await client.listCollaborations.getGroupCollaborations(group.id); +``` ### Arguments diff --git a/docs/shieldInformationBarrierReports.md b/docs/shieldInformationBarrierReports.md index 563c67e5..b6e3c23e 100644 --- a/docs/shieldInformationBarrierReports.md +++ b/docs/shieldInformationBarrierReports.md @@ -13,7 +13,15 @@ This operation is performed by calling function `getShieldInformationBarrierRepo See the endpoint docs at [API Reference](https://developer.box.com/reference/get-shield-information-barrier-reports/). -_Currently we don't have an example for calling `getShieldInformationBarrierReports` in integration tests_ + + +```ts +await client.shieldInformationBarrierReports.getShieldInformationBarrierReports( + { + shieldInformationBarrierId: barrierId, + } satisfies GetShieldInformationBarrierReportsQueryParamsArg +); +``` ### Arguments @@ -39,7 +47,18 @@ This operation is performed by calling function `createShieldInformationBarrierR See the endpoint docs at [API Reference](https://developer.box.com/reference/post-shield-information-barrier-reports/). -_Currently we don't have an example for calling `createShieldInformationBarrierReport` in integration tests_ + + +```ts +await client.shieldInformationBarrierReports.createShieldInformationBarrierReport( + { + shieldInformationBarrier: { + id: barrierId, + type: 'shield_information_barrier' as ShieldInformationBarrierBaseTypeField, + } satisfies ShieldInformationBarrierBase, + } satisfies ShieldInformationBarrierReference +); +``` ### Arguments @@ -65,7 +84,13 @@ This operation is performed by calling function `getShieldInformationBarrierRepo See the endpoint docs at [API Reference](https://developer.box.com/reference/get-shield-information-barrier-reports-id/). -_Currently we don't have an example for calling `getShieldInformationBarrierReportById` in integration tests_ + + +```ts +await client.shieldInformationBarrierReports.getShieldInformationBarrierReportById( + createdReport.id! +); +``` ### Arguments diff --git a/docs/userCollaborations.md b/docs/userCollaborations.md index 860509ca..5093ce67 100644 --- a/docs/userCollaborations.md +++ b/docs/userCollaborations.md @@ -139,7 +139,7 @@ await client.userCollaborations.createCollaboration({ } satisfies CreateCollaborationRequestBodyArgItemField, accessibleBy: { type: 'user' as CreateCollaborationRequestBodyArgAccessibleByFieldTypeField, - id: user.id, + login: userLogin, } satisfies CreateCollaborationRequestBodyArgAccessibleByField, role: 'editor' as CreateCollaborationRequestBodyArgRoleField, } satisfies CreateCollaborationRequestBodyArg); diff --git a/src/test/listCollaborations.generated.test.ts b/src/test/listCollaborations.generated.test.ts new file mode 100644 index 00000000..d3b23b20 --- /dev/null +++ b/src/test/listCollaborations.generated.test.ts @@ -0,0 +1,122 @@ +import { serializeFolderFull } from '../schemas.generated.js'; +import { deserializeFolderFull } from '../schemas.generated.js'; +import { serializeFileFull } from '../schemas.generated.js'; +import { deserializeFileFull } from '../schemas.generated.js'; +import { serializeGroupFull } from '../schemas.generated.js'; +import { deserializeGroupFull } from '../schemas.generated.js'; +import { serializeCreateGroupRequestBodyArg } from '../managers/groups.generated.js'; +import { deserializeCreateGroupRequestBodyArg } from '../managers/groups.generated.js'; +import { serializeCollaboration } from '../schemas.generated.js'; +import { deserializeCollaboration } from '../schemas.generated.js'; +import { serializeCreateCollaborationRequestBodyArg } from '../managers/userCollaborations.generated.js'; +import { deserializeCreateCollaborationRequestBodyArg } from '../managers/userCollaborations.generated.js'; +import { serializeCreateCollaborationRequestBodyArgItemField } from '../managers/userCollaborations.generated.js'; +import { deserializeCreateCollaborationRequestBodyArgItemField } from '../managers/userCollaborations.generated.js'; +import { serializeCreateCollaborationRequestBodyArgItemFieldTypeField } from '../managers/userCollaborations.generated.js'; +import { deserializeCreateCollaborationRequestBodyArgItemFieldTypeField } from '../managers/userCollaborations.generated.js'; +import { serializeCreateCollaborationRequestBodyArgAccessibleByField } from '../managers/userCollaborations.generated.js'; +import { deserializeCreateCollaborationRequestBodyArgAccessibleByField } from '../managers/userCollaborations.generated.js'; +import { serializeCreateCollaborationRequestBodyArgAccessibleByFieldTypeField } from '../managers/userCollaborations.generated.js'; +import { deserializeCreateCollaborationRequestBodyArgAccessibleByFieldTypeField } from '../managers/userCollaborations.generated.js'; +import { serializeCreateCollaborationRequestBodyArgRoleField } from '../managers/userCollaborations.generated.js'; +import { deserializeCreateCollaborationRequestBodyArgRoleField } from '../managers/userCollaborations.generated.js'; +import { serializeCollaborations } from '../schemas.generated.js'; +import { deserializeCollaborations } from '../schemas.generated.js'; +import { serializeGetCollaborationsQueryParamsArgStatusField } from '../managers/listCollaborations.generated.js'; +import { deserializeGetCollaborationsQueryParamsArgStatusField } from '../managers/listCollaborations.generated.js'; +import { BoxClient } from '../client.generated.js'; +import { FolderFull } from '../schemas.generated.js'; +import { FileFull } from '../schemas.generated.js'; +import { GroupFull } from '../schemas.generated.js'; +import { CreateGroupRequestBodyArg } from '../managers/groups.generated.js'; +import { Collaboration } from '../schemas.generated.js'; +import { CreateCollaborationRequestBodyArg } from '../managers/userCollaborations.generated.js'; +import { CreateCollaborationRequestBodyArgItemField } from '../managers/userCollaborations.generated.js'; +import { CreateCollaborationRequestBodyArgItemFieldTypeField } from '../managers/userCollaborations.generated.js'; +import { CreateCollaborationRequestBodyArgAccessibleByField } from '../managers/userCollaborations.generated.js'; +import { CreateCollaborationRequestBodyArgAccessibleByFieldTypeField } from '../managers/userCollaborations.generated.js'; +import { CreateCollaborationRequestBodyArgRoleField } from '../managers/userCollaborations.generated.js'; +import { Collaborations } from '../schemas.generated.js'; +import { GetCollaborationsQueryParamsArg } from '../managers/listCollaborations.generated.js'; +import { GetCollaborationsQueryParamsArgStatusField } from '../managers/listCollaborations.generated.js'; +import { getUuid } from '../utils.js'; +import { getEnvVar } from '../utils.js'; +import { getDefaultClient } from './commons.generated.js'; +import { createNewFolder } from './commons.generated.js'; +import { uploadNewFile } from './commons.generated.js'; +import { toString } from '../utils.js'; +import { sdToJson } from '../json.js'; +import { SerializedData } from '../json.js'; +import { sdIsEmpty } from '../json.js'; +import { sdIsBoolean } from '../json.js'; +import { sdIsNumber } from '../json.js'; +import { sdIsString } from '../json.js'; +import { sdIsList } from '../json.js'; +import { sdIsMap } from '../json.js'; +test('testListCollaborations', async function testListCollaborations(): Promise { + const client: BoxClient = getDefaultClient(); + const folder: FolderFull = await createNewFolder(); + const file: FileFull = await uploadNewFile(); + const group: GroupFull = await client.groups.createGroup({ + name: getUuid(), + } satisfies CreateGroupRequestBodyArg); + const groupCollaboration: Collaboration = + await client.userCollaborations.createCollaboration({ + item: { + type: 'folder' as CreateCollaborationRequestBodyArgItemFieldTypeField, + id: folder.id, + } satisfies CreateCollaborationRequestBodyArgItemField, + accessibleBy: { + type: 'group' as CreateCollaborationRequestBodyArgAccessibleByFieldTypeField, + id: group.id, + } satisfies CreateCollaborationRequestBodyArgAccessibleByField, + role: 'editor' as CreateCollaborationRequestBodyArgRoleField, + } satisfies CreateCollaborationRequestBodyArg); + const fileCollaboration: Collaboration = + await client.userCollaborations.createCollaboration({ + item: { + type: 'file' as CreateCollaborationRequestBodyArgItemFieldTypeField, + id: file.id, + } satisfies CreateCollaborationRequestBodyArgItemField, + accessibleBy: { + type: 'user' as CreateCollaborationRequestBodyArgAccessibleByFieldTypeField, + id: getEnvVar('USER_ID'), + } satisfies CreateCollaborationRequestBodyArgAccessibleByField, + role: 'editor' as CreateCollaborationRequestBodyArgRoleField, + } satisfies CreateCollaborationRequestBodyArg); + if (!((toString(groupCollaboration.role) as string) == 'editor')) { + throw 'Assertion failed'; + } + if (!((toString(groupCollaboration.type) as string) == 'collaboration')) { + throw 'Assertion failed'; + } + const fileCollaborations: Collaborations = + await client.listCollaborations.getFileCollaborations(file.id); + if (!(fileCollaborations.entries!.length > 0)) { + throw 'Assertion failed'; + } + const folderCollaborations: Collaborations = + await client.listCollaborations.getFolderCollaborations(folder.id); + if (!(folderCollaborations.entries!.length > 0)) { + throw 'Assertion failed'; + } + const pendingCollaborations: Collaborations = + await client.listCollaborations.getCollaborations({ + status: 'pending' as GetCollaborationsQueryParamsArgStatusField, + } satisfies GetCollaborationsQueryParamsArg); + if (!(pendingCollaborations.entries!.length >= 0)) { + throw 'Assertion failed'; + } + const groupCollaborations: Collaborations = + await client.listCollaborations.getGroupCollaborations(group.id); + if (!(groupCollaborations.entries!.length > 0)) { + throw 'Assertion failed'; + } + await client.userCollaborations.deleteCollaborationById( + groupCollaboration.id + ); + await client.files.deleteFileById(file.id); + await client.folders.deleteFolderById(folder.id); + await client.groups.deleteGroupById(group.id); +}); +export {}; diff --git a/src/test/shieldInformationBarrierReports.generated.test.ts b/src/test/shieldInformationBarrierReports.generated.test.ts new file mode 100644 index 00000000..38465600 --- /dev/null +++ b/src/test/shieldInformationBarrierReports.generated.test.ts @@ -0,0 +1,94 @@ +import { serializeShieldInformationBarrierReports } from '../schemas.generated.js'; +import { deserializeShieldInformationBarrierReports } from '../schemas.generated.js'; +import { serializeShieldInformationBarrierReport } from '../schemas.generated.js'; +import { deserializeShieldInformationBarrierReport } from '../schemas.generated.js'; +import { serializeShieldInformationBarrierReference } from '../schemas.generated.js'; +import { deserializeShieldInformationBarrierReference } from '../schemas.generated.js'; +import { serializeShieldInformationBarrierBase } from '../schemas.generated.js'; +import { deserializeShieldInformationBarrierBase } from '../schemas.generated.js'; +import { serializeShieldInformationBarrierBaseTypeField } from '../schemas.generated.js'; +import { deserializeShieldInformationBarrierBaseTypeField } from '../schemas.generated.js'; +import { serializeShieldInformationBarrier } from '../schemas.generated.js'; +import { deserializeShieldInformationBarrier } from '../schemas.generated.js'; +import { ShieldInformationBarrierReports } from '../schemas.generated.js'; +import { GetShieldInformationBarrierReportsQueryParamsArg } from '../managers/shieldInformationBarrierReports.generated.js'; +import { ShieldInformationBarrierReport } from '../schemas.generated.js'; +import { ShieldInformationBarrierReference } from '../schemas.generated.js'; +import { ShieldInformationBarrierBase } from '../schemas.generated.js'; +import { ShieldInformationBarrierBaseTypeField } from '../schemas.generated.js'; +import { getEnvVar } from '../utils.js'; +import { getDefaultClientAsUser } from './commons.generated.js'; +import { getOrCreateShieldInformationBarrier } from './commons.generated.js'; +import { ShieldInformationBarrier } from '../schemas.generated.js'; +import { BoxClient } from '../client.generated.js'; +import { toString } from '../utils.js'; +import { sdToJson } from '../json.js'; +import { SerializedData } from '../json.js'; +import { sdIsEmpty } from '../json.js'; +import { sdIsBoolean } from '../json.js'; +import { sdIsNumber } from '../json.js'; +import { sdIsString } from '../json.js'; +import { sdIsList } from '../json.js'; +import { sdIsMap } from '../json.js'; +test('shieldInformationBarrierReports', async function shieldInformationBarrierReports(): Promise { + const client: BoxClient = await getDefaultClientAsUser(getEnvVar('USER_ID')); + const enterpriseId: string = getEnvVar('ENTERPRISE_ID'); + const barrier: ShieldInformationBarrier = + await getOrCreateShieldInformationBarrier(client, enterpriseId); + if (!((toString(barrier.status!) as string) == 'draft')) { + throw 'Assertion failed'; + } + if (!((toString(barrier.type!) as string) == 'shield_information_barrier')) { + throw 'Assertion failed'; + } + if (!(barrier.enterprise!.id == enterpriseId)) { + throw 'Assertion failed'; + } + if (!((toString(barrier.enterprise!.type) as string) == 'enterprise')) { + throw 'Assertion failed'; + } + const barrierId: string = barrier.id!; + const existingReports: ShieldInformationBarrierReports = + await client.shieldInformationBarrierReports.getShieldInformationBarrierReports( + { + shieldInformationBarrierId: barrierId, + } satisfies GetShieldInformationBarrierReportsQueryParamsArg + ); + if (existingReports.entries!.length > 0) { + return void 0; + } + const createdReport: ShieldInformationBarrierReport = + await client.shieldInformationBarrierReports.createShieldInformationBarrierReport( + { + shieldInformationBarrier: { + id: barrierId, + type: 'shield_information_barrier' as ShieldInformationBarrierBaseTypeField, + } satisfies ShieldInformationBarrierBase, + } satisfies ShieldInformationBarrierReference + ); + if ( + !( + createdReport.shieldInformationBarrier!.shieldInformationBarrier!.id == + barrierId + ) + ) { + throw 'Assertion failed'; + } + const retrievedReport: ShieldInformationBarrierReport = + await client.shieldInformationBarrierReports.getShieldInformationBarrierReportById( + createdReport.id! + ); + if (!(retrievedReport.id == createdReport.id)) { + throw 'Assertion failed'; + } + const retrievedReports: ShieldInformationBarrierReports = + await client.shieldInformationBarrierReports.getShieldInformationBarrierReports( + { + shieldInformationBarrierId: barrierId, + } satisfies GetShieldInformationBarrierReportsQueryParamsArg + ); + if (!(retrievedReports.entries!.length > 0)) { + throw 'Assertion failed'; + } +}); +export {}; diff --git a/src/test/userCollaborations.generated.test.ts b/src/test/userCollaborations.generated.test.ts index 60440c0d..295d8406 100644 --- a/src/test/userCollaborations.generated.test.ts +++ b/src/test/userCollaborations.generated.test.ts @@ -101,4 +101,51 @@ test('testUserCollaborations', async function testUserCollaborations(): Promise< await client.folders.deleteFolderById(folder.id); await client.users.deleteUserById(user.id); }); +test('testExternalUserCollaborations', async function testExternalUserCollaborations(): Promise { + const userName: string = getUuid(); + const userLogin: string = ''.concat(getUuid(), '@boxdemo.com') as string; + const folder: FolderFull = await createNewFolder(); + const collaboration: Collaboration = + await client.userCollaborations.createCollaboration({ + item: { + type: 'folder' as CreateCollaborationRequestBodyArgItemFieldTypeField, + id: folder.id, + } satisfies CreateCollaborationRequestBodyArgItemField, + accessibleBy: { + type: 'user' as CreateCollaborationRequestBodyArgAccessibleByFieldTypeField, + login: userLogin, + } satisfies CreateCollaborationRequestBodyArgAccessibleByField, + role: 'editor' as CreateCollaborationRequestBodyArgRoleField, + } satisfies CreateCollaborationRequestBodyArg); + if (!((toString(collaboration.role!) as string) == 'editor')) { + throw 'Assertion failed'; + } + const collaborationId: string = collaboration.id; + const collaborationFromApi: Collaboration = + await client.userCollaborations.getCollaborationById(collaborationId); + if (!(collaborationId == collaborationFromApi.id)) { + throw 'Assertion failed'; + } + if (!((toString(collaborationFromApi.status!) as string) == 'pending')) { + throw 'Assertion failed'; + } + if (!((toString(collaborationFromApi.type) as string) == 'collaboration')) { + throw 'Assertion failed'; + } + if (!(collaborationFromApi.inviteEmail == userLogin)) { + throw 'Assertion failed'; + } + const updatedCollaboration: Collaboration = + await client.userCollaborations.updateCollaborationById(collaborationId, { + role: 'viewer' as UpdateCollaborationByIdRequestBodyArgRoleField, + } satisfies UpdateCollaborationByIdRequestBodyArg); + if (!((toString(updatedCollaboration.role!) as string) == 'viewer')) { + throw 'Assertion failed'; + } + await client.userCollaborations.deleteCollaborationById(collaborationId); + expect(async () => { + await client.userCollaborations.getCollaborationById(collaborationId); + }).rejects.toThrow(); + await client.folders.deleteFolderById(folder.id); +}); export {}; From 81f220efcc8d2b3e9623ff979c17cdd1086c0c4a Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Tue, 5 Dec 2023 03:28:41 -0800 Subject: [PATCH 4/8] generated with codegen at box/box-codegen@45cc95ee and spec at box/box-openapi@b7eff15 --- docs/authentication.md | 16 +- docs/authorization.md | 43 +-- docs/avatars.md | 108 ------ docs/chunkedUploads.md | 259 --------------- docs/classifications.md | 180 ---------- docs/collaborationAllowlistEntries.md | 138 -------- docs/collaborationAllowlistExemptTargets.md | 141 -------- docs/collections.md | 70 ---- docs/comments.md | 182 ----------- docs/devicePinners.md | 88 ----- docs/emailAliases.md | 102 ------ docs/events.md | 101 ------ docs/fileClassifications.md | 137 -------- docs/fileMetadata.md | 221 ------------- docs/fileRequests.md | 141 -------- docs/fileVersionLegalHolds.md | 77 ----- docs/fileVersionRetentions.md | 56 ---- docs/fileVersions.md | 208 ------------ docs/fileWatermarks.md | 105 ------ docs/folderClassifications.md | 137 -------- docs/folderLocks.md | 118 ------- docs/folderMetadata.md | 226 ------------- docs/folderWatermarks.md | 106 ------ docs/groups.md | 178 ---------- docs/integrationMappings.md | 126 ------- docs/invites.md | 83 ----- docs/legalHoldPolicies.md | 170 ---------- docs/legalHoldPolicyAssignments.md | 204 ------------ docs/listCollaborations.md | 156 --------- docs/memberships.md | 221 ------------- docs/metadataCascadePolicies.md | 191 ----------- docs/metadataTemplates.md | 307 ------------------ docs/recentItems.md | 35 -- docs/retentionPolicies.md | 174 ---------- docs/retentionPolicyAssignments.md | 179 ---------- docs/search.md | 115 ------- docs/sessionTermination.md | 75 ----- docs/sharedLinksFiles.md | 210 ------------ docs/sharedLinksFolders.md | 207 ------------ docs/sharedLinksWebLinks.md | 210 ------------ docs/shieldInformationBarrierReports.md | 108 ------ .../shieldInformationBarrierSegmentMembers.md | 150 --------- ...ldInformationBarrierSegmentRestrictions.md | 153 --------- docs/shieldInformationBarrierSegments.md | 183 ----------- docs/shieldInformationBarriers.md | 144 -------- docs/signTemplates.md | 66 ---- docs/skills.md | 150 --------- docs/storagePolicies.md | 56 ---- docs/storagePolicyAssignments.md | 148 --------- docs/taskAssignments.md | 146 --------- docs/tasks.md | 177 ---------- docs/termsOfServiceUserStatuses.md | 87 ----- docs/termsOfServices.md | 115 ------- docs/transfer.md | 78 ----- docs/trashedFiles.md | 118 ------- docs/trashedFolders.md | 127 -------- docs/trashedItems.md | 41 --- docs/trashedWebLinks.md | 108 ------ docs/userCollaborations.md | 163 ---------- docs/users.md | 240 -------------- docs/webLinks.md | 140 -------- docs/webhooks.md | 174 ---------- docs/workflows.md | 65 ---- docs/zipDownloads.md | 195 ----------- src/ccgAuth.ts | 35 +- src/json.ts | 6 +- src/jwtAuth.ts | 25 +- src/managers/authorization.generated.ts | 128 +++++++- src/oauth.generated.ts | 101 +++--- src/schemas.generated.ts | 19 +- src/test/auth.generated.test.ts | 116 ++++++- 71 files changed, 342 insertions(+), 9021 deletions(-) delete mode 100644 docs/avatars.md delete mode 100644 docs/chunkedUploads.md delete mode 100644 docs/classifications.md delete mode 100644 docs/collaborationAllowlistEntries.md delete mode 100644 docs/collaborationAllowlistExemptTargets.md delete mode 100644 docs/collections.md delete mode 100644 docs/comments.md delete mode 100644 docs/devicePinners.md delete mode 100644 docs/emailAliases.md delete mode 100644 docs/events.md delete mode 100644 docs/fileClassifications.md delete mode 100644 docs/fileMetadata.md delete mode 100644 docs/fileRequests.md delete mode 100644 docs/fileVersionLegalHolds.md delete mode 100644 docs/fileVersionRetentions.md delete mode 100644 docs/fileVersions.md delete mode 100644 docs/fileWatermarks.md delete mode 100644 docs/folderClassifications.md delete mode 100644 docs/folderLocks.md delete mode 100644 docs/folderMetadata.md delete mode 100644 docs/folderWatermarks.md delete mode 100644 docs/groups.md delete mode 100644 docs/integrationMappings.md delete mode 100644 docs/invites.md delete mode 100644 docs/legalHoldPolicies.md delete mode 100644 docs/legalHoldPolicyAssignments.md delete mode 100644 docs/listCollaborations.md delete mode 100644 docs/memberships.md delete mode 100644 docs/metadataCascadePolicies.md delete mode 100644 docs/metadataTemplates.md delete mode 100644 docs/recentItems.md delete mode 100644 docs/retentionPolicies.md delete mode 100644 docs/retentionPolicyAssignments.md delete mode 100644 docs/search.md delete mode 100644 docs/sessionTermination.md delete mode 100644 docs/sharedLinksFiles.md delete mode 100644 docs/sharedLinksFolders.md delete mode 100644 docs/sharedLinksWebLinks.md delete mode 100644 docs/shieldInformationBarrierReports.md delete mode 100644 docs/shieldInformationBarrierSegmentMembers.md delete mode 100644 docs/shieldInformationBarrierSegmentRestrictions.md delete mode 100644 docs/shieldInformationBarrierSegments.md delete mode 100644 docs/shieldInformationBarriers.md delete mode 100644 docs/signTemplates.md delete mode 100644 docs/skills.md delete mode 100644 docs/storagePolicies.md delete mode 100644 docs/storagePolicyAssignments.md delete mode 100644 docs/taskAssignments.md delete mode 100644 docs/tasks.md delete mode 100644 docs/termsOfServiceUserStatuses.md delete mode 100644 docs/termsOfServices.md delete mode 100644 docs/transfer.md delete mode 100644 docs/trashedFiles.md delete mode 100644 docs/trashedFolders.md delete mode 100644 docs/trashedItems.md delete mode 100644 docs/trashedWebLinks.md delete mode 100644 docs/userCollaborations.md delete mode 100644 docs/users.md delete mode 100644 docs/webLinks.md delete mode 100644 docs/webhooks.md delete mode 100644 docs/workflows.md delete mode 100644 docs/zipDownloads.md diff --git a/docs/authentication.md b/docs/authentication.md index ceea64c8..50e7bd1b 100644 --- a/docs/authentication.md +++ b/docs/authentication.md @@ -14,6 +14,7 @@ - [Switching between Service Account and User](#switching-between-service-account-and-user) - [OAuth 2.0 Auth](#oauth-20-auth) - [Authentication with OAuth2](#authentication-with-oauth2) + - [Revoking tokens](#revoking-tokens) - [Downscoping tokens](#downscoping-tokens) - [Token storage](#token-storage) - [In-memory token storage](#in-memory-token-storage) @@ -312,17 +313,26 @@ await oauth.revokeTokens(); You can exchange a client's access token for one with a lower scope, in order to restrict the permissions for a child client or to pass to a less secure -location (e.g. a browser-based app). This method is only available for OAuth2 clients. +location (e.g. a browser-based app). -For example to exchange the client's token for one with scopes to upload and delete items, but not to view their contents, which would be suitable for an less-trusted server-side process; use the following code: +A downscoped token does not include a refresh token. +In that case, to get a new downscoped token, refresh the original refresh token and use that new token to get a downscoped token. + +More information about downscoping tokens can be found [here](https://developer.box.com/guides/authentication/tokens/downscope/). +If you want to learn more about available scopes please go [here](https://developer.box.com/guides/api-calls/permissions-and-errors/scopes/#scopes-for-downscoping). + +For example to exchange the token for a new token with only `item_preview` scope, restricted to a single file, suitable for the [Content Preview UI Element](https://developer.box.com/en/guides/embed/ui-elements/preview/) you can the following code: ```js -let accessToken = await oauth.downscopeToken(['item_upload', 'item_delete']); +let resource = 'https://api.box.com/2.0/files/123456789'; +let accessToken = await oauth.downscopeToken(['item_preview'], resource); // accessToken contains the new downscoped access token ``` +This method is only available for OAuth2 clients. + # Token storage ## In-memory token storage diff --git a/docs/authorization.md b/docs/authorization.md index 282d880e..6cad9ab7 100644 --- a/docs/authorization.md +++ b/docs/authorization.md @@ -1,35 +1,40 @@ # AuthorizationManager -- [Authorize user](#authorize-user) +- [](#) +- [](#) -## Authorize user +## -Authorize a user by sending them through the [Box](https://box.com) -website and request their permission to act on their behalf. +This operation is performed by calling function `createOauth2Token`. -This is the first step when authenticating a user using -OAuth 2.0. To request a user's authorization to use the Box APIs -on their behalf you will need to send a user to the URL with this -format. +See the endpoint docs at +[API Reference](https://developer.box.com/reference//). + +_Currently we don't have an example for calling `createOauth2Token` in integration tests_ + +### Arguments + +- requestBody `` + - -This operation is performed by calling function `getAuthorize`. +### Returns + +This function returns a value of type `AccessToken`. + +## + +This operation is performed by calling function `createOauth2Revoke`. See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-authorize/). +[API Reference](https://developer.box.com/reference//). -_Currently we don't have an example for calling `getAuthorize` in integration tests_ +_Currently we don't have an example for calling `createOauth2Revoke` in integration tests_ ### Arguments -- queryParams `GetAuthorizeQueryParamsArg` - - Query parameters of getAuthorize method -- headers `GetAuthorizeHeadersArg` - - Headers of getAuthorize method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. +- requestBody `` + - ### Returns This function returns a value of type `undefined`. - -Does not return any data, but rather should be used in the browser. diff --git a/docs/avatars.md b/docs/avatars.md deleted file mode 100644 index 2274b8f2..00000000 --- a/docs/avatars.md +++ /dev/null @@ -1,108 +0,0 @@ -# AvatarsManager - -- [Get user avatar](#get-user-avatar) -- [Add or update user avatar](#add-or-update-user-avatar) -- [Delete user avatar](#delete-user-avatar) - -## Get user avatar - -Retrieves an image of a the user's avatar. - -This operation is performed by calling function `getUserAvatar`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-users-id-avatar/). - - - -```ts -await client.avatars.getUserAvatar(user.id); -``` - -### Arguments - -- userId `string` - - The ID of the user. Example: "12345" -- headers `GetUserAvatarHeadersArg` - - Headers of getUserAvatar method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ByteStream`. - -When an avatar can be found for the user the -image data will be returned in the body of the -response. - -## Add or update user avatar - -Adds or updates a user avatar. - -This operation is performed by calling function `createUserAvatar`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-users-id-avatar/). - - - -```ts -await client.avatars.createUserAvatar(user.id, { - pic: decodeBase64ByteStream( - 'iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDolAAAAA1BMVEW10NBjBBbqAAAAH0lEQVRoge3BAQ0AAADCoPdPbQ43oAAAAAAAAAAAvg0hAAABmmDh1QAAAABJRU5ErkJggg==' - ), - picContentType: 'image/png', - picFileName: 'avatar.png', -} satisfies CreateUserAvatarRequestBodyArg); -``` - -### Arguments - -- userId `string` - - The ID of the user. Example: "12345" -- requestBody `CreateUserAvatarRequestBodyArg` - - Request body of createUserAvatar method -- headers `CreateUserAvatarHeadersArg` - - Headers of createUserAvatar method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `UserAvatar`. - -- `ok`: Returns the `pic_urls` object with URLs to existing - user avatars that were updated.\* `created`: Returns the `pic_urls` object with URLS to user avatars - uploaded to Box with the request. - -## Delete user avatar - -Removes an existing user avatar. -You cannot reverse this operation. - -This operation is performed by calling function `deleteUserAvatar`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-users-id-avatar/). - - - -```ts -await client.avatars.deleteUserAvatar(user.id); -``` - -### Arguments - -- userId `string` - - The ID of the user. Example: "12345" -- headers `DeleteUserAvatarHeadersArg` - - Headers of deleteUserAvatar method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -- `no_content`: Removes the avatar and returns an empty response. diff --git a/docs/chunkedUploads.md b/docs/chunkedUploads.md deleted file mode 100644 index 87ec98c5..00000000 --- a/docs/chunkedUploads.md +++ /dev/null @@ -1,259 +0,0 @@ -# ChunkedUploadsManager - -This is a manager for chunked uploads (allowed for files at least 20MB). - -- [Create upload session](#create-upload-session) -- [Create upload session for existing file](#create-upload-session-for-existing-file) -- [Get upload session](#get-upload-session) -- [Upload part of file](#upload-part-of-file) -- [Remove upload session](#remove-upload-session) -- [List parts](#list-parts) -- [Commit upload session](#commit-upload-session) -- [](#) -- [](#) - -## Create upload session - -Creates an upload session for a new file. - -This operation is performed by calling function `createFileUploadSession`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-files-upload-sessions/). - -_Currently we don't have an example for calling `createFileUploadSession` in integration tests_ - -### Arguments - -- requestBody `CreateFileUploadSessionRequestBodyArg` - - Request body of createFileUploadSession method -- headers `CreateFileUploadSessionHeadersArg` - - Headers of createFileUploadSession method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `UploadSession`. - -Returns a new upload session. - -## Create upload session for existing file - -Creates an upload session for an existing file. - -This operation is performed by calling function `createFileUploadSessionForExistingFile`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-files-id-upload-sessions/). - -_Currently we don't have an example for calling `createFileUploadSessionForExistingFile` in integration tests_ - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- requestBody `CreateFileUploadSessionForExistingFileRequestBodyArg` - - Request body of createFileUploadSessionForExistingFile method -- headers `CreateFileUploadSessionForExistingFileHeadersArg` - - Headers of createFileUploadSessionForExistingFile method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `UploadSession`. - -Returns a new upload session. - -## Get upload session - -Return information about an upload session. - -This operation is performed by calling function `getFileUploadSessionById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-files-upload-sessions-id/). - -_Currently we don't have an example for calling `getFileUploadSessionById` in integration tests_ - -### Arguments - -- uploadSessionId `string` - - The ID of the upload session. Example: "D5E3F7A" -- headers `GetFileUploadSessionByIdHeadersArg` - - Headers of getFileUploadSessionById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `UploadSession`. - -Returns an upload session object. - -## Upload part of file - -Updates a chunk of an upload session for a file. - -This operation is performed by calling function `uploadFilePart`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-files-upload-sessions-id/). - -_Currently we don't have an example for calling `uploadFilePart` in integration tests_ - -### Arguments - -- uploadSessionId `string` - - The ID of the upload session. Example: "D5E3F7A" -- requestBody `ByteStream` - - Request body of uploadFilePart method -- headers `UploadFilePartHeadersArg` - - Headers of uploadFilePart method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `UploadedPart`. - -Chunk has been uploaded successfully. - -## Remove upload session - -Abort an upload session and discard all data uploaded. - -This cannot be reversed. - -This operation is performed by calling function `deleteFileUploadSessionById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-files-upload-sessions-id/). - -_Currently we don't have an example for calling `deleteFileUploadSessionById` in integration tests_ - -### Arguments - -- uploadSessionId `string` - - The ID of the upload session. Example: "D5E3F7A" -- headers `DeleteFileUploadSessionByIdHeadersArg` - - Headers of deleteFileUploadSessionById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -A blank response is returned if the session was -successfully aborted. - -## List parts - -Return a list of the chunks uploaded to the upload -session so far. - -This operation is performed by calling function `getFileUploadSessionParts`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-files-upload-sessions-id-parts/). - -_Currently we don't have an example for calling `getFileUploadSessionParts` in integration tests_ - -### Arguments - -- uploadSessionId `string` - - The ID of the upload session. Example: "D5E3F7A" -- queryParams `GetFileUploadSessionPartsQueryParamsArg` - - Query parameters of getFileUploadSessionParts method -- headers `GetFileUploadSessionPartsHeadersArg` - - Headers of getFileUploadSessionParts method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `UploadParts`. - -Returns a list of parts that have been uploaded. - -## Commit upload session - -Close an upload session and create a file from the -uploaded chunks. - -This operation is performed by calling function `createFileUploadSessionCommit`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-files-upload-sessions-id-commit/). - -_Currently we don't have an example for calling `createFileUploadSessionCommit` in integration tests_ - -### Arguments - -- uploadSessionId `string` - - The ID of the upload session. Example: "D5E3F7A" -- requestBody `CreateFileUploadSessionCommitRequestBodyArg` - - Request body of createFileUploadSessionCommit method -- headers `CreateFileUploadSessionCommitHeadersArg` - - Headers of createFileUploadSessionCommit method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Files`. - -Returns the file object in a list.Returns when all chunks have been uploaded but not yet processed. - -Inspect the upload session to get more information about the -progress of processing the chunks, then retry committing the file -when all chunks have processed. - -## - -This operation is performed by calling function `reducer`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference//). - -_Currently we don't have an example for calling `reducer` in integration tests_ - -### Arguments - -- acc `PartAccumulator` - - -- chunk `ByteStream` - - - -## - -This operation is performed by calling function `uploadBigFile`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference//). - - - -```ts -await client.chunkedUploads.uploadBigFile( - fileByteStream, - fileName, - fileSize, - parentFolderId -); -``` - -### Arguments - -- file `ByteStream` - - The stream of the file to upload. -- fileName `string` - - The name of the file, which will be used for storage in Box. -- fileSize `number` - - The total size of the file for the chunked upload in bytes. -- parentFolderId `string` - - The ID of the folder where the file should be uploaded. -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. diff --git a/docs/classifications.md b/docs/classifications.md deleted file mode 100644 index 96d19b51..00000000 --- a/docs/classifications.md +++ /dev/null @@ -1,180 +0,0 @@ -# ClassificationsManager - -- [List all classifications](#list-all-classifications) -- [Add classification](#add-classification) -- [Update classification](#update-classification) -- [Add initial classifications](#add-initial-classifications) - -## List all classifications - -Retrieves the classification metadata template and lists all the -classifications available to this enterprise. - -This API can also be called by including the enterprise ID in the -URL explicitly, for example -`/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`. - -This operation is performed by calling function `getClassificationTemplate`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-metadata-templates-enterprise-security-classification-6-vm-vochw-u-wo-schema/). - - - -```ts -await client.classifications.getClassificationTemplate(); -``` - -### Arguments - -- headers `GetClassificationTemplateHeadersArg` - - Headers of getClassificationTemplate method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ClassificationTemplate`. - -Returns the `securityClassification` metadata template, which contains -a `Box__Security__Classification__Key` field that lists all the -classifications available to this enterprise. - -## Add classification - -Adds one or more new classifications to the list of classifications -available to the enterprise. - -This API can also be called by including the enterprise ID in the -URL explicitly, for example -`/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`. - -This operation is performed by calling function `addClassification`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-metadata-templates-enterprise-security-classification-6-vm-vochw-u-wo-schema-add/). - - - -```ts -await client.classifications.addClassification([ - { - op: 'addEnumOption' as AddClassificationRequestBodyArgOpField, - fieldKey: - 'Box__Security__Classification__Key' as AddClassificationRequestBodyArgFieldKeyField, - data: { - key: getUuid(), - staticConfig: { - classification: { - colorId: 3, - classificationDefinition: 'Some description', - } satisfies AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField, - } satisfies AddClassificationRequestBodyArgDataFieldStaticConfigField, - } satisfies AddClassificationRequestBodyArgDataField, - } satisfies AddClassificationRequestBodyArg, -]); -``` - -### Arguments - -- requestBody `readonly AddClassificationRequestBodyArg[]` - - Request body of addClassification method -- headers `AddClassificationHeadersArg` - - Headers of addClassification method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ClassificationTemplate`. - -Returns the updated `securityClassification` metadata template, which -contains a `Box__Security__Classification__Key` field that lists all -the classifications available to this enterprise. - -## Update classification - -Updates the labels and descriptions of one or more classifications -available to the enterprise. - -This API can also be called by including the enterprise ID in the -URL explicitly, for example -`/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`. - -This operation is performed by calling function `updateClassification`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-metadata-templates-enterprise-security-classification-6-vm-vochw-u-wo-schema-update/). - - - -```ts -await client.classifications.updateClassification([ - { - op: 'editEnumOption' as UpdateClassificationRequestBodyArgOpField, - fieldKey: - 'Box__Security__Classification__Key' as UpdateClassificationRequestBodyArgFieldKeyField, - enumOptionKey: classification.key, - data: { - key: updatedClassificationName, - staticConfig: { - classification: { - colorId: 2, - classificationDefinition: updatedClassificationDescription, - } satisfies UpdateClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField, - } satisfies UpdateClassificationRequestBodyArgDataFieldStaticConfigField, - } satisfies UpdateClassificationRequestBodyArgDataField, - } satisfies UpdateClassificationRequestBodyArg, -]); -``` - -### Arguments - -- requestBody `readonly UpdateClassificationRequestBodyArg[]` - - Request body of updateClassification method -- headers `UpdateClassificationHeadersArg` - - Headers of updateClassification method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ClassificationTemplate`. - -Returns the updated `securityClassification` metadata template, which -contains a `Box__Security__Classification__Key` field that lists all -the classifications available to this enterprise. - -## Add initial classifications - -When an enterprise does not yet have any classifications, this API call -initializes the classification template with an initial set of -classifications. - -If an enterprise already has a classification, the template will already -exist and instead an API call should be made to add additional -classifications. - -This operation is performed by calling function `createClassificationTemplate`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-metadata-templates-schema-classifications/). - -_Currently we don't have an example for calling `createClassificationTemplate` in integration tests_ - -### Arguments - -- requestBody `CreateClassificationTemplateRequestBodyArg` - - Request body of createClassificationTemplate method -- headers `CreateClassificationTemplateHeadersArg` - - Headers of createClassificationTemplate method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ClassificationTemplate`. - -Returns a new `securityClassification` metadata template, which -contains a `Box__Security__Classification__Key` field that lists all -the classifications available to this enterprise. diff --git a/docs/collaborationAllowlistEntries.md b/docs/collaborationAllowlistEntries.md deleted file mode 100644 index 3ef6d4ea..00000000 --- a/docs/collaborationAllowlistEntries.md +++ /dev/null @@ -1,138 +0,0 @@ -# CollaborationAllowlistEntriesManager - -- [List allowed collaboration domains](#list-allowed-collaboration-domains) -- [Add domain to list of allowed collaboration domains](#add-domain-to-list-of-allowed-collaboration-domains) -- [Get allowed collaboration domain](#get-allowed-collaboration-domain) -- [Remove domain from list of allowed collaboration domains](#remove-domain-from-list-of-allowed-collaboration-domains) - -## List allowed collaboration domains - -Returns the list domains that have been deemed safe to create collaborations -for within the current enterprise. - -This operation is performed by calling function `getCollaborationWhitelistEntries`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-collaboration-whitelist-entries/). - - - -```ts -await client.collaborationAllowlistEntries.getCollaborationWhitelistEntries(); -``` - -### Arguments - -- queryParams `GetCollaborationWhitelistEntriesQueryParamsArg` - - Query parameters of getCollaborationWhitelistEntries method -- headers `GetCollaborationWhitelistEntriesHeadersArg` - - Headers of getCollaborationWhitelistEntries method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `CollaborationAllowlistEntries`. - -Returns a collection of domains that are allowed for collaboration. - -## Add domain to list of allowed collaboration domains - -Creates a new entry in the list of allowed domains to allow -collaboration for. - -This operation is performed by calling function `createCollaborationWhitelistEntry`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-collaboration-whitelist-entries/). - - - -```ts -await client.collaborationAllowlistEntries.createCollaborationWhitelistEntry({ - direction: direction, - domain: domain, -} satisfies CreateCollaborationWhitelistEntryRequestBodyArg); -``` - -### Arguments - -- requestBody `CreateCollaborationWhitelistEntryRequestBodyArg` - - Request body of createCollaborationWhitelistEntry method -- headers `CreateCollaborationWhitelistEntryHeadersArg` - - Headers of createCollaborationWhitelistEntry method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `CollaborationAllowlistEntry`. - -Returns a new entry on the list of allowed domains. - -## Get allowed collaboration domain - -Returns a domain that has been deemed safe to create collaborations -for within the current enterprise. - -This operation is performed by calling function `getCollaborationWhitelistEntryById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-collaboration-whitelist-entries-id/). - - - -```ts -await client.collaborationAllowlistEntries.getCollaborationWhitelistEntryById( - entry.id! -); -``` - -### Arguments - -- collaborationWhitelistEntryId `string` - - The ID of the entry in the list. Example: "213123" -- headers `GetCollaborationWhitelistEntryByIdHeadersArg` - - Headers of getCollaborationWhitelistEntryById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `CollaborationAllowlistEntry`. - -Returns an entry on the list of allowed domains. - -## Remove domain from list of allowed collaboration domains - -Removes a domain from the list of domains that have been deemed safe to create -collaborations for within the current enterprise. - -This operation is performed by calling function `deleteCollaborationWhitelistEntryById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-collaboration-whitelist-entries-id/). - - - -```ts -await client.collaborationAllowlistEntries.deleteCollaborationWhitelistEntryById( - entry.id! -); -``` - -### Arguments - -- collaborationWhitelistEntryId `string` - - The ID of the entry in the list. Example: "213123" -- headers `DeleteCollaborationWhitelistEntryByIdHeadersArg` - - Headers of deleteCollaborationWhitelistEntryById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -A blank response is returned if the entry was -successfully deleted. diff --git a/docs/collaborationAllowlistExemptTargets.md b/docs/collaborationAllowlistExemptTargets.md deleted file mode 100644 index a7b344aa..00000000 --- a/docs/collaborationAllowlistExemptTargets.md +++ /dev/null @@ -1,141 +0,0 @@ -# CollaborationAllowlistExemptTargetsManager - -- [List users exempt from collaboration domain restrictions](#list-users-exempt-from-collaboration-domain-restrictions) -- [Create user exemption from collaboration domain restrictions](#create-user-exemption-from-collaboration-domain-restrictions) -- [Get user exempt from collaboration domain restrictions](#get-user-exempt-from-collaboration-domain-restrictions) -- [Remove user from list of users exempt from domain restrictions](#remove-user-from-list-of-users-exempt-from-domain-restrictions) - -## List users exempt from collaboration domain restrictions - -Returns a list of users who have been exempt from the collaboration -domain restrictions. - -This operation is performed by calling function `getCollaborationWhitelistExemptTargets`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-collaboration-whitelist-exempt-targets/). - - - -```ts -await client.collaborationAllowlistExemptTargets.getCollaborationWhitelistExemptTargets(); -``` - -### Arguments - -- queryParams `GetCollaborationWhitelistExemptTargetsQueryParamsArg` - - Query parameters of getCollaborationWhitelistExemptTargets method -- headers `GetCollaborationWhitelistExemptTargetsHeadersArg` - - Headers of getCollaborationWhitelistExemptTargets method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `CollaborationAllowlistExemptTargets`. - -Returns a collection of user exemptions. - -## Create user exemption from collaboration domain restrictions - -Exempts a user from the restrictions set out by the allowed list of domains -for collaborations. - -This operation is performed by calling function `createCollaborationWhitelistExemptTarget`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-collaboration-whitelist-exempt-targets/). - - - -```ts -await client.collaborationAllowlistExemptTargets.createCollaborationWhitelistExemptTarget( - { - user: { - id: user.id, - } satisfies CreateCollaborationWhitelistExemptTargetRequestBodyArgUserField, - } satisfies CreateCollaborationWhitelistExemptTargetRequestBodyArg -); -``` - -### Arguments - -- requestBody `CreateCollaborationWhitelistExemptTargetRequestBodyArg` - - Request body of createCollaborationWhitelistExemptTarget method -- headers `CreateCollaborationWhitelistExemptTargetHeadersArg` - - Headers of createCollaborationWhitelistExemptTarget method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `CollaborationAllowlistExemptTarget`. - -Returns a new exemption entry. - -## Get user exempt from collaboration domain restrictions - -Returns a users who has been exempt from the collaboration -domain restrictions. - -This operation is performed by calling function `getCollaborationWhitelistExemptTargetById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-collaboration-whitelist-exempt-targets-id/). - - - -```ts -await client.collaborationAllowlistExemptTargets.getCollaborationWhitelistExemptTargetById( - exemptTarget.id! -); -``` - -### Arguments - -- collaborationWhitelistExemptTargetId `string` - - The ID of the exemption to the list. Example: "984923" -- headers `GetCollaborationWhitelistExemptTargetByIdHeadersArg` - - Headers of getCollaborationWhitelistExemptTargetById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `CollaborationAllowlistExemptTarget`. - -Returns the user's exempted from the list of collaboration domains. - -## Remove user from list of users exempt from domain restrictions - -Removes a user's exemption from the restrictions set out by the allowed list -of domains for collaborations. - -This operation is performed by calling function `deleteCollaborationWhitelistExemptTargetById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-collaboration-whitelist-exempt-targets-id/). - - - -```ts -await client.collaborationAllowlistExemptTargets.deleteCollaborationWhitelistExemptTargetById( - exemptTarget.id! -); -``` - -### Arguments - -- collaborationWhitelistExemptTargetId `string` - - The ID of the exemption to the list. Example: "984923" -- headers `DeleteCollaborationWhitelistExemptTargetByIdHeadersArg` - - Headers of deleteCollaborationWhitelistExemptTargetById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -A blank response is returned if the exemption was -successfully deleted. diff --git a/docs/collections.md b/docs/collections.md deleted file mode 100644 index 17489f1b..00000000 --- a/docs/collections.md +++ /dev/null @@ -1,70 +0,0 @@ -# CollectionsManager - -- [List all collections](#list-all-collections) -- [List collection items](#list-collection-items) - -## List all collections - -Retrieves all collections for a given user. - -Currently, only the `favorites` collection -is supported. - -This operation is performed by calling function `getCollections`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-collections/). - - - -```ts -await client.collections.getCollections(); -``` - -### Arguments - -- queryParams `GetCollectionsQueryParamsArg` - - Query parameters of getCollections method -- headers `GetCollectionsHeadersArg` - - Headers of getCollections method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Collections`. - -Returns all collections for the given user - -## List collection items - -Retrieves the files and/or folders contained within -this collection. - -This operation is performed by calling function `getCollectionItems`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-collections-id-items/). - - - -```ts -await client.collections.getCollectionItems(favouriteCollection.id!); -``` - -### Arguments - -- collectionId `string` - - The ID of the collection. Example: "926489" -- queryParams `GetCollectionItemsQueryParamsArg` - - Query parameters of getCollectionItems method -- headers `GetCollectionItemsHeadersArg` - - Headers of getCollectionItems method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Items`. - -Returns an array of items in the collection. diff --git a/docs/comments.md b/docs/comments.md deleted file mode 100644 index d41bb931..00000000 --- a/docs/comments.md +++ /dev/null @@ -1,182 +0,0 @@ -# CommentsManager - -- [List file comments](#list-file-comments) -- [Get comment](#get-comment) -- [Update comment](#update-comment) -- [Remove comment](#remove-comment) -- [Create comment](#create-comment) - -## List file comments - -Retrieves a list of comments for a file. - -This operation is performed by calling function `getFileComments`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-files-id-comments/). - - - -```ts -await client.comments.getFileComments(fileId); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- queryParams `GetFileCommentsQueryParamsArg` - - Query parameters of getFileComments method -- headers `GetFileCommentsHeadersArg` - - Headers of getFileComments method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Comments`. - -Returns a collection of comment objects. If there are no -comments on this file an empty collection will be returned. - -## Get comment - -Retrieves the message and metadata for a specific comment, as well -as information on the user who created the comment. - -This operation is performed by calling function `getCommentById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-comments-id/). - - - -```ts -await client.comments.getCommentById(newComment.id!); -``` - -### Arguments - -- commentId `string` - - The ID of the comment. Example: "12345" -- queryParams `GetCommentByIdQueryParamsArg` - - Query parameters of getCommentById method -- headers `GetCommentByIdHeadersArg` - - Headers of getCommentById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `CommentFull`. - -Returns a full comment object. - -## Update comment - -Update the message of a comment. - -This operation is performed by calling function `updateCommentById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-comments-id/). - - - -```ts -await client.comments.updateCommentById(newReplyComment.id!, { - message: newMessage, -} satisfies UpdateCommentByIdRequestBodyArg); -``` - -### Arguments - -- commentId `string` - - The ID of the comment. Example: "12345" -- requestBody `UpdateCommentByIdRequestBodyArg` - - Request body of updateCommentById method -- queryParams `UpdateCommentByIdQueryParamsArg` - - Query parameters of updateCommentById method -- headers `UpdateCommentByIdHeadersArg` - - Headers of updateCommentById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `CommentFull`. - -Returns the updated comment object. - -## Remove comment - -Permanently deletes a comment. - -This operation is performed by calling function `deleteCommentById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-comments-id/). - - - -```ts -await client.comments.deleteCommentById(newComment.id!); -``` - -### Arguments - -- commentId `string` - - The ID of the comment. Example: "12345" -- headers `DeleteCommentByIdHeadersArg` - - Headers of deleteCommentById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the comment has been deleted. - -## Create comment - -Adds a comment by the user to a specific file, or -as a reply to an other comment. - -This operation is performed by calling function `createComment`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-comments/). - - - -```ts -await client.comments.createComment({ - message: message, - item: { - id: newComment.id!, - type: 'comment' as CreateCommentRequestBodyArgItemFieldTypeField, - } satisfies CreateCommentRequestBodyArgItemField, -} satisfies CreateCommentRequestBodyArg); -``` - -### Arguments - -- requestBody `CreateCommentRequestBodyArg` - - Request body of createComment method -- queryParams `CreateCommentQueryParamsArg` - - Query parameters of createComment method -- headers `CreateCommentHeadersArg` - - Headers of createComment method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `CommentFull`. - -Returns the newly created comment object. - -Not all available fields are returned by default. Use the -[fields](#param-fields) query parameter to explicitly request -any specific fields. diff --git a/docs/devicePinners.md b/docs/devicePinners.md deleted file mode 100644 index 74a8580e..00000000 --- a/docs/devicePinners.md +++ /dev/null @@ -1,88 +0,0 @@ -# DevicePinnersManager - -- [Get device pin](#get-device-pin) -- [Remove device pin](#remove-device-pin) -- [List enterprise device pins](#list-enterprise-device-pins) - -## Get device pin - -Retrieves information about an individual device pin. - -This operation is performed by calling function `getDevicePinnerById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-device-pinners-id/). - -_Currently we don't have an example for calling `getDevicePinnerById` in integration tests_ - -### Arguments - -- devicePinnerId `string` - - The ID of the device pin Example: "2324234" -- headers `GetDevicePinnerByIdHeadersArg` - - Headers of getDevicePinnerById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `DevicePinner`. - -Returns information about a single device pin. - -## Remove device pin - -Deletes an individual device pin. - -This operation is performed by calling function `deleteDevicePinnerById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-device-pinners-id/). - -_Currently we don't have an example for calling `deleteDevicePinnerById` in integration tests_ - -### Arguments - -- devicePinnerId `string` - - The ID of the device pin Example: "2324234" -- headers `DeleteDevicePinnerByIdHeadersArg` - - Headers of deleteDevicePinnerById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the pin has been deleted. - -## List enterprise device pins - -Retrieves all the device pins within an enterprise. - -The user must have admin privileges, and the application -needs the "manage enterprise" scope to make this call. - -This operation is performed by calling function `getEnterpriseDevicePinners`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-enterprises-id-device-pinners/). - -_Currently we don't have an example for calling `getEnterpriseDevicePinners` in integration tests_ - -### Arguments - -- enterpriseId `string` - - The ID of the enterprise Example: "3442311" -- queryParams `GetEnterpriseDevicePinnersQueryParamsArg` - - Query parameters of getEnterpriseDevicePinners method -- headers `GetEnterpriseDevicePinnersHeadersArg` - - Headers of getEnterpriseDevicePinners method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `DevicePinners`. - -Returns a list of device pins for a given enterprise. diff --git a/docs/emailAliases.md b/docs/emailAliases.md deleted file mode 100644 index 94b9637a..00000000 --- a/docs/emailAliases.md +++ /dev/null @@ -1,102 +0,0 @@ -# EmailAliasesManager - -- [List user's email aliases](#list-users-email-aliases) -- [Create email alias](#create-email-alias) -- [Remove email alias](#remove-email-alias) - -## List user's email aliases - -Retrieves all email aliases for a user. The collection -does not include the primary login for the user. - -This operation is performed by calling function `getUserEmailAliases`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-users-id-email-aliases/). - - - -```ts -await client.emailAliases.getUserEmailAliases(newUser.id); -``` - -### Arguments - -- userId `string` - - The ID of the user. Example: "12345" -- headers `GetUserEmailAliasesHeadersArg` - - Headers of getUserEmailAliases method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `EmailAliases`. - -Returns a collection of email aliases. - -## Create email alias - -Adds a new email alias to a user account.. - -This operation is performed by calling function `createUserEmailAlias`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-users-id-email-aliases/). - - - -```ts -await client.emailAliases.createUserEmailAlias(newUser.id, { - email: newAliasEmail, -} satisfies CreateUserEmailAliasRequestBodyArg); -``` - -### Arguments - -- userId `string` - - The ID of the user. Example: "12345" -- requestBody `CreateUserEmailAliasRequestBodyArg` - - Request body of createUserEmailAlias method -- headers `CreateUserEmailAliasHeadersArg` - - Headers of createUserEmailAlias method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `EmailAlias`. - -Returns the newly created email alias object. - -## Remove email alias - -Removes an email alias from a user. - -This operation is performed by calling function `deleteUserEmailAliasById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-users-id-email-aliases-id/). - - - -```ts -await client.emailAliases.deleteUserEmailAliasById(newUser.id, newAlias.id!); -``` - -### Arguments - -- userId `string` - - The ID of the user. Example: "12345" -- emailAliasId `string` - - The ID of the email alias. Example: "23432" -- headers `DeleteUserEmailAliasByIdHeadersArg` - - Headers of deleteUserEmailAliasById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Removes the alias and returns an empty response. diff --git a/docs/events.md b/docs/events.md deleted file mode 100644 index 76793fa5..00000000 --- a/docs/events.md +++ /dev/null @@ -1,101 +0,0 @@ -# EventsManager - -- [List user and enterprise events](#list-user-and-enterprise-events) -- [Get events long poll endpoint](#get-events-long-poll-endpoint) - -## List user and enterprise events - -Returns up to a year of past events for a given user -or for the entire enterprise. - -By default this returns events for the authenticated user. To retrieve events -for the entire enterprise, set the `stream_type` to `admin_logs_streaming` -for live monitoring of new events, or `admin_logs` for querying across -historical events. The user making the API call will -need to have admin privileges, and the application will need to have the -scope `manage enterprise properties` checked. - -This operation is performed by calling function `getEvents`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-events/). - -_Currently we don't have an example for calling `getEvents` in integration tests_ - -### Arguments - -- queryParams `GetEventsQueryParamsArg` - - Query parameters of getEvents method -- headers `GetEventsHeadersArg` - - Headers of getEvents method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Events`. - -Returns a list of event objects. - -Events objects are returned in pages, with each page (chunk) -including a list of event objects. The response includes a -`chunk_size` parameter indicating how many events were returned in this -chunk, as well as the next `stream_position` that can be -queried. - -## Get events long poll endpoint - -Returns a list of real-time servers that can be used for long-polling updates -to the [event stream](#get-events). - -Long polling is the concept where a HTTP request is kept open until the -server sends a response, then repeating the process over and over to receive -updated responses. - -Long polling the event stream can only be used for user events, not for -enterprise events. - -To use long polling, first use this endpoint to retrieve a list of long poll -URLs. Next, make a long poll request to any of the provided URLs. - -When an event occurs in monitored account a response with the value -`new_change` will be sent. The response contains no other details as -it only serves as a prompt to take further action such as sending a -request to the [events endpoint](#get-events) with the last known -`stream_position`. - -After the server sends this response it closes the connection. You must now -repeat the long poll process to begin listening for events again. - -If no events occur for a while and the connection times out you will -receive a response with the value `reconnect`. When you receive this response -you’ll make another call to this endpoint to restart the process. - -If you receive no events in `retry_timeout` seconds then you will need to -make another request to the real-time server (one of the URLs in the response -for this endpoint). This might be necessary due to network errors. - -Finally, if you receive a `max_retries` error when making a request to the -real-time server, you should start over by making a call to this endpoint -first. - -This operation is performed by calling function `getEventsWithLongPolling`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/options-events/). - -_Currently we don't have an example for calling `getEventsWithLongPolling` in integration tests_ - -### Arguments - -- headers `GetEventsWithLongPollingHeadersArg` - - Headers of getEventsWithLongPolling method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `RealtimeServers`. - -Returns a paginated array of servers that can be used -instead of the regular endpoints for long-polling events. diff --git a/docs/fileClassifications.md b/docs/fileClassifications.md deleted file mode 100644 index d850751b..00000000 --- a/docs/fileClassifications.md +++ /dev/null @@ -1,137 +0,0 @@ -# FileClassificationsManager - -- [Get classification on file](#get-classification-on-file) -- [Add classification to file](#add-classification-to-file) -- [Update classification on file](#update-classification-on-file) -- [Remove classification from file](#remove-classification-from-file) - -## Get classification on file - -Retrieves the classification metadata instance that -has been applied to a file. - -This API can also be called by including the enterprise ID in the -URL explicitly, for example -`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`. - -This operation is performed by calling function `getFileMetadataEnterpriseSecurityClassification6VmVochwUWo`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-files-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/). - -_Currently we don't have an example for calling `getFileMetadataEnterpriseSecurityClassification6VmVochwUWo` in integration tests_ - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- headers `GetFileMetadataEnterpriseSecurityClassification6VmVochwUWoHeadersArg` - - Headers of getFileMetadataEnterpriseSecurityClassification6VmVochwUWo method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Classification`. - -Returns an instance of the `securityClassification` metadata -template, which contains a `Box__Security__Classification__Key` -field that lists all the classifications available to this -enterprise. - -## Add classification to file - -Adds a classification to a file by specifying the label of the -classification to add. - -This API can also be called by including the enterprise ID in the -URL explicitly, for example -`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`. - -This operation is performed by calling function `createFileMetadataEnterpriseSecurityClassification`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-files-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/). - -_Currently we don't have an example for calling `createFileMetadataEnterpriseSecurityClassification` in integration tests_ - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- requestBody `CreateFileMetadataEnterpriseSecurityClassificationRequestBodyArg` - - Request body of createFileMetadataEnterpriseSecurityClassification method -- headers `CreateFileMetadataEnterpriseSecurityClassificationHeadersArg` - - Headers of createFileMetadataEnterpriseSecurityClassification method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Classification`. - -Returns the classification template instance -that was applied to the file. - -## Update classification on file - -Updates a classification on a file. - -The classification can only be updated if a classification has already been -applied to the file before. When editing classifications, only values are -defined for the enterprise will be accepted. - -This operation is performed by calling function `updateFileMetadataEnterpriseSecurityClassification`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-files-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/). - -_Currently we don't have an example for calling `updateFileMetadataEnterpriseSecurityClassification` in integration tests_ - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- requestBody `readonly UpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArg[]` - - Request body of updateFileMetadataEnterpriseSecurityClassification method -- headers `UpdateFileMetadataEnterpriseSecurityClassificationHeadersArg` - - Headers of updateFileMetadataEnterpriseSecurityClassification method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Classification`. - -Returns the updated classification metadata template instance. - -## Remove classification from file - -Removes any classifications from a file. - -This API can also be called by including the enterprise ID in the -URL explicitly, for example -`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`. - -This operation is performed by calling function `deleteFileMetadataEnterpriseSecurityClassification`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-files-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/). - -_Currently we don't have an example for calling `deleteFileMetadataEnterpriseSecurityClassification` in integration tests_ - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- headers `DeleteFileMetadataEnterpriseSecurityClassificationHeadersArg` - - Headers of deleteFileMetadataEnterpriseSecurityClassification method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the classification is -successfully deleted. diff --git a/docs/fileMetadata.md b/docs/fileMetadata.md deleted file mode 100644 index e7e273ae..00000000 --- a/docs/fileMetadata.md +++ /dev/null @@ -1,221 +0,0 @@ -# FileMetadataManager - -- [List metadata instances on file](#list-metadata-instances-on-file) -- [Get metadata instance on file](#get-metadata-instance-on-file) -- [Create metadata instance on file](#create-metadata-instance-on-file) -- [Update metadata instance on file](#update-metadata-instance-on-file) -- [Remove metadata instance from file](#remove-metadata-instance-from-file) - -## List metadata instances on file - -Retrieves all metadata for a given file. - -This operation is performed by calling function `getFileMetadata`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-files-id-metadata/). - - - -```ts -await client.fileMetadata.getFileMetadata(file.id); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- headers `GetFileMetadataHeadersArg` - - Headers of getFileMetadata method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Metadatas`. - -Returns all the metadata associated with a file. - -This API does not support pagination and will therefore always return -all of the metadata associated to the file. - -## Get metadata instance on file - -Retrieves the instance of a metadata template that has been applied to a -file. - -This operation is performed by calling function `getFileMetadataById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-files-id-metadata-id-id/). - - - -```ts -await client.fileMetadata.getFileMetadataById( - file.id, - 'global' as GetFileMetadataByIdScopeArg, - 'properties' -); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- scope `GetFileMetadataByIdScopeArg` - - The scope of the metadata template Example: "global" -- templateKey `string` - - The name of the metadata template Example: "properties" -- headers `GetFileMetadataByIdHeadersArg` - - Headers of getFileMetadataById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `MetadataFull`. - -An instance of the metadata template that includes -additional "key:value" pairs defined by the user or -an application. - -## Create metadata instance on file - -Applies an instance of a metadata template to a file. - -In most cases only values that are present in the metadata template -will be accepted, except for the `global.properties` template which accepts -any key-value pair. - -This operation is performed by calling function `createFileMetadataById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-files-id-metadata-id-id/). - - - -```ts -await client.fileMetadata.createFileMetadataById( - file.id, - 'enterprise' as CreateFileMetadataByIdScopeArg, - templateKey, - { ['testName']: 1 } -); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- scope `CreateFileMetadataByIdScopeArg` - - The scope of the metadata template Example: "global" -- templateKey `string` - - The name of the metadata template Example: "properties" -- requestBody `CreateFileMetadataByIdRequestBodyArg` - - Request body of createFileMetadataById method -- headers `CreateFileMetadataByIdHeadersArg` - - Headers of createFileMetadataById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `MetadataFull`. - -Returns the instance of the template that was applied to the file, -including the data that was applied to the template. - -## Update metadata instance on file - -Updates a piece of metadata on a file. - -The metadata instance can only be updated if the template has already been -applied to the file before. When editing metadata, only values that match -the metadata template schema will be accepted. - -The update is applied atomically. If any errors occur during the -application of the operations, the metadata instance will not be changed. - -This operation is performed by calling function `updateFileMetadataById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-files-id-metadata-id-id/). - - - -```ts -await client.fileMetadata.updateFileMetadataById( - file.id, - 'global' as UpdateFileMetadataByIdScopeArg, - 'properties', - [ - { - op: 'replace' as UpdateFileMetadataByIdRequestBodyArgOpField, - path: '/abc', - value: newValue, - } satisfies UpdateFileMetadataByIdRequestBodyArg, - ] -); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- scope `UpdateFileMetadataByIdScopeArg` - - The scope of the metadata template Example: "global" -- templateKey `string` - - The name of the metadata template Example: "properties" -- requestBody `readonly UpdateFileMetadataByIdRequestBodyArg[]` - - Request body of updateFileMetadataById method -- headers `UpdateFileMetadataByIdHeadersArg` - - Headers of updateFileMetadataById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `MetadataFull`. - -Returns the updated metadata template instance, with the -custom template data included. - -## Remove metadata instance from file - -Deletes a piece of file metadata. - -This operation is performed by calling function `deleteFileMetadataById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-files-id-metadata-id-id/). - - - -```ts -await client.fileMetadata.deleteFileMetadataById( - file.id, - 'enterprise' as DeleteFileMetadataByIdScopeArg, - templateKey -); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- scope `DeleteFileMetadataByIdScopeArg` - - The scope of the metadata template Example: "global" -- templateKey `string` - - The name of the metadata template Example: "properties" -- headers `DeleteFileMetadataByIdHeadersArg` - - Headers of deleteFileMetadataById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the metadata is -successfully deleted. diff --git a/docs/fileRequests.md b/docs/fileRequests.md deleted file mode 100644 index 8b6428cf..00000000 --- a/docs/fileRequests.md +++ /dev/null @@ -1,141 +0,0 @@ -# FileRequestsManager - -- [Get file request](#get-file-request) -- [Update file request](#update-file-request) -- [Delete file request](#delete-file-request) -- [Copy file request](#copy-file-request) - -## Get file request - -Retrieves the information about a file request. - -This operation is performed by calling function `getFileRequestById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-file-requests-id/). - - - -```ts -await client.fileRequests.getFileRequestById(updatedFileRequest.id); -``` - -### Arguments - -- fileRequestId `string` - - The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`. Example: "123" -- headers `GetFileRequestByIdHeadersArg` - - Headers of getFileRequestById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FileRequest`. - -Returns a file request object. - -## Update file request - -Updates a file request. This can be used to activate or -deactivate a file request. - -This operation is performed by calling function `updateFileRequestById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-file-requests-id/). - - - -```ts -await client.fileRequests.updateFileRequestById(copiedFileRequest.id, { - title: 'updated title', - description: 'updated description', -} satisfies FileRequestUpdateRequest); -``` - -### Arguments - -- fileRequestId `string` - - The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`. Example: "123" -- requestBody `FileRequestUpdateRequest` - - Request body of updateFileRequestById method -- headers `UpdateFileRequestByIdHeadersArg` - - Headers of updateFileRequestById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FileRequest`. - -Returns the updated file request object. - -## Delete file request - -Deletes a file request permanently. - -This operation is performed by calling function `deleteFileRequestById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-file-requests-id/). - - - -```ts -await client.fileRequests.deleteFileRequestById(updatedFileRequest.id); -``` - -### Arguments - -- fileRequestId `string` - - The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`. Example: "123" -- headers `DeleteFileRequestByIdHeadersArg` - - Headers of deleteFileRequestById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the file request has been successfully -deleted. - -## Copy file request - -Copies an existing file request that is already present on one folder, -and applies it to another folder. - -This operation is performed by calling function `createFileRequestCopy`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-file-requests-id-copy/). - - - -```ts -await client.fileRequests.createFileRequestCopy(fileRequestId, { - folder: { - id: fileRequest.folder.id, - type: 'folder' as FileRequestCopyRequestFolderFieldTypeField, - } satisfies FileRequestCopyRequestFolderField, -} satisfies FileRequestCopyRequest); -``` - -### Arguments - -- fileRequestId `string` - - The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`. Example: "123" -- requestBody `FileRequestCopyRequest` - - Request body of createFileRequestCopy method -- headers `CreateFileRequestCopyHeadersArg` - - Headers of createFileRequestCopy method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FileRequest`. - -Returns updated file request object. diff --git a/docs/fileVersionLegalHolds.md b/docs/fileVersionLegalHolds.md deleted file mode 100644 index ed89f383..00000000 --- a/docs/fileVersionLegalHolds.md +++ /dev/null @@ -1,77 +0,0 @@ -# FileVersionLegalHoldsManager - -- [Get file version legal hold](#get-file-version-legal-hold) -- [List file version legal holds](#list-file-version-legal-holds) - -## Get file version legal hold - -Retrieves information about the legal hold policies -assigned to a file version. - -This operation is performed by calling function `getFileVersionLegalHoldById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-file-version-legal-holds-id/). - -_Currently we don't have an example for calling `getFileVersionLegalHoldById` in integration tests_ - -### Arguments - -- fileVersionLegalHoldId `string` - - The ID of the file version legal hold Example: "2348213" -- headers `GetFileVersionLegalHoldByIdHeadersArg` - - Headers of getFileVersionLegalHoldById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FileVersionLegalHold`. - -Returns the legal hold policy assignments for the file version. - -## List file version legal holds - -Get a list of file versions on legal hold for a legal hold -assignment. - -Due to ongoing re-architecture efforts this API might not return all file -versions for this policy ID. - -Instead, this API will only return file versions held in the legacy -architecture. Two new endpoints will available to request any file versions -held in the new architecture. - -For file versions held in the new architecture, the `GET -/legal_hold_policy_assignments/:id/file_versions_on_hold` API can be used to -return all past file versions available for this policy assignment, and the -`GET /legal_hold_policy_assignments/:id/files_on_hold` API can be used to -return any current (latest) versions of a file under legal hold. - -The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to -find a list of policy assignments for a given policy ID. - -Once the re-architecture is completed this API will be deprecated. - -This operation is performed by calling function `getFileVersionLegalHolds`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-file-version-legal-holds/). - -_Currently we don't have an example for calling `getFileVersionLegalHolds` in integration tests_ - -### Arguments - -- queryParams `GetFileVersionLegalHoldsQueryParamsArg` - - Query parameters of getFileVersionLegalHolds method -- headers `GetFileVersionLegalHoldsHeadersArg` - - Headers of getFileVersionLegalHolds method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FileVersionLegalHolds`. - -Returns the list of file version legal holds for a specific legal -hold policy. diff --git a/docs/fileVersionRetentions.md b/docs/fileVersionRetentions.md deleted file mode 100644 index 1c005a21..00000000 --- a/docs/fileVersionRetentions.md +++ /dev/null @@ -1,56 +0,0 @@ -# FileVersionRetentionsManager - -- [List file version retentions](#list-file-version-retentions) -- [Get retention on file](#get-retention-on-file) - -## List file version retentions - -Retrieves all file version retentions for the given enterprise. - -This operation is performed by calling function `getFileVersionRetentions`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-file-version-retentions/). - -_Currently we don't have an example for calling `getFileVersionRetentions` in integration tests_ - -### Arguments - -- queryParams `GetFileVersionRetentionsQueryParamsArg` - - Query parameters of getFileVersionRetentions method -- headers `GetFileVersionRetentionsHeadersArg` - - Headers of getFileVersionRetentions method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FileVersionRetentions`. - -Returns a list of all file version retentions for the enterprise. - -## Get retention on file - -Returns information about a file version retention. - -This operation is performed by calling function `getFileVersionRetentionById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-file-version-retentions-id/). - -_Currently we don't have an example for calling `getFileVersionRetentionById` in integration tests_ - -### Arguments - -- fileVersionRetentionId `string` - - The ID of the file version retention Example: "3424234" -- headers `GetFileVersionRetentionByIdHeadersArg` - - Headers of getFileVersionRetentionById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FileVersionRetention`. - -Returns a file version retention object. diff --git a/docs/fileVersions.md b/docs/fileVersions.md deleted file mode 100644 index 9d7ac7b0..00000000 --- a/docs/fileVersions.md +++ /dev/null @@ -1,208 +0,0 @@ -# FileVersionsManager - -- [List all file versions](#list-all-file-versions) -- [Get file version](#get-file-version) -- [Restore file version](#restore-file-version) -- [Remove file version](#remove-file-version) -- [Promote file version](#promote-file-version) - -## List all file versions - -Retrieve a list of the past versions for a file. - -Versions are only tracked by Box users with premium accounts. To fetch the ID -of the current version of a file, use the `GET /file/:id` API. - -This operation is performed by calling function `getFileVersions`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-files-id-versions/). - - - -```ts -await client.fileVersions.getFileVersions(file.id); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- queryParams `GetFileVersionsQueryParamsArg` - - Query parameters of getFileVersions method -- headers `GetFileVersionsHeadersArg` - - Headers of getFileVersions method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FileVersions`. - -Returns an array of past versions for this file. - -## Get file version - -Retrieve a specific version of a file. - -Versions are only tracked for Box users with premium accounts. - -This operation is performed by calling function `getFileVersionById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-files-id-versions-id/). - - - -```ts -await client.fileVersions.getFileVersionById( - file.id, - fileVersions.entries![0].id -); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- fileVersionId `string` - - The ID of the file version Example: "1234" -- queryParams `GetFileVersionByIdQueryParamsArg` - - Query parameters of getFileVersionById method -- headers `GetFileVersionByIdHeadersArg` - - Headers of getFileVersionById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FileVersionFull`. - -Returns a specific version of a file. - -Not all available fields are returned by default. Use the -[fields](#param-fields) query parameter to explicitly request -any specific fields. - -## Restore file version - -Restores a specific version of a file after it was deleted. -Don't use this endpoint to restore Box Notes, -as it works with file formats such as PDF, DOC, -PPTX or similar. - -This operation is performed by calling function `updateFileVersionById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-files-id-versions-id/). - -_Currently we don't have an example for calling `updateFileVersionById` in integration tests_ - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- fileVersionId `string` - - The ID of the file version Example: "1234" -- requestBody `UpdateFileVersionByIdRequestBodyArg` - - Request body of updateFileVersionById method -- headers `UpdateFileVersionByIdHeadersArg` - - Headers of updateFileVersionById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FileVersionFull`. - -Returns a restored file version object. - -## Remove file version - -Move a file version to the trash. - -Versions are only tracked for Box users with premium accounts. - -This operation is performed by calling function `deleteFileVersionById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-files-id-versions-id/). - - - -```ts -await client.fileVersions.deleteFileVersionById( - file.id, - fileVersionsRestored.entries![0].id -); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- fileVersionId `string` - - The ID of the file version Example: "1234" -- headers `DeleteFileVersionByIdHeadersArg` - - Headers of deleteFileVersionById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the file has been successfully -deleted. - -## Promote file version - -Promote a specific version of a file. - -If previous versions exist, this method can be used to -promote one of the older versions to the top of the version history. - -This creates a new copy of the old version and puts it at the -top of the versions history. The file will have the exact same contents -as the older version, with the the same hash digest, `etag`, and -name as the original. - -Other properties such as comments do not get updated to their -former values. - -Don't use this endpoint to restore Box Notes, -as it works with file formats such as PDF, DOC, -PPTX or similar. - -This operation is performed by calling function `promoteFileVersion`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-files-id-versions-current/). - - - -```ts -await client.fileVersions.promoteFileVersion(file.id, { - id: fileVersions.entries![0].id, - type: 'file_version' as PromoteFileVersionRequestBodyArgTypeField, -} satisfies PromoteFileVersionRequestBodyArg); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- requestBody `PromoteFileVersionRequestBodyArg` - - Request body of promoteFileVersion method -- queryParams `PromoteFileVersionQueryParamsArg` - - Query parameters of promoteFileVersion method -- headers `PromoteFileVersionHeadersArg` - - Headers of promoteFileVersion method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FileVersionFull`. - -Returns a newly created file version object. diff --git a/docs/fileWatermarks.md b/docs/fileWatermarks.md deleted file mode 100644 index 2103b789..00000000 --- a/docs/fileWatermarks.md +++ /dev/null @@ -1,105 +0,0 @@ -# FileWatermarksManager - -- [Get watermark on file](#get-watermark-on-file) -- [Apply watermark to file](#apply-watermark-to-file) -- [Remove watermark from file](#remove-watermark-from-file) - -## Get watermark on file - -Retrieve the watermark for a file. - -This operation is performed by calling function `getFileWatermark`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-files-id-watermark/). - - - -```ts -await client.fileWatermarks.getFileWatermark(file.id); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- headers `GetFileWatermarkHeadersArg` - - Headers of getFileWatermark method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Watermark`. - -Returns an object containing information about the -watermark associated for to this file. - -## Apply watermark to file - -Applies or update a watermark on a file. - -This operation is performed by calling function `updateFileWatermark`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-files-id-watermark/). - - - -```ts -await client.fileWatermarks.updateFileWatermark(file.id, { - watermark: { - imprint: - 'default' as UpdateFileWatermarkRequestBodyArgWatermarkFieldImprintField, - } satisfies UpdateFileWatermarkRequestBodyArgWatermarkField, -} satisfies UpdateFileWatermarkRequestBodyArg); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- requestBody `UpdateFileWatermarkRequestBodyArg` - - Request body of updateFileWatermark method -- headers `UpdateFileWatermarkHeadersArg` - - Headers of updateFileWatermark method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Watermark`. - -Returns an updated watermark if a watermark already -existed on this file.Returns a new watermark if no watermark existed on -this file yet. - -## Remove watermark from file - -Removes the watermark from a file. - -This operation is performed by calling function `deleteFileWatermark`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-files-id-watermark/). - - - -```ts -await client.fileWatermarks.deleteFileWatermark(file.id); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- headers `DeleteFileWatermarkHeadersArg` - - Headers of deleteFileWatermark method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Removes the watermark and returns an empty response. diff --git a/docs/folderClassifications.md b/docs/folderClassifications.md deleted file mode 100644 index b363b33d..00000000 --- a/docs/folderClassifications.md +++ /dev/null @@ -1,137 +0,0 @@ -# FolderClassificationsManager - -- [Get classification on folder](#get-classification-on-folder) -- [Add classification to folder](#add-classification-to-folder) -- [Update classification on folder](#update-classification-on-folder) -- [Remove classification from folder](#remove-classification-from-folder) - -## Get classification on folder - -Retrieves the classification metadata instance that -has been applied to a folder. - -This API can also be called by including the enterprise ID in the -URL explicitly, for example -`/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo`. - -This operation is performed by calling function `getFolderMetadataEnterpriseSecurityClassification6VmVochwUWo`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-folders-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/). - -_Currently we don't have an example for calling `getFolderMetadataEnterpriseSecurityClassification6VmVochwUWo` in integration tests_ - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" -- headers `GetFolderMetadataEnterpriseSecurityClassification6VmVochwUWoHeadersArg` - - Headers of getFolderMetadataEnterpriseSecurityClassification6VmVochwUWo method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Classification`. - -Returns an instance of the `securityClassification` metadata -template, which contains a `Box__Security__Classification__Key` -field that lists all the classifications available to this -enterprise. - -## Add classification to folder - -Adds a classification to a folder by specifying the label of the -classification to add. - -This API can also be called by including the enterprise ID in the -URL explicitly, for example -`/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo`. - -This operation is performed by calling function `createFolderMetadataEnterpriseSecurityClassification`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-folders-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/). - -_Currently we don't have an example for calling `createFolderMetadataEnterpriseSecurityClassification` in integration tests_ - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" -- requestBody `CreateFolderMetadataEnterpriseSecurityClassificationRequestBodyArg` - - Request body of createFolderMetadataEnterpriseSecurityClassification method -- headers `CreateFolderMetadataEnterpriseSecurityClassificationHeadersArg` - - Headers of createFolderMetadataEnterpriseSecurityClassification method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Classification`. - -Returns the classification template instance -that was applied to the folder. - -## Update classification on folder - -Updates a classification on a folder. - -The classification can only be updated if a classification has already been -applied to the folder before. When editing classifications, only values are -defined for the enterprise will be accepted. - -This operation is performed by calling function `updateFolderMetadataEnterpriseSecurityClassification`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-folders-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/). - -_Currently we don't have an example for calling `updateFolderMetadataEnterpriseSecurityClassification` in integration tests_ - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" -- requestBody `readonly UpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArg[]` - - Request body of updateFolderMetadataEnterpriseSecurityClassification method -- headers `UpdateFolderMetadataEnterpriseSecurityClassificationHeadersArg` - - Headers of updateFolderMetadataEnterpriseSecurityClassification method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Classification`. - -Returns the updated classification metadata template instance. - -## Remove classification from folder - -Removes any classifications from a folder. - -This API can also be called by including the enterprise ID in the -URL explicitly, for example -`/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo`. - -This operation is performed by calling function `deleteFolderMetadataEnterpriseSecurityClassification`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-folders-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/). - -_Currently we don't have an example for calling `deleteFolderMetadataEnterpriseSecurityClassification` in integration tests_ - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" -- headers `DeleteFolderMetadataEnterpriseSecurityClassificationHeadersArg` - - Headers of deleteFolderMetadataEnterpriseSecurityClassification method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the classification is -successfully deleted. diff --git a/docs/folderLocks.md b/docs/folderLocks.md deleted file mode 100644 index 4ab47f95..00000000 --- a/docs/folderLocks.md +++ /dev/null @@ -1,118 +0,0 @@ -# FolderLocksManager - -- [List folder locks](#list-folder-locks) -- [Create folder lock](#create-folder-lock) -- [Delete folder lock](#delete-folder-lock) - -## List folder locks - -Retrieves folder lock details for a given folder. - -You must be authenticated as the owner or co-owner of the folder to -use this endpoint. - -This operation is performed by calling function `getFolderLocks`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-folder-locks/). - - - -```ts -await client.folderLocks.getFolderLocks({ - folderId: folder.id, -} satisfies GetFolderLocksQueryParamsArg); -``` - -### Arguments - -- queryParams `GetFolderLocksQueryParamsArg` - - Query parameters of getFolderLocks method -- headers `GetFolderLocksHeadersArg` - - Headers of getFolderLocks method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FolderLocks`. - -Returns details for all folder locks applied to the folder, including the -lock type and user that applied the lock. - -## Create folder lock - -Creates a folder lock on a folder, preventing it from being moved and/or -deleted. - -You must be authenticated as the owner or co-owner of the folder to -use this endpoint. - -This operation is performed by calling function `createFolderLock`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-folder-locks/). - - - -```ts -await client.folderLocks.createFolderLock({ - folder: { - id: folder.id, - type: 'folder', - } satisfies CreateFolderLockRequestBodyArgFolderField, - lockedOperations: { - move: true, - delete: true, - } satisfies CreateFolderLockRequestBodyArgLockedOperationsField, -} satisfies CreateFolderLockRequestBodyArg); -``` - -### Arguments - -- requestBody `CreateFolderLockRequestBodyArg` - - Request body of createFolderLock method -- headers `CreateFolderLockHeadersArg` - - Headers of createFolderLock method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FolderLock`. - -Returns the instance of the folder lock that was applied to the folder, -including the user that applied the lock and the operations set. - -## Delete folder lock - -Deletes a folder lock on a given folder. - -You must be authenticated as the owner or co-owner of the folder to -use this endpoint. - -This operation is performed by calling function `deleteFolderLockById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-folder-locks-id/). - - - -```ts -await client.folderLocks.deleteFolderLockById(folderLock.id!); -``` - -### Arguments - -- folderLockId `string` - - The ID of the folder lock. Example: "12345" -- headers `DeleteFolderLockByIdHeadersArg` - - Headers of deleteFolderLockById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the folder lock is successfully deleted. diff --git a/docs/folderMetadata.md b/docs/folderMetadata.md deleted file mode 100644 index dcac0ddf..00000000 --- a/docs/folderMetadata.md +++ /dev/null @@ -1,226 +0,0 @@ -# FolderMetadataManager - -- [List metadata instances on folder](#list-metadata-instances-on-folder) -- [Get metadata instance on folder](#get-metadata-instance-on-folder) -- [Create metadata instance on folder](#create-metadata-instance-on-folder) -- [Update metadata instance on folder](#update-metadata-instance-on-folder) -- [Remove metadata instance from folder](#remove-metadata-instance-from-folder) - -## List metadata instances on folder - -Retrieves all metadata for a given folder. This can not be used on the root -folder with ID `0`. - -This operation is performed by calling function `getFolderMetadata`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-folders-id-metadata/). - - - -```ts -await client.folderMetadata.getFolderMetadata(folder.id); -``` - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" -- headers `GetFolderMetadataHeadersArg` - - Headers of getFolderMetadata method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Metadatas`. - -Returns all the metadata associated with a folder. - -This API does not support pagination and will therefore always return -all of the metadata associated to the folder. - -## Get metadata instance on folder - -Retrieves the instance of a metadata template that has been applied to a -folder. This can not be used on the root folder with ID `0`. - -This operation is performed by calling function `getFolderMetadataById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-folders-id-metadata-id-id/). - - - -```ts -await client.folderMetadata.getFolderMetadataById( - folder.id, - 'global' as GetFolderMetadataByIdScopeArg, - 'properties' -); -``` - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" -- scope `GetFolderMetadataByIdScopeArg` - - The scope of the metadata template Example: "global" -- templateKey `string` - - The name of the metadata template Example: "properties" -- headers `GetFolderMetadataByIdHeadersArg` - - Headers of getFolderMetadataById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `MetadataFull`. - -An instance of the metadata template that includes -additional "key:value" pairs defined by the user or -an application. - -## Create metadata instance on folder - -Applies an instance of a metadata template to a folder. - -In most cases only values that are present in the metadata template -will be accepted, except for the `global.properties` template which accepts -any key-value pair. - -To display the metadata template in the Box web app the enterprise needs to be -configured to enable **Cascading Folder Level Metadata** for the user in the -admin console. - -This operation is performed by calling function `createFolderMetadataById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-folders-id-metadata-id-id/). - - - -```ts -await client.folderMetadata.createFolderMetadataById( - folder.id, - 'enterprise' as CreateFolderMetadataByIdScopeArg, - templateKey, - data -); -``` - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" -- scope `CreateFolderMetadataByIdScopeArg` - - The scope of the metadata template Example: "global" -- templateKey `string` - - The name of the metadata template Example: "properties" -- requestBody `CreateFolderMetadataByIdRequestBodyArg` - - Request body of createFolderMetadataById method -- headers `CreateFolderMetadataByIdHeadersArg` - - Headers of createFolderMetadataById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `MetadataFull`. - -Returns the instance of the template that was applied to the folder, -including the data that was applied to the template. - -## Update metadata instance on folder - -Updates a piece of metadata on a folder. - -The metadata instance can only be updated if the template has already been -applied to the folder before. When editing metadata, only values that match -the metadata template schema will be accepted. - -The update is applied atomically. If any errors occur during the -application of the operations, the metadata instance will not be changed. - -This operation is performed by calling function `updateFolderMetadataById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-folders-id-metadata-id-id/). - - - -```ts -await client.folderMetadata.updateFolderMetadataById( - folder.id, - 'global' as UpdateFolderMetadataByIdScopeArg, - 'properties', - [ - { - op: 'replace' as UpdateFolderMetadataByIdRequestBodyArgOpField, - path: '/abc', - value: newValue, - } satisfies UpdateFolderMetadataByIdRequestBodyArg, - ] -); -``` - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" -- scope `UpdateFolderMetadataByIdScopeArg` - - The scope of the metadata template Example: "global" -- templateKey `string` - - The name of the metadata template Example: "properties" -- requestBody `readonly UpdateFolderMetadataByIdRequestBodyArg[]` - - Request body of updateFolderMetadataById method -- headers `UpdateFolderMetadataByIdHeadersArg` - - Headers of updateFolderMetadataById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `MetadataFull`. - -Returns the updated metadata template instance, with the -custom template data included. - -## Remove metadata instance from folder - -Deletes a piece of folder metadata. - -This operation is performed by calling function `deleteFolderMetadataById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-folders-id-metadata-id-id/). - - - -```ts -await client.folderMetadata.deleteFolderMetadataById( - folder.id, - 'global' as DeleteFolderMetadataByIdScopeArg, - 'properties' -); -``` - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" -- scope `DeleteFolderMetadataByIdScopeArg` - - The scope of the metadata template Example: "global" -- templateKey `string` - - The name of the metadata template Example: "properties" -- headers `DeleteFolderMetadataByIdHeadersArg` - - Headers of deleteFolderMetadataById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the metadata is -successfully deleted. diff --git a/docs/folderWatermarks.md b/docs/folderWatermarks.md deleted file mode 100644 index 27b3d850..00000000 --- a/docs/folderWatermarks.md +++ /dev/null @@ -1,106 +0,0 @@ -# FolderWatermarksManager - -- [Get watermark for folder](#get-watermark-for-folder) -- [Apply watermark to folder](#apply-watermark-to-folder) -- [Remove watermark from folder](#remove-watermark-from-folder) - -## Get watermark for folder - -Retrieve the watermark for a folder. - -This operation is performed by calling function `getFolderWatermark`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-folders-id-watermark/). - - - -```ts -await client.folderWatermarks.getFolderWatermark(folder.id); -``` - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" -- headers `GetFolderWatermarkHeadersArg` - - Headers of getFolderWatermark method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Watermark`. - -Returns an object containing information about the -watermark associated for to this folder. - -## Apply watermark to folder - -Applies or update a watermark on a folder. - -This operation is performed by calling function `updateFolderWatermark`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-folders-id-watermark/). - - - -```ts -await client.folderWatermarks.updateFolderWatermark(folder.id, { - watermark: { - imprint: - 'default' as UpdateFolderWatermarkRequestBodyArgWatermarkFieldImprintField, - } satisfies UpdateFolderWatermarkRequestBodyArgWatermarkField, -} satisfies UpdateFolderWatermarkRequestBodyArg); -``` - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" -- requestBody `UpdateFolderWatermarkRequestBodyArg` - - Request body of updateFolderWatermark method -- headers `UpdateFolderWatermarkHeadersArg` - - Headers of updateFolderWatermark method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Watermark`. - -Returns an updated watermark if a watermark already -existed on this folder.Returns a new watermark if no watermark existed on -this folder yet. - -## Remove watermark from folder - -Removes the watermark from a folder. - -This operation is performed by calling function `deleteFolderWatermark`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-folders-id-watermark/). - - - -```ts -await client.folderWatermarks.deleteFolderWatermark(folder.id); -``` - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" -- headers `DeleteFolderWatermarkHeadersArg` - - Headers of deleteFolderWatermark method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -An empty response will be returned when the watermark -was successfully deleted. diff --git a/docs/groups.md b/docs/groups.md deleted file mode 100644 index fbe1b685..00000000 --- a/docs/groups.md +++ /dev/null @@ -1,178 +0,0 @@ -# GroupsManager - -- [List groups for enterprise](#list-groups-for-enterprise) -- [Create group](#create-group) -- [Get group](#get-group) -- [Update group](#update-group) -- [Remove group](#remove-group) - -## List groups for enterprise - -Retrieves all of the groups for a given enterprise. The user -must have admin permissions to inspect enterprise's groups. - -This operation is performed by calling function `getGroups`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-groups/). - - - -```ts -await client.groups.getGroups(); -``` - -### Arguments - -- queryParams `GetGroupsQueryParamsArg` - - Query parameters of getGroups method -- headers `GetGroupsHeadersArg` - - Headers of getGroups method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Groups`. - -Returns a collection of group objects. If there are no groups, an -empty collection will be returned. - -## Create group - -Creates a new group of users in an enterprise. Only users with admin -permissions can create new groups. - -This operation is performed by calling function `createGroup`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-groups/). - - - -```ts -await client.groups.createGroup({ - name: groupName, -} satisfies CreateGroupRequestBodyArg); -``` - -### Arguments - -- requestBody `CreateGroupRequestBodyArg` - - Request body of createGroup method -- queryParams `CreateGroupQueryParamsArg` - - Query parameters of createGroup method -- headers `CreateGroupHeadersArg` - - Headers of createGroup method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `GroupFull`. - -Returns the new group object. - -## Get group - -Retrieves information about a group. Only members of this -group or users with admin-level permissions will be able to -use this API. - -This operation is performed by calling function `getGroupById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-groups-id/). - - - -```ts -await client.groups.getGroupById(group.id); -``` - -### Arguments - -- groupId `string` - - The ID of the group. Example: "57645" -- queryParams `GetGroupByIdQueryParamsArg` - - Query parameters of getGroupById method -- headers `GetGroupByIdHeadersArg` - - Headers of getGroupById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `GroupFull`. - -Returns the group object - -## Update group - -Updates a specific group. Only admins of this -group or users with admin-level permissions will be able to -use this API. - -This operation is performed by calling function `updateGroupById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-groups-id/). - - - -```ts -await client.groups.updateGroupById(group.id, { - name: updatedGroupName, -} satisfies UpdateGroupByIdRequestBodyArg); -``` - -### Arguments - -- groupId `string` - - The ID of the group. Example: "57645" -- requestBody `UpdateGroupByIdRequestBodyArg` - - Request body of updateGroupById method -- queryParams `UpdateGroupByIdQueryParamsArg` - - Query parameters of updateGroupById method -- headers `UpdateGroupByIdHeadersArg` - - Headers of updateGroupById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `GroupFull`. - -Returns the updated group object. - -## Remove group - -Permanently deletes a group. Only users with -admin-level permissions will be able to use this API. - -This operation is performed by calling function `deleteGroupById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-groups-id/). - - - -```ts -await client.groups.deleteGroupById(group.id); -``` - -### Arguments - -- groupId `string` - - The ID of the group. Example: "57645" -- headers `DeleteGroupByIdHeadersArg` - - Headers of deleteGroupById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -A blank response is returned if the group was -successfully deleted. diff --git a/docs/integrationMappings.md b/docs/integrationMappings.md deleted file mode 100644 index d5132ee4..00000000 --- a/docs/integrationMappings.md +++ /dev/null @@ -1,126 +0,0 @@ -# IntegrationMappingsManager - -- [List Slack integration mappings](#list-slack-integration-mappings) -- [Create Slack integration mapping](#create-slack-integration-mapping) -- [Update Slack integration mapping](#update-slack-integration-mapping) -- [Delete Slack integration mapping](#delete-slack-integration-mapping) - -## List Slack integration mappings - -Lists [Slack integration mappings](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) in a users' enterprise. - -You need Admin or Co-Admin role to -use this endpoint. - -This operation is performed by calling function `getIntegrationMappingSlack`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-integration-mappings-slack/). - -_Currently we don't have an example for calling `getIntegrationMappingSlack` in integration tests_ - -### Arguments - -- queryParams `GetIntegrationMappingSlackQueryParamsArg` - - Query parameters of getIntegrationMappingSlack method -- headers `GetIntegrationMappingSlackHeadersArg` - - Headers of getIntegrationMappingSlack method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `IntegrationMappings`. - -Returns a collection of integration mappings - -## Create Slack integration mapping - -Creates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) -by mapping a Slack channel to a Box item. - -You need Admin or Co-Admin role to -use this endpoint. - -This operation is performed by calling function `createIntegrationMappingSlack`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-integration-mappings-slack/). - -_Currently we don't have an example for calling `createIntegrationMappingSlack` in integration tests_ - -### Arguments - -- requestBody `IntegrationMappingSlackCreateRequest` - - Request body of createIntegrationMappingSlack method -- headers `CreateIntegrationMappingSlackHeadersArg` - - Headers of createIntegrationMappingSlack method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `IntegrationMapping`. - -Returns the created integration mapping. - -## Update Slack integration mapping - -Updates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack). -Supports updating the Box folder ID and options. - -You need Admin or Co-Admin role to -use this endpoint. - -This operation is performed by calling function `updateIntegrationMappingSlackById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-integration-mappings-slack-id/). - -_Currently we don't have an example for calling `updateIntegrationMappingSlackById` in integration tests_ - -### Arguments - -- integrationMappingId `string` - - An ID of an integration mapping Example: "11235432" -- requestBody `UpdateIntegrationMappingSlackByIdRequestBodyArg` - - Request body of updateIntegrationMappingSlackById method -- headers `UpdateIntegrationMappingSlackByIdHeadersArg` - - Headers of updateIntegrationMappingSlackById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `IntegrationMapping`. - -Returns the updated integration mapping object. - -## Delete Slack integration mapping - -Deletes a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack). - -You need Admin or Co-Admin role to -use this endpoint. - -This operation is performed by calling function `deleteIntegrationMappingSlackById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-integration-mappings-slack-id/). - -_Currently we don't have an example for calling `deleteIntegrationMappingSlackById` in integration tests_ - -### Arguments - -- integrationMappingId `string` - - An ID of an integration mapping Example: "11235432" -- headers `DeleteIntegrationMappingSlackByIdHeadersArg` - - Headers of deleteIntegrationMappingSlackById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Empty body in response diff --git a/docs/invites.md b/docs/invites.md deleted file mode 100644 index cb8fbf25..00000000 --- a/docs/invites.md +++ /dev/null @@ -1,83 +0,0 @@ -# InvitesManager - -- [Create user invite](#create-user-invite) -- [Get user invite status](#get-user-invite-status) - -## Create user invite - -Invites an existing external user to join an enterprise. - -The existing user can not be part of another enterprise and -must already have a Box account. Once invited, the user will receive an -email and are prompted to accept the invitation within the -Box web application. - -This method requires the "Manage An Enterprise" scope enabled for -the application, which can be enabled within the developer console. - -This operation is performed by calling function `createInvite`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-invites/). - - - -```ts -await client.invites.createInvite({ - enterprise: { - id: currentUser.enterprise!.id!, - } satisfies CreateInviteRequestBodyArgEnterpriseField, - actionableBy: { - login: email, - } satisfies CreateInviteRequestBodyArgActionableByField, -} satisfies CreateInviteRequestBodyArg); -``` - -### Arguments - -- requestBody `CreateInviteRequestBodyArg` - - Request body of createInvite method -- queryParams `CreateInviteQueryParamsArg` - - Query parameters of createInvite method -- headers `CreateInviteHeadersArg` - - Headers of createInvite method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Invite`. - -Returns a new invite object. - -## Get user invite status - -Returns the status of a user invite. - -This operation is performed by calling function `getInviteById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-invites-id/). - - - -```ts -await client.invites.getInviteById(invitation.id); -``` - -### Arguments - -- inviteId `string` - - The ID of an invite. Example: "213723" -- queryParams `GetInviteByIdQueryParamsArg` - - Query parameters of getInviteById method -- headers `GetInviteByIdHeadersArg` - - Headers of getInviteById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Invite`. - -Returns an invite object diff --git a/docs/legalHoldPolicies.md b/docs/legalHoldPolicies.md deleted file mode 100644 index 3942cbea..00000000 --- a/docs/legalHoldPolicies.md +++ /dev/null @@ -1,170 +0,0 @@ -# LegalHoldPoliciesManager - -- [List all legal hold policies](#list-all-legal-hold-policies) -- [Create legal hold policy](#create-legal-hold-policy) -- [Get legal hold policy](#get-legal-hold-policy) -- [Update legal hold policy](#update-legal-hold-policy) -- [Remove legal hold policy](#remove-legal-hold-policy) - -## List all legal hold policies - -Retrieves a list of legal hold policies that belong to -an enterprise. - -This operation is performed by calling function `getLegalHoldPolicies`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-legal-hold-policies/). - - - -```ts -await client.legalHoldPolicies.getLegalHoldPolicies(); -``` - -### Arguments - -- queryParams `GetLegalHoldPoliciesQueryParamsArg` - - Query parameters of getLegalHoldPolicies method -- headers `GetLegalHoldPoliciesHeadersArg` - - Headers of getLegalHoldPolicies method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `LegalHoldPolicies`. - -Returns a list of legal hold policies. - -## Create legal hold policy - -Create a new legal hold policy. - -This operation is performed by calling function `createLegalHoldPolicy`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-legal-hold-policies/). - - - -```ts -await client.legalHoldPolicies.createLegalHoldPolicy({ - policyName: legalHoldPolicyName, - description: legalHoldDescription, - isOngoing: true, -} satisfies CreateLegalHoldPolicyRequestBodyArg); -``` - -### Arguments - -- requestBody `CreateLegalHoldPolicyRequestBodyArg` - - Request body of createLegalHoldPolicy method -- headers `CreateLegalHoldPolicyHeadersArg` - - Headers of createLegalHoldPolicy method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `LegalHoldPolicy`. - -Returns a new legal hold policy object. - -## Get legal hold policy - -Retrieve a legal hold policy. - -This operation is performed by calling function `getLegalHoldPolicyById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-legal-hold-policies-id/). - - - -```ts -await client.legalHoldPolicies.getLegalHoldPolicyById(legalHoldPolicyId); -``` - -### Arguments - -- legalHoldPolicyId `string` - - The ID of the legal hold policy Example: "324432" -- headers `GetLegalHoldPolicyByIdHeadersArg` - - Headers of getLegalHoldPolicyById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `LegalHoldPolicy`. - -Returns a legal hold policy object. - -## Update legal hold policy - -Update legal hold policy. - -This operation is performed by calling function `updateLegalHoldPolicyById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-legal-hold-policies-id/). - - - -```ts -await client.legalHoldPolicies.updateLegalHoldPolicyById(legalHoldPolicyId, { - policyName: updatedLegalHoldPolicyName, -} satisfies UpdateLegalHoldPolicyByIdRequestBodyArg); -``` - -### Arguments - -- legalHoldPolicyId `string` - - The ID of the legal hold policy Example: "324432" -- requestBody `UpdateLegalHoldPolicyByIdRequestBodyArg` - - Request body of updateLegalHoldPolicyById method -- headers `UpdateLegalHoldPolicyByIdHeadersArg` - - Headers of updateLegalHoldPolicyById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `LegalHoldPolicy`. - -Returns a new legal hold policy object. - -## Remove legal hold policy - -Delete an existing legal hold policy. - -This is an asynchronous process. The policy will not be -fully deleted yet when the response returns. - -This operation is performed by calling function `deleteLegalHoldPolicyById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-legal-hold-policies-id/). - - - -```ts -await client.legalHoldPolicies.deleteLegalHoldPolicyById(legalHoldPolicyId); -``` - -### Arguments - -- legalHoldPolicyId `string` - - The ID of the legal hold policy Example: "324432" -- headers `DeleteLegalHoldPolicyByIdHeadersArg` - - Headers of deleteLegalHoldPolicyById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -A blank response is returned if the policy was -successfully deleted. diff --git a/docs/legalHoldPolicyAssignments.md b/docs/legalHoldPolicyAssignments.md deleted file mode 100644 index 24fff9b2..00000000 --- a/docs/legalHoldPolicyAssignments.md +++ /dev/null @@ -1,204 +0,0 @@ -# LegalHoldPolicyAssignmentsManager - -- [List legal hold policy assignments](#list-legal-hold-policy-assignments) -- [Assign legal hold policy](#assign-legal-hold-policy) -- [Get legal hold policy assignment](#get-legal-hold-policy-assignment) -- [Unassign legal hold policy](#unassign-legal-hold-policy) -- [List current file versions for legal hold policy assignment](#list-current-file-versions-for-legal-hold-policy-assignment) -- [List previous file versions for legal hold policy assignment](#list-previous-file-versions-for-legal-hold-policy-assignment) - -## List legal hold policy assignments - -Retrieves a list of items a legal hold policy has been assigned to. - -This operation is performed by calling function `getLegalHoldPolicyAssignments`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-legal-hold-policy-assignments/). - -_Currently we don't have an example for calling `getLegalHoldPolicyAssignments` in integration tests_ - -### Arguments - -- queryParams `GetLegalHoldPolicyAssignmentsQueryParamsArg` - - Query parameters of getLegalHoldPolicyAssignments method -- headers `GetLegalHoldPolicyAssignmentsHeadersArg` - - Headers of getLegalHoldPolicyAssignments method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `LegalHoldPolicyAssignments`. - -Returns a list of legal hold policy assignments. - -## Assign legal hold policy - -Assign a legal hold to a file, file version, folder, or user. - -This operation is performed by calling function `createLegalHoldPolicyAssignment`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-legal-hold-policy-assignments/). - -_Currently we don't have an example for calling `createLegalHoldPolicyAssignment` in integration tests_ - -### Arguments - -- requestBody `CreateLegalHoldPolicyAssignmentRequestBodyArg` - - Request body of createLegalHoldPolicyAssignment method -- headers `CreateLegalHoldPolicyAssignmentHeadersArg` - - Headers of createLegalHoldPolicyAssignment method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `LegalHoldPolicyAssignment`. - -Returns a new legal hold policy assignment. - -## Get legal hold policy assignment - -Retrieve a legal hold policy assignment. - -This operation is performed by calling function `getLegalHoldPolicyAssignmentById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-legal-hold-policy-assignments-id/). - -_Currently we don't have an example for calling `getLegalHoldPolicyAssignmentById` in integration tests_ - -### Arguments - -- legalHoldPolicyAssignmentId `string` - - The ID of the legal hold policy assignment Example: "753465" -- headers `GetLegalHoldPolicyAssignmentByIdHeadersArg` - - Headers of getLegalHoldPolicyAssignmentById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `LegalHoldPolicyAssignment`. - -Returns a legal hold policy object. - -## Unassign legal hold policy - -Remove a legal hold from an item. - -This is an asynchronous process. The policy will not be -fully removed yet when the response returns. - -This operation is performed by calling function `deleteLegalHoldPolicyAssignmentById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-legal-hold-policy-assignments-id/). - -_Currently we don't have an example for calling `deleteLegalHoldPolicyAssignmentById` in integration tests_ - -### Arguments - -- legalHoldPolicyAssignmentId `string` - - The ID of the legal hold policy assignment Example: "753465" -- headers `DeleteLegalHoldPolicyAssignmentByIdHeadersArg` - - Headers of deleteLegalHoldPolicyAssignmentById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -A blank response is returned if the assignment was -successfully deleted. - -## List current file versions for legal hold policy assignment - -Get a list of current file versions for a legal hold -assignment. - -In some cases you may want to get previous file versions instead. In these -cases, use the `GET /legal_hold_policy_assignments/:id/file_versions_on_hold` -API instead to return any previous versions of a file for this legal hold -policy assignment. - -Due to ongoing re-architecture efforts this API might not return all file -versions held for this policy ID. Instead, this API will only return the -latest file version held in the newly developed architecture. The `GET -/file_version_legal_holds` API can be used to fetch current and past versions -of files held within the legacy architecture. - -The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to -find a list of policy assignments for a given policy ID. - -This operation is performed by calling function `getLegalHoldPolicyAssignmentFileOnHold`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-legal-hold-policy-assignments-id-files-on-hold/). - -_Currently we don't have an example for calling `getLegalHoldPolicyAssignmentFileOnHold` in integration tests_ - -### Arguments - -- legalHoldPolicyAssignmentId `string` - - The ID of the legal hold policy assignment Example: "753465" -- queryParams `GetLegalHoldPolicyAssignmentFileOnHoldQueryParamsArg` - - Query parameters of getLegalHoldPolicyAssignmentFileOnHold method -- headers `GetLegalHoldPolicyAssignmentFileOnHoldHeadersArg` - - Headers of getLegalHoldPolicyAssignmentFileOnHold method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FileVersionLegalHolds`. - -Returns the list of current file versions held under legal hold for a -specific legal hold policy assignment. - -## List previous file versions for legal hold policy assignment - -Get a list of previous file versions for a legal hold -assignment. - -In some cases you may only need the latest file versions instead. In these -cases, use the `GET /legal_hold_policy_assignments/:id/files_on_hold` API -instead to return any current (latest) versions of a file for this legal hold -policy assignment. - -Due to ongoing re-architecture efforts this API might not return all files -held for this policy ID. Instead, this API will only return past file versions -held in the newly developed architecture. The `GET /file_version_legal_holds` -API can be used to fetch current and past versions of files held within the -legacy architecture. - -The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to -find a list of policy assignments for a given policy ID. - -This operation is performed by calling function `getLegalHoldPolicyAssignmentFileVersionOnHold`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-legal-hold-policy-assignments-id-file-versions-on-hold/). - -_Currently we don't have an example for calling `getLegalHoldPolicyAssignmentFileVersionOnHold` in integration tests_ - -### Arguments - -- legalHoldPolicyAssignmentId `string` - - The ID of the legal hold policy assignment Example: "753465" -- queryParams `GetLegalHoldPolicyAssignmentFileVersionOnHoldQueryParamsArg` - - Query parameters of getLegalHoldPolicyAssignmentFileVersionOnHold method -- headers `GetLegalHoldPolicyAssignmentFileVersionOnHoldHeadersArg` - - Headers of getLegalHoldPolicyAssignmentFileVersionOnHold method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FileVersionLegalHolds`. - -Returns the list of previous file versions held under legal hold for a -specific legal hold policy assignment. diff --git a/docs/listCollaborations.md b/docs/listCollaborations.md deleted file mode 100644 index 7d3223c0..00000000 --- a/docs/listCollaborations.md +++ /dev/null @@ -1,156 +0,0 @@ -# ListCollaborationsManager - -- [List file collaborations](#list-file-collaborations) -- [List folder collaborations](#list-folder-collaborations) -- [List pending collaborations](#list-pending-collaborations) -- [List group collaborations](#list-group-collaborations) - -## List file collaborations - -Retrieves a list of pending and active collaborations for a -file. This returns all the users that have access to the file -or have been invited to the file. - -This operation is performed by calling function `getFileCollaborations`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-files-id-collaborations/). - - - -```ts -await client.listCollaborations.getFileCollaborations(file.id); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- queryParams `GetFileCollaborationsQueryParamsArg` - - Query parameters of getFileCollaborations method -- headers `GetFileCollaborationsHeadersArg` - - Headers of getFileCollaborations method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Collaborations`. - -Returns a collection of collaboration objects. If there are no -collaborations on this file an empty collection will be returned. - -This list includes pending collaborations, for which the `status` -is set to `pending`, indicating invitations that have been sent but not -yet accepted. - -## List folder collaborations - -Retrieves a list of pending and active collaborations for a -folder. This returns all the users that have access to the folder -or have been invited to the folder. - -This operation is performed by calling function `getFolderCollaborations`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-folders-id-collaborations/). - - - -```ts -await client.listCollaborations.getFolderCollaborations(folder.id); -``` - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. Example: "12345" -- queryParams `GetFolderCollaborationsQueryParamsArg` - - Query parameters of getFolderCollaborations method -- headers `GetFolderCollaborationsHeadersArg` - - Headers of getFolderCollaborations method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Collaborations`. - -Returns a collection of collaboration objects. If there are no -collaborations on this folder an empty collection will be returned. - -This list includes pending collaborations, for which the `status` -is set to `pending`, indicating invitations that have been sent but not -yet accepted. - -## List pending collaborations - -Retrieves all pending collaboration invites for this user. - -This operation is performed by calling function `getCollaborations`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-collaborations/). - - - -```ts -await client.listCollaborations.getCollaborations({ - status: 'pending' as GetCollaborationsQueryParamsArgStatusField, -} satisfies GetCollaborationsQueryParamsArg); -``` - -### Arguments - -- queryParams `GetCollaborationsQueryParamsArg` - - Query parameters of getCollaborations method -- headers `GetCollaborationsHeadersArg` - - Headers of getCollaborations method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Collaborations`. - -Returns a collection of pending collaboration objects. - -If the user has no pending collaborations, the collection -will be empty. - -## List group collaborations - -Retrieves all the collaborations for a group. The user -must have admin permissions to inspect enterprise's groups. - -Each collaboration object has details on which files or -folders the group has access to and with what role. - -This operation is performed by calling function `getGroupCollaborations`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-groups-id-collaborations/). - - - -```ts -await client.listCollaborations.getGroupCollaborations(group.id); -``` - -### Arguments - -- groupId `string` - - The ID of the group. Example: "57645" -- queryParams `GetGroupCollaborationsQueryParamsArg` - - Query parameters of getGroupCollaborations method -- headers `GetGroupCollaborationsHeadersArg` - - Headers of getGroupCollaborations method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Collaborations`. - -Returns a collection of collaboration objects. If there are no -collaborations, an empty collection will be returned. diff --git a/docs/memberships.md b/docs/memberships.md deleted file mode 100644 index d2a5968b..00000000 --- a/docs/memberships.md +++ /dev/null @@ -1,221 +0,0 @@ -# MembershipsManager - -- [List user's groups](#list-users-groups) -- [List members of group](#list-members-of-group) -- [Add user to group](#add-user-to-group) -- [Get group membership](#get-group-membership) -- [Update group membership](#update-group-membership) -- [Remove user from group](#remove-user-from-group) - -## List user's groups - -Retrieves all the groups for a user. Only members of this -group or users with admin-level permissions will be able to -use this API. - -This operation is performed by calling function `getUserMemberships`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-users-id-memberships/). - - - -```ts -await client.memberships.getUserMemberships(user.id); -``` - -### Arguments - -- userId `string` - - The ID of the user. Example: "12345" -- queryParams `GetUserMembershipsQueryParamsArg` - - Query parameters of getUserMemberships method -- headers `GetUserMembershipsHeadersArg` - - Headers of getUserMemberships method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `GroupMemberships`. - -Returns a collection of membership objects. If there are no -memberships, an empty collection will be returned. - -## List members of group - -Retrieves all the members for a group. Only members of this -group or users with admin-level permissions will be able to -use this API. - -This operation is performed by calling function `getGroupMemberships`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-groups-id-memberships/). - - - -```ts -await client.memberships.getGroupMemberships(group.id); -``` - -### Arguments - -- groupId `string` - - The ID of the group. Example: "57645" -- queryParams `GetGroupMembershipsQueryParamsArg` - - Query parameters of getGroupMemberships method -- headers `GetGroupMembershipsHeadersArg` - - Headers of getGroupMemberships method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `GroupMemberships`. - -Returns a collection of membership objects. If there are no -memberships, an empty collection will be returned. - -## Add user to group - -Creates a group membership. Only users with -admin-level permissions will be able to use this API. - -This operation is performed by calling function `createGroupMembership`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-group-memberships/). - - - -```ts -await client.memberships.createGroupMembership({ - user: { id: user.id } satisfies CreateGroupMembershipRequestBodyArgUserField, - group: { - id: group.id, - } satisfies CreateGroupMembershipRequestBodyArgGroupField, -} satisfies CreateGroupMembershipRequestBodyArg); -``` - -### Arguments - -- requestBody `CreateGroupMembershipRequestBodyArg` - - Request body of createGroupMembership method -- queryParams `CreateGroupMembershipQueryParamsArg` - - Query parameters of createGroupMembership method -- headers `CreateGroupMembershipHeadersArg` - - Headers of createGroupMembership method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `GroupMembership`. - -Returns a new group membership object. - -## Get group membership - -Retrieves a specific group membership. Only admins of this -group or users with admin-level permissions will be able to -use this API. - -This operation is performed by calling function `getGroupMembershipById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-group-memberships-id/). - - - -```ts -await client.memberships.getGroupMembershipById(groupMembership.id!); -``` - -### Arguments - -- groupMembershipId `string` - - The ID of the group membership. Example: "434534" -- queryParams `GetGroupMembershipByIdQueryParamsArg` - - Query parameters of getGroupMembershipById method -- headers `GetGroupMembershipByIdHeadersArg` - - Headers of getGroupMembershipById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `GroupMembership`. - -Returns the group membership object. - -## Update group membership - -Updates a user's group membership. Only admins of this -group or users with admin-level permissions will be able to -use this API. - -This operation is performed by calling function `updateGroupMembershipById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-group-memberships-id/). - - - -```ts -await client.memberships.updateGroupMembershipById(groupMembership.id!, { - role: 'admin' as UpdateGroupMembershipByIdRequestBodyArgRoleField, -} satisfies UpdateGroupMembershipByIdRequestBodyArg); -``` - -### Arguments - -- groupMembershipId `string` - - The ID of the group membership. Example: "434534" -- requestBody `UpdateGroupMembershipByIdRequestBodyArg` - - Request body of updateGroupMembershipById method -- queryParams `UpdateGroupMembershipByIdQueryParamsArg` - - Query parameters of updateGroupMembershipById method -- headers `UpdateGroupMembershipByIdHeadersArg` - - Headers of updateGroupMembershipById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `GroupMembership`. - -Returns a new group membership object. - -## Remove user from group - -Deletes a specific group membership. Only admins of this -group or users with admin-level permissions will be able to -use this API. - -This operation is performed by calling function `deleteGroupMembershipById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-group-memberships-id/). - - - -```ts -await client.memberships.deleteGroupMembershipById(groupMembership.id!); -``` - -### Arguments - -- groupMembershipId `string` - - The ID of the group membership. Example: "434534" -- headers `DeleteGroupMembershipByIdHeadersArg` - - Headers of deleteGroupMembershipById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -A blank response is returned if the membership was -successfully deleted. diff --git a/docs/metadataCascadePolicies.md b/docs/metadataCascadePolicies.md deleted file mode 100644 index bae69d14..00000000 --- a/docs/metadataCascadePolicies.md +++ /dev/null @@ -1,191 +0,0 @@ -# MetadataCascadePoliciesManager - -- [List metadata cascade policies](#list-metadata-cascade-policies) -- [Create metadata cascade policy](#create-metadata-cascade-policy) -- [Get metadata cascade policy](#get-metadata-cascade-policy) -- [Remove metadata cascade policy](#remove-metadata-cascade-policy) -- [Force-apply metadata cascade policy to folder](#force-apply-metadata-cascade-policy-to-folder) - -## List metadata cascade policies - -Retrieves a list of all the metadata cascade policies -that are applied to a given folder. This can not be used on the root -folder with ID `0`. - -This operation is performed by calling function `getMetadataCascadePolicies`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-metadata-cascade-policies/). - - - -```ts -await client.metadataCascadePolicies.getMetadataCascadePolicies({ - folderId: folder.id, -} satisfies GetMetadataCascadePoliciesQueryParamsArg); -``` - -### Arguments - -- queryParams `GetMetadataCascadePoliciesQueryParamsArg` - - Query parameters of getMetadataCascadePolicies method -- headers `GetMetadataCascadePoliciesHeadersArg` - - Headers of getMetadataCascadePolicies method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `MetadataCascadePolicies`. - -Returns a list of metadata cascade policies - -## Create metadata cascade policy - -Creates a new metadata cascade policy that applies a given -metadata template to a given folder and automatically -cascades it down to any files within that folder. - -In order for the policy to be applied a metadata instance must first -be applied to the folder the policy is to be applied to. - -This operation is performed by calling function `createMetadataCascadePolicy`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-metadata-cascade-policies/). - - - -```ts -await client.metadataCascadePolicies.createMetadataCascadePolicy({ - folderId: folder.id, - scope: 'enterprise' as CreateMetadataCascadePolicyRequestBodyArgScopeField, - templateKey: templateKey, -} satisfies CreateMetadataCascadePolicyRequestBodyArg); -``` - -### Arguments - -- requestBody `CreateMetadataCascadePolicyRequestBodyArg` - - Request body of createMetadataCascadePolicy method -- headers `CreateMetadataCascadePolicyHeadersArg` - - Headers of createMetadataCascadePolicy method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `MetadataCascadePolicy`. - -Returns a new of metadata cascade policy - -## Get metadata cascade policy - -Retrieve a specific metadata cascade policy assigned to a folder. - -This operation is performed by calling function `getMetadataCascadePolicyById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-metadata-cascade-policies-id/). - - - -```ts -await client.metadataCascadePolicies.getMetadataCascadePolicyById( - cascadePolicyId -); -``` - -### Arguments - -- metadataCascadePolicyId `string` - - The ID of the metadata cascade policy. Example: "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7" -- headers `GetMetadataCascadePolicyByIdHeadersArg` - - Headers of getMetadataCascadePolicyById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `MetadataCascadePolicy`. - -Returns a metadata cascade policy - -## Remove metadata cascade policy - -Deletes a metadata cascade policy. - -This operation is performed by calling function `deleteMetadataCascadePolicyById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-metadata-cascade-policies-id/). - - - -```ts -await client.metadataCascadePolicies.deleteMetadataCascadePolicyById( - cascadePolicyId -); -``` - -### Arguments - -- metadataCascadePolicyId `string` - - The ID of the metadata cascade policy. Example: "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7" -- headers `DeleteMetadataCascadePolicyByIdHeadersArg` - - Headers of deleteMetadataCascadePolicyById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the policy -is successfully deleted. - -## Force-apply metadata cascade policy to folder - -Force the metadata on a folder with a metadata cascade policy to be applied to -all of its children. This can be used after creating a new cascade policy to -enforce the metadata to be cascaded down to all existing files within that -folder. - -This operation is performed by calling function `createMetadataCascadePolicyApply`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-metadata-cascade-policies-id-apply/). - - - -```ts -await client.metadataCascadePolicies.createMetadataCascadePolicyApply( - cascadePolicyId, - { - conflictResolution: - 'overwrite' as CreateMetadataCascadePolicyApplyRequestBodyArgConflictResolutionField, - } satisfies CreateMetadataCascadePolicyApplyRequestBodyArg -); -``` - -### Arguments - -- metadataCascadePolicyId `string` - - The ID of the cascade policy to force-apply. Example: "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7" -- requestBody `CreateMetadataCascadePolicyApplyRequestBodyArg` - - Request body of createMetadataCascadePolicyApply method -- headers `CreateMetadataCascadePolicyApplyHeadersArg` - - Headers of createMetadataCascadePolicyApply method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the API call was successful. The metadata -cascade operation will be performed asynchronously. - -The API call will return directly, before the cascade operation -is complete. There is currently no API to check for the status of this -operation. diff --git a/docs/metadataTemplates.md b/docs/metadataTemplates.md deleted file mode 100644 index ec3e0600..00000000 --- a/docs/metadataTemplates.md +++ /dev/null @@ -1,307 +0,0 @@ -# MetadataTemplatesManager - -- [Find metadata template by instance ID](#find-metadata-template-by-instance-id) -- [Get metadata template by name](#get-metadata-template-by-name) -- [Update metadata template](#update-metadata-template) -- [Remove metadata template](#remove-metadata-template) -- [Get metadata template by ID](#get-metadata-template-by-id) -- [List all global metadata templates](#list-all-global-metadata-templates) -- [List all metadata templates for enterprise](#list-all-metadata-templates-for-enterprise) -- [Create metadata template](#create-metadata-template) - -## Find metadata template by instance ID - -Finds a metadata template by searching for the ID of an instance of the -template. - -This operation is performed by calling function `getMetadataTemplatesByInstanceId`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-metadata-templates/). - - - -```ts -await client.metadataTemplates.getMetadataTemplatesByInstanceId({ - metadataInstanceId: createdMetadataInstance.id!, -} satisfies GetMetadataTemplatesByInstanceIdQueryParamsArg); -``` - -### Arguments - -- queryParams `GetMetadataTemplatesByInstanceIdQueryParamsArg` - - Query parameters of getMetadataTemplatesByInstanceId method -- headers `GetMetadataTemplatesByInstanceIdHeadersArg` - - Headers of getMetadataTemplatesByInstanceId method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `MetadataTemplates`. - -Returns a list containing the 1 metadata template that matches the -instance ID. - -## Get metadata template by name - -Retrieves a metadata template by its `scope` and `templateKey` values. - -To find the `scope` and `templateKey` for a template, list all templates for -an enterprise or globally, or list all templates applied to a file or folder. - -This operation is performed by calling function `getMetadataTemplate`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-metadata-templates-id-id-schema/). - - - -```ts -await client.metadataTemplates.getMetadataTemplate( - 'enterprise' as GetMetadataTemplateScopeArg, - template.templateKey! -); -``` - -### Arguments - -- scope `GetMetadataTemplateScopeArg` - - The scope of the metadata template Example: "global" -- templateKey `string` - - The name of the metadata template Example: "properties" -- headers `GetMetadataTemplateHeadersArg` - - Headers of getMetadataTemplate method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `MetadataTemplate`. - -Returns the metadata template matching the `scope` -and `template` name. - -## Update metadata template - -Updates a metadata template. - -The metadata template can only be updated if the template -already exists. - -The update is applied atomically. If any errors occur during the -application of the operations, the metadata template will not be changed. - -This operation is performed by calling function `updateMetadataTemplate`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-metadata-templates-id-id-schema/). - - - -```ts -await client.metadataTemplates.updateMetadataTemplate( - 'enterprise' as UpdateMetadataTemplateScopeArg, - templateKey, - [ - { - op: 'addField' as UpdateMetadataTemplateRequestBodyArgOpField, - fieldKey: 'newfieldname', - data: { ['type']: 'string', ['displayName']: 'newFieldName' }, - } satisfies UpdateMetadataTemplateRequestBodyArg, - ] -); -``` - -### Arguments - -- scope `UpdateMetadataTemplateScopeArg` - - The scope of the metadata template Example: "global" -- templateKey `string` - - The name of the metadata template Example: "properties" -- requestBody `readonly UpdateMetadataTemplateRequestBodyArg[]` - - Request body of updateMetadataTemplate method -- headers `UpdateMetadataTemplateHeadersArg` - - Headers of updateMetadataTemplate method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `MetadataTemplate`. - -Returns the updated metadata template, with the -custom template data included. - -## Remove metadata template - -Delete a metadata template and its instances. -This deletion is permanent and can not be reversed. - -This operation is performed by calling function `deleteMetadataTemplate`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-metadata-templates-id-id-schema/). - - - -```ts -await client.metadataTemplates.deleteMetadataTemplate( - 'enterprise' as DeleteMetadataTemplateScopeArg, - template.templateKey -); -``` - -### Arguments - -- scope `DeleteMetadataTemplateScopeArg` - - The scope of the metadata template Example: "global" -- templateKey `string` - - The name of the metadata template Example: "properties" -- headers `DeleteMetadataTemplateHeadersArg` - - Headers of deleteMetadataTemplate method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the metadata -template is successfully deleted. - -## Get metadata template by ID - -Retrieves a metadata template by its ID. - -This operation is performed by calling function `getMetadataTemplateById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-metadata-templates-id/). - - - -```ts -await client.metadataTemplates.getMetadataTemplateById(template.id); -``` - -### Arguments - -- templateId `string` - - The ID of the template Example: "f7a9891f" -- headers `GetMetadataTemplateByIdHeadersArg` - - Headers of getMetadataTemplateById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `MetadataTemplate`. - -Returns the metadata template that matches the ID. - -## List all global metadata templates - -Used to retrieve all generic, global metadata templates available to all -enterprises using Box. - -This operation is performed by calling function `getGlobalMetadataTemplates`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-metadata-templates-global/). - - - -```ts -await client.metadataTemplates.getGlobalMetadataTemplates(); -``` - -### Arguments - -- queryParams `GetGlobalMetadataTemplatesQueryParamsArg` - - Query parameters of getGlobalMetadataTemplates method -- headers `GetGlobalMetadataTemplatesHeadersArg` - - Headers of getGlobalMetadataTemplates method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `MetadataTemplates`. - -Returns all of the metadata templates available to all enterprises -and their corresponding schema. - -## List all metadata templates for enterprise - -Used to retrieve all metadata templates created to be used specifically within -the user's enterprise - -This operation is performed by calling function `getEnterpriseMetadataTemplates`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-metadata-templates-enterprise/). - - - -```ts -await client.metadataTemplates.getEnterpriseMetadataTemplates(); -``` - -### Arguments - -- queryParams `GetEnterpriseMetadataTemplatesQueryParamsArg` - - Query parameters of getEnterpriseMetadataTemplates method -- headers `GetEnterpriseMetadataTemplatesHeadersArg` - - Headers of getEnterpriseMetadataTemplates method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `MetadataTemplates`. - -Returns all of the metadata templates within an enterprise -and their corresponding schema. - -## Create metadata template - -Creates a new metadata template that can be applied to -files and folders. - -This operation is performed by calling function `createMetadataTemplate`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-metadata-templates-schema/). - - - -```ts -await client.metadataTemplates.createMetadataTemplate({ - scope: 'enterprise', - displayName: templateKey, - templateKey: templateKey, - fields: [ - { - type: 'string' as CreateMetadataTemplateRequestBodyArgFieldsFieldTypeField, - key: 'testName', - displayName: 'testName', - } satisfies CreateMetadataTemplateRequestBodyArgFieldsField, - ], -} satisfies CreateMetadataTemplateRequestBodyArg); -``` - -### Arguments - -- requestBody `CreateMetadataTemplateRequestBodyArg` - - Request body of createMetadataTemplate method -- headers `CreateMetadataTemplateHeadersArg` - - Headers of createMetadataTemplate method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `MetadataTemplate`. - -The schema representing the metadata template created. diff --git a/docs/recentItems.md b/docs/recentItems.md deleted file mode 100644 index 84922bad..00000000 --- a/docs/recentItems.md +++ /dev/null @@ -1,35 +0,0 @@ -# RecentItemsManager - -- [List recently accessed items](#list-recently-accessed-items) - -## List recently accessed items - -Returns information about the recent items accessed -by a user, either in the last 90 days or up to the last -1000 items accessed. - -This operation is performed by calling function `getRecentItems`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-recent-items/). - - - -```ts -await client.recentItems.getRecentItems(); -``` - -### Arguments - -- queryParams `GetRecentItemsQueryParamsArg` - - Query parameters of getRecentItems method -- headers `GetRecentItemsHeadersArg` - - Headers of getRecentItems method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `RecentItems`. - -Returns a list recent items access by a user. diff --git a/docs/retentionPolicies.md b/docs/retentionPolicies.md deleted file mode 100644 index 3fbcb5c7..00000000 --- a/docs/retentionPolicies.md +++ /dev/null @@ -1,174 +0,0 @@ -# RetentionPoliciesManager - -- [List retention policies](#list-retention-policies) -- [Create retention policy](#create-retention-policy) -- [Get retention policy](#get-retention-policy) -- [Update retention policy](#update-retention-policy) -- [Delete retention policy](#delete-retention-policy) - -## List retention policies - -Retrieves all of the retention policies for an enterprise. - -This operation is performed by calling function `getRetentionPolicies`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-retention-policies/). - - - -```ts -await client.retentionPolicies.getRetentionPolicies(); -``` - -### Arguments - -- queryParams `GetRetentionPoliciesQueryParamsArg` - - Query parameters of getRetentionPolicies method -- headers `GetRetentionPoliciesHeadersArg` - - Headers of getRetentionPolicies method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `RetentionPolicies`. - -Returns a list retention policies in the enterprise. - -## Create retention policy - -Creates a retention policy. - -This operation is performed by calling function `createRetentionPolicy`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-retention-policies/). - - - -```ts -await client.retentionPolicies.createRetentionPolicy({ - policyName: retentionPolicyName, - policyType: 'finite' as CreateRetentionPolicyRequestBodyArgPolicyTypeField, - areOwnersNotified: true, - canOwnerExtendRetention: true, - description: retentionDescription, - dispositionAction: - 'remove_retention' as CreateRetentionPolicyRequestBodyArgDispositionActionField, - retentionLength: '1', - retentionType: - 'modifiable' as CreateRetentionPolicyRequestBodyArgRetentionTypeField, -} satisfies CreateRetentionPolicyRequestBodyArg); -``` - -### Arguments - -- requestBody `CreateRetentionPolicyRequestBodyArg` - - Request body of createRetentionPolicy method -- headers `CreateRetentionPolicyHeadersArg` - - Headers of createRetentionPolicy method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `RetentionPolicy`. - -Returns a new retention policy object. - -## Get retention policy - -Retrieves a retention policy. - -This operation is performed by calling function `getRetentionPolicyById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-retention-policies-id/). - - - -```ts -await client.retentionPolicies.getRetentionPolicyById(retentionPolicy.id); -``` - -### Arguments - -- retentionPolicyId `string` - - The ID of the retention policy. Example: "982312" -- queryParams `GetRetentionPolicyByIdQueryParamsArg` - - Query parameters of getRetentionPolicyById method -- headers `GetRetentionPolicyByIdHeadersArg` - - Headers of getRetentionPolicyById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `RetentionPolicy`. - -Returns the retention policy object. - -## Update retention policy - -Updates a retention policy. - -This operation is performed by calling function `updateRetentionPolicyById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-retention-policies-id/). - - - -```ts -await client.retentionPolicies.updateRetentionPolicyById(retentionPolicy.id, { - policyName: updatedRetentionPolicyName, -} satisfies UpdateRetentionPolicyByIdRequestBodyArg); -``` - -### Arguments - -- retentionPolicyId `string` - - The ID of the retention policy. Example: "982312" -- requestBody `UpdateRetentionPolicyByIdRequestBodyArg` - - Request body of updateRetentionPolicyById method -- headers `UpdateRetentionPolicyByIdHeadersArg` - - Headers of updateRetentionPolicyById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `RetentionPolicy`. - -Returns the updated retention policy object. - -## Delete retention policy - -Permanently deletes a retention policy. - -This operation is performed by calling function `deleteRetentionPolicyById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-retention-policies-id/). - - - -```ts -await client.retentionPolicies.deleteRetentionPolicyById(retentionPolicy.id); -``` - -### Arguments - -- retentionPolicyId `string` - - The ID of the retention policy. Example: "982312" -- headers `DeleteRetentionPolicyByIdHeadersArg` - - Headers of deleteRetentionPolicyById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the policy has been deleted. diff --git a/docs/retentionPolicyAssignments.md b/docs/retentionPolicyAssignments.md deleted file mode 100644 index b97040d8..00000000 --- a/docs/retentionPolicyAssignments.md +++ /dev/null @@ -1,179 +0,0 @@ -# RetentionPolicyAssignmentsManager - -- [List retention policy assignments](#list-retention-policy-assignments) -- [Assign retention policy](#assign-retention-policy) -- [Get retention policy assignment](#get-retention-policy-assignment) -- [Remove retention policy assignment](#remove-retention-policy-assignment) -- [Get files under retention](#get-files-under-retention) -- [Get file versions under retention](#get-file-versions-under-retention) - -## List retention policy assignments - -Returns a list of all retention policy assignments associated with a specified -retention policy. - -This operation is performed by calling function `getRetentionPolicyAssignments`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-retention-policies-id-assignments/). - -_Currently we don't have an example for calling `getRetentionPolicyAssignments` in integration tests_ - -### Arguments - -- retentionPolicyId `string` - - The ID of the retention policy. Example: "982312" -- queryParams `GetRetentionPolicyAssignmentsQueryParamsArg` - - Query parameters of getRetentionPolicyAssignments method -- headers `GetRetentionPolicyAssignmentsHeadersArg` - - Headers of getRetentionPolicyAssignments method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `RetentionPolicyAssignments`. - -Returns a list of the retention policy assignments associated with the -specified retention policy. - -## Assign retention policy - -Assigns a retention policy to an item. - -This operation is performed by calling function `createRetentionPolicyAssignment`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-retention-policy-assignments/). - -_Currently we don't have an example for calling `createRetentionPolicyAssignment` in integration tests_ - -### Arguments - -- requestBody `CreateRetentionPolicyAssignmentRequestBodyArg` - - Request body of createRetentionPolicyAssignment method -- headers `CreateRetentionPolicyAssignmentHeadersArg` - - Headers of createRetentionPolicyAssignment method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `RetentionPolicyAssignment`. - -Returns a new retention policy assignment object. - -## Get retention policy assignment - -Retrieves a retention policy assignment - -This operation is performed by calling function `getRetentionPolicyAssignmentById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-retention-policy-assignments-id/). - -_Currently we don't have an example for calling `getRetentionPolicyAssignmentById` in integration tests_ - -### Arguments - -- retentionPolicyAssignmentId `string` - - The ID of the retention policy assignment. Example: "1233123" -- queryParams `GetRetentionPolicyAssignmentByIdQueryParamsArg` - - Query parameters of getRetentionPolicyAssignmentById method -- headers `GetRetentionPolicyAssignmentByIdHeadersArg` - - Headers of getRetentionPolicyAssignmentById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `RetentionPolicyAssignment`. - -Returns the retention policy assignment object. - -## Remove retention policy assignment - -Removes a retention policy assignment -applied to content. - -This operation is performed by calling function `deleteRetentionPolicyAssignmentById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-retention-policy-assignments-id/). - -_Currently we don't have an example for calling `deleteRetentionPolicyAssignmentById` in integration tests_ - -### Arguments - -- retentionPolicyAssignmentId `string` - - The ID of the retention policy assignment. Example: "1233123" -- headers `DeleteRetentionPolicyAssignmentByIdHeadersArg` - - Headers of deleteRetentionPolicyAssignmentById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the policy assignment -is successfully deleted. - -## Get files under retention - -Returns a list of files under retention for a retention policy assignment. - -This operation is performed by calling function `getRetentionPolicyAssignmentFileUnderRetention`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention/). - -_Currently we don't have an example for calling `getRetentionPolicyAssignmentFileUnderRetention` in integration tests_ - -### Arguments - -- retentionPolicyAssignmentId `string` - - The ID of the retention policy assignment. Example: "1233123" -- queryParams `GetRetentionPolicyAssignmentFileUnderRetentionQueryParamsArg` - - Query parameters of getRetentionPolicyAssignmentFileUnderRetention method -- headers `GetRetentionPolicyAssignmentFileUnderRetentionHeadersArg` - - Headers of getRetentionPolicyAssignmentFileUnderRetention method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FilesUnderRetention`. - -Returns a list of files under retention that are associated with the -specified retention policy assignment. - -## Get file versions under retention - -Returns a list of file versions under retention for a retention policy -assignment. - -This operation is performed by calling function `getRetentionPolicyAssignmentFileVersionUnderRetention`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention/). - -_Currently we don't have an example for calling `getRetentionPolicyAssignmentFileVersionUnderRetention` in integration tests_ - -### Arguments - -- retentionPolicyAssignmentId `string` - - The ID of the retention policy assignment. Example: "1233123" -- queryParams `GetRetentionPolicyAssignmentFileVersionUnderRetentionQueryParamsArg` - - Query parameters of getRetentionPolicyAssignmentFileVersionUnderRetention method -- headers `GetRetentionPolicyAssignmentFileVersionUnderRetentionHeadersArg` - - Headers of getRetentionPolicyAssignmentFileVersionUnderRetention method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FilesUnderRetention`. - -Returns a list of file versions under retention that are associated with -the specified retention policy assignment. diff --git a/docs/search.md b/docs/search.md deleted file mode 100644 index 0d51ec4b..00000000 --- a/docs/search.md +++ /dev/null @@ -1,115 +0,0 @@ -# SearchManager - -- [Query files/folders by metadata](#query-files-folders-by-metadata) -- [List metadata query indices](#list-metadata-query-indices) -- [Search for content](#search-for-content) - -## Query files/folders by metadata - -Create a search using SQL-like syntax to return items that match specific -metadata. - -By default, this endpoint returns only the most basic info about the items for -which the query matches. To get additional fields for each item, including any -of the metadata, use the `fields` attribute in the query. - -This operation is performed by calling function `createMetadataQueryExecuteRead`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-metadata-queries-execute-read/). - - - -```ts -await client.search.createMetadataQueryExecuteRead({ - ancestorFolderId: '0', - from: searchFrom, - query: 'testName >= :value', - queryParams: { ['value']: '0.0' }, -} satisfies MetadataQuery); -``` - -### Arguments - -- requestBody `MetadataQuery` - - Request body of createMetadataQueryExecuteRead method -- headers `CreateMetadataQueryExecuteReadHeadersArg` - - Headers of createMetadataQueryExecuteRead method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `MetadataQueryResults`. - -Returns a list of files and folders that match this metadata query. - -## List metadata query indices - -Retrieves the metadata query indices for a given scope and template key. - -This operation is performed by calling function `getMetadataQueryIndices`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-metadata-query-indices/). - - - -```ts -await client.search.getMetadataQueryIndices({ - scope: 'enterprise' as GetMetadataQueryIndicesQueryParamsArgScopeField, - templateKey: templateKey, -} satisfies GetMetadataQueryIndicesQueryParamsArg); -``` - -### Arguments - -- queryParams `GetMetadataQueryIndicesQueryParamsArg` - - Query parameters of getMetadataQueryIndices method -- headers `GetMetadataQueryIndicesHeadersArg` - - Headers of getMetadataQueryIndices method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `MetadataQueryIndices`. - -Returns a collection of metadata query indices for scope and template key. - -## Search for content - -Searches for files, folders, web links, and shared files across the -users content or across the entire enterprise. - -This operation is performed by calling function `getSearch`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-search/). - - - -```ts -await client.search.getSearch({ - ancestorFolderIds: ['0' as ''], - query: keyword, - trashContent: 'non_trashed_only' as GetSearchQueryParamsArgTrashContentField, - includeRecentSharedLinks: true, -} satisfies GetSearchQueryParamsArg); -``` - -### Arguments - -- queryParams `GetSearchQueryParamsArg` - - Query parameters of getSearch method -- headers `GetSearchHeadersArg` - - Headers of getSearch method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `SearchResultsOrSearchResultsWithSharedLinks`. - -Returns a collection of search results. If there are no matching -search results, the `entries` array will be empty. diff --git a/docs/sessionTermination.md b/docs/sessionTermination.md deleted file mode 100644 index d83e952b..00000000 --- a/docs/sessionTermination.md +++ /dev/null @@ -1,75 +0,0 @@ -# SessionTerminationManager - -- [Create jobs to terminate users session](#create-jobs-to-terminate-users-session) -- [Create jobs to terminate user group session](#create-jobs-to-terminate-user-group-session) - -## Create jobs to terminate users session - -Validates the roles and permissions of the user, -and creates asynchronous jobs -to terminate the user's sessions. -Returns the status for the POST request. - -This operation is performed by calling function `createUserTerminateSession`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-users-terminate-sessions/). - - - -```ts -await client.sessionTermination.createUserTerminateSession({ - userIds: [getEnvVar('USER_ID')], - userLogins: [user.login!], -} satisfies CreateUserTerminateSessionRequestBodyArg); -``` - -### Arguments - -- requestBody `CreateUserTerminateSessionRequestBodyArg` - - Request body of createUserTerminateSession method -- headers `CreateUserTerminateSessionHeadersArg` - - Headers of createUserTerminateSession method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `SessionTerminationMessage`. - -Returns a message about the request status. - -## Create jobs to terminate user group session - -Validates the roles and permissions of the group, -and creates asynchronous jobs -to terminate the group's sessions. -Returns the status for the POST request. - -This operation is performed by calling function `createGroupTerminateSession`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-groups-terminate-sessions/). - - - -```ts -await client.sessionTermination.createGroupTerminateSession({ - groupIds: [group.id], -} satisfies CreateGroupTerminateSessionRequestBodyArg); -``` - -### Arguments - -- requestBody `CreateGroupTerminateSessionRequestBodyArg` - - Request body of createGroupTerminateSession method -- headers `CreateGroupTerminateSessionHeadersArg` - - Headers of createGroupTerminateSession method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `SessionTerminationMessage`. - -Returns a message about the request status. diff --git a/docs/sharedLinksFiles.md b/docs/sharedLinksFiles.md deleted file mode 100644 index a64044c5..00000000 --- a/docs/sharedLinksFiles.md +++ /dev/null @@ -1,210 +0,0 @@ -# SharedLinksFilesManager - -- [Find file for shared link](#find-file-for-shared-link) -- [Get shared link for file](#get-shared-link-for-file) -- [Add shared link to file](#add-shared-link-to-file) -- [Update shared link on file](#update-shared-link-on-file) -- [Remove shared link from file](#remove-shared-link-from-file) - -## Find file for shared link - -Returns the file represented by a shared link. - -A shared file can be represented by a shared link, -which can originate within the current enterprise or within another. - -This endpoint allows an application to retrieve information about a -shared file when only given a shared link. - -The `shared_link_permission_options` array field can be returned -by requesting it in the `fields` query parameter. - -This operation is performed by calling function `getSharedItems`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-shared-items/). - - - -```ts -await userClient.sharedLinksFiles.getSharedItems( - {} satisfies GetSharedItemsQueryParamsArg, - new GetSharedItemsHeadersArg({ - boxapi: ''.concat( - 'shared_link=', - fileFromApi.sharedLink!.url, - '&shared_link_password=incorrectPassword' - ) as string, - }) -); -``` - -### Arguments - -- queryParams `GetSharedItemsQueryParamsArg` - - Query parameters of getSharedItems method -- headers `GetSharedItemsHeadersArg` - - Headers of getSharedItems method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FileFull`. - -Returns a full file resource if the shared link is valid and -the user has access to it. - -## Get shared link for file - -Gets the information for a shared link on a file. - -This operation is performed by calling function `getFileGetSharedLink`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-files-id-get-shared-link/). - - - -```ts -await client.sharedLinksFiles.getFileGetSharedLink(fileId, { - fields: 'shared_link', -} satisfies GetFileGetSharedLinkQueryParamsArg); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- queryParams `GetFileGetSharedLinkQueryParamsArg` - - Query parameters of getFileGetSharedLink method -- headers `GetFileGetSharedLinkHeadersArg` - - Headers of getFileGetSharedLink method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FileFull`. - -Returns the base representation of a file with the -additional shared link information. - -## Add shared link to file - -Adds a shared link to a file. - -This operation is performed by calling function `updateFileAddSharedLink`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-files-id-add-shared-link/). - - - -```ts -await client.sharedLinksFiles.updateFileAddSharedLink( - fileId, - { - sharedLink: { - access: - 'open' as UpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldAccessField, - password: 'Secret123@', - } satisfies UpdateFileAddSharedLinkRequestBodyArgSharedLinkField, - } satisfies UpdateFileAddSharedLinkRequestBodyArg, - { fields: 'shared_link' } satisfies UpdateFileAddSharedLinkQueryParamsArg -); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- requestBody `UpdateFileAddSharedLinkRequestBodyArg` - - Request body of updateFileAddSharedLink method -- queryParams `UpdateFileAddSharedLinkQueryParamsArg` - - Query parameters of updateFileAddSharedLink method -- headers `UpdateFileAddSharedLinkHeadersArg` - - Headers of updateFileAddSharedLink method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FileFull`. - -Returns the base representation of a file with a new shared -link attached. - -## Update shared link on file - -Updates a shared link on a file. - -This operation is performed by calling function `updateFileUpdateSharedLink`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-files-id-update-shared-link/). - - - -```ts -await client.sharedLinksFiles.updateFileUpdateSharedLink( - fileId, - { - sharedLink: { - access: - 'collaborators' as UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField, - } satisfies UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkField, - } satisfies UpdateFileUpdateSharedLinkRequestBodyArg, - { fields: 'shared_link' } satisfies UpdateFileUpdateSharedLinkQueryParamsArg -); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- requestBody `UpdateFileUpdateSharedLinkRequestBodyArg` - - Request body of updateFileUpdateSharedLink method -- queryParams `UpdateFileUpdateSharedLinkQueryParamsArg` - - Query parameters of updateFileUpdateSharedLink method -- headers `UpdateFileUpdateSharedLinkHeadersArg` - - Headers of updateFileUpdateSharedLink method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FileFull`. - -Returns a basic representation of the file, with the updated shared -link attached. - -## Remove shared link from file - -Removes a shared link from a file. - -This operation is performed by calling function `updateFileRemoveSharedLink`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-files-id-remove-shared-link/). - -_Currently we don't have an example for calling `updateFileRemoveSharedLink` in integration tests_ - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- requestBody `UpdateFileRemoveSharedLinkRequestBodyArg` - - Request body of updateFileRemoveSharedLink method -- queryParams `UpdateFileRemoveSharedLinkQueryParamsArg` - - Query parameters of updateFileRemoveSharedLink method -- headers `UpdateFileRemoveSharedLinkHeadersArg` - - Headers of updateFileRemoveSharedLink method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FileFull`. - -Returns a basic representation of a file, with the shared link removed. diff --git a/docs/sharedLinksFolders.md b/docs/sharedLinksFolders.md deleted file mode 100644 index fe54a876..00000000 --- a/docs/sharedLinksFolders.md +++ /dev/null @@ -1,207 +0,0 @@ -# SharedLinksFoldersManager - -- [Find folder for shared link](#find-folder-for-shared-link) -- [Get shared link for folder](#get-shared-link-for-folder) -- [Add shared link to folder](#add-shared-link-to-folder) -- [Update shared link on folder](#update-shared-link-on-folder) -- [Remove shared link from folder](#remove-shared-link-from-folder) - -## Find folder for shared link - -Return the folder represented by a shared link. - -A shared folder can be represented by a shared link, -which can originate within the current enterprise or within another. - -This endpoint allows an application to retrieve information about a -shared folder when only given a shared link. - -This operation is performed by calling function `getSharedItemFolders`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-shared-items-folders/). - - - -```ts -await userClient.sharedLinksFolders.getSharedItemFolders( - {} satisfies GetSharedItemFoldersQueryParamsArg, - new GetSharedItemFoldersHeadersArg({ - boxapi: ''.concat( - 'shared_link=', - folderFromApi.sharedLink!.url, - '&shared_link_password=incorrectPassword' - ) as string, - }) -); -``` - -### Arguments - -- queryParams `GetSharedItemFoldersQueryParamsArg` - - Query parameters of getSharedItemFolders method -- headers `GetSharedItemFoldersHeadersArg` - - Headers of getSharedItemFolders method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FolderFull`. - -Returns a full folder resource if the shared link is valid and -the user has access to it. - -## Get shared link for folder - -Gets the information for a shared link on a folder. - -This operation is performed by calling function `getFolderGetSharedLink`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-folders-id-get-shared-link/). - - - -```ts -await client.sharedLinksFolders.getFolderGetSharedLink(folder.id, { - fields: 'shared_link', -} satisfies GetFolderGetSharedLinkQueryParamsArg); -``` - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" -- queryParams `GetFolderGetSharedLinkQueryParamsArg` - - Query parameters of getFolderGetSharedLink method -- headers `GetFolderGetSharedLinkHeadersArg` - - Headers of getFolderGetSharedLink method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FolderFull`. - -Returns the base representation of a folder with the -additional shared link information. - -## Add shared link to folder - -Adds a shared link to a folder. - -This operation is performed by calling function `updateFolderAddSharedLink`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-folders-id-add-shared-link/). - - - -```ts -await client.sharedLinksFolders.updateFolderAddSharedLink( - folder.id, - { - sharedLink: { - access: - 'open' as UpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldAccessField, - password: 'Secret123@', - } satisfies UpdateFolderAddSharedLinkRequestBodyArgSharedLinkField, - } satisfies UpdateFolderAddSharedLinkRequestBodyArg, - { fields: 'shared_link' } satisfies UpdateFolderAddSharedLinkQueryParamsArg -); -``` - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" -- requestBody `UpdateFolderAddSharedLinkRequestBodyArg` - - Request body of updateFolderAddSharedLink method -- queryParams `UpdateFolderAddSharedLinkQueryParamsArg` - - Query parameters of updateFolderAddSharedLink method -- headers `UpdateFolderAddSharedLinkHeadersArg` - - Headers of updateFolderAddSharedLink method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FolderFull`. - -Returns the base representation of a folder with a new shared -link attached. - -## Update shared link on folder - -Updates a shared link on a folder. - -This operation is performed by calling function `updateFolderUpdateSharedLink`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-folders-id-update-shared-link/). - - - -```ts -await client.sharedLinksFolders.updateFolderUpdateSharedLink( - folder.id, - { - sharedLink: { - access: - 'collaborators' as UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField, - } satisfies UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkField, - } satisfies UpdateFolderUpdateSharedLinkRequestBodyArg, - { fields: 'shared_link' } satisfies UpdateFolderUpdateSharedLinkQueryParamsArg -); -``` - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" -- requestBody `UpdateFolderUpdateSharedLinkRequestBodyArg` - - Request body of updateFolderUpdateSharedLink method -- queryParams `UpdateFolderUpdateSharedLinkQueryParamsArg` - - Query parameters of updateFolderUpdateSharedLink method -- headers `UpdateFolderUpdateSharedLinkHeadersArg` - - Headers of updateFolderUpdateSharedLink method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FolderFull`. - -Returns a basic representation of the folder, with the updated shared -link attached. - -## Remove shared link from folder - -Removes a shared link from a folder. - -This operation is performed by calling function `updateFolderRemoveSharedLink`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-folders-id-remove-shared-link/). - -_Currently we don't have an example for calling `updateFolderRemoveSharedLink` in integration tests_ - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" -- requestBody `UpdateFolderRemoveSharedLinkRequestBodyArg` - - Request body of updateFolderRemoveSharedLink method -- queryParams `UpdateFolderRemoveSharedLinkQueryParamsArg` - - Query parameters of updateFolderRemoveSharedLink method -- headers `UpdateFolderRemoveSharedLinkHeadersArg` - - Headers of updateFolderRemoveSharedLink method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FolderFull`. - -Returns a basic representation of a folder, with the shared link removed. diff --git a/docs/sharedLinksWebLinks.md b/docs/sharedLinksWebLinks.md deleted file mode 100644 index 5eab6502..00000000 --- a/docs/sharedLinksWebLinks.md +++ /dev/null @@ -1,210 +0,0 @@ -# SharedLinksWebLinksManager - -- [Find web link for shared link](#find-web-link-for-shared-link) -- [Get shared link for web link](#get-shared-link-for-web-link) -- [Add shared link to web link](#add-shared-link-to-web-link) -- [Update shared link on web link](#update-shared-link-on-web-link) -- [Remove shared link from web link](#remove-shared-link-from-web-link) - -## Find web link for shared link - -Returns the web link represented by a shared link. - -A shared web link can be represented by a shared link, -which can originate within the current enterprise or within another. - -This endpoint allows an application to retrieve information about a -shared web link when only given a shared link. - -This operation is performed by calling function `getSharedItemWebLinks`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-shared-items-web-links/). - - - -```ts -await userClient.sharedLinksWebLinks.getSharedItemWebLinks( - {} satisfies GetSharedItemWebLinksQueryParamsArg, - new GetSharedItemWebLinksHeadersArg({ - boxapi: ''.concat( - 'shared_link=', - webLinkFromApi.sharedLink!.url, - '&shared_link_password=incorrectPassword' - ) as string, - }) -); -``` - -### Arguments - -- queryParams `GetSharedItemWebLinksQueryParamsArg` - - Query parameters of getSharedItemWebLinks method -- headers `GetSharedItemWebLinksHeadersArg` - - Headers of getSharedItemWebLinks method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `WebLink`. - -Returns a full file resource if the shared link is valid and -the user has access to it. - -## Get shared link for web link - -Gets the information for a shared link on a web link. - -This operation is performed by calling function `getWebLinkGetSharedLink`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-web-links-id-get-shared-link/). - - - -```ts -await client.sharedLinksWebLinks.getWebLinkGetSharedLink(webLinkId, { - fields: 'shared_link', -} satisfies GetWebLinkGetSharedLinkQueryParamsArg); -``` - -### Arguments - -- webLinkId `string` - - The ID of the web link. Example: "12345" -- queryParams `GetWebLinkGetSharedLinkQueryParamsArg` - - Query parameters of getWebLinkGetSharedLink method -- headers `GetWebLinkGetSharedLinkHeadersArg` - - Headers of getWebLinkGetSharedLink method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `WebLink`. - -Returns the base representation of a web link with the -additional shared link information. - -## Add shared link to web link - -Adds a shared link to a web link. - -This operation is performed by calling function `updateWebLinkAddSharedLink`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-web-links-id-add-shared-link/). - - - -```ts -await client.sharedLinksWebLinks.updateWebLinkAddSharedLink( - webLinkId, - { - sharedLink: { - access: - 'open' as UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldAccessField, - password: 'Secret123@', - } satisfies UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkField, - } satisfies UpdateWebLinkAddSharedLinkRequestBodyArg, - { fields: 'shared_link' } satisfies UpdateWebLinkAddSharedLinkQueryParamsArg -); -``` - -### Arguments - -- webLinkId `string` - - The ID of the web link. Example: "12345" -- requestBody `UpdateWebLinkAddSharedLinkRequestBodyArg` - - Request body of updateWebLinkAddSharedLink method -- queryParams `UpdateWebLinkAddSharedLinkQueryParamsArg` - - Query parameters of updateWebLinkAddSharedLink method -- headers `UpdateWebLinkAddSharedLinkHeadersArg` - - Headers of updateWebLinkAddSharedLink method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `WebLink`. - -Returns the base representation of a web link with a new shared -link attached. - -## Update shared link on web link - -Updates a shared link on a web link. - -This operation is performed by calling function `updateWebLinkUpdateSharedLink`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-web-links-id-update-shared-link/). - - - -```ts -await client.sharedLinksWebLinks.updateWebLinkUpdateSharedLink( - webLinkId, - { - sharedLink: { - access: - 'collaborators' as UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField, - } satisfies UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkField, - } satisfies UpdateWebLinkUpdateSharedLinkRequestBodyArg, - { - fields: 'shared_link', - } satisfies UpdateWebLinkUpdateSharedLinkQueryParamsArg -); -``` - -### Arguments - -- webLinkId `string` - - The ID of the web link. Example: "12345" -- requestBody `UpdateWebLinkUpdateSharedLinkRequestBodyArg` - - Request body of updateWebLinkUpdateSharedLink method -- queryParams `UpdateWebLinkUpdateSharedLinkQueryParamsArg` - - Query parameters of updateWebLinkUpdateSharedLink method -- headers `UpdateWebLinkUpdateSharedLinkHeadersArg` - - Headers of updateWebLinkUpdateSharedLink method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `WebLink`. - -Returns a basic representation of the web link, with the updated shared -link attached. - -## Remove shared link from web link - -Removes a shared link from a web link. - -This operation is performed by calling function `updateWebLinkRemoveSharedLink`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-web-links-id-remove-shared-link/). - -_Currently we don't have an example for calling `updateWebLinkRemoveSharedLink` in integration tests_ - -### Arguments - -- webLinkId `string` - - The ID of the web link. Example: "12345" -- requestBody `UpdateWebLinkRemoveSharedLinkRequestBodyArg` - - Request body of updateWebLinkRemoveSharedLink method -- queryParams `UpdateWebLinkRemoveSharedLinkQueryParamsArg` - - Query parameters of updateWebLinkRemoveSharedLink method -- headers `UpdateWebLinkRemoveSharedLinkHeadersArg` - - Headers of updateWebLinkRemoveSharedLink method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `WebLink`. - -Returns a basic representation of a web link, with the -shared link removed. diff --git a/docs/shieldInformationBarrierReports.md b/docs/shieldInformationBarrierReports.md deleted file mode 100644 index b6e3c23e..00000000 --- a/docs/shieldInformationBarrierReports.md +++ /dev/null @@ -1,108 +0,0 @@ -# ShieldInformationBarrierReportsManager - -- [List shield information barrier reports](#list-shield-information-barrier-reports) -- [Create shield information barrier report](#create-shield-information-barrier-report) -- [Get shield information barrier report by ID](#get-shield-information-barrier-report-by-id) - -## List shield information barrier reports - -Lists shield information barrier reports. - -This operation is performed by calling function `getShieldInformationBarrierReports`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-shield-information-barrier-reports/). - - - -```ts -await client.shieldInformationBarrierReports.getShieldInformationBarrierReports( - { - shieldInformationBarrierId: barrierId, - } satisfies GetShieldInformationBarrierReportsQueryParamsArg -); -``` - -### Arguments - -- queryParams `GetShieldInformationBarrierReportsQueryParamsArg` - - Query parameters of getShieldInformationBarrierReports method -- headers `GetShieldInformationBarrierReportsHeadersArg` - - Headers of getShieldInformationBarrierReports method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ShieldInformationBarrierReports`. - -Returns a paginated list of shield information barrier report objects. - -## Create shield information barrier report - -Creates a shield information barrier report for a given barrier. - -This operation is performed by calling function `createShieldInformationBarrierReport`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-shield-information-barrier-reports/). - - - -```ts -await client.shieldInformationBarrierReports.createShieldInformationBarrierReport( - { - shieldInformationBarrier: { - id: barrierId, - type: 'shield_information_barrier' as ShieldInformationBarrierBaseTypeField, - } satisfies ShieldInformationBarrierBase, - } satisfies ShieldInformationBarrierReference -); -``` - -### Arguments - -- requestBody `ShieldInformationBarrierReference` - - Request body of createShieldInformationBarrierReport method -- headers `CreateShieldInformationBarrierReportHeadersArg` - - Headers of createShieldInformationBarrierReport method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ShieldInformationBarrierReport`. - -Returns the shield information barrier report information object. - -## Get shield information barrier report by ID - -Retrieves a shield information barrier report by its ID. - -This operation is performed by calling function `getShieldInformationBarrierReportById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-shield-information-barrier-reports-id/). - - - -```ts -await client.shieldInformationBarrierReports.getShieldInformationBarrierReportById( - createdReport.id! -); -``` - -### Arguments - -- shieldInformationBarrierReportId `string` - - The ID of the shield information barrier Report. Example: "3423" -- headers `GetShieldInformationBarrierReportByIdHeadersArg` - - Headers of getShieldInformationBarrierReportById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ShieldInformationBarrierReport`. - -Returns the shield information barrier report object. diff --git a/docs/shieldInformationBarrierSegmentMembers.md b/docs/shieldInformationBarrierSegmentMembers.md deleted file mode 100644 index bf8da812..00000000 --- a/docs/shieldInformationBarrierSegmentMembers.md +++ /dev/null @@ -1,150 +0,0 @@ -# ShieldInformationBarrierSegmentMembersManager - -- [Get shield information barrier segment member by ID](#get-shield-information-barrier-segment-member-by-id) -- [Delete shield information barrier segment member by ID](#delete-shield-information-barrier-segment-member-by-id) -- [List shield information barrier segment members](#list-shield-information-barrier-segment-members) -- [Create shield information barrier segment member](#create-shield-information-barrier-segment-member) - -## Get shield information barrier segment member by ID - -Retrieves a shield information barrier -segment member by its ID. - -This operation is performed by calling function `getShieldInformationBarrierSegmentMemberById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-shield-information-barrier-segment-members-id/). - - - -```ts -await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMemberById( - segmentMember.id! -); -``` - -### Arguments - -- shieldInformationBarrierSegmentMemberId `string` - - The ID of the shield information barrier segment Member. Example: "7815" -- headers `GetShieldInformationBarrierSegmentMemberByIdHeadersArg` - - Headers of getShieldInformationBarrierSegmentMemberById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ShieldInformationBarrierSegmentMember`. - -Returns the shield information barrier segment member object. - -## Delete shield information barrier segment member by ID - -Deletes a shield information barrier -segment member based on provided ID. - -This operation is performed by calling function `deleteShieldInformationBarrierSegmentMemberById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-shield-information-barrier-segment-members-id/). - - - -```ts -await client.shieldInformationBarrierSegmentMembers.deleteShieldInformationBarrierSegmentMemberById( - segmentMember.id! -); -``` - -### Arguments - -- shieldInformationBarrierSegmentMemberId `string` - - The ID of the shield information barrier segment Member. Example: "7815" -- headers `DeleteShieldInformationBarrierSegmentMemberByIdHeadersArg` - - Headers of deleteShieldInformationBarrierSegmentMemberById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response if the -segment member was deleted successfully. - -## List shield information barrier segment members - -Lists shield information barrier segment members -based on provided segment IDs. - -This operation is performed by calling function `getShieldInformationBarrierSegmentMembers`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-shield-information-barrier-segment-members/). - - - -```ts -await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMembers( - { - shieldInformationBarrierSegmentId: segment.id!, - } satisfies GetShieldInformationBarrierSegmentMembersQueryParamsArg -); -``` - -### Arguments - -- queryParams `GetShieldInformationBarrierSegmentMembersQueryParamsArg` - - Query parameters of getShieldInformationBarrierSegmentMembers method -- headers `GetShieldInformationBarrierSegmentMembersHeadersArg` - - Headers of getShieldInformationBarrierSegmentMembers method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ShieldInformationBarrierSegmentMembers`. - -Returns a paginated list of -shield information barrier segment member objects. - -## Create shield information barrier segment member - -Creates a new shield information barrier segment member. - -This operation is performed by calling function `createShieldInformationBarrierSegmentMember`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-shield-information-barrier-segment-members/). - - - -```ts -await client.shieldInformationBarrierSegmentMembers.createShieldInformationBarrierSegmentMember( - { - shieldInformationBarrierSegment: { - id: segment.id!, - type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField, - } satisfies CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField, - user: { - id: getEnvVar('USER_ID'), - type: 'user' as UserBaseTypeField, - } satisfies UserBase, - } satisfies CreateShieldInformationBarrierSegmentMemberRequestBodyArg -); -``` - -### Arguments - -- requestBody `CreateShieldInformationBarrierSegmentMemberRequestBodyArg` - - Request body of createShieldInformationBarrierSegmentMember method -- headers `CreateShieldInformationBarrierSegmentMemberHeadersArg` - - Headers of createShieldInformationBarrierSegmentMember method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ShieldInformationBarrierSegmentMember`. - -Returns a new shield information barrier segment member object. diff --git a/docs/shieldInformationBarrierSegmentRestrictions.md b/docs/shieldInformationBarrierSegmentRestrictions.md deleted file mode 100644 index 76addc22..00000000 --- a/docs/shieldInformationBarrierSegmentRestrictions.md +++ /dev/null @@ -1,153 +0,0 @@ -# ShieldInformationBarrierSegmentRestrictionsManager - -- [Get shield information barrier segment restriction by ID](#get-shield-information-barrier-segment-restriction-by-id) -- [Delete shield information barrier segment restriction by ID](#delete-shield-information-barrier-segment-restriction-by-id) -- [List shield information barrier segment restrictions](#list-shield-information-barrier-segment-restrictions) -- [Create shield information barrier segment restriction](#create-shield-information-barrier-segment-restriction) - -## Get shield information barrier segment restriction by ID - -Retrieves a shield information barrier segment -restriction based on provided ID. - -This operation is performed by calling function `getShieldInformationBarrierSegmentRestrictionById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-shield-information-barrier-segment-restrictions-id/). - - - -```ts -await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictionById( - segmentRestrictionId -); -``` - -### Arguments - -- shieldInformationBarrierSegmentRestrictionId `string` - - The ID of the shield information barrier segment Restriction. Example: "4563" -- headers `GetShieldInformationBarrierSegmentRestrictionByIdHeadersArg` - - Headers of getShieldInformationBarrierSegmentRestrictionById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ShieldInformationBarrierSegmentRestriction`. - -Returns the shield information barrier segment -restriction object. - -## Delete shield information barrier segment restriction by ID - -Delete shield information barrier segment restriction -based on provided ID. - -This operation is performed by calling function `deleteShieldInformationBarrierSegmentRestrictionById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-shield-information-barrier-segment-restrictions-id/). - - - -```ts -await client.shieldInformationBarrierSegmentRestrictions.deleteShieldInformationBarrierSegmentRestrictionById( - segmentRestrictionId -); -``` - -### Arguments - -- shieldInformationBarrierSegmentRestrictionId `string` - - The ID of the shield information barrier segment Restriction. Example: "4563" -- headers `DeleteShieldInformationBarrierSegmentRestrictionByIdHeadersArg` - - Headers of deleteShieldInformationBarrierSegmentRestrictionById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Empty body in response - -## List shield information barrier segment restrictions - -Lists shield information barrier segment restrictions -based on provided segment ID. - -This operation is performed by calling function `getShieldInformationBarrierSegmentRestrictions`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-shield-information-barrier-segment-restrictions/). - - - -```ts -await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictions( - { - shieldInformationBarrierSegmentId: segmentId, - } satisfies GetShieldInformationBarrierSegmentRestrictionsQueryParamsArg -); -``` - -### Arguments - -- queryParams `GetShieldInformationBarrierSegmentRestrictionsQueryParamsArg` - - Query parameters of getShieldInformationBarrierSegmentRestrictions method -- headers `GetShieldInformationBarrierSegmentRestrictionsHeadersArg` - - Headers of getShieldInformationBarrierSegmentRestrictions method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ShieldInformationBarrierSegmentRestrictions`. - -Returns a paginated list of -shield information barrier segment restriction objects. - -## Create shield information barrier segment restriction - -Creates a shield information barrier -segment restriction object. - -This operation is performed by calling function `createShieldInformationBarrierSegmentRestriction`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-shield-information-barrier-segment-restrictions/). - - - -```ts -await client.shieldInformationBarrierSegmentRestrictions.createShieldInformationBarrierSegmentRestriction( - { - restrictedSegment: { - id: segmentToRestrictId, - type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField, - } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField, - shieldInformationBarrierSegment: { - id: segmentId, - type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField, - } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField, - type: 'shield_information_barrier_segment_restriction' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField, - } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyArg -); -``` - -### Arguments - -- requestBody `CreateShieldInformationBarrierSegmentRestrictionRequestBodyArg` - - Request body of createShieldInformationBarrierSegmentRestriction method -- headers `CreateShieldInformationBarrierSegmentRestrictionHeadersArg` - - Headers of createShieldInformationBarrierSegmentRestriction method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ShieldInformationBarrierSegmentRestriction`. - -Returns the newly created Shield -Information Barrier Segment Restriction object. diff --git a/docs/shieldInformationBarrierSegments.md b/docs/shieldInformationBarrierSegments.md deleted file mode 100644 index d61836cf..00000000 --- a/docs/shieldInformationBarrierSegments.md +++ /dev/null @@ -1,183 +0,0 @@ -# ShieldInformationBarrierSegmentsManager - -- [Get shield information barrier segment with specified ID](#get-shield-information-barrier-segment-with-specified-id) -- [Update shield information barrier segment with specified ID](#update-shield-information-barrier-segment-with-specified-id) -- [Delete shield information barrier segment](#delete-shield-information-barrier-segment) -- [List shield information barrier segments](#list-shield-information-barrier-segments) -- [Create shield information barrier segment](#create-shield-information-barrier-segment) - -## Get shield information barrier segment with specified ID - -Retrieves shield information barrier segment based on provided ID.. - -This operation is performed by calling function `getShieldInformationBarrierSegmentById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-shield-information-barrier-segments-id/). - - - -```ts -await client.shieldInformationBarrierSegments.getShieldInformationBarrierSegmentById( - segmentId -); -``` - -### Arguments - -- shieldInformationBarrierSegmentId `string` - - The ID of the shield information barrier segment. Example: "3423" -- headers `GetShieldInformationBarrierSegmentByIdHeadersArg` - - Headers of getShieldInformationBarrierSegmentById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ShieldInformationBarrierSegment`. - -Returns the shield information barrier segment object. - -## Update shield information barrier segment with specified ID - -Updates the shield information barrier segment based on provided ID.. - -This operation is performed by calling function `updateShieldInformationBarrierSegmentById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-shield-information-barrier-segments-id/). - - - -```ts -await client.shieldInformationBarrierSegments.updateShieldInformationBarrierSegmentById( - segmentId, - { - description: updatedSegmentDescription, - } satisfies UpdateShieldInformationBarrierSegmentByIdRequestBodyArg -); -``` - -### Arguments - -- shieldInformationBarrierSegmentId `string` - - The ID of the shield information barrier segment. Example: "3423" -- requestBody `UpdateShieldInformationBarrierSegmentByIdRequestBodyArg` - - Request body of updateShieldInformationBarrierSegmentById method -- headers `UpdateShieldInformationBarrierSegmentByIdHeadersArg` - - Headers of updateShieldInformationBarrierSegmentById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ShieldInformationBarrierSegment`. - -Returns the updated shield information barrier segment object. - -## Delete shield information barrier segment - -Deletes the shield information barrier segment -based on provided ID. - -This operation is performed by calling function `deleteShieldInformationBarrierSegmentById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-shield-information-barrier-segments-id/). - - - -```ts -await client.shieldInformationBarrierSegments.deleteShieldInformationBarrierSegmentById( - segmentId -); -``` - -### Arguments - -- shieldInformationBarrierSegmentId `string` - - The ID of the shield information barrier segment. Example: "3423" -- headers `DeleteShieldInformationBarrierSegmentByIdHeadersArg` - - Headers of deleteShieldInformationBarrierSegmentById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Empty body in response - -## List shield information barrier segments - -Retrieves a list of shield information barrier segment objects -for the specified Information Barrier ID. - -This operation is performed by calling function `getShieldInformationBarrierSegments`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-shield-information-barrier-segments/). - - - -```ts -await client.shieldInformationBarrierSegments.getShieldInformationBarrierSegments( - { - shieldInformationBarrierId: barrierId, - } satisfies GetShieldInformationBarrierSegmentsQueryParamsArg -); -``` - -### Arguments - -- queryParams `GetShieldInformationBarrierSegmentsQueryParamsArg` - - Query parameters of getShieldInformationBarrierSegments method -- headers `GetShieldInformationBarrierSegmentsHeadersArg` - - Headers of getShieldInformationBarrierSegments method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ShieldInformationBarrierSegments`. - -Returns a paginated list of shield information barrier segment objects. - -## Create shield information barrier segment - -Creates a shield information barrier segment. - -This operation is performed by calling function `createShieldInformationBarrierSegment`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-shield-information-barrier-segments/). - - - -```ts -await client.shieldInformationBarrierSegments.createShieldInformationBarrierSegment( - { - shieldInformationBarrier: { - id: barrierId, - type: 'shield_information_barrier' as ShieldInformationBarrierBaseTypeField, - } satisfies ShieldInformationBarrierBase, - name: segmentName, - description: segmentDescription, - } satisfies CreateShieldInformationBarrierSegmentRequestBodyArg -); -``` - -### Arguments - -- requestBody `CreateShieldInformationBarrierSegmentRequestBodyArg` - - Request body of createShieldInformationBarrierSegment method -- headers `CreateShieldInformationBarrierSegmentHeadersArg` - - Headers of createShieldInformationBarrierSegment method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ShieldInformationBarrierSegment`. - -Returns a new shield information barrier segment object. diff --git a/docs/shieldInformationBarriers.md b/docs/shieldInformationBarriers.md deleted file mode 100644 index 2f164447..00000000 --- a/docs/shieldInformationBarriers.md +++ /dev/null @@ -1,144 +0,0 @@ -# ShieldInformationBarriersManager - -- [Get shield information barrier with specified ID](#get-shield-information-barrier-with-specified-id) -- [Add changed status of shield information barrier with specified ID](#add-changed-status-of-shield-information-barrier-with-specified-id) -- [List shield information barriers](#list-shield-information-barriers) -- [Create shield information barrier](#create-shield-information-barrier) - -## Get shield information barrier with specified ID - -Get shield information barrier based on provided ID. - -This operation is performed by calling function `getShieldInformationBarrierById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-shield-information-barriers-id/). - - - -```ts -await client.shieldInformationBarriers.getShieldInformationBarrierById( - barrierId -); -``` - -### Arguments - -- shieldInformationBarrierId `string` - - The ID of the shield information barrier. Example: "1910967" -- headers `GetShieldInformationBarrierByIdHeadersArg` - - Headers of getShieldInformationBarrierById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ShieldInformationBarrier`. - -Returns the shield information barrier object. - -## Add changed status of shield information barrier with specified ID - -Change status of shield information barrier with the specified ID. - -This operation is performed by calling function `createShieldInformationBarrierChangeStatus`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-shield-information-barriers-change-status/). - - - -```ts -await client.shieldInformationBarriers.createShieldInformationBarrierChangeStatus( - { - id: barrierId, - status: - 'disabled' as CreateShieldInformationBarrierChangeStatusRequestBodyArgStatusField, - } satisfies CreateShieldInformationBarrierChangeStatusRequestBodyArg -); -``` - -### Arguments - -- requestBody `CreateShieldInformationBarrierChangeStatusRequestBodyArg` - - Request body of createShieldInformationBarrierChangeStatus method -- headers `CreateShieldInformationBarrierChangeStatusHeadersArg` - - Headers of createShieldInformationBarrierChangeStatus method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ShieldInformationBarrier`. - -Returns the updated shield information barrier object. - -## List shield information barriers - -Retrieves a list of shield information barrier objects -for the enterprise of JWT. - -This operation is performed by calling function `getShieldInformationBarriers`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-shield-information-barriers/). - - - -```ts -await client.shieldInformationBarriers.getShieldInformationBarriers(); -``` - -### Arguments - -- queryParams `GetShieldInformationBarriersQueryParamsArg` - - Query parameters of getShieldInformationBarriers method -- headers `GetShieldInformationBarriersHeadersArg` - - Headers of getShieldInformationBarriers method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ShieldInformationBarriers`. - -Returns a paginated list of -shield information barrier objects, -empty list if currently no barrier. - -## Create shield information barrier - -Creates a shield information barrier to -separate individuals/groups within the same -firm and prevents confidential information passing between them. - -This operation is performed by calling function `createShieldInformationBarrier`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-shield-information-barriers/). - - - -```ts -await client.shieldInformationBarriers.createShieldInformationBarrier({ - enterprise: { - id: enterpriseId, - type: 'enterprise' as EnterpriseBaseTypeField, - } satisfies EnterpriseBase, -} satisfies CreateShieldInformationBarrierRequestBodyArg); -``` - -### Arguments - -- requestBody `CreateShieldInformationBarrierRequestBodyArg` - - Request body of createShieldInformationBarrier method -- headers `CreateShieldInformationBarrierHeadersArg` - - Headers of createShieldInformationBarrier method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ShieldInformationBarrier`. - -Returns a new shield information barrier object. diff --git a/docs/signTemplates.md b/docs/signTemplates.md deleted file mode 100644 index 46b76e25..00000000 --- a/docs/signTemplates.md +++ /dev/null @@ -1,66 +0,0 @@ -# SignTemplatesManager - -- [List Box Sign templates](#list-box-sign-templates) -- [Get Box Sign template by ID](#get-box-sign-template-by-id) - -## List Box Sign templates - -Gets Box Sign templates created by a user. - -This operation is performed by calling function `getSignTemplates`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-sign-templates/). - - - -```ts -await client.signTemplates.getSignTemplates({ - limit: 2, -} satisfies GetSignTemplatesQueryParamsArg); -``` - -### Arguments - -- queryParams `GetSignTemplatesQueryParamsArg` - - Query parameters of getSignTemplates method -- headers `GetSignTemplatesHeadersArg` - - Headers of getSignTemplates method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `SignTemplates`. - -Returns a collection of templates. - -## Get Box Sign template by ID - -Fetches details of a specific Box Sign template. - -This operation is performed by calling function `getSignTemplateById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-sign-templates-id/). - - - -```ts -await client.signTemplates.getSignTemplateById(signTemplates.entries![0].id!); -``` - -### Arguments - -- templateId `string` - - The ID of a Box Sign template. Example: "123075213-7d117509-8f05-42e4-a5ef-5190a319d41d" -- headers `GetSignTemplateByIdHeadersArg` - - Headers of getSignTemplateById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `SignTemplate`. - -Returns details of a template. diff --git a/docs/skills.md b/docs/skills.md deleted file mode 100644 index 0d1c2ad5..00000000 --- a/docs/skills.md +++ /dev/null @@ -1,150 +0,0 @@ -# SkillsManager - -- [List Box Skill cards on file](#list-box-skill-cards-on-file) -- [Create Box Skill cards on file](#create-box-skill-cards-on-file) -- [Update Box Skill cards on file](#update-box-skill-cards-on-file) -- [Remove Box Skill cards from file](#remove-box-skill-cards-from-file) -- [Update all Box Skill cards on file](#update-all-box-skill-cards-on-file) - -## List Box Skill cards on file - -List the Box Skills metadata cards that are attached to a file. - -This operation is performed by calling function `getFileMetadataGlobalBoxSkillsCards`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-files-id-metadata-global-box-skills-cards/). - -_Currently we don't have an example for calling `getFileMetadataGlobalBoxSkillsCards` in integration tests_ - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- headers `GetFileMetadataGlobalBoxSkillsCardsHeadersArg` - - Headers of getFileMetadataGlobalBoxSkillsCards method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `SkillCardsMetadata`. - -Returns all the metadata associated with a file. - -This API does not support pagination and will therefore always return -all of the metadata associated to the file. - -## Create Box Skill cards on file - -Applies one or more Box Skills metadata cards to a file. - -This operation is performed by calling function `createFileMetadataGlobalBoxSkillsCard`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-files-id-metadata-global-box-skills-cards/). - -_Currently we don't have an example for calling `createFileMetadataGlobalBoxSkillsCard` in integration tests_ - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- requestBody `CreateFileMetadataGlobalBoxSkillsCardRequestBodyArg` - - Request body of createFileMetadataGlobalBoxSkillsCard method -- headers `CreateFileMetadataGlobalBoxSkillsCardHeadersArg` - - Headers of createFileMetadataGlobalBoxSkillsCard method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `SkillCardsMetadata`. - -Returns the instance of the template that was applied to the file, -including the data that was applied to the template. - -## Update Box Skill cards on file - -Updates one or more Box Skills metadata cards to a file. - -This operation is performed by calling function `updateFileMetadataGlobalBoxSkillsCard`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-files-id-metadata-global-box-skills-cards/). - -_Currently we don't have an example for calling `updateFileMetadataGlobalBoxSkillsCard` in integration tests_ - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- requestBody `readonly UpdateFileMetadataGlobalBoxSkillsCardRequestBodyArg[]` - - Request body of updateFileMetadataGlobalBoxSkillsCard method -- headers `UpdateFileMetadataGlobalBoxSkillsCardHeadersArg` - - Headers of updateFileMetadataGlobalBoxSkillsCard method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `SkillCardsMetadata`. - -Returns the updated metadata template, with the -custom template data included. - -## Remove Box Skill cards from file - -Removes any Box Skills cards metadata from a file. - -This operation is performed by calling function `deleteFileMetadataGlobalBoxSkillsCard`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-files-id-metadata-global-box-skills-cards/). - -_Currently we don't have an example for calling `deleteFileMetadataGlobalBoxSkillsCard` in integration tests_ - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- headers `DeleteFileMetadataGlobalBoxSkillsCardHeadersArg` - - Headers of deleteFileMetadataGlobalBoxSkillsCard method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the cards are -successfully deleted. - -## Update all Box Skill cards on file - -An alternative method that can be used to overwrite and update all Box Skill -metadata cards on a file. - -This operation is performed by calling function `updateSkillInvocationById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-skill-invocations-id/). - -_Currently we don't have an example for calling `updateSkillInvocationById` in integration tests_ - -### Arguments - -- skillId `string` - - The ID of the skill to apply this metadata for. Example: "33243242" -- requestBody `UpdateSkillInvocationByIdRequestBodyArg` - - Request body of updateSkillInvocationById method -- headers `UpdateSkillInvocationByIdHeadersArg` - - Headers of updateSkillInvocationById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the card has been successfully updated. diff --git a/docs/storagePolicies.md b/docs/storagePolicies.md deleted file mode 100644 index 2e4a2704..00000000 --- a/docs/storagePolicies.md +++ /dev/null @@ -1,56 +0,0 @@ -# StoragePoliciesManager - -- [List storage policies](#list-storage-policies) -- [Get storage policy](#get-storage-policy) - -## List storage policies - -Fetches all the storage policies in the enterprise. - -This operation is performed by calling function `getStoragePolicies`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-storage-policies/). - -_Currently we don't have an example for calling `getStoragePolicies` in integration tests_ - -### Arguments - -- queryParams `GetStoragePoliciesQueryParamsArg` - - Query parameters of getStoragePolicies method -- headers `GetStoragePoliciesHeadersArg` - - Headers of getStoragePolicies method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `StoragePolicies`. - -Returns a collection of storage policies. - -## Get storage policy - -Fetches a specific storage policy. - -This operation is performed by calling function `getStoragePolicyById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-storage-policies-id/). - -_Currently we don't have an example for calling `getStoragePolicyById` in integration tests_ - -### Arguments - -- storagePolicyId `string` - - The ID of the storage policy. Example: "34342" -- headers `GetStoragePolicyByIdHeadersArg` - - Headers of getStoragePolicyById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `StoragePolicy`. - -Returns a storage policy object. diff --git a/docs/storagePolicyAssignments.md b/docs/storagePolicyAssignments.md deleted file mode 100644 index 38da3e9a..00000000 --- a/docs/storagePolicyAssignments.md +++ /dev/null @@ -1,148 +0,0 @@ -# StoragePolicyAssignmentsManager - -- [List storage policy assignments](#list-storage-policy-assignments) -- [Assign storage policy](#assign-storage-policy) -- [Get storage policy assignment](#get-storage-policy-assignment) -- [Update storage policy assignment](#update-storage-policy-assignment) -- [Unassign storage policy](#unassign-storage-policy) - -## List storage policy assignments - -Fetches all the storage policy assignment for an enterprise or user. - -This operation is performed by calling function `getStoragePolicyAssignments`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-storage-policy-assignments/). - -_Currently we don't have an example for calling `getStoragePolicyAssignments` in integration tests_ - -### Arguments - -- queryParams `GetStoragePolicyAssignmentsQueryParamsArg` - - Query parameters of getStoragePolicyAssignments method -- headers `GetStoragePolicyAssignmentsHeadersArg` - - Headers of getStoragePolicyAssignments method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `StoragePolicyAssignments`. - -Returns a collection of storage policies for -the enterprise or user. - -## Assign storage policy - -Creates a storage policy assignment for an enterprise or user. - -This operation is performed by calling function `createStoragePolicyAssignment`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-storage-policy-assignments/). - -_Currently we don't have an example for calling `createStoragePolicyAssignment` in integration tests_ - -### Arguments - -- requestBody `CreateStoragePolicyAssignmentRequestBodyArg` - - Request body of createStoragePolicyAssignment method -- headers `CreateStoragePolicyAssignmentHeadersArg` - - Headers of createStoragePolicyAssignment method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `StoragePolicyAssignment`. - -Returns the new storage policy assignment created. - -## Get storage policy assignment - -Fetches a specific storage policy assignment. - -This operation is performed by calling function `getStoragePolicyAssignmentById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-storage-policy-assignments-id/). - -_Currently we don't have an example for calling `getStoragePolicyAssignmentById` in integration tests_ - -### Arguments - -- storagePolicyAssignmentId `string` - - The ID of the storage policy assignment. Example: "932483" -- headers `GetStoragePolicyAssignmentByIdHeadersArg` - - Headers of getStoragePolicyAssignmentById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `StoragePolicyAssignment`. - -Returns a storage policy assignment object. - -## Update storage policy assignment - -Updates a specific storage policy assignment. - -This operation is performed by calling function `updateStoragePolicyAssignmentById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-storage-policy-assignments-id/). - -_Currently we don't have an example for calling `updateStoragePolicyAssignmentById` in integration tests_ - -### Arguments - -- storagePolicyAssignmentId `string` - - The ID of the storage policy assignment. Example: "932483" -- requestBody `UpdateStoragePolicyAssignmentByIdRequestBodyArg` - - Request body of updateStoragePolicyAssignmentById method -- headers `UpdateStoragePolicyAssignmentByIdHeadersArg` - - Headers of updateStoragePolicyAssignmentById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `StoragePolicyAssignment`. - -Returns an updated storage policy assignment object. - -## Unassign storage policy - -Delete a storage policy assignment. - -Deleting a storage policy assignment on a user -will have the user inherit the enterprise's default -storage policy. - -There is a rate limit for calling this endpoint of only -twice per user in a 24 hour time frame. - -This operation is performed by calling function `deleteStoragePolicyAssignmentById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-storage-policy-assignments-id/). - -_Currently we don't have an example for calling `deleteStoragePolicyAssignmentById` in integration tests_ - -### Arguments - -- storagePolicyAssignmentId `string` - - The ID of the storage policy assignment. Example: "932483" -- headers `DeleteStoragePolicyAssignmentByIdHeadersArg` - - Headers of deleteStoragePolicyAssignmentById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the storage policy -assignment is successfully deleted. diff --git a/docs/taskAssignments.md b/docs/taskAssignments.md deleted file mode 100644 index fbdb1a57..00000000 --- a/docs/taskAssignments.md +++ /dev/null @@ -1,146 +0,0 @@ -# TaskAssignmentsManager - -- [List task assignments](#list-task-assignments) -- [Assign task](#assign-task) -- [Get task assignment](#get-task-assignment) -- [Update task assignment](#update-task-assignment) -- [Unassign task](#unassign-task) - -## List task assignments - -Lists all of the assignments for a given task. - -This operation is performed by calling function `getTaskAssignments`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-tasks-id-assignments/). - -_Currently we don't have an example for calling `getTaskAssignments` in integration tests_ - -### Arguments - -- taskId `string` - - The ID of the task. Example: "12345" -- headers `GetTaskAssignmentsHeadersArg` - - Headers of getTaskAssignments method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `TaskAssignments`. - -Returns a collection of task assignment defining what task on -a file has been assigned to which users and by who. - -## Assign task - -Assigns a task to a user. - -A task can be assigned to more than one user by creating multiple -assignments. - -This operation is performed by calling function `createTaskAssignment`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-task-assignments/). - -_Currently we don't have an example for calling `createTaskAssignment` in integration tests_ - -### Arguments - -- requestBody `CreateTaskAssignmentRequestBodyArg` - - Request body of createTaskAssignment method -- headers `CreateTaskAssignmentHeadersArg` - - Headers of createTaskAssignment method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `TaskAssignment`. - -Returns a new task assignment object. - -## Get task assignment - -Retrieves information about a task assignment. - -This operation is performed by calling function `getTaskAssignmentById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-task-assignments-id/). - -_Currently we don't have an example for calling `getTaskAssignmentById` in integration tests_ - -### Arguments - -- taskAssignmentId `string` - - The ID of the task assignment. Example: "12345" -- headers `GetTaskAssignmentByIdHeadersArg` - - Headers of getTaskAssignmentById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `TaskAssignment`. - -Returns a task assignment, specifying who the task has been assigned to -and by whom. - -## Update task assignment - -Updates a task assignment. This endpoint can be -used to update the state of a task assigned to a user. - -This operation is performed by calling function `updateTaskAssignmentById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-task-assignments-id/). - -_Currently we don't have an example for calling `updateTaskAssignmentById` in integration tests_ - -### Arguments - -- taskAssignmentId `string` - - The ID of the task assignment. Example: "12345" -- requestBody `UpdateTaskAssignmentByIdRequestBodyArg` - - Request body of updateTaskAssignmentById method -- headers `UpdateTaskAssignmentByIdHeadersArg` - - Headers of updateTaskAssignmentById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `TaskAssignment`. - -Returns the updated task assignment object. - -## Unassign task - -Deletes a specific task assignment. - -This operation is performed by calling function `deleteTaskAssignmentById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-task-assignments-id/). - -_Currently we don't have an example for calling `deleteTaskAssignmentById` in integration tests_ - -### Arguments - -- taskAssignmentId `string` - - The ID of the task assignment. Example: "12345" -- headers `DeleteTaskAssignmentByIdHeadersArg` - - Headers of deleteTaskAssignmentById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the task -assignment was successfully deleted. diff --git a/docs/tasks.md b/docs/tasks.md deleted file mode 100644 index f72cd652..00000000 --- a/docs/tasks.md +++ /dev/null @@ -1,177 +0,0 @@ -# TasksManager - -- [List tasks on file](#list-tasks-on-file) -- [Create task](#create-task) -- [Get task](#get-task) -- [Update task](#update-task) -- [Remove task](#remove-task) - -## List tasks on file - -Retrieves a list of all the tasks for a file. This -endpoint does not support pagination. - -This operation is performed by calling function `getFileTasks`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-files-id-tasks/). - - - -```ts -await client.tasks.getFileTasks(file.id); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- headers `GetFileTasksHeadersArg` - - Headers of getFileTasks method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Tasks`. - -Returns a list of tasks on a file. - -If there are no tasks on this file an empty collection is returned -instead. - -## Create task - -Creates a single task on a file. This task is not assigned to any user and -will need to be assigned separately. - -This operation is performed by calling function `createTask`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-tasks/). - - - -```ts -await client.tasks.createTask({ - item: { - type: 'file' as CreateTaskRequestBodyArgItemFieldTypeField, - id: file.id, - } satisfies CreateTaskRequestBodyArgItemField, - message: 'test message', - dueAt: '2035-01-01T00:00:00Z', - action: 'review' as CreateTaskRequestBodyArgActionField, - completionRule: - 'all_assignees' as CreateTaskRequestBodyArgCompletionRuleField, -} satisfies CreateTaskRequestBodyArg); -``` - -### Arguments - -- requestBody `CreateTaskRequestBodyArg` - - Request body of createTask method -- headers `CreateTaskHeadersArg` - - Headers of createTask method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Task`. - -Returns the newly created task. - -## Get task - -Retrieves information about a specific task. - -This operation is performed by calling function `getTaskById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-tasks-id/). - - - -```ts -await client.tasks.getTaskById(task.id!); -``` - -### Arguments - -- taskId `string` - - The ID of the task. Example: "12345" -- headers `GetTaskByIdHeadersArg` - - Headers of getTaskById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Task`. - -Returns a task object. - -## Update task - -Updates a task. This can be used to update a task's configuration, or to -update its completion state. - -This operation is performed by calling function `updateTaskById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-tasks-id/). - - - -```ts -await client.tasks.updateTaskById(task.id!, { - message: 'updated message', -} satisfies UpdateTaskByIdRequestBodyArg); -``` - -### Arguments - -- taskId `string` - - The ID of the task. Example: "12345" -- requestBody `UpdateTaskByIdRequestBodyArg` - - Request body of updateTaskById method -- headers `UpdateTaskByIdHeadersArg` - - Headers of updateTaskById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Task`. - -Returns the updated task object - -## Remove task - -Removes a task from a file. - -This operation is performed by calling function `deleteTaskById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-tasks-id/). - - - -```ts -await client.tasks.deleteTaskById(task.id!); -``` - -### Arguments - -- taskId `string` - - The ID of the task. Example: "12345" -- headers `DeleteTaskByIdHeadersArg` - - Headers of deleteTaskById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the task was successfully deleted. diff --git a/docs/termsOfServiceUserStatuses.md b/docs/termsOfServiceUserStatuses.md deleted file mode 100644 index d4f239f5..00000000 --- a/docs/termsOfServiceUserStatuses.md +++ /dev/null @@ -1,87 +0,0 @@ -# TermsOfServiceUserStatusesManager - -- [List terms of service user statuses](#list-terms-of-service-user-statuses) -- [Create terms of service status for new user](#create-terms-of-service-status-for-new-user) -- [Update terms of service status for existing user](#update-terms-of-service-status-for-existing-user) - -## List terms of service user statuses - -Retrieves an overview of users and their status for a -terms of service, including Whether they have accepted -the terms and when. - -This operation is performed by calling function `getTermOfServiceUserStatuses`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-terms-of-service-user-statuses/). - -_Currently we don't have an example for calling `getTermOfServiceUserStatuses` in integration tests_ - -### Arguments - -- queryParams `GetTermOfServiceUserStatusesQueryParamsArg` - - Query parameters of getTermOfServiceUserStatuses method -- headers `GetTermOfServiceUserStatusesHeadersArg` - - Headers of getTermOfServiceUserStatuses method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `TermsOfServiceUserStatuses`. - -Returns a list of terms of service statuses. - -## Create terms of service status for new user - -Sets the status for a terms of service for a user. - -This operation is performed by calling function `createTermOfServiceUserStatus`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-terms-of-service-user-statuses/). - -_Currently we don't have an example for calling `createTermOfServiceUserStatus` in integration tests_ - -### Arguments - -- requestBody `CreateTermOfServiceUserStatusRequestBodyArg` - - Request body of createTermOfServiceUserStatus method -- headers `CreateTermOfServiceUserStatusHeadersArg` - - Headers of createTermOfServiceUserStatus method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `TermsOfServiceUserStatus`. - -Returns a terms of service status object. - -## Update terms of service status for existing user - -Updates the status for a terms of service for a user. - -This operation is performed by calling function `updateTermOfServiceUserStatusById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-terms-of-service-user-statuses-id/). - -_Currently we don't have an example for calling `updateTermOfServiceUserStatusById` in integration tests_ - -### Arguments - -- termsOfServiceUserStatusId `string` - - The ID of the terms of service status. Example: "324234" -- requestBody `UpdateTermOfServiceUserStatusByIdRequestBodyArg` - - Request body of updateTermOfServiceUserStatusById method -- headers `UpdateTermOfServiceUserStatusByIdHeadersArg` - - Headers of updateTermOfServiceUserStatusById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `TermsOfServiceUserStatus`. - -Returns the updated terms of service status object. diff --git a/docs/termsOfServices.md b/docs/termsOfServices.md deleted file mode 100644 index bde7d560..00000000 --- a/docs/termsOfServices.md +++ /dev/null @@ -1,115 +0,0 @@ -# TermsOfServicesManager - -- [List terms of services](#list-terms-of-services) -- [Create terms of service](#create-terms-of-service) -- [Get terms of service](#get-terms-of-service) -- [Update terms of service](#update-terms-of-service) - -## List terms of services - -Returns the current terms of service text and settings -for the enterprise. - -This operation is performed by calling function `getTermOfServices`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-terms-of-services/). - -_Currently we don't have an example for calling `getTermOfServices` in integration tests_ - -### Arguments - -- queryParams `GetTermOfServicesQueryParamsArg` - - Query parameters of getTermOfServices method -- headers `GetTermOfServicesHeadersArg` - - Headers of getTermOfServices method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `TermsOfServices`. - -Returns a collection of terms of service text and settings for the -enterprise. - -## Create terms of service - -Creates a terms of service for a given enterprise -and type of user. - -This operation is performed by calling function `createTermOfService`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-terms-of-services/). - -_Currently we don't have an example for calling `createTermOfService` in integration tests_ - -### Arguments - -- requestBody `CreateTermOfServiceRequestBodyArg` - - Request body of createTermOfService method -- headers `CreateTermOfServiceHeadersArg` - - Headers of createTermOfService method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Task`. - -Returns a new task object - -## Get terms of service - -Fetches a specific terms of service. - -This operation is performed by calling function `getTermOfServiceById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-terms-of-services-id/). - -_Currently we don't have an example for calling `getTermOfServiceById` in integration tests_ - -### Arguments - -- termsOfServiceId `string` - - The ID of the terms of service. Example: "324234" -- headers `GetTermOfServiceByIdHeadersArg` - - Headers of getTermOfServiceById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `TermsOfService`. - -Returns a terms of service object. - -## Update terms of service - -Updates a specific terms of service. - -This operation is performed by calling function `updateTermOfServiceById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-terms-of-services-id/). - -_Currently we don't have an example for calling `updateTermOfServiceById` in integration tests_ - -### Arguments - -- termsOfServiceId `string` - - The ID of the terms of service. Example: "324234" -- requestBody `UpdateTermOfServiceByIdRequestBodyArg` - - Request body of updateTermOfServiceById method -- headers `UpdateTermOfServiceByIdHeadersArg` - - Headers of updateTermOfServiceById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `TermsOfService`. - -Returns an updated terms of service object. diff --git a/docs/transfer.md b/docs/transfer.md deleted file mode 100644 index 51ef4fad..00000000 --- a/docs/transfer.md +++ /dev/null @@ -1,78 +0,0 @@ -# TransferManager - -- [Transfer owned folders](#transfer-owned-folders) - -## Transfer owned folders - -Move all of the items (files, folders and workflows) owned by a user into -another user's account - -Only the root folder (`0`) can be transferred. - -Folders can only be moved across users by users with administrative -permissions. - -All existing shared links and folder-level collaborations are transferred -during the operation. Please note that while collaborations at the individual -file-level are transferred during the operation, the collaborations are -deleted when the original user is deleted. - -This call will be performed synchronously which might lead to a slow response -when the source user has a large number of items in all of its folders. - -If the destination path has a metadata cascade policy attached to any of -the parent folders, a metadata cascade operation will be kicked off -asynchronously. - -There is currently no way to check for when this operation is finished. - -The destination folder's name will be in the format `{User}'s Files and -Folders`, where `{User}` is the display name of the user. - -To make this API call your application will need to have the "Read and write -all files and folders stored in Box" scope enabled. - -Please make sure the destination user has access to `Relay` or `Relay Lite`, -and has access to the files and folders involved in the workflows being -transferred. - -Admins will receive an email when the operation is completed. - -This operation is performed by calling function `transferOwnedFolder`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-users-id-folders-0/). - - - -```ts -await client.transfer.transferOwnedFolder( - newUser.id, - { - ownedBy: { - id: currentUser.id, - } satisfies TransferOwnedFolderRequestBodyArgOwnedByField, - } satisfies TransferOwnedFolderRequestBodyArg, - { notify: false } satisfies TransferOwnedFolderQueryParamsArg -); -``` - -### Arguments - -- userId `string` - - The ID of the user. Example: "12345" -- requestBody `TransferOwnedFolderRequestBodyArg` - - Request body of transferOwnedFolder method -- queryParams `TransferOwnedFolderQueryParamsArg` - - Query parameters of transferOwnedFolder method -- headers `TransferOwnedFolderHeadersArg` - - Headers of transferOwnedFolder method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `FolderFull`. - -Returns the information for the newly created -destination folder. diff --git a/docs/trashedFiles.md b/docs/trashedFiles.md deleted file mode 100644 index 22de4c7a..00000000 --- a/docs/trashedFiles.md +++ /dev/null @@ -1,118 +0,0 @@ -# TrashedFilesManager - -- [Restore file](#restore-file) -- [Get trashed file](#get-trashed-file) -- [Permanently remove file](#permanently-remove-file) - -## Restore file - -Restores a file that has been moved to the trash. - -An optional new parent ID can be provided to restore the file to in case the -original folder has been deleted. - -This operation is performed by calling function `restoreFileFromTrash`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-files-id/). - - - -```ts -await client.trashedFiles.restoreFileFromTrash(file.id); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- requestBody `RestoreFileFromTrashRequestBodyArg` - - Request body of restoreFileFromTrash method -- queryParams `RestoreFileFromTrashQueryParamsArg` - - Query parameters of restoreFileFromTrash method -- headers `RestoreFileFromTrashHeadersArg` - - Headers of restoreFileFromTrash method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `TrashFileRestored`. - -Returns a file object when the file has been restored. - -## Get trashed file - -Retrieves a file that has been moved to the trash. - -Please note that only if the file itself has been moved to the -trash can it be retrieved with this API call. If instead one of -its parent folders was moved to the trash, only that folder -can be inspected using the -[`GET /folders/:id/trash`](e://get_folders_id_trash) API. - -To list all items that have been moved to the trash, please -use the [`GET /folders/trash/items`](e://get-folders-trash-items/) -API. - -This operation is performed by calling function `getFileTrash`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-files-id-trash/). - - - -```ts -await client.trashedFiles.getFileTrash(file.id); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- queryParams `GetFileTrashQueryParamsArg` - - Query parameters of getFileTrash method -- headers `GetFileTrashHeadersArg` - - Headers of getFileTrash method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `TrashFile`. - -Returns the file that was trashed, -including information about when the it -was moved to the trash. - -## Permanently remove file - -Permanently deletes a file that is in the trash. -This action cannot be undone. - -This operation is performed by calling function `deleteFileTrash`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-files-id-trash/). - - - -```ts -await client.trashedFiles.deleteFileTrash(file.id); -``` - -### Arguments - -- fileId `string` - - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" -- headers `DeleteFileTrashHeadersArg` - - Headers of deleteFileTrash method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the file was -permanently deleted. diff --git a/docs/trashedFolders.md b/docs/trashedFolders.md deleted file mode 100644 index 09cce3aa..00000000 --- a/docs/trashedFolders.md +++ /dev/null @@ -1,127 +0,0 @@ -# TrashedFoldersManager - -- [Restore folder](#restore-folder) -- [Get trashed folder](#get-trashed-folder) -- [Permanently remove folder](#permanently-remove-folder) - -## Restore folder - -Restores a folder that has been moved to the trash. - -An optional new parent ID can be provided to restore the folder to in case the -original folder has been deleted. - -# Folder locking - -During this operation, part of the file tree will be locked, mainly -the source folder and all of its descendants, as well as the destination -folder. - -For the duration of the operation, no other move, copy, delete, or restore -operation can performed on any of the locked folders. - -This operation is performed by calling function `restoreFolderFromTrash`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-folders-id/). - - - -```ts -await client.trashedFolders.restoreFolderFromTrash(folder.id); -``` - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" -- requestBody `RestoreFolderFromTrashRequestBodyArg` - - Request body of restoreFolderFromTrash method -- queryParams `RestoreFolderFromTrashQueryParamsArg` - - Query parameters of restoreFolderFromTrash method -- headers `RestoreFolderFromTrashHeadersArg` - - Headers of restoreFolderFromTrash method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `TrashFolderRestored`. - -Returns a folder object when the folder has been restored. - -## Get trashed folder - -Retrieves a folder that has been moved to the trash. - -Please note that only if the folder itself has been moved to the -trash can it be retrieved with this API call. If instead one of -its parent folders was moved to the trash, only that folder -can be inspected using the -[`GET /folders/:id/trash`](e://get_folders_id_trash) API. - -To list all items that have been moved to the trash, please -use the [`GET /folders/trash/items`](e://get-folders-trash-items/) -API. - -This operation is performed by calling function `getFolderTrash`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-folders-id-trash/). - - - -```ts -await client.trashedFolders.getFolderTrash(folder.id); -``` - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" -- queryParams `GetFolderTrashQueryParamsArg` - - Query parameters of getFolderTrash method -- headers `GetFolderTrashHeadersArg` - - Headers of getFolderTrash method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `TrashFolder`. - -Returns the folder that was trashed, -including information about when the it -was moved to the trash. - -## Permanently remove folder - -Permanently deletes a folder that is in the trash. -This action cannot be undone. - -This operation is performed by calling function `deleteFolderTrash`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-folders-id-trash/). - - - -```ts -await client.trashedFolders.deleteFolderTrash(folder.id); -``` - -### Arguments - -- folderId `string` - - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" -- headers `DeleteFolderTrashHeadersArg` - - Headers of deleteFolderTrash method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the folder was -permanently deleted. diff --git a/docs/trashedItems.md b/docs/trashedItems.md deleted file mode 100644 index c6c319a2..00000000 --- a/docs/trashedItems.md +++ /dev/null @@ -1,41 +0,0 @@ -# TrashedItemsManager - -- [List trashed items](#list-trashed-items) - -## List trashed items - -Retrieves the files and folders that have been moved -to the trash. - -Any attribute in the full files or folders objects can be passed -in with the `fields` parameter to retrieve those specific -attributes that are not returned by default. - -This endpoint defaults to use offset-based pagination, yet also supports -marker-based pagination using the `marker` parameter. - -This operation is performed by calling function `getFolderTrashItems`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-folders-trash-items/). - - - -```ts -await client.trashedItems.getFolderTrashItems(); -``` - -### Arguments - -- queryParams `GetFolderTrashItemsQueryParamsArg` - - Query parameters of getFolderTrashItems method -- headers `GetFolderTrashItemsHeadersArg` - - Headers of getFolderTrashItems method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Items`. - -Returns a list of items that have been deleted diff --git a/docs/trashedWebLinks.md b/docs/trashedWebLinks.md deleted file mode 100644 index d7548eb0..00000000 --- a/docs/trashedWebLinks.md +++ /dev/null @@ -1,108 +0,0 @@ -# TrashedWebLinksManager - -- [Restore web link](#restore-web-link) -- [Get trashed web link](#get-trashed-web-link) -- [Permanently remove web link](#permanently-remove-web-link) - -## Restore web link - -Restores a web link that has been moved to the trash. - -An optional new parent ID can be provided to restore the web link to in case -the original folder has been deleted. - -This operation is performed by calling function `restoreWeblinkFromTrash`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-web-links-id/). - - - -```ts -await client.trashedWebLinks.restoreWeblinkFromTrash(weblink.id); -``` - -### Arguments - -- webLinkId `string` - - The ID of the web link. Example: "12345" -- requestBody `RestoreWeblinkFromTrashRequestBodyArg` - - Request body of restoreWeblinkFromTrash method -- queryParams `RestoreWeblinkFromTrashQueryParamsArg` - - Query parameters of restoreWeblinkFromTrash method -- headers `RestoreWeblinkFromTrashHeadersArg` - - Headers of restoreWeblinkFromTrash method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `TrashWebLinkRestored`. - -Returns a web link object when it has been restored. - -## Get trashed web link - -Retrieves a web link that has been moved to the trash. - -This operation is performed by calling function `getWebLinkTrash`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-web-links-id-trash/). - - - -```ts -await client.trashedWebLinks.getWebLinkTrash(weblink.id); -``` - -### Arguments - -- webLinkId `string` - - The ID of the web link. Example: "12345" -- queryParams `GetWebLinkTrashQueryParamsArg` - - Query parameters of getWebLinkTrash method -- headers `GetWebLinkTrashHeadersArg` - - Headers of getWebLinkTrash method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `TrashWebLink`. - -Returns the web link that was trashed, -including information about when the it -was moved to the trash. - -## Permanently remove web link - -Permanently deletes a web link that is in the trash. -This action cannot be undone. - -This operation is performed by calling function `deleteWebLinkTrash`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-web-links-id-trash/). - - - -```ts -await client.trashedWebLinks.deleteWebLinkTrash(weblink.id); -``` - -### Arguments - -- webLinkId `string` - - The ID of the web link. Example: "12345" -- headers `DeleteWebLinkTrashHeadersArg` - - Headers of deleteWebLinkTrash method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Returns an empty response when the web link was -permanently deleted. diff --git a/docs/userCollaborations.md b/docs/userCollaborations.md deleted file mode 100644 index 5093ce67..00000000 --- a/docs/userCollaborations.md +++ /dev/null @@ -1,163 +0,0 @@ -# UserCollaborationsManager - -- [Get collaboration](#get-collaboration) -- [Update collaboration](#update-collaboration) -- [Remove collaboration](#remove-collaboration) -- [Create collaboration](#create-collaboration) - -## Get collaboration - -Retrieves a single collaboration. - -This operation is performed by calling function `getCollaborationById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-collaborations-id/). - - - -```ts -await client.userCollaborations.getCollaborationById(collaborationId); -``` - -### Arguments - -- collaborationId `string` - - The ID of the collaboration Example: "1234" -- queryParams `GetCollaborationByIdQueryParamsArg` - - Query parameters of getCollaborationById method -- headers `GetCollaborationByIdHeadersArg` - - Headers of getCollaborationById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Collaboration`. - -Returns a collaboration object. - -## Update collaboration - -Updates a collaboration. -Can be used to change the owner of an item, or to -accept collaboration invites. - -This operation is performed by calling function `updateCollaborationById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-collaborations-id/). - - - -```ts -await client.userCollaborations.updateCollaborationById(collaborationId, { - role: 'viewer' as UpdateCollaborationByIdRequestBodyArgRoleField, -} satisfies UpdateCollaborationByIdRequestBodyArg); -``` - -### Arguments - -- collaborationId `string` - - The ID of the collaboration Example: "1234" -- requestBody `UpdateCollaborationByIdRequestBodyArg` - - Request body of updateCollaborationById method -- headers `UpdateCollaborationByIdHeadersArg` - - Headers of updateCollaborationById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Collaboration`. - -Returns an updated collaboration object unless the owner has changed.If the role is changed to `owner`, the collaboration is deleted -and a new collaboration is created. The previous `owner` of -the old collaboration will be a `co-owner` on the new collaboration. - -## Remove collaboration - -Deletes a single collaboration. - -This operation is performed by calling function `deleteCollaborationById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-collaborations-id/). - - - -```ts -await client.userCollaborations.deleteCollaborationById(collaborationId); -``` - -### Arguments - -- collaborationId `string` - - The ID of the collaboration Example: "1234" -- headers `DeleteCollaborationByIdHeadersArg` - - Headers of deleteCollaborationById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -A blank response is returned if the collaboration was -successfully deleted. - -## Create collaboration - -Adds a collaboration for a single user or a single group to a file -or folder. - -Collaborations can be created using email address, user IDs, or a -group IDs. - -If a collaboration is being created with a group, access to -this endpoint is dependent on the group's ability to be invited. - -If collaboration is in `pending` status, the following fields -are redacted: - -- `login` and `name` are hidden if a collaboration was created - using `user_id`, -- `name` is hidden if a collaboration was created using `login`. - -This operation is performed by calling function `createCollaboration`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-collaborations/). - - - -```ts -await client.userCollaborations.createCollaboration({ - item: { - type: 'folder' as CreateCollaborationRequestBodyArgItemFieldTypeField, - id: folder.id, - } satisfies CreateCollaborationRequestBodyArgItemField, - accessibleBy: { - type: 'user' as CreateCollaborationRequestBodyArgAccessibleByFieldTypeField, - login: userLogin, - } satisfies CreateCollaborationRequestBodyArgAccessibleByField, - role: 'editor' as CreateCollaborationRequestBodyArgRoleField, -} satisfies CreateCollaborationRequestBodyArg); -``` - -### Arguments - -- requestBody `CreateCollaborationRequestBodyArg` - - Request body of createCollaboration method -- queryParams `CreateCollaborationQueryParamsArg` - - Query parameters of createCollaboration method -- headers `CreateCollaborationHeadersArg` - - Headers of createCollaboration method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Collaboration`. - -Returns a new collaboration object. diff --git a/docs/users.md b/docs/users.md deleted file mode 100644 index c17c428c..00000000 --- a/docs/users.md +++ /dev/null @@ -1,240 +0,0 @@ -# UsersManager - -- [List enterprise users](#list-enterprise-users) -- [Create user](#create-user) -- [Get current user](#get-current-user) -- [Get user](#get-user) -- [Update user](#update-user) -- [Delete user](#delete-user) - -## List enterprise users - -Returns a list of all users for the Enterprise along with their `user_id`, -`public_name`, and `login`. - -The application and the authenticated user need to -have the permission to look up users in the entire -enterprise. - -This operation is performed by calling function `getUsers`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-users/). - - - -```ts -await client.users.getUsers(); -``` - -### Arguments - -- queryParams `GetUsersQueryParamsArg` - - Query parameters of getUsers method -- headers `GetUsersHeadersArg` - - Headers of getUsers method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Users`. - -Returns all of the users in the enterprise. - -## Create user - -Creates a new managed user in an enterprise. This endpoint -is only available to users and applications with the right -admin permissions. - -This operation is performed by calling function `createUser`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-users/). - - - -```ts -await client.users.createUser({ - name: userName, - login: userLogin, - isPlatformAccessOnly: true, -} satisfies CreateUserRequestBodyArg); -``` - -### Arguments - -- requestBody `CreateUserRequestBodyArg` - - Request body of createUser method -- queryParams `CreateUserQueryParamsArg` - - Query parameters of createUser method -- headers `CreateUserHeadersArg` - - Headers of createUser method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `UserFull`. - -Returns a user object for the newly created user. - -## Get current user - -Retrieves information about the user who is currently authenticated. - -In the case of a client-side authenticated OAuth 2.0 application -this will be the user who authorized the app. - -In the case of a JWT, server-side authenticated application -this will be the service account that belongs to the application -by default. - -Use the `As-User` header to change who this API call is made on behalf of. - -This operation is performed by calling function `getUserMe`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-users-me/). - - - -```ts -await client.users.getUserMe(); -``` - -### Arguments - -- queryParams `GetUserMeQueryParamsArg` - - Query parameters of getUserMe method -- headers `GetUserMeHeadersArg` - - Headers of getUserMe method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `UserFull`. - -Returns a single user object. - -## Get user - -Retrieves information about a user in the enterprise. - -The application and the authenticated user need to -have the permission to look up users in the entire -enterprise. - -This endpoint also returns a limited set of information -for external users who are collaborated on content -owned by the enterprise for authenticated users with the -right scopes. In this case, disallowed fields will return -null instead. - -This operation is performed by calling function `getUserById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-users-id/). - - - -```ts -await client.users.getUserById(user.id); -``` - -### Arguments - -- userId `string` - - The ID of the user. Example: "12345" -- queryParams `GetUserByIdQueryParamsArg` - - Query parameters of getUserById method -- headers `GetUserByIdHeadersArg` - - Headers of getUserById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `UserFull`. - -Returns a single user object. - -Not all available fields are returned by default. Use the -[fields](#param-fields) query parameter to explicitly request -any specific fields using the [fields](#get-users-id--request--fields) -parameter. - -## Update user - -Updates a managed or app user in an enterprise. This endpoint -is only available to users and applications with the right -admin permissions. - -This operation is performed by calling function `updateUserById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-users-id/). - - - -```ts -await client.users.updateUserById(user.id, { - name: updatedUserName, -} satisfies UpdateUserByIdRequestBodyArg); -``` - -### Arguments - -- userId `string` - - The ID of the user. Example: "12345" -- requestBody `UpdateUserByIdRequestBodyArg` - - Request body of updateUserById method -- queryParams `UpdateUserByIdQueryParamsArg` - - Query parameters of updateUserById method -- headers `UpdateUserByIdHeadersArg` - - Headers of updateUserById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `UserFull`. - -Returns the updated user object. - -## Delete user - -Deletes a user. By default this will fail if the user -still owns any content. Move their owned content first -before proceeding, or use the `force` field to delete -the user and their files. - -This operation is performed by calling function `deleteUserById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-users-id/). - - - -```ts -await client.users.deleteUserById(user.id); -``` - -### Arguments - -- userId `string` - - The ID of the user. Example: "12345" -- queryParams `DeleteUserByIdQueryParamsArg` - - Query parameters of deleteUserById method -- headers `DeleteUserByIdHeadersArg` - - Headers of deleteUserById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Removes the user and returns an empty response. diff --git a/docs/webLinks.md b/docs/webLinks.md deleted file mode 100644 index e0d2c676..00000000 --- a/docs/webLinks.md +++ /dev/null @@ -1,140 +0,0 @@ -# WebLinksManager - -- [Create web link](#create-web-link) -- [Get web link](#get-web-link) -- [Update web link](#update-web-link) -- [Remove web link](#remove-web-link) - -## Create web link - -Creates a web link object within a folder. - -This operation is performed by calling function `createWebLink`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-web-links/). - - - -```ts -await client.webLinks.createWebLink({ - url: url, - parent: { id: parent.id } satisfies CreateWebLinkRequestBodyArgParentField, - name: name, - description: description, -} satisfies CreateWebLinkRequestBodyArg); -``` - -### Arguments - -- requestBody `CreateWebLinkRequestBodyArg` - - Request body of createWebLink method -- headers `CreateWebLinkHeadersArg` - - Headers of createWebLink method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `WebLink`. - -Returns the newly created web link object. - -## Get web link - -Retrieve information about a web link. - -This operation is performed by calling function `getWebLinkById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-web-links-id/). - - - -```ts -await client.webLinks.getWebLinkById(weblink.id); -``` - -### Arguments - -- webLinkId `string` - - The ID of the web link. Example: "12345" -- headers `GetWebLinkByIdHeadersArg` - - Headers of getWebLinkById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `WebLink`. - -Returns the web link object. - -## Update web link - -Updates a web link object. - -This operation is performed by calling function `updateWebLinkById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-web-links-id/). - - - -```ts -await client.webLinks.updateWebLinkById(weblink.id, { - name: updatedName, - sharedLink: { - access: sharedAccess, - password: password, - } satisfies UpdateWebLinkByIdRequestBodyArgSharedLinkField, -} satisfies UpdateWebLinkByIdRequestBodyArg); -``` - -### Arguments - -- webLinkId `string` - - The ID of the web link. Example: "12345" -- requestBody `UpdateWebLinkByIdRequestBodyArg` - - Request body of updateWebLinkById method -- headers `UpdateWebLinkByIdHeadersArg` - - Headers of updateWebLinkById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `WebLink`. - -Returns the updated web link object. - -## Remove web link - -Deletes a web link. - -This operation is performed by calling function `deleteWebLinkById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-web-links-id/). - - - -```ts -await client.webLinks.deleteWebLinkById(weblink.id); -``` - -### Arguments - -- webLinkId `string` - - The ID of the web link. Example: "12345" -- headers `DeleteWebLinkByIdHeadersArg` - - Headers of deleteWebLinkById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -An empty response will be returned when the web link -was successfully deleted. diff --git a/docs/webhooks.md b/docs/webhooks.md deleted file mode 100644 index ed148c9b..00000000 --- a/docs/webhooks.md +++ /dev/null @@ -1,174 +0,0 @@ -# WebhooksManager - -- [List all webhooks](#list-all-webhooks) -- [Create webhook](#create-webhook) -- [Get webhook](#get-webhook) -- [Update webhook](#update-webhook) -- [Remove webhook](#remove-webhook) - -## List all webhooks - -Returns all defined webhooks for the requesting application. - -This API only returns webhooks that are applied to files or folders that are -owned by the authenticated user. This means that an admin can not see webhooks -created by a service account unless the admin has access to those folders, and -vice versa. - -This operation is performed by calling function `getWebhooks`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-webhooks/). - - - -```ts -await client.webhooks.getWebhooks(); -``` - -### Arguments - -- queryParams `GetWebhooksQueryParamsArg` - - Query parameters of getWebhooks method -- headers `GetWebhooksHeadersArg` - - Headers of getWebhooks method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Webhooks`. - -Returns a list of webhooks. - -## Create webhook - -Creates a webhook. - -This operation is performed by calling function `createWebhook`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-webhooks/). - - - -```ts -await client.webhooks.createWebhook({ - target: { - id: folder.id, - type: 'folder' as CreateWebhookRequestBodyArgTargetFieldTypeField, - } satisfies CreateWebhookRequestBodyArgTargetField, - address: 'https://example.com/new-webhook', - triggers: ['FILE.UPLOADED' as CreateWebhookRequestBodyArgTriggersField], -} satisfies CreateWebhookRequestBodyArg); -``` - -### Arguments - -- requestBody `CreateWebhookRequestBodyArg` - - Request body of createWebhook method -- headers `CreateWebhookHeadersArg` - - Headers of createWebhook method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Webhook`. - -Returns the new webhook object. - -## Get webhook - -Retrieves a specific webhook - -This operation is performed by calling function `getWebhookById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-webhooks-id/). - - - -```ts -await client.webhooks.getWebhookById(webhook.id!); -``` - -### Arguments - -- webhookId `string` - - The ID of the webhook. Example: "3321123" -- headers `GetWebhookByIdHeadersArg` - - Headers of getWebhookById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Webhook`. - -Returns a webhook object - -## Update webhook - -Updates a webhook. - -This operation is performed by calling function `updateWebhookById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/put-webhooks-id/). - - - -```ts -await client.webhooks.updateWebhookById(webhook.id!, { - address: 'https://example.com/updated-webhook', -} satisfies UpdateWebhookByIdRequestBodyArg); -``` - -### Arguments - -- webhookId `string` - - The ID of the webhook. Example: "3321123" -- requestBody `UpdateWebhookByIdRequestBodyArg` - - Request body of updateWebhookById method -- headers `UpdateWebhookByIdHeadersArg` - - Headers of updateWebhookById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Webhook`. - -Returns the new webhook object. - -## Remove webhook - -Deletes a webhook. - -This operation is performed by calling function `deleteWebhookById`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/delete-webhooks-id/). - - - -```ts -await client.webhooks.deleteWebhookById(webhook.id!); -``` - -### Arguments - -- webhookId `string` - - The ID of the webhook. Example: "3321123" -- headers `DeleteWebhookByIdHeadersArg` - - Headers of deleteWebhookById method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -An empty response will be returned when the webhook -was successfully deleted. diff --git a/docs/workflows.md b/docs/workflows.md deleted file mode 100644 index 60182972..00000000 --- a/docs/workflows.md +++ /dev/null @@ -1,65 +0,0 @@ -# WorkflowsManager - -- [List workflows](#list-workflows) -- [Starts workflow based on request body](#starts-workflow-based-on-request-body) - -## List workflows - -Returns list of workflows that act on a given `folder ID`, and -have a flow with a trigger type of `WORKFLOW_MANUAL_START`. - -You application must be authorized to use the `Manage Box Relay` application -scope within the developer console in to use this endpoint. - -This operation is performed by calling function `getWorkflows`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-workflows/). - -_Currently we don't have an example for calling `getWorkflows` in integration tests_ - -### Arguments - -- queryParams `GetWorkflowsQueryParamsArg` - - Query parameters of getWorkflows method -- headers `GetWorkflowsHeadersArg` - - Headers of getWorkflows method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `Workflows`. - -Returns the workflow. - -## Starts workflow based on request body - -Initiates a flow with a trigger type of `WORKFLOW_MANUAL_START`. - -You application must be authorized to use the `Manage Box Relay` application -scope within the developer console. - -This operation is performed by calling function `createWorkflowStart`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-workflows-id-start/). - -_Currently we don't have an example for calling `createWorkflowStart` in integration tests_ - -### Arguments - -- workflowId `string` - - The ID of the workflow. Example: "12345" -- requestBody `CreateWorkflowStartRequestBodyArg` - - Request body of createWorkflowStart method -- headers `CreateWorkflowStartHeadersArg` - - Headers of createWorkflowStart method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `undefined`. - -Starts the workflow. diff --git a/docs/zipDownloads.md b/docs/zipDownloads.md deleted file mode 100644 index 2e50853c..00000000 --- a/docs/zipDownloads.md +++ /dev/null @@ -1,195 +0,0 @@ -# ZipDownloadsManager - -- [Create zip download](#create-zip-download) -- [Download zip archive](#download-zip-archive) -- [Get zip download status](#get-zip-download-status) -- [](#) - -## Create zip download - -Creates a request to download multiple files and folders as a single `zip` -archive file. This API does not return the archive but instead performs all -the checks to ensure that the user has access to all the items, and then -returns a `download_url` and a `status_url` that can be used to download the -archive. - -The limit for an archive is either the Account's upload limit or -10,000 files, whichever is met first. - -**Note**: Downloading a large file can be -affected by various -factors such as distance, network latency, -bandwidth, and congestion, as well as packet loss -ratio and current server load. -For these reasons we recommend that a maximum ZIP archive -total size does not exceed 25GB. - -This operation is performed by calling function `createZipDownload`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/post-zip-downloads/). - - - -```ts -await client.zipDownloads.createZipDownload({ - items: [ - { - id: file1.id, - type: 'file' as ZipDownloadRequestItemsFieldTypeField, - } satisfies ZipDownloadRequestItemsField, - { - id: file2.id, - type: 'file' as ZipDownloadRequestItemsFieldTypeField, - } satisfies ZipDownloadRequestItemsField, - { - id: folder1.id, - type: 'folder' as ZipDownloadRequestItemsFieldTypeField, - } satisfies ZipDownloadRequestItemsField, - ], - downloadFileName: 'zip', -} satisfies ZipDownloadRequest); -``` - -### Arguments - -- requestBody `ZipDownloadRequest` - - Request body of createZipDownload method -- headers `CreateZipDownloadHeadersArg` - - Headers of createZipDownload method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ZipDownload`. - -If the `zip` archive is ready to be downloaded, the API will return a -response that will include a `download_url`, a `status_url`, as well as -any conflicts that might have occurred when creating the request. - -## Download zip archive - -Returns the contents of a `zip` archive in binary format. This URL does not -require any form of authentication and could be used in a user's browser to -download the archive to a user's device. - -By default, this URL is only valid for a few seconds from the creation of -the request for this archive. Once a download has started it can not be -stopped and resumed, instead a new request for a zip archive would need to -be created. - -The URL of this endpoint should not be considered as fixed. Instead, use -the [Create zip download](e://post_zip_downloads) API to request to create a -`zip` archive, and then follow the `download_url` field in the response to -this endpoint. - -This operation is performed by calling function `getZipDownloadContent`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-zip-downloads-id-content/). - - - -```ts -await client.zipDownloads.getZipDownloadContent(zipDownload.downloadUrl!); -``` - -### Arguments - -- downloadUrl `string` - - The URL that can be used to download created `zip` archive. Example: `https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/content` -- headers `GetZipDownloadContentHeadersArg` - - Headers of getZipDownloadContent method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ByteStream`. - -Returns the content of the items requested for this download, formatted as -a stream of files and folders in a `zip` archive. - -## Get zip download status - -Returns the download status of a `zip` archive, allowing an application to -inspect the progress of the download as well as the number of items that -might have been skipped. - -This endpoint can only be accessed once the download has started. -Subsequently this endpoint is valid for 12 hours from the start of the -download. - -The URL of this endpoint should not be considered as fixed. Instead, use -the [Create zip download](e://post_zip_downloads) API to request to create a -`zip` archive, and then follow the `status_url` field in the response to -this endpoint. - -This operation is performed by calling function `getZipDownloadStatus`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference/get-zip-downloads-id-status/). - - - -```ts -await client.zipDownloads.getZipDownloadStatus(zipDownload.statusUrl!); -``` - -### Arguments - -- statusUrl `string` - - The URL that can be used to get the status of the `zip` archive being downloaded. Example: `https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/status` -- headers `GetZipDownloadStatusHeadersArg` - - Headers of getZipDownloadStatus method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ZipDownloadStatus`. - -Returns the status of the `zip` archive that is being downloaded. - -## - -This operation is performed by calling function `downloadZip`. - -See the endpoint docs at -[API Reference](https://developer.box.com/reference//). - - - -```ts -await client.zipDownloads.downloadZip({ - items: [ - { - id: file1.id, - type: 'file' as ZipDownloadRequestItemsFieldTypeField, - } satisfies ZipDownloadRequestItemsField, - { - id: file2.id, - type: 'file' as ZipDownloadRequestItemsFieldTypeField, - } satisfies ZipDownloadRequestItemsField, - { - id: folder1.id, - type: 'folder' as ZipDownloadRequestItemsFieldTypeField, - } satisfies ZipDownloadRequestItemsField, - ], - downloadFileName: 'zip', -} satisfies ZipDownloadRequest); -``` - -### Arguments - -- requestBody `ZipDownloadRequest` - - Zip download request body -- headers `DownloadZipHeadersArg` - - Headers of zip download method -- cancellationToken `undefined | CancellationToken` - - Token used for request cancellation. - -### Returns - -This function returns a value of type `ByteStream`. diff --git a/src/ccgAuth.ts b/src/ccgAuth.ts index 77a99e85..b0a9711b 100644 --- a/src/ccgAuth.ts +++ b/src/ccgAuth.ts @@ -1,12 +1,11 @@ import { Authentication } from './auth'; import { - TokenRequest, TokenRequestBoxSubjectType, TokenRequestGrantType, } from './authSchemas'; -import { FetchOptions, FetchResponse, fetch } from './fetch.js'; +import { AuthorizationManager } from './managers/authorization.generated'; import { NetworkSession } from './network'; -import { AccessToken, deserializeAccessToken } from './schemas.generated.js'; +import { AccessToken } from './schemas.generated.js'; import { InMemoryTokenStorage, TokenStorage } from './tokenStorage.generated'; export class CcgConfig { @@ -29,7 +28,7 @@ export class BoxCcgAuth implements Authentication { config: CcgConfig; token?: AccessToken; subjectId: string; - subjectType: string; + subjectType: TokenRequestBoxSubjectType; tokenStorage: TokenStorage; constructor({ config }: Pick) { @@ -41,10 +40,10 @@ export class BoxCcgAuth implements Authentication { if (this.config.userId) { this.subjectId = this.config.userId!; - this.subjectType = 'user' as TokenRequestBoxSubjectType; + this.subjectType = 'user'; } else { this.subjectId = this.config.enterpriseId!; - this.subjectType = 'enterprise' as TokenRequestBoxSubjectType; + this.subjectType = 'enterprise'; } } @@ -67,22 +66,16 @@ export class BoxCcgAuth implements Authentication { * @returns {Promise} A promise resolving to the access token. */ async refreshToken(networkSession?: NetworkSession): Promise { - const requestBody = { - grant_type: 'client_credentials' as TokenRequestGrantType, - client_id: this.config.clientId, - client_secret: this.config.clientSecret, - box_subject_id: this.subjectId, - box_subject_type: this.subjectType, - } as TokenRequest; + const newToken = await new AuthorizationManager({ + networkSession, + }).createOauth2Token({ + grantType: 'client_credentials' satisfies TokenRequestGrantType, + clientId: this.config.clientId, + clientSecret: this.config.clientSecret, + boxSubjectId: this.subjectId, + boxSubjectType: this.subjectType, + }); - const response = (await fetch('https://api.box.com/oauth2/token', { - method: 'POST', - data: requestBody as Record, - contentType: 'application/x-www-form-urlencoded', - networkSession: networkSession, - } as FetchOptions)) as FetchResponse; - - const newToken = deserializeAccessToken(response.data); await this.tokenStorage.store(newToken); return newToken; } diff --git a/src/json.ts b/src/json.ts index 2f3faabc..e904f1dc 100644 --- a/src/json.ts +++ b/src/json.ts @@ -22,7 +22,11 @@ export function sdToUrlParams(data: SerializedData): string { if (!sdIsMap(data)) { throw new Error('Expecting an object as an argument for sdToUrlParams'); } - return new URLSearchParams(data as Record).toString(); + return new URLSearchParams( + Object.fromEntries( + Object.entries(data).filter(([key, value]) => value != null) + ) as Record + ).toString(); } export function sdIsEmpty(data: SerializedData): data is undefined | null { diff --git a/src/jwtAuth.ts b/src/jwtAuth.ts index 086d32eb..1beb848f 100644 --- a/src/jwtAuth.ts +++ b/src/jwtAuth.ts @@ -2,13 +2,12 @@ import type * as jwt from 'jsonwebtoken'; import { v4 as uuidv4 } from 'uuid'; import { Authentication } from './auth'; import { - TokenRequest, TokenRequestBoxSubjectType, TokenRequestGrantType, } from './authSchemas.js'; -import { FetchResponse, fetch } from './fetch.js'; +import { AuthorizationManager } from './managers/authorization.generated'; import { NetworkSession } from './network'; -import { AccessToken, deserializeAccessToken } from './schemas.generated.js'; +import { AccessToken } from './schemas.generated.js'; import { InMemoryTokenStorage, TokenStorage } from './tokenStorage.generated'; import { isBrowser } from './utils.js'; @@ -215,21 +214,15 @@ export class BoxJwtAuth implements Authentication { jwtOptions ); - const requestBody: TokenRequest = { - grant_type: BOX_JWT_GRANT_TYPE, - assertion: assertion, - client_id: this.config.clientId, - client_secret: this.config.clientSecret, - }; - const params = { - method: 'POST', - data: requestBody as Record, - contentType: 'application/x-www-form-urlencoded', + const newToken = await new AuthorizationManager({ networkSession, - }; + }).createOauth2Token({ + grantType: BOX_JWT_GRANT_TYPE, + assertion, + clientId: this.config.clientId, + clientSecret: this.config.clientSecret, + }); - const response = (await fetch(BOX_JWT_AUDIENCE, params)) as FetchResponse; - const newToken = deserializeAccessToken(response.data); await this.tokenStorage.store(newToken); return newToken; } diff --git a/src/managers/authorization.generated.ts b/src/managers/authorization.generated.ts index ad08ed0f..1d319d70 100644 --- a/src/managers/authorization.generated.ts +++ b/src/managers/authorization.generated.ts @@ -2,8 +2,17 @@ import { serializeAccessToken } from '../schemas.generated.js'; import { deserializeAccessToken } from '../schemas.generated.js'; import { serializeOAuth2Error } from '../schemas.generated.js'; import { deserializeOAuth2Error } from '../schemas.generated.js'; +import { serializePostOAuth2Token } from '../schemas.generated.js'; +import { deserializePostOAuth2Token } from '../schemas.generated.js'; +import { serializePostOAuth2TokenRefreshAccessToken } from '../schemas.generated.js'; +import { deserializePostOAuth2TokenRefreshAccessToken } from '../schemas.generated.js'; +import { serializePostOAuth2Revoke } from '../schemas.generated.js'; +import { deserializePostOAuth2Revoke } from '../schemas.generated.js'; import { AccessToken } from '../schemas.generated.js'; import { OAuth2Error } from '../schemas.generated.js'; +import { PostOAuth2Token } from '../schemas.generated.js'; +import { PostOAuth2TokenRefreshAccessToken } from '../schemas.generated.js'; +import { PostOAuth2Revoke } from '../schemas.generated.js'; import { Authentication } from '../auth.js'; import { NetworkSession } from '../network.js'; import { prepareParams } from '../utils.js'; @@ -41,10 +50,54 @@ export class GetAuthorizeHeadersArg { Object.assign(this, fields); } } +export class CreateOauth2TokenHeadersArg { + readonly extraHeaders?: { + readonly [key: string]: undefined | string; + } = {}; + constructor( + fields: + | Omit + | Partial> + ) { + Object.assign(this, fields); + } +} +export class CreateOauth2TokenRefreshHeadersArg { + readonly extraHeaders?: { + readonly [key: string]: undefined | string; + } = {}; + constructor( + fields: + | Omit + | Partial> + ) { + Object.assign(this, fields); + } +} +export class CreateOauth2RevokeHeadersArg { + readonly extraHeaders?: { + readonly [key: string]: undefined | string; + } = {}; + constructor( + fields: + | Omit + | Partial> + ) { + Object.assign(this, fields); + } +} export class AuthorizationManager { readonly auth?: Authentication; readonly networkSession?: NetworkSession; - constructor(fields: Omit) { + constructor( + fields: Omit< + AuthorizationManager, + | 'getAuthorize' + | 'createOauth2Token' + | 'createOauth2TokenRefresh' + | 'createOauth2Revoke' + > + ) { Object.assign(this, fields); } async getAuthorize( @@ -78,6 +131,79 @@ export class AuthorizationManager { )) as FetchResponse; return void 0; } + async createOauth2Token( + requestBody: PostOAuth2Token, + headers: CreateOauth2TokenHeadersArg = new CreateOauth2TokenHeadersArg({}), + cancellationToken?: CancellationToken + ): Promise { + const headersMap: { + readonly [key: string]: string; + } = prepareParams({ ...{}, ...headers.extraHeaders }); + const response: FetchResponse = (await fetch( + ''.concat('https://api.box.com/oauth2/token') as string, + { + method: 'POST', + headers: headersMap, + data: serializePostOAuth2Token(requestBody), + contentType: 'application/x-www-form-urlencoded', + responseFormat: 'json', + auth: this.auth, + networkSession: this.networkSession, + cancellationToken: cancellationToken, + } satisfies FetchOptions + )) as FetchResponse; + return deserializeAccessToken(response.data); + } + async createOauth2TokenRefresh( + requestBody: PostOAuth2TokenRefreshAccessToken, + headers: CreateOauth2TokenRefreshHeadersArg = new CreateOauth2TokenRefreshHeadersArg( + {} + ), + cancellationToken?: CancellationToken + ): Promise { + const headersMap: { + readonly [key: string]: string; + } = prepareParams({ ...{}, ...headers.extraHeaders }); + const response: FetchResponse = (await fetch( + ''.concat('https://api.box.com/oauth2/token#refresh') as string, + { + method: 'POST', + headers: headersMap, + data: serializePostOAuth2TokenRefreshAccessToken(requestBody), + contentType: 'application/x-www-form-urlencoded', + responseFormat: 'json', + auth: this.auth, + networkSession: this.networkSession, + cancellationToken: cancellationToken, + } satisfies FetchOptions + )) as FetchResponse; + return deserializeAccessToken(response.data); + } + async createOauth2Revoke( + requestBody: PostOAuth2Revoke, + headers: CreateOauth2RevokeHeadersArg = new CreateOauth2RevokeHeadersArg( + {} + ), + cancellationToken?: CancellationToken + ): Promise { + const headersMap: { + readonly [key: string]: string; + } = prepareParams({ ...{}, ...headers.extraHeaders }); + const response: FetchResponse = (await fetch( + ''.concat('https://api.box.com/oauth2/revoke') as string, + { + method: 'POST', + headers: headersMap, + data: serializePostOAuth2Revoke(requestBody), + contentType: 'application/x-www-form-urlencoded', + responseFormat: void 0, + auth: this.auth, + networkSession: this.networkSession, + cancellationToken: cancellationToken, + } satisfies FetchOptions + )) as FetchResponse; + return void 0; + } } export function serializeGetAuthorizeQueryParamsArgResponseTypeField( val: GetAuthorizeQueryParamsArgResponseTypeField diff --git a/src/oauth.generated.ts b/src/oauth.generated.ts index 96ecd468..0c8bea67 100644 --- a/src/oauth.generated.ts +++ b/src/oauth.generated.ts @@ -1,13 +1,10 @@ import { Authentication } from './auth.js'; import { NetworkSession } from './network.js'; import { AccessToken } from './schemas.generated.js'; +import { AuthorizationManager } from './managers/authorization.generated.js'; import { TokenStorage } from './tokenStorage.generated.js'; import { InMemoryTokenStorage } from './tokenStorage.generated.js'; import { sdToUrlParams } from './json.js'; -import { deserializeAccessToken } from './schemas.generated.js'; -import { fetch } from './fetch.js'; -import { FetchOptions } from './fetch.js'; -import { FetchResponse } from './fetch.js'; import { toString } from './utils.js'; import { sdToJson } from './json.js'; import { SerializedData } from './json.js'; @@ -18,8 +15,6 @@ import { sdIsString } from './json.js'; import { sdIsList } from './json.js'; import { sdIsMap } from './json.js'; const boxOauth2AuthUrl: string = 'https://account.box.com/api/oauth2/authorize'; -const boxOauth2TokenUrl: string = 'https://api.box.com/oauth2/token'; -const boxOauth2RevokeUrl: string = 'https://api.box.com/oauth2/revoke'; export class OAuthConfig { readonly clientId!: string; readonly clientSecret!: string; @@ -83,18 +78,15 @@ export class BoxOAuth implements Authentication { authorizationCode: string, networkSession?: NetworkSession ): Promise { - const response: FetchResponse = (await fetch(boxOauth2TokenUrl, { - method: 'POST', - data: { - ['grant_type']: 'authorization_code', - ['code']: authorizationCode, - ['client_id']: this.config.clientId, - ['client_secret']: this.config.clientSecret, - }, - contentType: 'application/x-www-form-urlencoded', + const authManager: AuthorizationManager = new AuthorizationManager({ networkSession: networkSession, - })) as FetchResponse; - const token: AccessToken = deserializeAccessToken(response.data); + }); + const token: AccessToken = await authManager.createOauth2Token({ + grantType: 'authorization_code', + code: authorizationCode, + clientId: this.config.clientId, + clientSecret: this.config.clientSecret, + }); await this.tokenStorage.store(token); return token; } @@ -115,18 +107,15 @@ export class BoxOAuth implements Authentication { : !(oldToken == void 0) ? oldToken.refreshToken : void 0; - const response: FetchResponse = (await fetch(boxOauth2TokenUrl, { - method: 'POST', - data: { - ['grant_type']: 'refresh_token', - ['client_id']: this.config.clientId, - ['client_secret']: this.config.clientSecret, - ['refresh_token']: tokenUsedForRefresh, - }, - contentType: 'application/x-www-form-urlencoded', + const authManager: AuthorizationManager = new AuthorizationManager({ networkSession: networkSession, - })) as FetchResponse; - const token: AccessToken = deserializeAccessToken(response.data); + }); + const token: AccessToken = await authManager.createOauth2Token({ + grantType: 'refresh_token', + clientId: this.config.clientId, + clientSecret: this.config.clientSecret, + refreshToken: tokenUsedForRefresh, + }); await this.tokenStorage.store(token); return token; } @@ -135,47 +124,39 @@ export class BoxOAuth implements Authentication { if (token == void 0) { return void 0; } - (await fetch(boxOauth2RevokeUrl, { - method: 'POST', - data: { - ['client_id']: this.config.clientId, - ['client_secret']: this.config.clientSecret, - ['token']: token.accessToken, - }, - contentType: 'application/x-www-form-urlencoded', + const authManager: AuthorizationManager = new AuthorizationManager({ networkSession: networkSession, - })) as FetchResponse; + }); + await authManager.createOauth2Revoke({ + clientId: this.config.clientId, + clientSecret: this.config.clientSecret, + token: token.accessToken, + }); await this.tokenStorage.clear(); return void 0; } async downscopeToken( scopes: readonly string[], - networkSession?: NetworkSession, - refreshToken?: string + resource?: string, + sharedLink?: string, + networkSession?: NetworkSession ): Promise { - const oldToken: undefined | AccessToken = await this.tokenStorage.get(); - const tokenUsedForRefresh: any = !(refreshToken == void 0) - ? refreshToken - : !(oldToken == void 0) - ? oldToken.refreshToken - : void 0; - if (tokenUsedForRefresh == void 0) { - throw 'No refresh token is available.'; + const token: undefined | AccessToken = await this.tokenStorage.get(); + if (token == void 0 || token.accessToken == void 0) { + throw 'No access token is available.'; } - const response: FetchResponse = (await fetch(boxOauth2TokenUrl, { - method: 'POST', - data: { - ['grant_type']: 'urn:ietf:params:oauth:grant-type:token-exchange', - ['subject_token']: tokenUsedForRefresh, - ['subject_token_type']: 'urn:ietf:params:oauth:token-type:access_token', - ['scope']: toString(scopes) as string, - }, - contentType: 'application/x-www-form-urlencoded', + const authManager: AuthorizationManager = new AuthorizationManager({ networkSession: networkSession, - })) as FetchResponse; - const token: AccessToken = deserializeAccessToken(response.data); - await this.tokenStorage.store(token); - return token; + }); + const downscopedToken: AccessToken = await authManager.createOauth2Token({ + grantType: 'urn:ietf:params:oauth:grant-type:token-exchange', + subjectToken: token.accessToken, + subjectTokenType: 'urn:ietf:params:oauth:token-type:access_token', + scope: toString(scopes) as string, + resource: resource, + boxSharedLink: sharedLink, + }); + return downscopedToken; } } export function serializeGetAuthorizeUrlOptionsArg( diff --git a/src/schemas.generated.ts b/src/schemas.generated.ts index 9e5f1d54..0d16002e 100644 --- a/src/schemas.generated.ts +++ b/src/schemas.generated.ts @@ -1001,8 +1001,8 @@ export interface RetentionPolicyAssignmentFilterFieldsField { readonly value?: string; } export interface RetentionPolicyAssignment { - readonly id?: string; - readonly type?: RetentionPolicyAssignmentTypeField; + readonly id: string; + readonly type: RetentionPolicyAssignmentTypeField; readonly retentionPolicy?: RetentionPolicyMini; readonly assignedTo?: RetentionPolicyAssignmentAssignedToField; readonly filterFields?: readonly RetentionPolicyAssignmentFilterFieldsField[]; @@ -9022,11 +9022,8 @@ export function serializeRetentionPolicyAssignment( val: RetentionPolicyAssignment ): SerializedData { return { - ['id']: val.id == void 0 ? void 0 : val.id, - ['type']: - val.type == void 0 - ? void 0 - : serializeRetentionPolicyAssignmentTypeField(val.type), + ['id']: val.id, + ['type']: serializeRetentionPolicyAssignmentTypeField(val.type), ['retention_policy']: val.retentionPolicy == void 0 ? void 0 @@ -9053,11 +9050,9 @@ export function serializeRetentionPolicyAssignment( export function deserializeRetentionPolicyAssignment( val: any ): RetentionPolicyAssignment { - const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: undefined | RetentionPolicyAssignmentTypeField = - val.type == void 0 - ? void 0 - : deserializeRetentionPolicyAssignmentTypeField(val.type); + const id: string = val.id; + const type: RetentionPolicyAssignmentTypeField = + deserializeRetentionPolicyAssignmentTypeField(val.type); const retentionPolicy: undefined | RetentionPolicyMini = val.retention_policy == void 0 ? void 0 diff --git a/src/test/auth.generated.test.ts b/src/test/auth.generated.test.ts index 2e132201..546f7836 100644 --- a/src/test/auth.generated.test.ts +++ b/src/test/auth.generated.test.ts @@ -1,13 +1,30 @@ +import { serializeFiles } from '../schemas.generated.js'; +import { deserializeFiles } from '../schemas.generated.js'; +import { serializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { serializeFileFull } from '../schemas.generated.js'; +import { deserializeFileFull } from '../schemas.generated.js'; +import { serializeUpdateFileByIdRequestBodyArg } from '../managers/files.generated.js'; +import { deserializeUpdateFileByIdRequestBodyArg } from '../managers/files.generated.js'; import { serializeUserFull } from '../schemas.generated.js'; import { deserializeUserFull } from '../schemas.generated.js'; import { GetUserMeQueryParamsArg } from '../managers/users.generated.js'; import { AccessToken } from '../schemas.generated.js'; +import { Files } from '../schemas.generated.js'; +import { UploadFileRequestBodyArg } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { FileFull } from '../schemas.generated.js'; +import { UpdateFileByIdRequestBodyArg } from '../managers/files.generated.js'; import { decodeBase64 } from '../utils.js'; import { getEnvVar } from '../utils.js'; import { getUuid } from '../utils.js'; import { bufferEquals } from '../utils.js'; import { readByteStream } from '../utils.js'; import { generateByteBuffer } from '../utils.js'; +import { generateByteStream } from '../utils.js'; import { decodeBase64ByteStream } from '../utils.js'; import { BoxClient } from '../client.generated.js'; import { BoxCcgAuth } from '../ccgAuth.js'; @@ -25,6 +42,20 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; +export async function getAccessToken(): Promise { + const userId: string = getEnvVar('USER_ID'); + const enterpriseId: string = getEnvVar('ENTERPRISE_ID'); + const ccgConfig: CcgConfig = new CcgConfig({ + clientId: getEnvVar('CLIENT_ID'), + clientSecret: getEnvVar('CLIENT_SECRET'), + enterpriseId: enterpriseId, + userId: userId, + }); + const auth: BoxCcgAuth = new BoxCcgAuth({ config: ccgConfig }); + await auth.asUser(userId); + const token: AccessToken = await auth.retrieveToken(); + return token; +} test('test_jwt_auth', async function test_jwt_auth(): Promise { const userId: string = getEnvVar('USER_ID'); const enterpriseId: string = getEnvVar('ENTERPRISE_ID'); @@ -52,16 +83,21 @@ test('test_jwt_auth', async function test_jwt_auth(): Promise { throw 'Assertion failed'; } }); -test('test_oauth_auth', function test_oauth_auth(): any { +test('test_oauth_auth_authorizeUrl', function test_oauth_auth_authorizeUrl(): any { const config: OAuthConfig = new OAuthConfig({ clientId: 'OAUTH_CLIENT_ID', clientSecret: 'OAUTH_CLIENT_SECRET', }); const auth: BoxOAuth = new BoxOAuth({ config: config }); const authUrl: string = auth.getAuthorizeUrl(); - const expectedAuthUrl: string = - 'https://account.box.com/api/oauth2/authorize?client_id=OAUTH_CLIENT_ID&response_type=code'; - if (!(authUrl == expectedAuthUrl)) { + if ( + !( + authUrl == + 'https://account.box.com/api/oauth2/authorize?client_id=OAUTH_CLIENT_ID&response_type=code' || + authUrl == + 'https://account.box.com/api/oauth2/authorize?response_type=code&client_id=OAUTH_CLIENT_ID' + ) + ) { throw 'Assertion failed'; } }); @@ -97,16 +133,7 @@ test('test_ccg_auth', async function test_ccg_auth(): Promise { }); test('test_developer_token_auth', async function test_developer_token_auth(): Promise { const userId: string = getEnvVar('USER_ID'); - const enterpriseId: string = getEnvVar('ENTERPRISE_ID'); - const ccgConfig: CcgConfig = new CcgConfig({ - clientId: getEnvVar('CLIENT_ID'), - clientSecret: getEnvVar('CLIENT_SECRET'), - enterpriseId: enterpriseId, - userId: userId, - }); - const auth: BoxCcgAuth = new BoxCcgAuth({ config: ccgConfig }); - await auth.asUser(userId); - const token: AccessToken = await auth.retrieveToken(); + const token: AccessToken = await getAccessToken(); const devAuth: BoxDeveloperTokenAuth = new BoxDeveloperTokenAuth({ token: token.accessToken!, }); @@ -116,4 +143,65 @@ test('test_developer_token_auth', async function test_developer_token_auth(): Pr throw 'Assertion failed'; } }); +test('test_oauth_auth_revoke', async function test_oauth_auth_revoke(): Promise { + const config: OAuthConfig = new OAuthConfig({ + clientId: getEnvVar('CLIENT_ID'), + clientSecret: getEnvVar('CLIENT_SECRET'), + }); + const auth: BoxOAuth = new BoxOAuth({ config: config }); + const token: AccessToken = await getAccessToken(); + await auth.tokenStorage.store(token); + const tokenBeforeRevoke: undefined | AccessToken = + await auth.tokenStorage.get(); + await auth.revokeToken(); + const tokenAfterRevoke: undefined | AccessToken = + await auth.tokenStorage.get(); + if (!!(tokenBeforeRevoke == void 0)) { + throw 'Assertion failed'; + } + if (!(tokenAfterRevoke == void 0)) { + throw 'Assertion failed'; + } +}); +test('test_oauth_auth_downscope', async function test_oauth_auth_downscope(): Promise { + const config: OAuthConfig = new OAuthConfig({ + clientId: getEnvVar('CLIENT_ID'), + clientSecret: getEnvVar('CLIENT_SECRET'), + }); + const auth: BoxOAuth = new BoxOAuth({ config: config }); + const token: AccessToken = await getAccessToken(); + await auth.tokenStorage.store(token); + const parentClient: BoxClient = new BoxClient({ auth: auth }); + const uploadedFiles: Files = await parentClient.uploads.uploadFile({ + attributes: { + name: getUuid(), + parent: { + id: '0', + } satisfies UploadFileRequestBodyArgAttributesFieldParentField, + } satisfies UploadFileRequestBodyArgAttributesField, + file: generateByteStream(1024 * 1024), + } satisfies UploadFileRequestBodyArg); + const file: FileFull = uploadedFiles.entries![0]; + const resourcePath: string = ''.concat( + 'https://api.box.com/2.0/files/', + file.id + ) as string; + const downscopedToken: AccessToken = await auth.downscopeToken( + ['item_rename'], + resourcePath + ); + if (!!(downscopedToken.accessToken == void 0)) { + throw 'Assertion failed'; + } + const downscopedClient: BoxClient = new BoxClient({ + auth: new BoxDeveloperTokenAuth({ token: downscopedToken.accessToken! }), + }); + await downscopedClient.files.updateFileById(file.id, { + name: getUuid(), + } satisfies UpdateFileByIdRequestBodyArg); + expect(async () => { + await downscopedClient.files.deleteFileById(file.id); + }).rejects.toThrow(); + await parentClient.files.deleteFileById(file.id); +}); export {}; From 7a3f3b1faceb207863d6013e339c3c0f0bc26feb Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Mon, 11 Dec 2023 01:08:56 -0800 Subject: [PATCH 5/8] generated with codegen at box/box-codegen@338d0d6 and spec at box/box-openapi@fc21828 --- src/managers/fileClassifications.generated.ts | 191 +++++++----------- .../folderClassifications.generated.ts | 191 +++++++----------- src/test/auth.generated.test.ts | 2 +- src/test/avatars.generated.test.ts | 2 +- src/test/classifications.generated.test.ts | 113 +---------- ...borationAllowlistEntries.generated.test.ts | 2 +- ...onAllowlistExemptTargets.generated.test.ts | 2 +- src/test/comments.generated.test.ts | 2 +- src/test/commons.generated.ts | 102 ++++++++++ .../fileClassifications.generated.test.ts | 139 +++++++++++++ src/test/fileMetadata.generated.test.ts | 2 +- src/test/fileRequests.generated.test.ts | 2 +- src/test/fileWatermarks.generated.test.ts | 2 +- src/test/files.generated.test.ts | 2 +- .../folderClassifications.generated.test.ts | 139 +++++++++++++ src/test/folderLocks.generated.test.ts | 2 +- src/test/folderMetadata.generated.test.ts | 2 +- src/test/folderWatermarks.generated.test.ts | 2 +- src/test/folders.generated.test.ts | 2 +- src/test/groups.generated.test.ts | 2 +- src/test/memberships.generated.test.ts | 2 +- .../metadataCascadePolicies.generated.test.ts | 4 +- src/test/metadataTemplates.generated.test.ts | 2 +- src/test/sharedLinksFiles.generated.test.ts | 2 +- src/test/sharedLinksFolders.generated.test.ts | 2 +- .../sharedLinksWebLinks.generated.test.ts | 2 +- ...ionBarrierSegmentMembers.generated.test.ts | 2 +- ...rrierSegmentRestrictions.generated.test.ts | 2 +- ...formationBarrierSegments.generated.test.ts | 2 +- ...hieldInformationBarriers.generated.test.ts | 2 +- src/test/trashedFiles.generated.test.ts | 2 +- src/test/trashedFolders.generated.test.ts | 4 +- src/test/trashedWebLinks.generated.test.ts | 2 +- src/test/uploads.generated.test.ts | 2 +- src/test/userCollaborations.generated.test.ts | 4 +- src/test/webhooks.generated.test.ts | 2 +- 36 files changed, 558 insertions(+), 383 deletions(-) create mode 100644 src/test/fileClassifications.generated.test.ts create mode 100644 src/test/folderClassifications.generated.test.ts diff --git a/src/managers/fileClassifications.generated.ts b/src/managers/fileClassifications.generated.ts index 3b8067da..669c5d84 100644 --- a/src/managers/fileClassifications.generated.ts +++ b/src/managers/fileClassifications.generated.ts @@ -21,94 +21,61 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetFileMetadataEnterpriseSecurityClassification6VmVochwUWoHeadersArg { +export class GetClassificationOnFileHeadersArg { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit< - GetFileMetadataEnterpriseSecurityClassification6VmVochwUWoHeadersArg, - 'extraHeaders' - > - | Partial< - Pick< - GetFileMetadataEnterpriseSecurityClassification6VmVochwUWoHeadersArg, - 'extraHeaders' - > - > + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface CreateFileMetadataEnterpriseSecurityClassificationRequestBodyArg { +export interface AddClassificationToFileRequestBodyArg { readonly boxSecurityClassificationKey?: string; } -export class CreateFileMetadataEnterpriseSecurityClassificationHeadersArg { +export class AddClassificationToFileHeadersArg { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit< - CreateFileMetadataEnterpriseSecurityClassificationHeadersArg, - 'extraHeaders' - > - | Partial< - Pick< - CreateFileMetadataEnterpriseSecurityClassificationHeadersArg, - 'extraHeaders' - > - > + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgOpField = - 'replace'; -export type UpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgPathField = - 'Box__Security__Classification__Key'; -export interface UpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArg { - readonly op?: UpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgOpField; - readonly path?: UpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgPathField; - readonly value?: string; +export type UpdateClassificationOnFileRequestBodyArgOpField = 'replace'; +export type UpdateClassificationOnFileRequestBodyArgPathField = + '/Box__Security__Classification__Key'; +export interface UpdateClassificationOnFileRequestBodyArg { + readonly op: UpdateClassificationOnFileRequestBodyArgOpField; + readonly path: UpdateClassificationOnFileRequestBodyArgPathField; + readonly value: string; } -export class UpdateFileMetadataEnterpriseSecurityClassificationHeadersArg { +export class UpdateClassificationOnFileHeadersArg { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit< - UpdateFileMetadataEnterpriseSecurityClassificationHeadersArg, - 'extraHeaders' - > - | Partial< - Pick< - UpdateFileMetadataEnterpriseSecurityClassificationHeadersArg, - 'extraHeaders' - > - > + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteFileMetadataEnterpriseSecurityClassificationHeadersArg { +export class DeleteClassificationFromFileHeadersArg { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit< - DeleteFileMetadataEnterpriseSecurityClassificationHeadersArg, - 'extraHeaders' - > - | Partial< - Pick< - DeleteFileMetadataEnterpriseSecurityClassificationHeadersArg, - 'extraHeaders' - > - > + | Omit + | Partial> ) { Object.assign(this, fields); } @@ -119,17 +86,17 @@ export class FileClassificationsManager { constructor( fields: Omit< FileClassificationsManager, - | 'getFileMetadataEnterpriseSecurityClassification6VmVochwUWo' - | 'createFileMetadataEnterpriseSecurityClassification' - | 'updateFileMetadataEnterpriseSecurityClassification' - | 'deleteFileMetadataEnterpriseSecurityClassification' + | 'getClassificationOnFile' + | 'addClassificationToFile' + | 'updateClassificationOnFile' + | 'deleteClassificationFromFile' > ) { Object.assign(this, fields); } - async getFileMetadataEnterpriseSecurityClassification6VmVochwUWo( + async getClassificationOnFile( fileId: string, - headers: GetFileMetadataEnterpriseSecurityClassification6VmVochwUWoHeadersArg = new GetFileMetadataEnterpriseSecurityClassification6VmVochwUWoHeadersArg( + headers: GetClassificationOnFileHeadersArg = new GetClassificationOnFileHeadersArg( {} ), cancellationToken?: CancellationToken @@ -154,10 +121,10 @@ export class FileClassificationsManager { )) as FetchResponse; return deserializeClassification(response.data); } - async createFileMetadataEnterpriseSecurityClassification( + async addClassificationToFile( fileId: string, - requestBody: CreateFileMetadataEnterpriseSecurityClassificationRequestBodyArg = {} satisfies CreateFileMetadataEnterpriseSecurityClassificationRequestBodyArg, - headers: CreateFileMetadataEnterpriseSecurityClassificationHeadersArg = new CreateFileMetadataEnterpriseSecurityClassificationHeadersArg( + requestBody: AddClassificationToFileRequestBodyArg = {} satisfies AddClassificationToFileRequestBodyArg, + headers: AddClassificationToFileHeadersArg = new AddClassificationToFileHeadersArg( {} ), cancellationToken?: CancellationToken @@ -174,9 +141,7 @@ export class FileClassificationsManager { { method: 'POST', headers: headersMap, - data: serializeCreateFileMetadataEnterpriseSecurityClassificationRequestBodyArg( - requestBody - ), + data: serializeAddClassificationToFileRequestBodyArg(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -186,10 +151,10 @@ export class FileClassificationsManager { )) as FetchResponse; return deserializeClassification(response.data); } - async updateFileMetadataEnterpriseSecurityClassification( + async updateClassificationOnFile( fileId: string, - requestBody: readonly UpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArg[], - headers: UpdateFileMetadataEnterpriseSecurityClassificationHeadersArg = new UpdateFileMetadataEnterpriseSecurityClassificationHeadersArg( + requestBody: readonly UpdateClassificationOnFileRequestBodyArg[], + headers: UpdateClassificationOnFileHeadersArg = new UpdateClassificationOnFileHeadersArg( {} ), cancellationToken?: CancellationToken @@ -207,7 +172,7 @@ export class FileClassificationsManager { method: 'PUT', headers: headersMap, data: requestBody.map( - serializeUpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArg + serializeUpdateClassificationOnFileRequestBodyArg ) as readonly any[], contentType: 'application/json-patch+json', responseFormat: 'json', @@ -218,9 +183,9 @@ export class FileClassificationsManager { )) as FetchResponse; return deserializeClassification(response.data); } - async deleteFileMetadataEnterpriseSecurityClassification( + async deleteClassificationFromFile( fileId: string, - headers: DeleteFileMetadataEnterpriseSecurityClassificationHeadersArg = new DeleteFileMetadataEnterpriseSecurityClassificationHeadersArg( + headers: DeleteClassificationFromFileHeadersArg = new DeleteClassificationFromFileHeadersArg( {} ), cancellationToken?: CancellationToken @@ -246,8 +211,8 @@ export class FileClassificationsManager { return void 0; } } -export function serializeCreateFileMetadataEnterpriseSecurityClassificationRequestBodyArg( - val: CreateFileMetadataEnterpriseSecurityClassificationRequestBodyArg +export function serializeAddClassificationToFileRequestBodyArg( + val: AddClassificationToFileRequestBodyArg ): SerializedData { return { ['Box__Security__Classification__Key']: @@ -256,91 +221,71 @@ export function serializeCreateFileMetadataEnterpriseSecurityClassificationReque : val.boxSecurityClassificationKey, }; } -export function deserializeCreateFileMetadataEnterpriseSecurityClassificationRequestBodyArg( +export function deserializeAddClassificationToFileRequestBodyArg( val: any -): CreateFileMetadataEnterpriseSecurityClassificationRequestBodyArg { +): AddClassificationToFileRequestBodyArg { const boxSecurityClassificationKey: undefined | string = val.Box__Security__Classification__Key == void 0 ? void 0 : val.Box__Security__Classification__Key; return { boxSecurityClassificationKey: boxSecurityClassificationKey, - } satisfies CreateFileMetadataEnterpriseSecurityClassificationRequestBodyArg; + } satisfies AddClassificationToFileRequestBodyArg; } -export function serializeUpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgOpField( - val: UpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgOpField +export function serializeUpdateClassificationOnFileRequestBodyArgOpField( + val: UpdateClassificationOnFileRequestBodyArgOpField ): SerializedData { return val; } -export function deserializeUpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgOpField( +export function deserializeUpdateClassificationOnFileRequestBodyArgOpField( val: any -): UpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgOpField { +): UpdateClassificationOnFileRequestBodyArgOpField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgOpField"'; + throw 'Expecting a string for "UpdateClassificationOnFileRequestBodyArgOpField"'; } if (val == 'replace') { return 'replace'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgPathField( - val: UpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgPathField +export function serializeUpdateClassificationOnFileRequestBodyArgPathField( + val: UpdateClassificationOnFileRequestBodyArgPathField ): SerializedData { return val; } -export function deserializeUpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgPathField( +export function deserializeUpdateClassificationOnFileRequestBodyArgPathField( val: any -): UpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgPathField { +): UpdateClassificationOnFileRequestBodyArgPathField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgPathField"'; + throw 'Expecting a string for "UpdateClassificationOnFileRequestBodyArgPathField"'; } - if (val == 'Box__Security__Classification__Key') { - return 'Box__Security__Classification__Key'; + if (val == '/Box__Security__Classification__Key') { + return '/Box__Security__Classification__Key'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArg( - val: UpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArg +export function serializeUpdateClassificationOnFileRequestBodyArg( + val: UpdateClassificationOnFileRequestBodyArg ): SerializedData { return { - ['op']: - val.op == void 0 - ? void 0 - : serializeUpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgOpField( - val.op - ), - ['path']: - val.path == void 0 - ? void 0 - : serializeUpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgPathField( - val.path - ), - ['value']: val.value == void 0 ? void 0 : val.value, + ['op']: serializeUpdateClassificationOnFileRequestBodyArgOpField(val.op), + ['path']: serializeUpdateClassificationOnFileRequestBodyArgPathField( + val.path + ), + ['value']: val.value, }; } -export function deserializeUpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArg( +export function deserializeUpdateClassificationOnFileRequestBodyArg( val: any -): UpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArg { - const op: - | undefined - | UpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgOpField = - val.op == void 0 - ? void 0 - : deserializeUpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgOpField( - val.op - ); - const path: - | undefined - | UpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgPathField = - val.path == void 0 - ? void 0 - : deserializeUpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArgPathField( - val.path - ); - const value: undefined | string = val.value == void 0 ? void 0 : val.value; +): UpdateClassificationOnFileRequestBodyArg { + const op: UpdateClassificationOnFileRequestBodyArgOpField = + deserializeUpdateClassificationOnFileRequestBodyArgOpField(val.op); + const path: UpdateClassificationOnFileRequestBodyArgPathField = + deserializeUpdateClassificationOnFileRequestBodyArgPathField(val.path); + const value: string = val.value; return { op: op, path: path, value: value, - } satisfies UpdateFileMetadataEnterpriseSecurityClassificationRequestBodyArg; + } satisfies UpdateClassificationOnFileRequestBodyArg; } diff --git a/src/managers/folderClassifications.generated.ts b/src/managers/folderClassifications.generated.ts index 739d3f03..ae941233 100644 --- a/src/managers/folderClassifications.generated.ts +++ b/src/managers/folderClassifications.generated.ts @@ -21,94 +21,61 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetFolderMetadataEnterpriseSecurityClassification6VmVochwUWoHeadersArg { +export class GetClassificationOnFolderHeadersArg { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit< - GetFolderMetadataEnterpriseSecurityClassification6VmVochwUWoHeadersArg, - 'extraHeaders' - > - | Partial< - Pick< - GetFolderMetadataEnterpriseSecurityClassification6VmVochwUWoHeadersArg, - 'extraHeaders' - > - > + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface CreateFolderMetadataEnterpriseSecurityClassificationRequestBodyArg { +export interface AddClassificationToFolderRequestBodyArg { readonly boxSecurityClassificationKey?: string; } -export class CreateFolderMetadataEnterpriseSecurityClassificationHeadersArg { +export class AddClassificationToFolderHeadersArg { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit< - CreateFolderMetadataEnterpriseSecurityClassificationHeadersArg, - 'extraHeaders' - > - | Partial< - Pick< - CreateFolderMetadataEnterpriseSecurityClassificationHeadersArg, - 'extraHeaders' - > - > + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgOpField = - 'replace'; -export type UpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgPathField = - 'Box__Security__Classification__Key'; -export interface UpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArg { - readonly op?: UpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgOpField; - readonly path?: UpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgPathField; - readonly value?: string; +export type UpdateClassificationOnFolderRequestBodyArgOpField = 'replace'; +export type UpdateClassificationOnFolderRequestBodyArgPathField = + '/Box__Security__Classification__Key'; +export interface UpdateClassificationOnFolderRequestBodyArg { + readonly op: UpdateClassificationOnFolderRequestBodyArgOpField; + readonly path: UpdateClassificationOnFolderRequestBodyArgPathField; + readonly value: string; } -export class UpdateFolderMetadataEnterpriseSecurityClassificationHeadersArg { +export class UpdateClassificationOnFolderHeadersArg { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit< - UpdateFolderMetadataEnterpriseSecurityClassificationHeadersArg, - 'extraHeaders' - > - | Partial< - Pick< - UpdateFolderMetadataEnterpriseSecurityClassificationHeadersArg, - 'extraHeaders' - > - > + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteFolderMetadataEnterpriseSecurityClassificationHeadersArg { +export class DeleteClassificationFromFolderHeadersArg { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit< - DeleteFolderMetadataEnterpriseSecurityClassificationHeadersArg, - 'extraHeaders' - > - | Partial< - Pick< - DeleteFolderMetadataEnterpriseSecurityClassificationHeadersArg, - 'extraHeaders' - > - > + | Omit + | Partial> ) { Object.assign(this, fields); } @@ -119,17 +86,17 @@ export class FolderClassificationsManager { constructor( fields: Omit< FolderClassificationsManager, - | 'getFolderMetadataEnterpriseSecurityClassification6VmVochwUWo' - | 'createFolderMetadataEnterpriseSecurityClassification' - | 'updateFolderMetadataEnterpriseSecurityClassification' - | 'deleteFolderMetadataEnterpriseSecurityClassification' + | 'getClassificationOnFolder' + | 'addClassificationToFolder' + | 'updateClassificationOnFolder' + | 'deleteClassificationFromFolder' > ) { Object.assign(this, fields); } - async getFolderMetadataEnterpriseSecurityClassification6VmVochwUWo( + async getClassificationOnFolder( folderId: string, - headers: GetFolderMetadataEnterpriseSecurityClassification6VmVochwUWoHeadersArg = new GetFolderMetadataEnterpriseSecurityClassification6VmVochwUWoHeadersArg( + headers: GetClassificationOnFolderHeadersArg = new GetClassificationOnFolderHeadersArg( {} ), cancellationToken?: CancellationToken @@ -154,10 +121,10 @@ export class FolderClassificationsManager { )) as FetchResponse; return deserializeClassification(response.data); } - async createFolderMetadataEnterpriseSecurityClassification( + async addClassificationToFolder( folderId: string, - requestBody: CreateFolderMetadataEnterpriseSecurityClassificationRequestBodyArg = {} satisfies CreateFolderMetadataEnterpriseSecurityClassificationRequestBodyArg, - headers: CreateFolderMetadataEnterpriseSecurityClassificationHeadersArg = new CreateFolderMetadataEnterpriseSecurityClassificationHeadersArg( + requestBody: AddClassificationToFolderRequestBodyArg = {} satisfies AddClassificationToFolderRequestBodyArg, + headers: AddClassificationToFolderHeadersArg = new AddClassificationToFolderHeadersArg( {} ), cancellationToken?: CancellationToken @@ -174,9 +141,7 @@ export class FolderClassificationsManager { { method: 'POST', headers: headersMap, - data: serializeCreateFolderMetadataEnterpriseSecurityClassificationRequestBodyArg( - requestBody - ), + data: serializeAddClassificationToFolderRequestBodyArg(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -186,10 +151,10 @@ export class FolderClassificationsManager { )) as FetchResponse; return deserializeClassification(response.data); } - async updateFolderMetadataEnterpriseSecurityClassification( + async updateClassificationOnFolder( folderId: string, - requestBody: readonly UpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArg[], - headers: UpdateFolderMetadataEnterpriseSecurityClassificationHeadersArg = new UpdateFolderMetadataEnterpriseSecurityClassificationHeadersArg( + requestBody: readonly UpdateClassificationOnFolderRequestBodyArg[], + headers: UpdateClassificationOnFolderHeadersArg = new UpdateClassificationOnFolderHeadersArg( {} ), cancellationToken?: CancellationToken @@ -207,7 +172,7 @@ export class FolderClassificationsManager { method: 'PUT', headers: headersMap, data: requestBody.map( - serializeUpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArg + serializeUpdateClassificationOnFolderRequestBodyArg ) as readonly any[], contentType: 'application/json-patch+json', responseFormat: 'json', @@ -218,9 +183,9 @@ export class FolderClassificationsManager { )) as FetchResponse; return deserializeClassification(response.data); } - async deleteFolderMetadataEnterpriseSecurityClassification( + async deleteClassificationFromFolder( folderId: string, - headers: DeleteFolderMetadataEnterpriseSecurityClassificationHeadersArg = new DeleteFolderMetadataEnterpriseSecurityClassificationHeadersArg( + headers: DeleteClassificationFromFolderHeadersArg = new DeleteClassificationFromFolderHeadersArg( {} ), cancellationToken?: CancellationToken @@ -246,8 +211,8 @@ export class FolderClassificationsManager { return void 0; } } -export function serializeCreateFolderMetadataEnterpriseSecurityClassificationRequestBodyArg( - val: CreateFolderMetadataEnterpriseSecurityClassificationRequestBodyArg +export function serializeAddClassificationToFolderRequestBodyArg( + val: AddClassificationToFolderRequestBodyArg ): SerializedData { return { ['Box__Security__Classification__Key']: @@ -256,91 +221,71 @@ export function serializeCreateFolderMetadataEnterpriseSecurityClassificationReq : val.boxSecurityClassificationKey, }; } -export function deserializeCreateFolderMetadataEnterpriseSecurityClassificationRequestBodyArg( +export function deserializeAddClassificationToFolderRequestBodyArg( val: any -): CreateFolderMetadataEnterpriseSecurityClassificationRequestBodyArg { +): AddClassificationToFolderRequestBodyArg { const boxSecurityClassificationKey: undefined | string = val.Box__Security__Classification__Key == void 0 ? void 0 : val.Box__Security__Classification__Key; return { boxSecurityClassificationKey: boxSecurityClassificationKey, - } satisfies CreateFolderMetadataEnterpriseSecurityClassificationRequestBodyArg; + } satisfies AddClassificationToFolderRequestBodyArg; } -export function serializeUpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgOpField( - val: UpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgOpField +export function serializeUpdateClassificationOnFolderRequestBodyArgOpField( + val: UpdateClassificationOnFolderRequestBodyArgOpField ): SerializedData { return val; } -export function deserializeUpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgOpField( +export function deserializeUpdateClassificationOnFolderRequestBodyArgOpField( val: any -): UpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgOpField { +): UpdateClassificationOnFolderRequestBodyArgOpField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgOpField"'; + throw 'Expecting a string for "UpdateClassificationOnFolderRequestBodyArgOpField"'; } if (val == 'replace') { return 'replace'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgPathField( - val: UpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgPathField +export function serializeUpdateClassificationOnFolderRequestBodyArgPathField( + val: UpdateClassificationOnFolderRequestBodyArgPathField ): SerializedData { return val; } -export function deserializeUpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgPathField( +export function deserializeUpdateClassificationOnFolderRequestBodyArgPathField( val: any -): UpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgPathField { +): UpdateClassificationOnFolderRequestBodyArgPathField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgPathField"'; + throw 'Expecting a string for "UpdateClassificationOnFolderRequestBodyArgPathField"'; } - if (val == 'Box__Security__Classification__Key') { - return 'Box__Security__Classification__Key'; + if (val == '/Box__Security__Classification__Key') { + return '/Box__Security__Classification__Key'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArg( - val: UpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArg +export function serializeUpdateClassificationOnFolderRequestBodyArg( + val: UpdateClassificationOnFolderRequestBodyArg ): SerializedData { return { - ['op']: - val.op == void 0 - ? void 0 - : serializeUpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgOpField( - val.op - ), - ['path']: - val.path == void 0 - ? void 0 - : serializeUpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgPathField( - val.path - ), - ['value']: val.value == void 0 ? void 0 : val.value, + ['op']: serializeUpdateClassificationOnFolderRequestBodyArgOpField(val.op), + ['path']: serializeUpdateClassificationOnFolderRequestBodyArgPathField( + val.path + ), + ['value']: val.value, }; } -export function deserializeUpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArg( +export function deserializeUpdateClassificationOnFolderRequestBodyArg( val: any -): UpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArg { - const op: - | undefined - | UpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgOpField = - val.op == void 0 - ? void 0 - : deserializeUpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgOpField( - val.op - ); - const path: - | undefined - | UpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgPathField = - val.path == void 0 - ? void 0 - : deserializeUpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArgPathField( - val.path - ); - const value: undefined | string = val.value == void 0 ? void 0 : val.value; +): UpdateClassificationOnFolderRequestBodyArg { + const op: UpdateClassificationOnFolderRequestBodyArgOpField = + deserializeUpdateClassificationOnFolderRequestBodyArgOpField(val.op); + const path: UpdateClassificationOnFolderRequestBodyArgPathField = + deserializeUpdateClassificationOnFolderRequestBodyArgPathField(val.path); + const value: string = val.value; return { op: op, path: path, value: value, - } satisfies UpdateFolderMetadataEnterpriseSecurityClassificationRequestBodyArg; + } satisfies UpdateClassificationOnFolderRequestBodyArg; } diff --git a/src/test/auth.generated.test.ts b/src/test/auth.generated.test.ts index 546f7836..57160862 100644 --- a/src/test/auth.generated.test.ts +++ b/src/test/auth.generated.test.ts @@ -199,7 +199,7 @@ test('test_oauth_auth_downscope', async function test_oauth_auth_downscope(): Pr await downscopedClient.files.updateFileById(file.id, { name: getUuid(), } satisfies UpdateFileByIdRequestBodyArg); - expect(async () => { + await expect(async () => { await downscopedClient.files.deleteFileById(file.id); }).rejects.toThrow(); await parentClient.files.deleteFileById(file.id); diff --git a/src/test/avatars.generated.test.ts b/src/test/avatars.generated.test.ts index 9a4347d5..538a1778 100644 --- a/src/test/avatars.generated.test.ts +++ b/src/test/avatars.generated.test.ts @@ -54,7 +54,7 @@ test('testAvatars', async function testAvatars(): Promise { throw 'Assertion failed'; } await client.avatars.deleteUserAvatar(user.id); - expect(async () => { + await expect(async () => { await client.avatars.getUserAvatar(user.id); }).rejects.toThrow(); }); diff --git a/src/test/classifications.generated.test.ts b/src/test/classifications.generated.test.ts index 2f7d4f6a..270d025b 100644 --- a/src/test/classifications.generated.test.ts +++ b/src/test/classifications.generated.test.ts @@ -1,33 +1,3 @@ -import { serializeCreateClassificationTemplateRequestBodyArg } from '../managers/classifications.generated.js'; -import { deserializeCreateClassificationTemplateRequestBodyArg } from '../managers/classifications.generated.js'; -import { serializeCreateClassificationTemplateRequestBodyArgScopeField } from '../managers/classifications.generated.js'; -import { deserializeCreateClassificationTemplateRequestBodyArgScopeField } from '../managers/classifications.generated.js'; -import { serializeCreateClassificationTemplateRequestBodyArgDisplayNameField } from '../managers/classifications.generated.js'; -import { deserializeCreateClassificationTemplateRequestBodyArgDisplayNameField } from '../managers/classifications.generated.js'; -import { serializeCreateClassificationTemplateRequestBodyArgTemplateKeyField } from '../managers/classifications.generated.js'; -import { deserializeCreateClassificationTemplateRequestBodyArgTemplateKeyField } from '../managers/classifications.generated.js'; -import { serializeCreateClassificationTemplateRequestBodyArgFieldsField } from '../managers/classifications.generated.js'; -import { deserializeCreateClassificationTemplateRequestBodyArgFieldsField } from '../managers/classifications.generated.js'; -import { serializeCreateClassificationTemplateRequestBodyArgFieldsFieldTypeField } from '../managers/classifications.generated.js'; -import { deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldTypeField } from '../managers/classifications.generated.js'; -import { serializeCreateClassificationTemplateRequestBodyArgFieldsFieldKeyField } from '../managers/classifications.generated.js'; -import { deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldKeyField } from '../managers/classifications.generated.js'; -import { serializeCreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField } from '../managers/classifications.generated.js'; -import { deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField } from '../managers/classifications.generated.js'; -import { serializeClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; -import { deserializeClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; -import { serializeAddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; import { serializeUpdateClassificationRequestBodyArg } from '../managers/classifications.generated.js'; import { deserializeUpdateClassificationRequestBodyArg } from '../managers/classifications.generated.js'; import { serializeUpdateClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; @@ -40,33 +10,22 @@ import { serializeUpdateClassificationRequestBodyArgDataFieldStaticConfigField } import { deserializeUpdateClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; import { serializeUpdateClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; import { deserializeUpdateClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; +import { serializeClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; +import { deserializeClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; import { serializeClassificationTemplate } from '../schemas.generated.js'; import { deserializeClassificationTemplate } from '../schemas.generated.js'; import { BoxClient } from '../client.generated.js'; -import { CreateClassificationTemplateRequestBodyArg } from '../managers/classifications.generated.js'; -import { CreateClassificationTemplateRequestBodyArgScopeField } from '../managers/classifications.generated.js'; -import { CreateClassificationTemplateRequestBodyArgDisplayNameField } from '../managers/classifications.generated.js'; -import { CreateClassificationTemplateRequestBodyArgTemplateKeyField } from '../managers/classifications.generated.js'; -import { CreateClassificationTemplateRequestBodyArgFieldsField } from '../managers/classifications.generated.js'; -import { CreateClassificationTemplateRequestBodyArgFieldsFieldTypeField } from '../managers/classifications.generated.js'; -import { CreateClassificationTemplateRequestBodyArgFieldsFieldKeyField } from '../managers/classifications.generated.js'; -import { CreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField } from '../managers/classifications.generated.js'; -import { ClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; -import { AddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; import { UpdateClassificationRequestBodyArg } from '../managers/classifications.generated.js'; import { UpdateClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; import { UpdateClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; import { UpdateClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; import { UpdateClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; import { UpdateClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; +import { ClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; -import { uploadNewFile } from './commons.generated.js'; +import { getOrCreateClassificationTemplate } from './commons.generated.js'; +import { getOrCreateClassification } from './commons.generated.js'; import { ClassificationTemplate } from '../schemas.generated.js'; import { SerializedData } from '../json.js'; import { sdIsEmpty } from '../json.js'; @@ -76,63 +35,12 @@ import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; const client: BoxClient = getDefaultClient(); -export async function getOrCreateClassificationTemplate(): Promise { - try { - return await client.classifications.getClassificationTemplate(); - } catch (error) { - return await client.classifications.createClassificationTemplate({ - scope: - 'enterprise' as CreateClassificationTemplateRequestBodyArgScopeField, - displayName: - 'Classification' as CreateClassificationTemplateRequestBodyArgDisplayNameField, - templateKey: - 'securityClassification-6VMVochwUWo' as CreateClassificationTemplateRequestBodyArgTemplateKeyField, - fields: [ - { - type: 'enum' as CreateClassificationTemplateRequestBodyArgFieldsFieldTypeField, - key: 'Box__Security__Classification__Key' as CreateClassificationTemplateRequestBodyArgFieldsFieldKeyField, - displayName: - 'Classification' as CreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField, - options: [], - } satisfies CreateClassificationTemplateRequestBodyArgFieldsField, - ], - } satisfies CreateClassificationTemplateRequestBodyArg); - } finally { - } -} -export async function getOrCreateClassification( - classificationTemplate: ClassificationTemplate -): Promise { - const classifications: readonly ClassificationTemplateFieldsFieldOptionsField[] = - classificationTemplate.fields[0].options; - const currentNumberOfClassifications: number = classifications.length; - if (currentNumberOfClassifications == 0) { - const classificationTemplateWithNewClassification: ClassificationTemplate = - await client.classifications.addClassification([ - { - op: 'addEnumOption' as AddClassificationRequestBodyArgOpField, - fieldKey: - 'Box__Security__Classification__Key' as AddClassificationRequestBodyArgFieldKeyField, - data: { - key: getUuid(), - staticConfig: { - classification: { - colorId: 3, - classificationDefinition: 'Some description', - } satisfies AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField, - } satisfies AddClassificationRequestBodyArgDataFieldStaticConfigField, - } satisfies AddClassificationRequestBodyArgDataField, - } satisfies AddClassificationRequestBodyArg, - ]); - return classificationTemplateWithNewClassification.fields[0].options[0]; - } - return classifications[currentNumberOfClassifications - 1]; -} test('testClassifications', async function testClassifications(): Promise { const classificationTemplate: ClassificationTemplate = await getOrCreateClassificationTemplate(); - const classification: ClassificationTemplateFieldsFieldOptionsField = - await getOrCreateClassification(classificationTemplate); + const classification: any = await getOrCreateClassification( + classificationTemplate + ); if (!!(classification.key == '')) { throw 'Assertion failed'; } @@ -169,10 +77,7 @@ test('testClassifications', async function testClassifications(): Promise { ]); const updatedClassifications: readonly ClassificationTemplateFieldsFieldOptionsField[] = classificationTemplateWithUpdatedClassification.fields[0].options; - const numberOfClassificationsAfterUpdate: number = - updatedClassifications.length; - const updatedClassification: ClassificationTemplateFieldsFieldOptionsField = - updatedClassifications[numberOfClassificationsAfterUpdate - 1]; + const updatedClassification: any = updatedClassifications[0]; if (!(updatedClassification.key == updatedClassificationName)) { throw 'Assertion failed'; } diff --git a/src/test/collaborationAllowlistEntries.generated.test.ts b/src/test/collaborationAllowlistEntries.generated.test.ts index 82682e03..b1bded23 100644 --- a/src/test/collaborationAllowlistEntries.generated.test.ts +++ b/src/test/collaborationAllowlistEntries.generated.test.ts @@ -57,7 +57,7 @@ test('collaborationAllowlistEntries', async function collaborationAllowlistEntri await client.collaborationAllowlistEntries.deleteCollaborationWhitelistEntryById( entry.id! ); - expect(async () => { + await expect(async () => { await client.collaborationAllowlistEntries.getCollaborationWhitelistEntryById( entry.id! ); diff --git a/src/test/collaborationAllowlistExemptTargets.generated.test.ts b/src/test/collaborationAllowlistExemptTargets.generated.test.ts index f28fdbd4..3ec1c25d 100644 --- a/src/test/collaborationAllowlistExemptTargets.generated.test.ts +++ b/src/test/collaborationAllowlistExemptTargets.generated.test.ts @@ -72,7 +72,7 @@ test('collaborationAllowlistExemptTargets', async function collaborationAllowlis await client.collaborationAllowlistExemptTargets.deleteCollaborationWhitelistExemptTargetById( exemptTarget.id! ); - expect(async () => { + await expect(async () => { await client.collaborationAllowlistExemptTargets.getCollaborationWhitelistExemptTargetById( exemptTarget.id! ); diff --git a/src/test/comments.generated.test.ts b/src/test/comments.generated.test.ts index 78dea1b8..fbed8b64 100644 --- a/src/test/comments.generated.test.ts +++ b/src/test/comments.generated.test.ts @@ -106,7 +106,7 @@ test('comments', async function comments(): Promise { throw 'Assertion failed'; } await client.comments.deleteCommentById(newComment.id!); - expect(async () => { + await expect(async () => { await client.comments.getCommentById(newComment.id!); }).rejects.toThrow(); await client.files.deleteFileById(fileId); diff --git a/src/test/commons.generated.ts b/src/test/commons.generated.ts index c67e88ac..06ee8fca 100644 --- a/src/test/commons.generated.ts +++ b/src/test/commons.generated.ts @@ -12,6 +12,36 @@ import { serializeUploadFileRequestBodyArgAttributesField } from '../managers/up import { deserializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; import { serializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; import { deserializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { serializeClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; +import { deserializeClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; +import { serializeAddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; +import { serializeCreateClassificationTemplateRequestBodyArg } from '../managers/classifications.generated.js'; +import { deserializeCreateClassificationTemplateRequestBodyArg } from '../managers/classifications.generated.js'; +import { serializeCreateClassificationTemplateRequestBodyArgScopeField } from '../managers/classifications.generated.js'; +import { deserializeCreateClassificationTemplateRequestBodyArgScopeField } from '../managers/classifications.generated.js'; +import { serializeCreateClassificationTemplateRequestBodyArgDisplayNameField } from '../managers/classifications.generated.js'; +import { deserializeCreateClassificationTemplateRequestBodyArgDisplayNameField } from '../managers/classifications.generated.js'; +import { serializeCreateClassificationTemplateRequestBodyArgTemplateKeyField } from '../managers/classifications.generated.js'; +import { deserializeCreateClassificationTemplateRequestBodyArgTemplateKeyField } from '../managers/classifications.generated.js'; +import { serializeCreateClassificationTemplateRequestBodyArgFieldsField } from '../managers/classifications.generated.js'; +import { deserializeCreateClassificationTemplateRequestBodyArgFieldsField } from '../managers/classifications.generated.js'; +import { serializeCreateClassificationTemplateRequestBodyArgFieldsFieldTypeField } from '../managers/classifications.generated.js'; +import { deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldTypeField } from '../managers/classifications.generated.js'; +import { serializeCreateClassificationTemplateRequestBodyArgFieldsFieldKeyField } from '../managers/classifications.generated.js'; +import { deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldKeyField } from '../managers/classifications.generated.js'; +import { serializeCreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField } from '../managers/classifications.generated.js'; +import { deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField } from '../managers/classifications.generated.js'; import { serializeShieldInformationBarrier } from '../schemas.generated.js'; import { deserializeShieldInformationBarrier } from '../schemas.generated.js'; import { serializeShieldInformationBarriers } from '../schemas.generated.js'; @@ -22,6 +52,8 @@ import { serializeEnterpriseBase } from '../schemas.generated.js'; import { deserializeEnterpriseBase } from '../schemas.generated.js'; import { serializeEnterpriseBaseTypeField } from '../schemas.generated.js'; import { deserializeEnterpriseBaseTypeField } from '../schemas.generated.js'; +import { serializeClassificationTemplate } from '../schemas.generated.js'; +import { deserializeClassificationTemplate } from '../schemas.generated.js'; import { FolderFull } from '../schemas.generated.js'; import { CreateFolderRequestBodyArg } from '../managers/folders.generated.js'; import { CreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; @@ -31,6 +63,21 @@ import { Files } from '../schemas.generated.js'; import { UploadFileRequestBodyArg } from '../managers/uploads.generated.js'; import { UploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; import { UploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { ClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; +import { AddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; +import { CreateClassificationTemplateRequestBodyArg } from '../managers/classifications.generated.js'; +import { CreateClassificationTemplateRequestBodyArgScopeField } from '../managers/classifications.generated.js'; +import { CreateClassificationTemplateRequestBodyArgDisplayNameField } from '../managers/classifications.generated.js'; +import { CreateClassificationTemplateRequestBodyArgTemplateKeyField } from '../managers/classifications.generated.js'; +import { CreateClassificationTemplateRequestBodyArgFieldsField } from '../managers/classifications.generated.js'; +import { CreateClassificationTemplateRequestBodyArgFieldsFieldTypeField } from '../managers/classifications.generated.js'; +import { CreateClassificationTemplateRequestBodyArgFieldsFieldKeyField } from '../managers/classifications.generated.js'; +import { CreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField } from '../managers/classifications.generated.js'; import { ShieldInformationBarrier } from '../schemas.generated.js'; import { ShieldInformationBarriers } from '../schemas.generated.js'; import { CreateShieldInformationBarrierRequestBodyArg } from '../managers/shieldInformationBarriers.generated.js'; @@ -41,6 +88,7 @@ import { getEnvVar } from '../utils.js'; import { getUuid } from '../utils.js'; import { generateByteStream } from '../utils.js'; import { BoxClient } from '../client.generated.js'; +import { ClassificationTemplate } from '../schemas.generated.js'; import { BoxJwtAuth } from '../jwtAuth.js'; import { JwtConfig } from '../jwtAuth.js'; import { SerializedData } from '../json.js'; @@ -91,6 +139,60 @@ export async function uploadNewFile(): Promise { } satisfies UploadFileRequestBodyArg); return uploadedFiles.entries![0]; } +export async function getOrCreateClassification( + classificationTemplate: ClassificationTemplate +): Promise { + const client: BoxClient = getDefaultClient(); + const classifications: readonly ClassificationTemplateFieldsFieldOptionsField[] = + classificationTemplate.fields[0].options; + const currentNumberOfClassifications: number = classifications.length; + if (currentNumberOfClassifications == 0) { + const classificationTemplateWithNewClassification: ClassificationTemplate = + await client.classifications.addClassification([ + { + op: 'addEnumOption' as AddClassificationRequestBodyArgOpField, + fieldKey: + 'Box__Security__Classification__Key' as AddClassificationRequestBodyArgFieldKeyField, + data: { + key: getUuid(), + staticConfig: { + classification: { + colorId: 3, + classificationDefinition: 'Some description', + } satisfies AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField, + } satisfies AddClassificationRequestBodyArgDataFieldStaticConfigField, + } satisfies AddClassificationRequestBodyArgDataField, + } satisfies AddClassificationRequestBodyArg, + ]); + return classificationTemplateWithNewClassification.fields[0].options[0]; + } + return classifications[0]; +} +export async function getOrCreateClassificationTemplate(): Promise { + const client: BoxClient = getDefaultClient(); + try { + return await client.classifications.getClassificationTemplate(); + } catch (error) { + return await client.classifications.createClassificationTemplate({ + scope: + 'enterprise' as CreateClassificationTemplateRequestBodyArgScopeField, + displayName: + 'Classification' as CreateClassificationTemplateRequestBodyArgDisplayNameField, + templateKey: + 'securityClassification-6VMVochwUWo' as CreateClassificationTemplateRequestBodyArgTemplateKeyField, + fields: [ + { + type: 'enum' as CreateClassificationTemplateRequestBodyArgFieldsFieldTypeField, + key: 'Box__Security__Classification__Key' as CreateClassificationTemplateRequestBodyArgFieldsFieldKeyField, + displayName: + 'Classification' as CreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField, + options: [], + } satisfies CreateClassificationTemplateRequestBodyArgFieldsField, + ], + } satisfies CreateClassificationTemplateRequestBodyArg); + } finally { + } +} export async function getOrCreateShieldInformationBarrier( client: BoxClient, enterpriseId: string diff --git a/src/test/fileClassifications.generated.test.ts b/src/test/fileClassifications.generated.test.ts new file mode 100644 index 00000000..35c0d7cc --- /dev/null +++ b/src/test/fileClassifications.generated.test.ts @@ -0,0 +1,139 @@ +import { serializeClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; +import { deserializeClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; +import { serializeAddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; +import { serializeFileFull } from '../schemas.generated.js'; +import { deserializeFileFull } from '../schemas.generated.js'; +import { serializeClassification } from '../schemas.generated.js'; +import { deserializeClassification } from '../schemas.generated.js'; +import { serializeAddClassificationToFileRequestBodyArg } from '../managers/fileClassifications.generated.js'; +import { deserializeAddClassificationToFileRequestBodyArg } from '../managers/fileClassifications.generated.js'; +import { serializeUpdateClassificationOnFileRequestBodyArg } from '../managers/fileClassifications.generated.js'; +import { deserializeUpdateClassificationOnFileRequestBodyArg } from '../managers/fileClassifications.generated.js'; +import { serializeUpdateClassificationOnFileRequestBodyArgOpField } from '../managers/fileClassifications.generated.js'; +import { deserializeUpdateClassificationOnFileRequestBodyArgOpField } from '../managers/fileClassifications.generated.js'; +import { serializeUpdateClassificationOnFileRequestBodyArgPathField } from '../managers/fileClassifications.generated.js'; +import { deserializeUpdateClassificationOnFileRequestBodyArgPathField } from '../managers/fileClassifications.generated.js'; +import { serializeClassificationTemplate } from '../schemas.generated.js'; +import { deserializeClassificationTemplate } from '../schemas.generated.js'; +import { BoxClient } from '../client.generated.js'; +import { ClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; +import { AddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; +import { FileFull } from '../schemas.generated.js'; +import { Classification } from '../schemas.generated.js'; +import { AddClassificationToFileRequestBodyArg } from '../managers/fileClassifications.generated.js'; +import { UpdateClassificationOnFileRequestBodyArg } from '../managers/fileClassifications.generated.js'; +import { UpdateClassificationOnFileRequestBodyArgOpField } from '../managers/fileClassifications.generated.js'; +import { UpdateClassificationOnFileRequestBodyArgPathField } from '../managers/fileClassifications.generated.js'; +import { getUuid } from '../utils.js'; +import { getDefaultClient } from './commons.generated.js'; +import { uploadNewFile } from './commons.generated.js'; +import { getOrCreateClassificationTemplate } from './commons.generated.js'; +import { getOrCreateClassification } from './commons.generated.js'; +import { ClassificationTemplate } from '../schemas.generated.js'; +import { SerializedData } from '../json.js'; +import { sdIsEmpty } from '../json.js'; +import { sdIsBoolean } from '../json.js'; +import { sdIsNumber } from '../json.js'; +import { sdIsString } from '../json.js'; +import { sdIsList } from '../json.js'; +import { sdIsMap } from '../json.js'; +const client: BoxClient = getDefaultClient(); +export async function getOrCreateSecondClassification( + classificationTemplate: ClassificationTemplate +): Promise { + const classifications: readonly ClassificationTemplateFieldsFieldOptionsField[] = + classificationTemplate.fields[0].options; + const currentNumberOfClassifications: number = classifications.length; + if (currentNumberOfClassifications == 1) { + const classificationTemplateWithNewClassification: ClassificationTemplate = + await client.classifications.addClassification([ + { + op: 'addEnumOption' as AddClassificationRequestBodyArgOpField, + fieldKey: + 'Box__Security__Classification__Key' as AddClassificationRequestBodyArgFieldKeyField, + data: { + key: getUuid(), + staticConfig: { + classification: { + colorId: 4, + classificationDefinition: 'Other description', + } satisfies AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField, + } satisfies AddClassificationRequestBodyArgDataFieldStaticConfigField, + } satisfies AddClassificationRequestBodyArgDataField, + } satisfies AddClassificationRequestBodyArg, + ]); + return classificationTemplateWithNewClassification.fields[0].options[1]; + } + return classifications[1]; +} +test('testFileClassifications', async function testFileClassifications(): Promise { + const classificationTemplate: ClassificationTemplate = + await getOrCreateClassificationTemplate(); + const classification: any = await getOrCreateClassification( + classificationTemplate + ); + const file: FileFull = await uploadNewFile(); + await expect(async () => { + await client.fileClassifications.getClassificationOnFile(file.id); + }).rejects.toThrow(); + const createdFileClassification: Classification = + await client.fileClassifications.addClassificationToFile(file.id, { + boxSecurityClassificationKey: classification.key, + } satisfies AddClassificationToFileRequestBodyArg); + if ( + !( + createdFileClassification.boxSecurityClassificationKey == + classification.key + ) + ) { + throw 'Assertion failed'; + } + const fileClassification: Classification = + await client.fileClassifications.getClassificationOnFile(file.id); + if ( + !(fileClassification.boxSecurityClassificationKey == classification.key) + ) { + throw 'Assertion failed'; + } + const secondClassification: any = await getOrCreateSecondClassification( + classificationTemplate + ); + const updatedFileClassification: Classification = + await client.fileClassifications.updateClassificationOnFile(file.id, [ + { + op: 'replace' as UpdateClassificationOnFileRequestBodyArgOpField, + path: '/Box__Security__Classification__Key' as UpdateClassificationOnFileRequestBodyArgPathField, + value: secondClassification.key, + } satisfies UpdateClassificationOnFileRequestBodyArg, + ]); + if ( + !( + updatedFileClassification.boxSecurityClassificationKey == + secondClassification.key + ) + ) { + throw 'Assertion failed'; + } + await client.fileClassifications.deleteClassificationFromFile(file.id); + await expect(async () => { + await client.fileClassifications.getClassificationOnFile(file.id); + }).rejects.toThrow(); + await client.files.deleteFileById(file.id); +}); +export {}; diff --git a/src/test/fileMetadata.generated.test.ts b/src/test/fileMetadata.generated.test.ts index 0f0b615b..8a1364ba 100644 --- a/src/test/fileMetadata.generated.test.ts +++ b/src/test/fileMetadata.generated.test.ts @@ -96,7 +96,7 @@ test('testFileMetadata', async function testFileMetadata(): Promise { 'global' as DeleteFileMetadataByIdScopeArg, 'properties' ); - expect(async () => { + await expect(async () => { await client.fileMetadata.getFileMetadataById( file.id, 'global' as GetFileMetadataByIdScopeArg, diff --git a/src/test/fileRequests.generated.test.ts b/src/test/fileRequests.generated.test.ts index 484bf637..b7ad9d8b 100644 --- a/src/test/fileRequests.generated.test.ts +++ b/src/test/fileRequests.generated.test.ts @@ -69,7 +69,7 @@ test('testGetCopyUpdateDeleteFileRequest', async function testGetCopyUpdateDelet throw 'Assertion failed'; } await client.fileRequests.deleteFileRequestById(updatedFileRequest.id); - expect(async () => { + await expect(async () => { await client.fileRequests.getFileRequestById(updatedFileRequest.id); }).rejects.toThrow(); }); diff --git a/src/test/fileWatermarks.generated.test.ts b/src/test/fileWatermarks.generated.test.ts index 73eff9b4..4eec4ebe 100644 --- a/src/test/fileWatermarks.generated.test.ts +++ b/src/test/fileWatermarks.generated.test.ts @@ -58,7 +58,7 @@ test('testCreateGetDeleteFileWatermark', async function testCreateGetDeleteFileW file.id ); await client.fileWatermarks.deleteFileWatermark(file.id); - expect(async () => { + await expect(async () => { await client.fileWatermarks.getFileWatermark(file.id); }).rejects.toThrow(); await client.files.deleteFileById(file.id); diff --git a/src/test/files.generated.test.ts b/src/test/files.generated.test.ts index 1a3da1dc..90e7e267 100644 --- a/src/test/files.generated.test.ts +++ b/src/test/files.generated.test.ts @@ -106,7 +106,7 @@ test('testCreateGetAndDeleteFile', async function testCreateGetAndDeleteFile(): updatedContentStream ); const file: FileFull = await client.files.getFileById(uploadedFile.id); - expect(async () => { + await expect(async () => { await client.files.getFileById( uploadedFile.id, { fields: ['name' as ''] } satisfies GetFileByIdQueryParamsArg, diff --git a/src/test/folderClassifications.generated.test.ts b/src/test/folderClassifications.generated.test.ts new file mode 100644 index 00000000..d450c57e --- /dev/null +++ b/src/test/folderClassifications.generated.test.ts @@ -0,0 +1,139 @@ +import { serializeClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; +import { deserializeClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; +import { serializeAddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; +import { serializeFolderFull } from '../schemas.generated.js'; +import { deserializeFolderFull } from '../schemas.generated.js'; +import { serializeClassification } from '../schemas.generated.js'; +import { deserializeClassification } from '../schemas.generated.js'; +import { serializeAddClassificationToFolderRequestBodyArg } from '../managers/folderClassifications.generated.js'; +import { deserializeAddClassificationToFolderRequestBodyArg } from '../managers/folderClassifications.generated.js'; +import { serializeUpdateClassificationOnFolderRequestBodyArg } from '../managers/folderClassifications.generated.js'; +import { deserializeUpdateClassificationOnFolderRequestBodyArg } from '../managers/folderClassifications.generated.js'; +import { serializeUpdateClassificationOnFolderRequestBodyArgOpField } from '../managers/folderClassifications.generated.js'; +import { deserializeUpdateClassificationOnFolderRequestBodyArgOpField } from '../managers/folderClassifications.generated.js'; +import { serializeUpdateClassificationOnFolderRequestBodyArgPathField } from '../managers/folderClassifications.generated.js'; +import { deserializeUpdateClassificationOnFolderRequestBodyArgPathField } from '../managers/folderClassifications.generated.js'; +import { serializeClassificationTemplate } from '../schemas.generated.js'; +import { deserializeClassificationTemplate } from '../schemas.generated.js'; +import { BoxClient } from '../client.generated.js'; +import { ClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; +import { AddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; +import { FolderFull } from '../schemas.generated.js'; +import { Classification } from '../schemas.generated.js'; +import { AddClassificationToFolderRequestBodyArg } from '../managers/folderClassifications.generated.js'; +import { UpdateClassificationOnFolderRequestBodyArg } from '../managers/folderClassifications.generated.js'; +import { UpdateClassificationOnFolderRequestBodyArgOpField } from '../managers/folderClassifications.generated.js'; +import { UpdateClassificationOnFolderRequestBodyArgPathField } from '../managers/folderClassifications.generated.js'; +import { getUuid } from '../utils.js'; +import { getDefaultClient } from './commons.generated.js'; +import { createNewFolder } from './commons.generated.js'; +import { getOrCreateClassificationTemplate } from './commons.generated.js'; +import { getOrCreateClassification } from './commons.generated.js'; +import { ClassificationTemplate } from '../schemas.generated.js'; +import { SerializedData } from '../json.js'; +import { sdIsEmpty } from '../json.js'; +import { sdIsBoolean } from '../json.js'; +import { sdIsNumber } from '../json.js'; +import { sdIsString } from '../json.js'; +import { sdIsList } from '../json.js'; +import { sdIsMap } from '../json.js'; +const client: BoxClient = getDefaultClient(); +export async function getOrCreateSecondClassification( + classificationTemplate: ClassificationTemplate +): Promise { + const classifications: readonly ClassificationTemplateFieldsFieldOptionsField[] = + classificationTemplate.fields[0].options; + const currentNumberOfClassifications: number = classifications.length; + if (currentNumberOfClassifications == 1) { + const classificationTemplateWithNewClassification: ClassificationTemplate = + await client.classifications.addClassification([ + { + op: 'addEnumOption' as AddClassificationRequestBodyArgOpField, + fieldKey: + 'Box__Security__Classification__Key' as AddClassificationRequestBodyArgFieldKeyField, + data: { + key: getUuid(), + staticConfig: { + classification: { + colorId: 4, + classificationDefinition: 'Other description', + } satisfies AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField, + } satisfies AddClassificationRequestBodyArgDataFieldStaticConfigField, + } satisfies AddClassificationRequestBodyArgDataField, + } satisfies AddClassificationRequestBodyArg, + ]); + return classificationTemplateWithNewClassification.fields[0].options[1]; + } + return classifications[1]; +} +test('testFolderClassifications', async function testFolderClassifications(): Promise { + const classificationTemplate: ClassificationTemplate = + await getOrCreateClassificationTemplate(); + const classification: any = await getOrCreateClassification( + classificationTemplate + ); + const folder: FolderFull = await createNewFolder(); + await expect(async () => { + await client.folderClassifications.getClassificationOnFolder(folder.id); + }).rejects.toThrow(); + const createdFolderClassification: Classification = + await client.folderClassifications.addClassificationToFolder(folder.id, { + boxSecurityClassificationKey: classification.key, + } satisfies AddClassificationToFolderRequestBodyArg); + if ( + !( + createdFolderClassification.boxSecurityClassificationKey == + classification.key + ) + ) { + throw 'Assertion failed'; + } + const folderClassification: Classification = + await client.folderClassifications.getClassificationOnFolder(folder.id); + if ( + !(folderClassification.boxSecurityClassificationKey == classification.key) + ) { + throw 'Assertion failed'; + } + const secondClassification: any = await getOrCreateSecondClassification( + classificationTemplate + ); + const updatedFolderClassification: Classification = + await client.folderClassifications.updateClassificationOnFolder(folder.id, [ + { + op: 'replace' as UpdateClassificationOnFolderRequestBodyArgOpField, + path: '/Box__Security__Classification__Key' as UpdateClassificationOnFolderRequestBodyArgPathField, + value: secondClassification.key, + } satisfies UpdateClassificationOnFolderRequestBodyArg, + ]); + if ( + !( + updatedFolderClassification.boxSecurityClassificationKey == + secondClassification.key + ) + ) { + throw 'Assertion failed'; + } + await client.folderClassifications.deleteClassificationFromFolder(folder.id); + await expect(async () => { + await client.folderClassifications.getClassificationOnFolder(folder.id); + }).rejects.toThrow(); + await client.folders.deleteFolderById(folder.id); +}); +export {}; diff --git a/src/test/folderLocks.generated.test.ts b/src/test/folderLocks.generated.test.ts index 8d052223..d0232141 100644 --- a/src/test/folderLocks.generated.test.ts +++ b/src/test/folderLocks.generated.test.ts @@ -57,7 +57,7 @@ test('testFolderLocks', async function testFolderLocks(): Promise { throw 'Assertion failed'; } await client.folderLocks.deleteFolderLockById(folderLock.id!); - expect(async () => { + await expect(async () => { await client.folderLocks.deleteFolderLockById(folderLock.id!); }).rejects.toThrow(); const newFolderLocks: FolderLocks = await client.folderLocks.getFolderLocks({ diff --git a/src/test/folderMetadata.generated.test.ts b/src/test/folderMetadata.generated.test.ts index 4c909c05..fe59ff70 100644 --- a/src/test/folderMetadata.generated.test.ts +++ b/src/test/folderMetadata.generated.test.ts @@ -100,7 +100,7 @@ test('testFolderMetadata', async function testFolderMetadata(): Promise { 'global' as DeleteFolderMetadataByIdScopeArg, 'properties' ); - expect(async () => { + await expect(async () => { await client.folderMetadata.getFolderMetadataById( folder.id, 'global' as GetFolderMetadataByIdScopeArg, diff --git a/src/test/folderWatermarks.generated.test.ts b/src/test/folderWatermarks.generated.test.ts index c9d20573..299ffe2d 100644 --- a/src/test/folderWatermarks.generated.test.ts +++ b/src/test/folderWatermarks.generated.test.ts @@ -47,7 +47,7 @@ test('testCreateGetDeleteFolderWatermark', async function testCreateGetDeleteFol folder.id ); await client.folderWatermarks.deleteFolderWatermark(folder.id); - expect(async () => { + await expect(async () => { await client.folderWatermarks.getFolderWatermark(folder.id); }).rejects.toThrow(); await client.folders.deleteFolderById(folder.id); diff --git a/src/test/folders.generated.test.ts b/src/test/folders.generated.test.ts index 51cb8e79..a29c69e8 100644 --- a/src/test/folders.generated.test.ts +++ b/src/test/folders.generated.test.ts @@ -71,7 +71,7 @@ test('test_create_and_delete_folder', async function test_create_and_delete_fold throw 'Assertion failed'; } await client.folders.deleteFolderById(newFolder.id); - expect(async () => { + await expect(async () => { await client.folders.getFolderById(newFolder.id); }).rejects.toThrow(); }); diff --git a/src/test/groups.generated.test.ts b/src/test/groups.generated.test.ts index b74367f4..acddab2d 100644 --- a/src/test/groups.generated.test.ts +++ b/src/test/groups.generated.test.ts @@ -56,7 +56,7 @@ test('test_create_get_delete_group', async function test_create_get_delete_group throw 'Assertion failed'; } await client.groups.deleteGroupById(group.id); - expect(async () => { + await expect(async () => { await client.groups.getGroupById(group.id); }).rejects.toThrow(); }); diff --git a/src/test/memberships.generated.test.ts b/src/test/memberships.generated.test.ts index 9cd09466..6b4ff458 100644 --- a/src/test/memberships.generated.test.ts +++ b/src/test/memberships.generated.test.ts @@ -96,7 +96,7 @@ test('testMemberships', async function testMemberships(): Promise { throw 'Assertion failed'; } await client.memberships.deleteGroupMembershipById(groupMembership.id!); - expect(async () => { + await expect(async () => { await client.memberships.getGroupMembershipById(groupMembership.id!); }).rejects.toThrow(); await client.groups.deleteGroupById(group.id); diff --git a/src/test/metadataCascadePolicies.generated.test.ts b/src/test/metadataCascadePolicies.generated.test.ts index f46f9671..6d931072 100644 --- a/src/test/metadataCascadePolicies.generated.test.ts +++ b/src/test/metadataCascadePolicies.generated.test.ts @@ -120,7 +120,7 @@ test('testMetadataCascadePolicies', async function testMetadataCascadePolicies() if (!(policies.entries!.length == 1)) { throw 'Assertion failed'; } - expect(async () => { + await expect(async () => { await client.metadataCascadePolicies.createMetadataCascadePolicyApply( cascadePolicyId, { @@ -148,7 +148,7 @@ test('testMetadataCascadePolicies', async function testMetadataCascadePolicies() await client.metadataCascadePolicies.deleteMetadataCascadePolicyById( cascadePolicyId ); - expect(async () => { + await expect(async () => { await client.metadataCascadePolicies.getMetadataCascadePolicyById( cascadePolicyId ); diff --git a/src/test/metadataTemplates.generated.test.ts b/src/test/metadataTemplates.generated.test.ts index 4579bba4..6ae1ab22 100644 --- a/src/test/metadataTemplates.generated.test.ts +++ b/src/test/metadataTemplates.generated.test.ts @@ -130,7 +130,7 @@ test('testMetadataTemplates', async function testMetadataTemplates(): Promise { + await expect(async () => { await client.metadataTemplates.deleteMetadataTemplate( 'enterprise' as DeleteMetadataTemplateScopeArg, template.templateKey! diff --git a/src/test/sharedLinksFiles.generated.test.ts b/src/test/sharedLinksFiles.generated.test.ts index 3d5edd91..6b591d69 100644 --- a/src/test/sharedLinksFiles.generated.test.ts +++ b/src/test/sharedLinksFiles.generated.test.ts @@ -95,7 +95,7 @@ test('testSharedLinksFiles', async function testSharedLinksFiles(): Promise if (!(fileId == fileFromSharedLinkPassword.id)) { throw 'Assertion failed'; } - expect(async () => { + await expect(async () => { await userClient.sharedLinksFiles.getSharedItems( {} satisfies GetSharedItemsQueryParamsArg, new GetSharedItemsHeadersArg({ diff --git a/src/test/sharedLinksFolders.generated.test.ts b/src/test/sharedLinksFolders.generated.test.ts index 1840721e..3c07bf60 100644 --- a/src/test/sharedLinksFolders.generated.test.ts +++ b/src/test/sharedLinksFolders.generated.test.ts @@ -85,7 +85,7 @@ test('testSharedLinksFolders', async function testSharedLinksFolders(): Promise< if (!(folder.id == folderFromSharedLinkPassword.id)) { throw 'Assertion failed'; } - expect(async () => { + await expect(async () => { await userClient.sharedLinksFolders.getSharedItemFolders( {} satisfies GetSharedItemFoldersQueryParamsArg, new GetSharedItemFoldersHeadersArg({ diff --git a/src/test/sharedLinksWebLinks.generated.test.ts b/src/test/sharedLinksWebLinks.generated.test.ts index bd222abe..a9927c36 100644 --- a/src/test/sharedLinksWebLinks.generated.test.ts +++ b/src/test/sharedLinksWebLinks.generated.test.ts @@ -92,7 +92,7 @@ test('testSharedLinksWebLinks', async function testSharedLinksWebLinks(): Promis if (!(webLinkId == webLinkFromSharedLinkPassword.id)) { throw 'Assertion failed'; } - expect(async () => { + await expect(async () => { await userClient.sharedLinksWebLinks.getSharedItemWebLinks( {} satisfies GetSharedItemWebLinksQueryParamsArg, new GetSharedItemWebLinksHeadersArg({ diff --git a/src/test/shieldInformationBarrierSegmentMembers.generated.test.ts b/src/test/shieldInformationBarrierSegmentMembers.generated.test.ts index c92b1d56..42e187ef 100644 --- a/src/test/shieldInformationBarrierSegmentMembers.generated.test.ts +++ b/src/test/shieldInformationBarrierSegmentMembers.generated.test.ts @@ -105,7 +105,7 @@ test('testShieldInformationBarrierSegmentMembers', async function testShieldInfo await client.shieldInformationBarrierSegmentMembers.deleteShieldInformationBarrierSegmentMemberById( segmentMember.id! ); - expect(async () => { + await expect(async () => { await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMemberById( segmentMember.id! ); diff --git a/src/test/shieldInformationBarrierSegmentRestrictions.generated.test.ts b/src/test/shieldInformationBarrierSegmentRestrictions.generated.test.ts index 9d5d5fc1..2f4d0505 100644 --- a/src/test/shieldInformationBarrierSegmentRestrictions.generated.test.ts +++ b/src/test/shieldInformationBarrierSegmentRestrictions.generated.test.ts @@ -130,7 +130,7 @@ test('testShieldInformationBarrierSegmentRestrictions', async function testShiel await client.shieldInformationBarrierSegmentRestrictions.deleteShieldInformationBarrierSegmentRestrictionById( segmentRestrictionId ); - expect(async () => { + await expect(async () => { await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictionById( segmentRestrictionId ); diff --git a/src/test/shieldInformationBarrierSegments.generated.test.ts b/src/test/shieldInformationBarrierSegments.generated.test.ts index 8df4ecc7..169619dc 100644 --- a/src/test/shieldInformationBarrierSegments.generated.test.ts +++ b/src/test/shieldInformationBarrierSegments.generated.test.ts @@ -105,7 +105,7 @@ test('testShieldInformationBarrierSegments', async function testShieldInformatio await client.shieldInformationBarrierSegments.deleteShieldInformationBarrierSegmentById( segmentId ); - expect(async () => { + await expect(async () => { await client.shieldInformationBarrierSegments.getShieldInformationBarrierSegmentById( segmentId ); diff --git a/src/test/shieldInformationBarriers.generated.test.ts b/src/test/shieldInformationBarriers.generated.test.ts index d86eb35d..d4af87cb 100644 --- a/src/test/shieldInformationBarriers.generated.test.ts +++ b/src/test/shieldInformationBarriers.generated.test.ts @@ -53,7 +53,7 @@ test('testShieldInformationBarriers', async function testShieldInformationBarrie if (!(barriers.entries!.length == 1)) { throw 'Assertion failed'; } - expect(async () => { + await expect(async () => { await client.shieldInformationBarriers.createShieldInformationBarrierChangeStatus( { id: barrierId, diff --git a/src/test/trashedFiles.generated.test.ts b/src/test/trashedFiles.generated.test.ts index e513de8e..055341b0 100644 --- a/src/test/trashedFiles.generated.test.ts +++ b/src/test/trashedFiles.generated.test.ts @@ -72,7 +72,7 @@ test('testTrashedFiles', async function testTrashedFiles(): Promise { } await client.files.deleteFileById(file.id); await client.trashedFiles.deleteFileTrash(file.id); - expect(async () => { + await expect(async () => { await client.trashedFiles.getFileTrash(file.id); }).rejects.toThrow(); }); diff --git a/src/test/trashedFolders.generated.test.ts b/src/test/trashedFolders.generated.test.ts index ba1b1af7..2ae6b24b 100644 --- a/src/test/trashedFolders.generated.test.ts +++ b/src/test/trashedFolders.generated.test.ts @@ -39,7 +39,7 @@ test('testTrashedFolders', async function testTrashedFolders(): Promise { if (!(fromTrash.name == folder.name)) { throw 'Assertion failed'; } - expect(async () => { + await expect(async () => { await client.folders.getFolderById(folder.id); }).rejects.toThrow(); const restoredFolder: TrashFolderRestored = @@ -53,7 +53,7 @@ test('testTrashedFolders', async function testTrashedFolders(): Promise { } await client.folders.deleteFolderById(folder.id); await client.trashedFolders.deleteFolderTrash(folder.id); - expect(async () => { + await expect(async () => { await client.trashedFolders.getFolderTrash(folder.id); }).rejects.toThrow(); }); diff --git a/src/test/trashedWebLinks.generated.test.ts b/src/test/trashedWebLinks.generated.test.ts index 0bbd99f0..225416f7 100644 --- a/src/test/trashedWebLinks.generated.test.ts +++ b/src/test/trashedWebLinks.generated.test.ts @@ -67,7 +67,7 @@ test('testTrashedWebLinks', async function testTrashedWebLinks(): Promise { } await client.webLinks.deleteWebLinkById(weblink.id); await client.trashedWebLinks.deleteWebLinkTrash(weblink.id); - expect(async () => { + await expect(async () => { await client.trashedWebLinks.getWebLinkTrash(weblink.id); }).rejects.toThrow(); }); diff --git a/src/test/uploads.generated.test.ts b/src/test/uploads.generated.test.ts index 56a0b394..f2112c54 100644 --- a/src/test/uploads.generated.test.ts +++ b/src/test/uploads.generated.test.ts @@ -70,7 +70,7 @@ test('testRequestCancellation', async function testRequestCancellation(): Promis const fileName: string = getUuid(); const fileByteStream: ByteStream = generateByteStream(fileSize); const cancellationToken: CancellationToken = createTokenAndCancelAfter(1); - expect(async () => { + await expect(async () => { await client.uploads.uploadFile( { attributes: { diff --git a/src/test/userCollaborations.generated.test.ts b/src/test/userCollaborations.generated.test.ts index 295d8406..086c0039 100644 --- a/src/test/userCollaborations.generated.test.ts +++ b/src/test/userCollaborations.generated.test.ts @@ -95,7 +95,7 @@ test('testUserCollaborations', async function testUserCollaborations(): Promise< throw 'Assertion failed'; } await client.userCollaborations.deleteCollaborationById(collaborationId); - expect(async () => { + await expect(async () => { await client.userCollaborations.getCollaborationById(collaborationId); }).rejects.toThrow(); await client.folders.deleteFolderById(folder.id); @@ -143,7 +143,7 @@ test('testExternalUserCollaborations', async function testExternalUserCollaborat throw 'Assertion failed'; } await client.userCollaborations.deleteCollaborationById(collaborationId); - expect(async () => { + await expect(async () => { await client.userCollaborations.getCollaborationById(collaborationId); }).rejects.toThrow(); await client.folders.deleteFolderById(folder.id); diff --git a/src/test/webhooks.generated.test.ts b/src/test/webhooks.generated.test.ts index 0bc0aecd..721356ce 100644 --- a/src/test/webhooks.generated.test.ts +++ b/src/test/webhooks.generated.test.ts @@ -95,7 +95,7 @@ test('testWebhooksCRUD', async function testWebhooksCRUD(): Promise { throw 'Assertion failed'; } await client.webhooks.deleteWebhookById(webhook.id!); - expect(async () => { + await expect(async () => { await client.webhooks.deleteWebhookById(webhook.id!); }).rejects.toThrow(); await client.folders.deleteFolderById(folder.id); From ce3adc3a97f1b18b966fddd9648d3bb49102c521 Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Thu, 14 Dec 2023 05:49:20 -0800 Subject: [PATCH 6/8] generated with codegen at box/box-codegen@efdca9b and spec at box/box-openapi@fc21828 --- docs/client.md | 13 + src/baseUrls.generated.ts | 36 + src/ccgAuth.ts | 7 +- src/client.generated.ts | 21 +- src/jwtAuth.ts | 7 +- src/managers/authorization.generated.ts | 73 +- src/managers/avatars.generated.ts | 52 +- src/managers/chunkedUploads.generated.ts | 187 +- src/managers/classifications.generated.ts | 534 ++-- ...collaborationAllowlistEntries.generated.ts | 109 +- ...orationAllowlistExemptTargets.generated.ts | 114 +- src/managers/collections.generated.ts | 40 +- src/managers/comments.generated.ts | 163 +- src/managers/devicePinners.generated.ts | 70 +- src/managers/downloads.generated.ts | 23 +- src/managers/emailAliases.generated.ts | 70 +- src/managers/events.generated.ts | 61 +- src/managers/fileClassifications.generated.ts | 137 +- src/managers/fileMetadata.generated.ts | 184 +- src/managers/fileRequests.generated.ts | 65 +- .../fileVersionLegalHolds.generated.ts | 42 +- .../fileVersionRetentions.generated.ts | 56 +- src/managers/fileVersions.generated.ts | 144 +- src/managers/fileWatermarks.generated.ts | 116 +- src/managers/files.generated.ts | 352 ++- .../folderClassifications.generated.ts | 135 +- src/managers/folderLocks.generated.ts | 114 +- src/managers/folderMetadata.generated.ts | 182 +- src/managers/folderWatermarks.generated.ts | 112 +- src/managers/folders.generated.ts | 494 ++-- src/managers/groups.generated.ts | 202 +- src/managers/integrationMappings.generated.ts | 119 +- src/managers/invites.generated.ts | 96 +- src/managers/legalHoldPolicies.generated.ts | 118 +- .../legalHoldPolicyAssignments.generated.ts | 180 +- src/managers/listCollaborations.generated.ts | 95 +- src/managers/memberships.generated.ts | 231 +- .../metadataCascadePolicies.generated.ts | 160 +- src/managers/metadataTemplates.generated.ts | 301 +-- src/managers/recentItems.generated.ts | 25 +- src/managers/retentionPolicies.generated.ts | 203 +- .../retentionPolicyAssignments.generated.ts | 205 +- src/managers/search.generated.ts | 155 +- src/managers/sessionTermination.generated.ts | 72 +- src/managers/sharedLinksFiles.generated.ts | 292 ++- src/managers/sharedLinksFolders.generated.ts | 290 ++- src/managers/sharedLinksWebLinks.generated.ts | 294 ++- ...ieldInformationBarrierReports.generated.ts | 56 +- ...ormationBarrierSegmentMembers.generated.ts | 154 +- ...ionBarrierSegmentRestrictions.generated.ts | 188 +- ...eldInformationBarrierSegments.generated.ts | 124 +- .../shieldInformationBarriers.generated.ts | 127 +- src/managers/signRequests.generated.ts | 86 +- src/managers/signTemplates.generated.ts | 42 +- src/managers/skills.generated.ts | 295 ++- src/managers/storagePolicies.generated.ts | 44 +- .../storagePolicyAssignments.generated.ts | 257 +- src/managers/taskAssignments.generated.ts | 196 +- src/managers/tasks.generated.ts | 231 +- .../termsOfServiceUserStatuses.generated.ts | 185 +- src/managers/termsOfServices.generated.ts | 189 +- src/managers/transfer.generated.ts | 61 +- src/managers/trashedFiles.generated.ts | 94 +- src/managers/trashedFolders.generated.ts | 92 +- src/managers/trashedItems.generated.ts | 58 +- src/managers/trashedWebLinks.generated.ts | 94 +- src/managers/uploads.generated.ts | 162 +- src/managers/userCollaborations.generated.ts | 267 +- src/managers/users.generated.ts | 259 +- src/managers/webLinks.generated.ts | 180 +- src/managers/webhooks.generated.ts | 252 +- src/managers/workflows.generated.ts | 245 +- src/managers/zipDownloads.generated.ts | 64 +- src/network.ts | 14 +- src/oauth.generated.ts | 38 +- src/schemas.generated.ts | 2294 ++++++++--------- src/test/auth.generated.test.ts | 36 +- src/test/avatars.generated.test.ts | 4 +- src/test/classifications.generated.test.ts | 56 +- src/test/client.generated.test.ts | 10 +- ...borationAllowlistEntries.generated.test.ts | 8 +- ...onAllowlistExemptTargets.generated.test.ts | 24 +- src/test/collections.generated.test.ts | 34 +- src/test/comments.generated.test.ts | 58 +- src/test/commons.generated.ts | 167 +- src/test/downloads.generated.test.ts | 22 +- src/test/emailAliases.generated.test.ts | 16 +- .../fileClassifications.generated.test.ts | 88 +- src/test/fileMetadata.generated.test.ts | 52 +- src/test/fileRequests.generated.test.ts | 8 +- src/test/fileVersions.generated.test.ts | 50 +- src/test/fileWatermarks.generated.test.ts | 46 +- src/test/files.generated.test.ts | 66 +- .../folderClassifications.generated.test.ts | 88 +- src/test/folderLocks.generated.test.ts | 30 +- src/test/folderMetadata.generated.test.ts | 52 +- src/test/folderWatermarks.generated.test.ts | 40 +- src/test/folders.generated.test.ts | 62 +- src/test/groups.generated.test.ts | 20 +- src/test/invites.generated.test.ts | 28 +- src/test/legalHoldPolicies.generated.test.ts | 16 +- src/test/listCollaborations.generated.test.ts | 80 +- src/test/memberships.generated.test.ts | 58 +- .../metadataCascadePolicies.generated.test.ts | 73 +- src/test/metadataTemplates.generated.test.ts | 94 +- src/test/retentionPolicies.generated.test.ts | 41 +- src/test/search.generated.test.ts | 100 +- src/test/sessionTermination.generated.test.ts | 24 +- src/test/sharedLinksFiles.generated.test.ts | 96 +- src/test/sharedLinksFolders.generated.test.ts | 88 +- .../sharedLinksWebLinks.generated.test.ts | 88 +- ...nformationBarrierReports.generated.test.ts | 6 +- ...ionBarrierSegmentMembers.generated.test.ts | 36 +- ...rrierSegmentRestrictions.generated.test.ts | 62 +- ...formationBarrierSegments.generated.test.ts | 20 +- ...hieldInformationBarriers.generated.test.ts | 16 +- src/test/signRequests.generated.test.ts | 4 +- src/test/signTemplates.generated.test.ts | 6 +- src/test/tasks.generated.test.ts | 71 +- src/test/transfer.generated.test.ts | 36 +- src/test/trashedFiles.generated.test.ts | 22 +- src/test/trashedFolders.generated.test.ts | 16 +- src/test/trashedWebLinks.generated.test.ts | 16 +- src/test/uploads.generated.test.ts | 48 +- src/test/userCollaborations.generated.test.ts | 88 +- src/test/users.generated.test.ts | 16 +- src/test/webhooks.generated.test.ts | 56 +- src/test/weblinks.generated.test.ts | 32 +- src/test/zipDownloads.generated.test.ts | 18 +- 129 files changed, 7847 insertions(+), 7644 deletions(-) create mode 100644 src/baseUrls.generated.ts diff --git a/docs/client.md b/docs/client.md index ae3bae7c..cc5d13b4 100644 --- a/docs/client.md +++ b/docs/client.md @@ -61,3 +61,16 @@ Calling the `client.withExtraHeaders()` method creates a new client, leaving the ```js const newClient = client.withExtraHeaders({ ['customHeader']: 'customValue' }); ``` + +## Custom Base URLs + +You can also specify the custom base URLs, which will be used for API calls made by client. +Calling the `client.withCustomBaseUrls()` method creates a new client, leaving the original client unmodified. + +```js +const newClient = client.withCustomBaseUrls({ + baseUrl: 'https://api.box.com/2.0', + uploadUrl: 'https://upload.box.com/api/2.0', + oauth2Url: 'https://account.box.com/api/oauth2', +}); +``` diff --git a/src/baseUrls.generated.ts b/src/baseUrls.generated.ts new file mode 100644 index 00000000..7e9cd1b2 --- /dev/null +++ b/src/baseUrls.generated.ts @@ -0,0 +1,36 @@ +import { SerializedData } from './json.js'; +import { sdIsEmpty } from './json.js'; +import { sdIsBoolean } from './json.js'; +import { sdIsNumber } from './json.js'; +import { sdIsString } from './json.js'; +import { sdIsList } from './json.js'; +import { sdIsMap } from './json.js'; +export class BaseUrls { + readonly baseUrl: string = 'https://api.box.com/2.0'; + readonly uploadUrl: string = 'https://upload.box.com/api/2.0'; + readonly oauth2Url: string = 'https://account.box.com/api/oauth2'; + constructor( + fields: + | Omit + | Partial> + ) { + Object.assign(this, fields); + } +} +export function serializeBaseUrls(val: BaseUrls): SerializedData { + return { + ['base_url']: val.baseUrl, + ['upload_url']: val.uploadUrl, + ['oauth2_url']: val.oauth2Url, + }; +} +export function deserializeBaseUrls(val: any): BaseUrls { + const baseUrl: string = val.base_url; + const uploadUrl: string = val.upload_url; + const oauth2Url: string = val.oauth2_url; + return { + baseUrl: baseUrl, + uploadUrl: uploadUrl, + oauth2Url: oauth2Url, + } satisfies BaseUrls; +} diff --git a/src/ccgAuth.ts b/src/ccgAuth.ts index b0a9711b..bbee6c8c 100644 --- a/src/ccgAuth.ts +++ b/src/ccgAuth.ts @@ -66,9 +66,10 @@ export class BoxCcgAuth implements Authentication { * @returns {Promise} A promise resolving to the access token. */ async refreshToken(networkSession?: NetworkSession): Promise { - const newToken = await new AuthorizationManager({ - networkSession, - }).createOauth2Token({ + const authManager: AuthorizationManager = !(networkSession == void 0) + ? new AuthorizationManager({ networkSession: networkSession }) + : new AuthorizationManager({}); + const newToken = await authManager.createOauth2Token({ grantType: 'client_credentials' satisfies TokenRequestGrantType, clientId: this.config.clientId, clientSecret: this.config.clientSecret, diff --git a/src/client.generated.ts b/src/client.generated.ts index 75b48de9..724d75f0 100644 --- a/src/client.generated.ts +++ b/src/client.generated.ts @@ -1,3 +1,5 @@ +import { serializeBaseUrls } from './baseUrls.generated.js'; +import { deserializeBaseUrls } from './baseUrls.generated.js'; import { AuthorizationManager } from './managers/authorization.generated.js'; import { FilesManager } from './managers/files.generated.js'; import { TrashedFilesManager } from './managers/trashedFiles.generated.js'; @@ -68,9 +70,19 @@ import { SignTemplatesManager } from './managers/signTemplates.generated.js'; import { IntegrationMappingsManager } from './managers/integrationMappings.generated.js'; import { Authentication } from './auth.js'; import { NetworkSession } from './network.js'; +import { BaseUrls } from './baseUrls.generated.js'; +import { SerializedData } from './json.js'; +import { sdIsEmpty } from './json.js'; +import { sdIsBoolean } from './json.js'; +import { sdIsNumber } from './json.js'; +import { sdIsString } from './json.js'; +import { sdIsList } from './json.js'; +import { sdIsMap } from './json.js'; export class BoxClient { readonly auth!: Authentication; - readonly networkSession: NetworkSession = new NetworkSession({}); + readonly networkSession: NetworkSession = new NetworkSession({ + baseUrls: new BaseUrls({}), + }); readonly authorization: AuthorizationManager; readonly files: FilesManager; readonly trashedFiles: TrashedFilesManager; @@ -215,6 +227,7 @@ export class BoxClient { | 'withAsUserHeader' | 'withSuppressedNotifications' | 'withExtraHeaders' + | 'withCustomBaseUrls' > | Partial> ) { @@ -524,4 +537,10 @@ export class BoxClient { networkSession: this.networkSession.withAdditionalHeaders(extraHeaders), }); } + withCustomBaseUrls(baseUrls: BaseUrls): BoxClient { + return new BoxClient({ + auth: this.auth, + networkSession: this.networkSession.withCustomBaseUrls(baseUrls), + }); + } } diff --git a/src/jwtAuth.ts b/src/jwtAuth.ts index 1beb848f..e31768f5 100644 --- a/src/jwtAuth.ts +++ b/src/jwtAuth.ts @@ -214,9 +214,10 @@ export class BoxJwtAuth implements Authentication { jwtOptions ); - const newToken = await new AuthorizationManager({ - networkSession, - }).createOauth2Token({ + const authManager: AuthorizationManager = !(networkSession == void 0) + ? new AuthorizationManager({ networkSession: networkSession }) + : new AuthorizationManager({}); + const newToken = await authManager.createOauth2Token({ grantType: BOX_JWT_GRANT_TYPE, assertion, clientId: this.config.clientId, diff --git a/src/managers/authorization.generated.ts b/src/managers/authorization.generated.ts index 1d319d70..de601105 100644 --- a/src/managers/authorization.generated.ts +++ b/src/managers/authorization.generated.ts @@ -30,79 +30,82 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export type GetAuthorizeQueryParamsArgResponseTypeField = 'code'; -export interface GetAuthorizeQueryParamsArg { - readonly responseType: GetAuthorizeQueryParamsArgResponseTypeField; +export type GetAuthorizeQueryParamsResponseTypeField = 'code'; +export interface GetAuthorizeQueryParams { + readonly responseType: GetAuthorizeQueryParamsResponseTypeField; readonly clientId: string; readonly redirectUri?: string; readonly state?: string; readonly scope?: string; } -export class GetAuthorizeHeadersArg { +export class GetAuthorizeHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class CreateOauth2TokenHeadersArg { +export class CreateOauth2TokenHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class CreateOauth2TokenRefreshHeadersArg { +export class CreateOauth2TokenRefreshHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class CreateOauth2RevokeHeadersArg { +export class CreateOauth2RevokeHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class AuthorizationManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - AuthorizationManager, - | 'getAuthorize' - | 'createOauth2Token' - | 'createOauth2TokenRefresh' - | 'createOauth2Revoke' - > + fields: + | Omit< + AuthorizationManager, + | 'networkSession' + | 'getAuthorize' + | 'createOauth2Token' + | 'createOauth2TokenRefresh' + | 'createOauth2Revoke' + > + | Partial> ) { Object.assign(this, fields); } async getAuthorize( - queryParams: GetAuthorizeQueryParamsArg, - headers: GetAuthorizeHeadersArg = new GetAuthorizeHeadersArg({}), + queryParams: GetAuthorizeQueryParams, + headers: GetAuthorizeHeaders = new GetAuthorizeHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -118,7 +121,7 @@ export class AuthorizationManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://account.box.com/api/oauth2/authorize') as string, + ''.concat(this.networkSession.baseUrls.oauth2Url, '/authorize') as string, { method: 'GET', params: queryParamsMap, @@ -133,7 +136,7 @@ export class AuthorizationManager { } async createOauth2Token( requestBody: PostOAuth2Token, - headers: CreateOauth2TokenHeadersArg = new CreateOauth2TokenHeadersArg({}), + headers: CreateOauth2TokenHeaders = new CreateOauth2TokenHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -156,7 +159,7 @@ export class AuthorizationManager { } async createOauth2TokenRefresh( requestBody: PostOAuth2TokenRefreshAccessToken, - headers: CreateOauth2TokenRefreshHeadersArg = new CreateOauth2TokenRefreshHeadersArg( + headers: CreateOauth2TokenRefreshHeaders = new CreateOauth2TokenRefreshHeaders( {} ), cancellationToken?: CancellationToken @@ -181,9 +184,7 @@ export class AuthorizationManager { } async createOauth2Revoke( requestBody: PostOAuth2Revoke, - headers: CreateOauth2RevokeHeadersArg = new CreateOauth2RevokeHeadersArg( - {} - ), + headers: CreateOauth2RevokeHeaders = new CreateOauth2RevokeHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -205,16 +206,16 @@ export class AuthorizationManager { return void 0; } } -export function serializeGetAuthorizeQueryParamsArgResponseTypeField( - val: GetAuthorizeQueryParamsArgResponseTypeField +export function serializeGetAuthorizeQueryParamsResponseTypeField( + val: GetAuthorizeQueryParamsResponseTypeField ): SerializedData { return val; } -export function deserializeGetAuthorizeQueryParamsArgResponseTypeField( +export function deserializeGetAuthorizeQueryParamsResponseTypeField( val: any -): GetAuthorizeQueryParamsArgResponseTypeField { +): GetAuthorizeQueryParamsResponseTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetAuthorizeQueryParamsArgResponseTypeField"'; + throw 'Expecting a string for "GetAuthorizeQueryParamsResponseTypeField"'; } if (val == 'code') { return 'code'; diff --git a/src/managers/avatars.generated.ts b/src/managers/avatars.generated.ts index 46d6f6a8..0a663d81 100644 --- a/src/managers/avatars.generated.ts +++ b/src/managers/avatars.generated.ts @@ -22,61 +22,66 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetUserAvatarHeadersArg { +export class GetUserAvatarHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface CreateUserAvatarRequestBodyArg { +export interface CreateUserAvatarRequestBody { readonly pic: ByteStream; readonly picFileName?: string; readonly picContentType?: string; } -export class CreateUserAvatarHeadersArg { +export class CreateUserAvatarHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteUserAvatarHeadersArg { +export class DeleteUserAvatarHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class AvatarsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - AvatarsManager, - 'getUserAvatar' | 'createUserAvatar' | 'deleteUserAvatar' - > + fields: + | Omit< + AvatarsManager, + | 'networkSession' + | 'getUserAvatar' + | 'createUserAvatar' + | 'deleteUserAvatar' + > + | Partial> ) { Object.assign(this, fields); } async getUserAvatar( userId: string, - headers: GetUserAvatarHeadersArg = new GetUserAvatarHeadersArg({}), + headers: GetUserAvatarHeaders = new GetUserAvatarHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -84,7 +89,8 @@ export class AvatarsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/users/', + this.networkSession.baseUrls.baseUrl, + '/users/', toString(userId) as string, '/avatar' ) as string, @@ -101,8 +107,8 @@ export class AvatarsManager { } async createUserAvatar( userId: string, - requestBody: CreateUserAvatarRequestBodyArg, - headers: CreateUserAvatarHeadersArg = new CreateUserAvatarHeadersArg({}), + requestBody: CreateUserAvatarRequestBody, + headers: CreateUserAvatarHeaders = new CreateUserAvatarHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -110,7 +116,8 @@ export class AvatarsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/users/', + this.networkSession.baseUrls.baseUrl, + '/users/', toString(userId) as string, '/avatar' ) as string, @@ -136,7 +143,7 @@ export class AvatarsManager { } async deleteUserAvatar( userId: string, - headers: DeleteUserAvatarHeadersArg = new DeleteUserAvatarHeadersArg({}), + headers: DeleteUserAvatarHeaders = new DeleteUserAvatarHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -144,7 +151,8 @@ export class AvatarsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/users/', + this.networkSession.baseUrls.baseUrl, + '/users/', toString(userId) as string, '/avatar' ) as string, diff --git a/src/managers/chunkedUploads.generated.ts b/src/managers/chunkedUploads.generated.ts index bf410ea6..73378fd3 100644 --- a/src/managers/chunkedUploads.generated.ts +++ b/src/managers/chunkedUploads.generated.ts @@ -1,3 +1,5 @@ +import { serializeFileFull } from '../schemas.generated.js'; +import { deserializeFileFull } from '../schemas.generated.js'; import { serializeUploadSession } from '../schemas.generated.js'; import { deserializeUploadSession } from '../schemas.generated.js'; import { serializeClientError } from '../schemas.generated.js'; @@ -12,6 +14,7 @@ import { serializeUploadPart } from '../schemas.generated.js'; import { deserializeUploadPart } from '../schemas.generated.js'; import { Buffer } from '../utils.js'; import { HashName } from '../utils.js'; +import { FileFull } from '../schemas.generated.js'; import { Iterator } from '../utils.js'; import { UploadSession } from '../schemas.generated.js'; import { ClientError } from '../schemas.generated.js'; @@ -51,54 +54,54 @@ export interface PartAccumulator { readonly uploadSessionId: string; readonly fileHash: Hash; } -export interface CreateFileUploadSessionRequestBodyArg { +export interface CreateFileUploadSessionRequestBody { readonly folderId: string; readonly fileSize: number; readonly fileName: string; } -export class CreateFileUploadSessionHeadersArg { +export class CreateFileUploadSessionHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface CreateFileUploadSessionForExistingFileRequestBodyArg { +export interface CreateFileUploadSessionForExistingFileRequestBody { readonly fileSize: number; readonly fileName?: string; } -export class CreateFileUploadSessionForExistingFileHeadersArg { +export class CreateFileUploadSessionForExistingFileHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit + | Omit | Partial< - Pick + Pick > ) { Object.assign(this, fields); } } -export class GetFileUploadSessionByIdHeadersArg { +export class GetFileUploadSessionByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class UploadFilePartHeadersArg { +export class UploadFilePartHeaders { readonly digest!: string; readonly contentRange!: string; readonly extraHeaders?: { @@ -106,44 +109,44 @@ export class UploadFilePartHeadersArg { } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteFileUploadSessionByIdHeadersArg { +export class DeleteFileUploadSessionByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetFileUploadSessionPartsQueryParamsArg { +export interface GetFileUploadSessionPartsQueryParams { readonly offset?: number; readonly limit?: number; } -export class GetFileUploadSessionPartsHeadersArg { +export class GetFileUploadSessionPartsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface CreateFileUploadSessionCommitRequestBodyArg { +export interface CreateFileUploadSessionCommitRequestBody { readonly parts: readonly UploadPart[]; } -export class CreateFileUploadSessionCommitHeadersArg { +export class CreateFileUploadSessionCommitHeaders { readonly digest!: string; readonly ifMatch?: string; readonly ifNoneMatch?: string; @@ -152,34 +155,37 @@ export class CreateFileUploadSessionCommitHeadersArg { } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class ChunkedUploadsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - ChunkedUploadsManager, - | 'createFileUploadSession' - | 'createFileUploadSessionForExistingFile' - | 'getFileUploadSessionById' - | 'uploadFilePart' - | 'deleteFileUploadSessionById' - | 'getFileUploadSessionParts' - | 'createFileUploadSessionCommit' - | 'reducer' - | 'uploadBigFile' - > + fields: + | Omit< + ChunkedUploadsManager, + | 'networkSession' + | 'createFileUploadSession' + | 'createFileUploadSessionForExistingFile' + | 'getFileUploadSessionById' + | 'uploadFilePart' + | 'deleteFileUploadSessionById' + | 'getFileUploadSessionParts' + | 'createFileUploadSessionCommit' + | 'reducer' + | 'uploadBigFile' + > + | Partial> ) { Object.assign(this, fields); } async createFileUploadSession( - requestBody: CreateFileUploadSessionRequestBodyArg, - headers: CreateFileUploadSessionHeadersArg = new CreateFileUploadSessionHeadersArg( + requestBody: CreateFileUploadSessionRequestBody, + headers: CreateFileUploadSessionHeaders = new CreateFileUploadSessionHeaders( {} ), cancellationToken?: CancellationToken @@ -189,12 +195,13 @@ export class ChunkedUploadsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://upload.box.com/api/2.0/files/upload_sessions' + this.networkSession.baseUrls.uploadUrl, + '/files/upload_sessions' ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateFileUploadSessionRequestBodyArg(requestBody), + data: serializeCreateFileUploadSessionRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -206,8 +213,8 @@ export class ChunkedUploadsManager { } async createFileUploadSessionForExistingFile( fileId: string, - requestBody: CreateFileUploadSessionForExistingFileRequestBodyArg, - headers: CreateFileUploadSessionForExistingFileHeadersArg = new CreateFileUploadSessionForExistingFileHeadersArg( + requestBody: CreateFileUploadSessionForExistingFileRequestBody, + headers: CreateFileUploadSessionForExistingFileHeaders = new CreateFileUploadSessionForExistingFileHeaders( {} ), cancellationToken?: CancellationToken @@ -217,14 +224,15 @@ export class ChunkedUploadsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://upload.box.com/api/2.0/files/', + this.networkSession.baseUrls.uploadUrl, + '/files/', toString(fileId) as string, '/upload_sessions' ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateFileUploadSessionForExistingFileRequestBodyArg( + data: serializeCreateFileUploadSessionForExistingFileRequestBody( requestBody ), contentType: 'application/json', @@ -238,7 +246,7 @@ export class ChunkedUploadsManager { } async getFileUploadSessionById( uploadSessionId: string, - headers: GetFileUploadSessionByIdHeadersArg = new GetFileUploadSessionByIdHeadersArg( + headers: GetFileUploadSessionByIdHeaders = new GetFileUploadSessionByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -248,7 +256,8 @@ export class ChunkedUploadsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://upload.box.com/api/2.0/files/upload_sessions/', + this.networkSession.baseUrls.uploadUrl, + '/files/upload_sessions/', toString(uploadSessionId) as string ) as string, { @@ -265,7 +274,7 @@ export class ChunkedUploadsManager { async uploadFilePart( uploadSessionId: string, requestBody: ByteStream, - headers: UploadFilePartHeadersArg, + headers: UploadFilePartHeaders, cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -279,7 +288,8 @@ export class ChunkedUploadsManager { }); const response: FetchResponse = (await fetch( ''.concat( - 'https://upload.box.com/api/2.0/files/upload_sessions/', + this.networkSession.baseUrls.uploadUrl, + '/files/upload_sessions/', toString(uploadSessionId) as string ) as string, { @@ -297,7 +307,7 @@ export class ChunkedUploadsManager { } async deleteFileUploadSessionById( uploadSessionId: string, - headers: DeleteFileUploadSessionByIdHeadersArg = new DeleteFileUploadSessionByIdHeadersArg( + headers: DeleteFileUploadSessionByIdHeaders = new DeleteFileUploadSessionByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -307,7 +317,8 @@ export class ChunkedUploadsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://upload.box.com/api/2.0/files/upload_sessions/', + this.networkSession.baseUrls.uploadUrl, + '/files/upload_sessions/', toString(uploadSessionId) as string ) as string, { @@ -323,8 +334,8 @@ export class ChunkedUploadsManager { } async getFileUploadSessionParts( uploadSessionId: string, - queryParams: GetFileUploadSessionPartsQueryParamsArg = {} satisfies GetFileUploadSessionPartsQueryParamsArg, - headers: GetFileUploadSessionPartsHeadersArg = new GetFileUploadSessionPartsHeadersArg( + queryParams: GetFileUploadSessionPartsQueryParams = {} satisfies GetFileUploadSessionPartsQueryParams, + headers: GetFileUploadSessionPartsHeaders = new GetFileUploadSessionPartsHeaders( {} ), cancellationToken?: CancellationToken @@ -340,7 +351,8 @@ export class ChunkedUploadsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://upload.box.com/api/2.0/files/upload_sessions/', + this.networkSession.baseUrls.uploadUrl, + '/files/upload_sessions/', toString(uploadSessionId) as string, '/parts' ) as string, @@ -358,8 +370,8 @@ export class ChunkedUploadsManager { } async createFileUploadSessionCommit( uploadSessionId: string, - requestBody: CreateFileUploadSessionCommitRequestBodyArg, - headers: CreateFileUploadSessionCommitHeadersArg, + requestBody: CreateFileUploadSessionCommitRequestBody, + headers: CreateFileUploadSessionCommitHeaders, cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -374,14 +386,15 @@ export class ChunkedUploadsManager { }); const response: FetchResponse = (await fetch( ''.concat( - 'https://upload.box.com/api/2.0/files/upload_sessions/', + this.networkSession.baseUrls.uploadUrl, + '/files/upload_sessions/', toString(uploadSessionId) as string, '/commit' ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateFileUploadSessionCommitRequestBodyArg(requestBody), + data: serializeCreateFileUploadSessionCommitRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -391,7 +404,10 @@ export class ChunkedUploadsManager { )) as FetchResponse; return deserializeFiles(response.data); } - async reducer(acc: PartAccumulator, chunk: ByteStream): Promise { + async reducer( + acc: PartAccumulator, + chunk: ByteStream + ): Promise { const lastIndex: number = acc.lastIndex; const parts: readonly UploadPart[] = acc.parts; const chunkBuffer: Buffer = await readByteStream(chunk); @@ -413,10 +429,7 @@ export class ChunkedUploadsManager { const uploadedPart: UploadedPart = await this.uploadFilePart( acc.uploadSessionId, generateByteStreamFromBuffer(chunkBuffer), - new UploadFilePartHeadersArg({ - digest: digest, - contentRange: contentRange, - }) + new UploadFilePartHeaders({ digest: digest, contentRange: contentRange }) ); const part: UploadPart = uploadedPart.part!; const partSha1: string = hexToBase64(part.sha1!); @@ -444,14 +457,14 @@ export class ChunkedUploadsManager { fileSize: number, parentFolderId: string, cancellationToken?: CancellationToken - ): Promise { + ): Promise { const uploadSession: UploadSession = await this.createFileUploadSession( { fileName: fileName, fileSize: fileSize, folderId: parentFolderId, - } satisfies CreateFileUploadSessionRequestBodyArg, - new CreateFileUploadSessionHeadersArg({}), + } satisfies CreateFileUploadSessionRequestBody, + new CreateFileUploadSessionHeaders({}), cancellationToken ); const uploadSessionId: string = uploadSession.id!; @@ -480,8 +493,8 @@ export class ChunkedUploadsManager { const processedSessionParts: UploadParts = await this.getFileUploadSessionParts( uploadSessionId, - {} satisfies GetFileUploadSessionPartsQueryParamsArg, - new GetFileUploadSessionPartsHeadersArg({}), + {} satisfies GetFileUploadSessionPartsQueryParams, + new GetFileUploadSessionPartsHeaders({}), cancellationToken ); if (!(processedSessionParts.totalCount! == totalParts)) { @@ -489,7 +502,7 @@ export class ChunkedUploadsManager { } const processedSession: UploadSession = await this.getFileUploadSessionById( uploadSessionId, - new GetFileUploadSessionByIdHeadersArg({}), + new GetFileUploadSessionByIdHeaders({}), cancellationToken ); if (!(processedSession.numPartsProcessed == totalParts)) { @@ -499,15 +512,15 @@ export class ChunkedUploadsManager { const digest: string = ''.concat('sha=', sha1) as string; const committedSession: Files = await this.createFileUploadSessionCommit( uploadSessionId, - { parts: parts } satisfies CreateFileUploadSessionCommitRequestBodyArg, - new CreateFileUploadSessionCommitHeadersArg({ digest: digest }), + { parts: parts } satisfies CreateFileUploadSessionCommitRequestBody, + new CreateFileUploadSessionCommitHeaders({ digest: digest }), cancellationToken ); return committedSession.entries![0]; } } -export function serializeCreateFileUploadSessionRequestBodyArg( - val: CreateFileUploadSessionRequestBodyArg +export function serializeCreateFileUploadSessionRequestBody( + val: CreateFileUploadSessionRequestBody ): SerializedData { return { ['folder_id']: val.folderId, @@ -515,9 +528,9 @@ export function serializeCreateFileUploadSessionRequestBodyArg( ['file_name']: val.fileName, }; } -export function deserializeCreateFileUploadSessionRequestBodyArg( +export function deserializeCreateFileUploadSessionRequestBody( val: any -): CreateFileUploadSessionRequestBodyArg { +): CreateFileUploadSessionRequestBody { const folderId: string = val.folder_id; const fileSize: number = val.file_size; const fileName: string = val.file_name; @@ -525,29 +538,29 @@ export function deserializeCreateFileUploadSessionRequestBodyArg( folderId: folderId, fileSize: fileSize, fileName: fileName, - } satisfies CreateFileUploadSessionRequestBodyArg; + } satisfies CreateFileUploadSessionRequestBody; } -export function serializeCreateFileUploadSessionForExistingFileRequestBodyArg( - val: CreateFileUploadSessionForExistingFileRequestBodyArg +export function serializeCreateFileUploadSessionForExistingFileRequestBody( + val: CreateFileUploadSessionForExistingFileRequestBody ): SerializedData { return { ['file_size']: val.fileSize, ['file_name']: val.fileName == void 0 ? void 0 : val.fileName, }; } -export function deserializeCreateFileUploadSessionForExistingFileRequestBodyArg( +export function deserializeCreateFileUploadSessionForExistingFileRequestBody( val: any -): CreateFileUploadSessionForExistingFileRequestBodyArg { +): CreateFileUploadSessionForExistingFileRequestBody { const fileSize: number = val.file_size; const fileName: undefined | string = val.file_name == void 0 ? void 0 : val.file_name; return { fileSize: fileSize, fileName: fileName, - } satisfies CreateFileUploadSessionForExistingFileRequestBodyArg; + } satisfies CreateFileUploadSessionForExistingFileRequestBody; } -export function serializeCreateFileUploadSessionCommitRequestBodyArg( - val: CreateFileUploadSessionCommitRequestBodyArg +export function serializeCreateFileUploadSessionCommitRequestBody( + val: CreateFileUploadSessionCommitRequestBody ): SerializedData { return { ['parts']: val.parts.map(function (item: UploadPart): any { @@ -555,13 +568,13 @@ export function serializeCreateFileUploadSessionCommitRequestBodyArg( }) as readonly any[], }; } -export function deserializeCreateFileUploadSessionCommitRequestBodyArg( +export function deserializeCreateFileUploadSessionCommitRequestBody( val: any -): CreateFileUploadSessionCommitRequestBodyArg { +): CreateFileUploadSessionCommitRequestBody { const parts: readonly UploadPart[] = sdIsList(val.parts) ? (val.parts.map(function (itm: SerializedData): any { return deserializeUploadPart(itm); }) as readonly any[]) : []; - return { parts: parts } satisfies CreateFileUploadSessionCommitRequestBodyArg; + return { parts: parts } satisfies CreateFileUploadSessionCommitRequestBody; } diff --git a/src/managers/classifications.generated.ts b/src/managers/classifications.generated.ts index d70cca84..9b6506e9 100644 --- a/src/managers/classifications.generated.ts +++ b/src/managers/classifications.generated.ts @@ -20,146 +20,148 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetClassificationTemplateHeadersArg { +export class GetClassificationTemplateHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type AddClassificationRequestBodyArgOpField = 'addEnumOption'; -export type AddClassificationRequestBodyArgFieldKeyField = +export type AddClassificationRequestBodyOpField = 'addEnumOption'; +export type AddClassificationRequestBodyFieldKeyField = 'Box__Security__Classification__Key'; -export interface AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField { +export interface AddClassificationRequestBodyDataStaticConfigClassificationField { readonly classificationDefinition?: string; readonly colorId?: number; } -export interface AddClassificationRequestBodyArgDataFieldStaticConfigField { - readonly classification?: AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField; +export interface AddClassificationRequestBodyDataStaticConfigField { + readonly classification?: AddClassificationRequestBodyDataStaticConfigClassificationField; } -export interface AddClassificationRequestBodyArgDataField { +export interface AddClassificationRequestBodyDataField { readonly key: string; - readonly staticConfig?: AddClassificationRequestBodyArgDataFieldStaticConfigField; + readonly staticConfig?: AddClassificationRequestBodyDataStaticConfigField; } -export interface AddClassificationRequestBodyArg { - readonly op: AddClassificationRequestBodyArgOpField; - readonly fieldKey: AddClassificationRequestBodyArgFieldKeyField; - readonly data: AddClassificationRequestBodyArgDataField; +export interface AddClassificationRequestBody { + readonly op: AddClassificationRequestBodyOpField; + readonly fieldKey: AddClassificationRequestBodyFieldKeyField; + readonly data: AddClassificationRequestBodyDataField; } -export class AddClassificationHeadersArg { +export class AddClassificationHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateClassificationRequestBodyArgOpField = 'editEnumOption'; -export type UpdateClassificationRequestBodyArgFieldKeyField = +export type UpdateClassificationRequestBodyOpField = 'editEnumOption'; +export type UpdateClassificationRequestBodyFieldKeyField = 'Box__Security__Classification__Key'; -export interface UpdateClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField { +export interface UpdateClassificationRequestBodyDataStaticConfigClassificationField { readonly classificationDefinition?: string; readonly colorId?: number; } -export interface UpdateClassificationRequestBodyArgDataFieldStaticConfigField { - readonly classification?: UpdateClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField; +export interface UpdateClassificationRequestBodyDataStaticConfigField { + readonly classification?: UpdateClassificationRequestBodyDataStaticConfigClassificationField; } -export interface UpdateClassificationRequestBodyArgDataField { +export interface UpdateClassificationRequestBodyDataField { readonly key: string; - readonly staticConfig?: UpdateClassificationRequestBodyArgDataFieldStaticConfigField; + readonly staticConfig?: UpdateClassificationRequestBodyDataStaticConfigField; } -export interface UpdateClassificationRequestBodyArg { - readonly op: UpdateClassificationRequestBodyArgOpField; - readonly fieldKey: UpdateClassificationRequestBodyArgFieldKeyField; +export interface UpdateClassificationRequestBody { + readonly op: UpdateClassificationRequestBodyOpField; + readonly fieldKey: UpdateClassificationRequestBodyFieldKeyField; readonly enumOptionKey: string; - readonly data: UpdateClassificationRequestBodyArgDataField; + readonly data: UpdateClassificationRequestBodyDataField; } -export class UpdateClassificationHeadersArg { +export class UpdateClassificationHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateClassificationTemplateRequestBodyArgScopeField = 'enterprise'; -export type CreateClassificationTemplateRequestBodyArgTemplateKeyField = +export type CreateClassificationTemplateRequestBodyScopeField = 'enterprise'; +export type CreateClassificationTemplateRequestBodyTemplateKeyField = 'securityClassification-6VMVochwUWo'; -export type CreateClassificationTemplateRequestBodyArgDisplayNameField = +export type CreateClassificationTemplateRequestBodyDisplayNameField = 'Classification'; -export type CreateClassificationTemplateRequestBodyArgFieldsFieldTypeField = - 'enum'; -export type CreateClassificationTemplateRequestBodyArgFieldsFieldKeyField = +export type CreateClassificationTemplateRequestBodyFieldsTypeField = 'enum'; +export type CreateClassificationTemplateRequestBodyFieldsKeyField = 'Box__Security__Classification__Key'; -export type CreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField = +export type CreateClassificationTemplateRequestBodyFieldsDisplayNameField = 'Classification'; -export interface CreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigFieldClassificationField { +export interface CreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigClassificationField { readonly classificationDefinition?: string; readonly colorId?: number; } -export interface CreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigField { - readonly classification?: CreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigFieldClassificationField; +export interface CreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigField { + readonly classification?: CreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigClassificationField; } -export interface CreateClassificationTemplateRequestBodyArgFieldsFieldOptionsField { +export interface CreateClassificationTemplateRequestBodyFieldsOptionsField { readonly key: string; - readonly staticConfig?: CreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigField; + readonly staticConfig?: CreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigField; } -export interface CreateClassificationTemplateRequestBodyArgFieldsField { - readonly type: CreateClassificationTemplateRequestBodyArgFieldsFieldTypeField; - readonly key: CreateClassificationTemplateRequestBodyArgFieldsFieldKeyField; - readonly displayName: CreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField; +export interface CreateClassificationTemplateRequestBodyFieldsField { + readonly type: CreateClassificationTemplateRequestBodyFieldsTypeField; + readonly key: CreateClassificationTemplateRequestBodyFieldsKeyField; + readonly displayName: CreateClassificationTemplateRequestBodyFieldsDisplayNameField; readonly hidden?: boolean; - readonly options: readonly CreateClassificationTemplateRequestBodyArgFieldsFieldOptionsField[]; + readonly options: readonly CreateClassificationTemplateRequestBodyFieldsOptionsField[]; } -export interface CreateClassificationTemplateRequestBodyArg { - readonly scope: CreateClassificationTemplateRequestBodyArgScopeField; - readonly templateKey: CreateClassificationTemplateRequestBodyArgTemplateKeyField; - readonly displayName: CreateClassificationTemplateRequestBodyArgDisplayNameField; +export interface CreateClassificationTemplateRequestBody { + readonly scope: CreateClassificationTemplateRequestBodyScopeField; + readonly templateKey: CreateClassificationTemplateRequestBodyTemplateKeyField; + readonly displayName: CreateClassificationTemplateRequestBodyDisplayNameField; readonly hidden?: boolean; readonly copyInstanceOnItemCopy?: boolean; - readonly fields: readonly CreateClassificationTemplateRequestBodyArgFieldsField[]; + readonly fields: readonly CreateClassificationTemplateRequestBodyFieldsField[]; } -export class CreateClassificationTemplateHeadersArg { +export class CreateClassificationTemplateHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class ClassificationsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - ClassificationsManager, - | 'getClassificationTemplate' - | 'addClassification' - | 'updateClassification' - | 'createClassificationTemplate' - > + fields: + | Omit< + ClassificationsManager, + | 'networkSession' + | 'getClassificationTemplate' + | 'addClassification' + | 'updateClassification' + | 'createClassificationTemplate' + > + | Partial> ) { Object.assign(this, fields); } async getClassificationTemplate( - headers: GetClassificationTemplateHeadersArg = new GetClassificationTemplateHeadersArg( + headers: GetClassificationTemplateHeaders = new GetClassificationTemplateHeaders( {} ), cancellationToken?: CancellationToken @@ -169,7 +171,8 @@ export class ClassificationsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema' + this.networkSession.baseUrls.baseUrl, + '/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema' ) as string, { method: 'GET', @@ -183,8 +186,8 @@ export class ClassificationsManager { return deserializeClassificationTemplate(response.data); } async addClassification( - requestBody: readonly AddClassificationRequestBodyArg[], - headers: AddClassificationHeadersArg = new AddClassificationHeadersArg({}), + requestBody: readonly AddClassificationRequestBody[], + headers: AddClassificationHeaders = new AddClassificationHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -192,13 +195,14 @@ export class ClassificationsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add' + this.networkSession.baseUrls.baseUrl, + '/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add' ) as string, { method: 'PUT', headers: headersMap, data: requestBody.map( - serializeAddClassificationRequestBodyArg + serializeAddClassificationRequestBody ) as readonly any[], contentType: 'application/json', responseFormat: 'json', @@ -210,10 +214,8 @@ export class ClassificationsManager { return deserializeClassificationTemplate(response.data); } async updateClassification( - requestBody: readonly UpdateClassificationRequestBodyArg[], - headers: UpdateClassificationHeadersArg = new UpdateClassificationHeadersArg( - {} - ), + requestBody: readonly UpdateClassificationRequestBody[], + headers: UpdateClassificationHeaders = new UpdateClassificationHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -221,13 +223,14 @@ export class ClassificationsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update' + this.networkSession.baseUrls.baseUrl, + '/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update' ) as string, { method: 'PUT', headers: headersMap, data: requestBody.map( - serializeUpdateClassificationRequestBodyArg + serializeUpdateClassificationRequestBody ) as readonly any[], contentType: 'application/json-patch+json', responseFormat: 'json', @@ -239,8 +242,8 @@ export class ClassificationsManager { return deserializeClassificationTemplate(response.data); } async createClassificationTemplate( - requestBody: CreateClassificationTemplateRequestBodyArg, - headers: CreateClassificationTemplateHeadersArg = new CreateClassificationTemplateHeadersArg( + requestBody: CreateClassificationTemplateRequestBody, + headers: CreateClassificationTemplateHeaders = new CreateClassificationTemplateHeaders( {} ), cancellationToken?: CancellationToken @@ -250,12 +253,13 @@ export class ClassificationsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/metadata_templates/schema#classifications' + this.networkSession.baseUrls.baseUrl, + '/metadata_templates/schema#classifications' ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateClassificationTemplateRequestBodyArg(requestBody), + data: serializeCreateClassificationTemplateRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -266,40 +270,40 @@ export class ClassificationsManager { return deserializeClassificationTemplate(response.data); } } -export function serializeAddClassificationRequestBodyArgOpField( - val: AddClassificationRequestBodyArgOpField +export function serializeAddClassificationRequestBodyOpField( + val: AddClassificationRequestBodyOpField ): SerializedData { return val; } -export function deserializeAddClassificationRequestBodyArgOpField( +export function deserializeAddClassificationRequestBodyOpField( val: any -): AddClassificationRequestBodyArgOpField { +): AddClassificationRequestBodyOpField { if (!sdIsString(val)) { - throw 'Expecting a string for "AddClassificationRequestBodyArgOpField"'; + throw 'Expecting a string for "AddClassificationRequestBodyOpField"'; } if (val == 'addEnumOption') { return 'addEnumOption'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeAddClassificationRequestBodyArgFieldKeyField( - val: AddClassificationRequestBodyArgFieldKeyField +export function serializeAddClassificationRequestBodyFieldKeyField( + val: AddClassificationRequestBodyFieldKeyField ): SerializedData { return val; } -export function deserializeAddClassificationRequestBodyArgFieldKeyField( +export function deserializeAddClassificationRequestBodyFieldKeyField( val: any -): AddClassificationRequestBodyArgFieldKeyField { +): AddClassificationRequestBodyFieldKeyField { if (!sdIsString(val)) { - throw 'Expecting a string for "AddClassificationRequestBodyArgFieldKeyField"'; + throw 'Expecting a string for "AddClassificationRequestBodyFieldKeyField"'; } if (val == 'Box__Security__Classification__Key') { return 'Box__Security__Classification__Key'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeAddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField( - val: AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField +export function serializeAddClassificationRequestBodyDataStaticConfigClassificationField( + val: AddClassificationRequestBodyDataStaticConfigClassificationField ): SerializedData { return { ['classificationDefinition']: @@ -309,9 +313,9 @@ export function serializeAddClassificationRequestBodyArgDataFieldStaticConfigFie ['colorID']: val.colorId == void 0 ? void 0 : val.colorId, }; } -export function deserializeAddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField( +export function deserializeAddClassificationRequestBodyDataStaticConfigClassificationField( val: any -): AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField { +): AddClassificationRequestBodyDataStaticConfigClassificationField { const classificationDefinition: undefined | string = val.classificationDefinition == void 0 ? void 0 @@ -321,125 +325,125 @@ export function deserializeAddClassificationRequestBodyArgDataFieldStaticConfigF return { classificationDefinition: classificationDefinition, colorId: colorId, - } satisfies AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField; + } satisfies AddClassificationRequestBodyDataStaticConfigClassificationField; } -export function serializeAddClassificationRequestBodyArgDataFieldStaticConfigField( - val: AddClassificationRequestBodyArgDataFieldStaticConfigField +export function serializeAddClassificationRequestBodyDataStaticConfigField( + val: AddClassificationRequestBodyDataStaticConfigField ): SerializedData { return { ['classification']: val.classification == void 0 ? void 0 - : serializeAddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField( + : serializeAddClassificationRequestBodyDataStaticConfigClassificationField( val.classification ), }; } -export function deserializeAddClassificationRequestBodyArgDataFieldStaticConfigField( +export function deserializeAddClassificationRequestBodyDataStaticConfigField( val: any -): AddClassificationRequestBodyArgDataFieldStaticConfigField { +): AddClassificationRequestBodyDataStaticConfigField { const classification: | undefined - | AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField = + | AddClassificationRequestBodyDataStaticConfigClassificationField = val.classification == void 0 ? void 0 - : deserializeAddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField( + : deserializeAddClassificationRequestBodyDataStaticConfigClassificationField( val.classification ); return { classification: classification, - } satisfies AddClassificationRequestBodyArgDataFieldStaticConfigField; + } satisfies AddClassificationRequestBodyDataStaticConfigField; } -export function serializeAddClassificationRequestBodyArgDataField( - val: AddClassificationRequestBodyArgDataField +export function serializeAddClassificationRequestBodyDataField( + val: AddClassificationRequestBodyDataField ): SerializedData { return { ['key']: val.key, ['staticConfig']: val.staticConfig == void 0 ? void 0 - : serializeAddClassificationRequestBodyArgDataFieldStaticConfigField( + : serializeAddClassificationRequestBodyDataStaticConfigField( val.staticConfig ), }; } -export function deserializeAddClassificationRequestBodyArgDataField( +export function deserializeAddClassificationRequestBodyDataField( val: any -): AddClassificationRequestBodyArgDataField { +): AddClassificationRequestBodyDataField { const key: string = val.key; const staticConfig: | undefined - | AddClassificationRequestBodyArgDataFieldStaticConfigField = + | AddClassificationRequestBodyDataStaticConfigField = val.staticConfig == void 0 ? void 0 - : deserializeAddClassificationRequestBodyArgDataFieldStaticConfigField( + : deserializeAddClassificationRequestBodyDataStaticConfigField( val.staticConfig ); return { key: key, staticConfig: staticConfig, - } satisfies AddClassificationRequestBodyArgDataField; + } satisfies AddClassificationRequestBodyDataField; } -export function serializeAddClassificationRequestBodyArg( - val: AddClassificationRequestBodyArg +export function serializeAddClassificationRequestBody( + val: AddClassificationRequestBody ): SerializedData { return { - ['op']: serializeAddClassificationRequestBodyArgOpField(val.op), - ['fieldKey']: serializeAddClassificationRequestBodyArgFieldKeyField( + ['op']: serializeAddClassificationRequestBodyOpField(val.op), + ['fieldKey']: serializeAddClassificationRequestBodyFieldKeyField( val.fieldKey ), - ['data']: serializeAddClassificationRequestBodyArgDataField(val.data), + ['data']: serializeAddClassificationRequestBodyDataField(val.data), }; } -export function deserializeAddClassificationRequestBodyArg( +export function deserializeAddClassificationRequestBody( val: any -): AddClassificationRequestBodyArg { - const op: AddClassificationRequestBodyArgOpField = - deserializeAddClassificationRequestBodyArgOpField(val.op); - const fieldKey: AddClassificationRequestBodyArgFieldKeyField = - deserializeAddClassificationRequestBodyArgFieldKeyField(val.fieldKey); - const data: AddClassificationRequestBodyArgDataField = - deserializeAddClassificationRequestBodyArgDataField(val.data); +): AddClassificationRequestBody { + const op: AddClassificationRequestBodyOpField = + deserializeAddClassificationRequestBodyOpField(val.op); + const fieldKey: AddClassificationRequestBodyFieldKeyField = + deserializeAddClassificationRequestBodyFieldKeyField(val.fieldKey); + const data: AddClassificationRequestBodyDataField = + deserializeAddClassificationRequestBodyDataField(val.data); return { op: op, fieldKey: fieldKey, data: data, - } satisfies AddClassificationRequestBodyArg; + } satisfies AddClassificationRequestBody; } -export function serializeUpdateClassificationRequestBodyArgOpField( - val: UpdateClassificationRequestBodyArgOpField +export function serializeUpdateClassificationRequestBodyOpField( + val: UpdateClassificationRequestBodyOpField ): SerializedData { return val; } -export function deserializeUpdateClassificationRequestBodyArgOpField( +export function deserializeUpdateClassificationRequestBodyOpField( val: any -): UpdateClassificationRequestBodyArgOpField { +): UpdateClassificationRequestBodyOpField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateClassificationRequestBodyArgOpField"'; + throw 'Expecting a string for "UpdateClassificationRequestBodyOpField"'; } if (val == 'editEnumOption') { return 'editEnumOption'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateClassificationRequestBodyArgFieldKeyField( - val: UpdateClassificationRequestBodyArgFieldKeyField +export function serializeUpdateClassificationRequestBodyFieldKeyField( + val: UpdateClassificationRequestBodyFieldKeyField ): SerializedData { return val; } -export function deserializeUpdateClassificationRequestBodyArgFieldKeyField( +export function deserializeUpdateClassificationRequestBodyFieldKeyField( val: any -): UpdateClassificationRequestBodyArgFieldKeyField { +): UpdateClassificationRequestBodyFieldKeyField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateClassificationRequestBodyArgFieldKeyField"'; + throw 'Expecting a string for "UpdateClassificationRequestBodyFieldKeyField"'; } if (val == 'Box__Security__Classification__Key') { return 'Box__Security__Classification__Key'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField( - val: UpdateClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField +export function serializeUpdateClassificationRequestBodyDataStaticConfigClassificationField( + val: UpdateClassificationRequestBodyDataStaticConfigClassificationField ): SerializedData { return { ['classificationDefinition']: @@ -449,9 +453,9 @@ export function serializeUpdateClassificationRequestBodyArgDataFieldStaticConfig ['colorID']: val.colorId == void 0 ? void 0 : val.colorId, }; } -export function deserializeUpdateClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField( +export function deserializeUpdateClassificationRequestBodyDataStaticConfigClassificationField( val: any -): UpdateClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField { +): UpdateClassificationRequestBodyDataStaticConfigClassificationField { const classificationDefinition: undefined | string = val.classificationDefinition == void 0 ? void 0 @@ -461,192 +465,192 @@ export function deserializeUpdateClassificationRequestBodyArgDataFieldStaticConf return { classificationDefinition: classificationDefinition, colorId: colorId, - } satisfies UpdateClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField; + } satisfies UpdateClassificationRequestBodyDataStaticConfigClassificationField; } -export function serializeUpdateClassificationRequestBodyArgDataFieldStaticConfigField( - val: UpdateClassificationRequestBodyArgDataFieldStaticConfigField +export function serializeUpdateClassificationRequestBodyDataStaticConfigField( + val: UpdateClassificationRequestBodyDataStaticConfigField ): SerializedData { return { ['classification']: val.classification == void 0 ? void 0 - : serializeUpdateClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField( + : serializeUpdateClassificationRequestBodyDataStaticConfigClassificationField( val.classification ), }; } -export function deserializeUpdateClassificationRequestBodyArgDataFieldStaticConfigField( +export function deserializeUpdateClassificationRequestBodyDataStaticConfigField( val: any -): UpdateClassificationRequestBodyArgDataFieldStaticConfigField { +): UpdateClassificationRequestBodyDataStaticConfigField { const classification: | undefined - | UpdateClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField = + | UpdateClassificationRequestBodyDataStaticConfigClassificationField = val.classification == void 0 ? void 0 - : deserializeUpdateClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField( + : deserializeUpdateClassificationRequestBodyDataStaticConfigClassificationField( val.classification ); return { classification: classification, - } satisfies UpdateClassificationRequestBodyArgDataFieldStaticConfigField; + } satisfies UpdateClassificationRequestBodyDataStaticConfigField; } -export function serializeUpdateClassificationRequestBodyArgDataField( - val: UpdateClassificationRequestBodyArgDataField +export function serializeUpdateClassificationRequestBodyDataField( + val: UpdateClassificationRequestBodyDataField ): SerializedData { return { ['key']: val.key, ['staticConfig']: val.staticConfig == void 0 ? void 0 - : serializeUpdateClassificationRequestBodyArgDataFieldStaticConfigField( + : serializeUpdateClassificationRequestBodyDataStaticConfigField( val.staticConfig ), }; } -export function deserializeUpdateClassificationRequestBodyArgDataField( +export function deserializeUpdateClassificationRequestBodyDataField( val: any -): UpdateClassificationRequestBodyArgDataField { +): UpdateClassificationRequestBodyDataField { const key: string = val.key; const staticConfig: | undefined - | UpdateClassificationRequestBodyArgDataFieldStaticConfigField = + | UpdateClassificationRequestBodyDataStaticConfigField = val.staticConfig == void 0 ? void 0 - : deserializeUpdateClassificationRequestBodyArgDataFieldStaticConfigField( + : deserializeUpdateClassificationRequestBodyDataStaticConfigField( val.staticConfig ); return { key: key, staticConfig: staticConfig, - } satisfies UpdateClassificationRequestBodyArgDataField; + } satisfies UpdateClassificationRequestBodyDataField; } -export function serializeUpdateClassificationRequestBodyArg( - val: UpdateClassificationRequestBodyArg +export function serializeUpdateClassificationRequestBody( + val: UpdateClassificationRequestBody ): SerializedData { return { - ['op']: serializeUpdateClassificationRequestBodyArgOpField(val.op), - ['fieldKey']: serializeUpdateClassificationRequestBodyArgFieldKeyField( + ['op']: serializeUpdateClassificationRequestBodyOpField(val.op), + ['fieldKey']: serializeUpdateClassificationRequestBodyFieldKeyField( val.fieldKey ), ['enumOptionKey']: val.enumOptionKey, - ['data']: serializeUpdateClassificationRequestBodyArgDataField(val.data), + ['data']: serializeUpdateClassificationRequestBodyDataField(val.data), }; } -export function deserializeUpdateClassificationRequestBodyArg( +export function deserializeUpdateClassificationRequestBody( val: any -): UpdateClassificationRequestBodyArg { - const op: UpdateClassificationRequestBodyArgOpField = - deserializeUpdateClassificationRequestBodyArgOpField(val.op); - const fieldKey: UpdateClassificationRequestBodyArgFieldKeyField = - deserializeUpdateClassificationRequestBodyArgFieldKeyField(val.fieldKey); +): UpdateClassificationRequestBody { + const op: UpdateClassificationRequestBodyOpField = + deserializeUpdateClassificationRequestBodyOpField(val.op); + const fieldKey: UpdateClassificationRequestBodyFieldKeyField = + deserializeUpdateClassificationRequestBodyFieldKeyField(val.fieldKey); const enumOptionKey: string = val.enumOptionKey; - const data: UpdateClassificationRequestBodyArgDataField = - deserializeUpdateClassificationRequestBodyArgDataField(val.data); + const data: UpdateClassificationRequestBodyDataField = + deserializeUpdateClassificationRequestBodyDataField(val.data); return { op: op, fieldKey: fieldKey, enumOptionKey: enumOptionKey, data: data, - } satisfies UpdateClassificationRequestBodyArg; + } satisfies UpdateClassificationRequestBody; } -export function serializeCreateClassificationTemplateRequestBodyArgScopeField( - val: CreateClassificationTemplateRequestBodyArgScopeField +export function serializeCreateClassificationTemplateRequestBodyScopeField( + val: CreateClassificationTemplateRequestBodyScopeField ): SerializedData { return val; } -export function deserializeCreateClassificationTemplateRequestBodyArgScopeField( +export function deserializeCreateClassificationTemplateRequestBodyScopeField( val: any -): CreateClassificationTemplateRequestBodyArgScopeField { +): CreateClassificationTemplateRequestBodyScopeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateClassificationTemplateRequestBodyArgScopeField"'; + throw 'Expecting a string for "CreateClassificationTemplateRequestBodyScopeField"'; } if (val == 'enterprise') { return 'enterprise'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateClassificationTemplateRequestBodyArgTemplateKeyField( - val: CreateClassificationTemplateRequestBodyArgTemplateKeyField +export function serializeCreateClassificationTemplateRequestBodyTemplateKeyField( + val: CreateClassificationTemplateRequestBodyTemplateKeyField ): SerializedData { return val; } -export function deserializeCreateClassificationTemplateRequestBodyArgTemplateKeyField( +export function deserializeCreateClassificationTemplateRequestBodyTemplateKeyField( val: any -): CreateClassificationTemplateRequestBodyArgTemplateKeyField { +): CreateClassificationTemplateRequestBodyTemplateKeyField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateClassificationTemplateRequestBodyArgTemplateKeyField"'; + throw 'Expecting a string for "CreateClassificationTemplateRequestBodyTemplateKeyField"'; } if (val == 'securityClassification-6VMVochwUWo') { return 'securityClassification-6VMVochwUWo'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateClassificationTemplateRequestBodyArgDisplayNameField( - val: CreateClassificationTemplateRequestBodyArgDisplayNameField +export function serializeCreateClassificationTemplateRequestBodyDisplayNameField( + val: CreateClassificationTemplateRequestBodyDisplayNameField ): SerializedData { return val; } -export function deserializeCreateClassificationTemplateRequestBodyArgDisplayNameField( +export function deserializeCreateClassificationTemplateRequestBodyDisplayNameField( val: any -): CreateClassificationTemplateRequestBodyArgDisplayNameField { +): CreateClassificationTemplateRequestBodyDisplayNameField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateClassificationTemplateRequestBodyArgDisplayNameField"'; + throw 'Expecting a string for "CreateClassificationTemplateRequestBodyDisplayNameField"'; } if (val == 'Classification') { return 'Classification'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateClassificationTemplateRequestBodyArgFieldsFieldTypeField( - val: CreateClassificationTemplateRequestBodyArgFieldsFieldTypeField +export function serializeCreateClassificationTemplateRequestBodyFieldsTypeField( + val: CreateClassificationTemplateRequestBodyFieldsTypeField ): SerializedData { return val; } -export function deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldTypeField( +export function deserializeCreateClassificationTemplateRequestBodyFieldsTypeField( val: any -): CreateClassificationTemplateRequestBodyArgFieldsFieldTypeField { +): CreateClassificationTemplateRequestBodyFieldsTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateClassificationTemplateRequestBodyArgFieldsFieldTypeField"'; + throw 'Expecting a string for "CreateClassificationTemplateRequestBodyFieldsTypeField"'; } if (val == 'enum') { return 'enum'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateClassificationTemplateRequestBodyArgFieldsFieldKeyField( - val: CreateClassificationTemplateRequestBodyArgFieldsFieldKeyField +export function serializeCreateClassificationTemplateRequestBodyFieldsKeyField( + val: CreateClassificationTemplateRequestBodyFieldsKeyField ): SerializedData { return val; } -export function deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldKeyField( +export function deserializeCreateClassificationTemplateRequestBodyFieldsKeyField( val: any -): CreateClassificationTemplateRequestBodyArgFieldsFieldKeyField { +): CreateClassificationTemplateRequestBodyFieldsKeyField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateClassificationTemplateRequestBodyArgFieldsFieldKeyField"'; + throw 'Expecting a string for "CreateClassificationTemplateRequestBodyFieldsKeyField"'; } if (val == 'Box__Security__Classification__Key') { return 'Box__Security__Classification__Key'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField( - val: CreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField +export function serializeCreateClassificationTemplateRequestBodyFieldsDisplayNameField( + val: CreateClassificationTemplateRequestBodyFieldsDisplayNameField ): SerializedData { return val; } -export function deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField( +export function deserializeCreateClassificationTemplateRequestBodyFieldsDisplayNameField( val: any -): CreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField { +): CreateClassificationTemplateRequestBodyFieldsDisplayNameField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField"'; + throw 'Expecting a string for "CreateClassificationTemplateRequestBodyFieldsDisplayNameField"'; } if (val == 'Classification') { return 'Classification'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigFieldClassificationField( - val: CreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigFieldClassificationField +export function serializeCreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigClassificationField( + val: CreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigClassificationField ): SerializedData { return { ['classificationDefinition']: @@ -656,9 +660,9 @@ export function serializeCreateClassificationTemplateRequestBodyArgFieldsFieldOp ['colorID']: val.colorId == void 0 ? void 0 : val.colorId, }; } -export function deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigFieldClassificationField( +export function deserializeCreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigClassificationField( val: any -): CreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigFieldClassificationField { +): CreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigClassificationField { const classificationDefinition: undefined | string = val.classificationDefinition == void 0 ? void 0 @@ -668,112 +672,106 @@ export function deserializeCreateClassificationTemplateRequestBodyArgFieldsField return { classificationDefinition: classificationDefinition, colorId: colorId, - } satisfies CreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigFieldClassificationField; + } satisfies CreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigClassificationField; } -export function serializeCreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigField( - val: CreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigField +export function serializeCreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigField( + val: CreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigField ): SerializedData { return { ['classification']: val.classification == void 0 ? void 0 - : serializeCreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigFieldClassificationField( + : serializeCreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigClassificationField( val.classification ), }; } -export function deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigField( +export function deserializeCreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigField( val: any -): CreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigField { +): CreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigField { const classification: | undefined - | CreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigFieldClassificationField = + | CreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigClassificationField = val.classification == void 0 ? void 0 - : deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigFieldClassificationField( + : deserializeCreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigClassificationField( val.classification ); return { classification: classification, - } satisfies CreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigField; + } satisfies CreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigField; } -export function serializeCreateClassificationTemplateRequestBodyArgFieldsFieldOptionsField( - val: CreateClassificationTemplateRequestBodyArgFieldsFieldOptionsField +export function serializeCreateClassificationTemplateRequestBodyFieldsOptionsField( + val: CreateClassificationTemplateRequestBodyFieldsOptionsField ): SerializedData { return { ['key']: val.key, ['staticConfig']: val.staticConfig == void 0 ? void 0 - : serializeCreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigField( + : serializeCreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigField( val.staticConfig ), }; } -export function deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldOptionsField( +export function deserializeCreateClassificationTemplateRequestBodyFieldsOptionsField( val: any -): CreateClassificationTemplateRequestBodyArgFieldsFieldOptionsField { +): CreateClassificationTemplateRequestBodyFieldsOptionsField { const key: string = val.key; const staticConfig: | undefined - | CreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigField = + | CreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigField = val.staticConfig == void 0 ? void 0 - : deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldOptionsFieldStaticConfigField( + : deserializeCreateClassificationTemplateRequestBodyFieldsOptionsStaticConfigField( val.staticConfig ); return { key: key, staticConfig: staticConfig, - } satisfies CreateClassificationTemplateRequestBodyArgFieldsFieldOptionsField; + } satisfies CreateClassificationTemplateRequestBodyFieldsOptionsField; } -export function serializeCreateClassificationTemplateRequestBodyArgFieldsField( - val: CreateClassificationTemplateRequestBodyArgFieldsField +export function serializeCreateClassificationTemplateRequestBodyFieldsField( + val: CreateClassificationTemplateRequestBodyFieldsField ): SerializedData { return { - ['type']: - serializeCreateClassificationTemplateRequestBodyArgFieldsFieldTypeField( - val.type - ), - ['key']: - serializeCreateClassificationTemplateRequestBodyArgFieldsFieldKeyField( - val.key - ), + ['type']: serializeCreateClassificationTemplateRequestBodyFieldsTypeField( + val.type + ), + ['key']: serializeCreateClassificationTemplateRequestBodyFieldsKeyField( + val.key + ), ['displayName']: - serializeCreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField( + serializeCreateClassificationTemplateRequestBodyFieldsDisplayNameField( val.displayName ), ['hidden']: val.hidden == void 0 ? void 0 : val.hidden, ['options']: val.options.map(function ( - item: CreateClassificationTemplateRequestBodyArgFieldsFieldOptionsField + item: CreateClassificationTemplateRequestBodyFieldsOptionsField ): any { - return serializeCreateClassificationTemplateRequestBodyArgFieldsFieldOptionsField( + return serializeCreateClassificationTemplateRequestBodyFieldsOptionsField( item ); }) as readonly any[], }; } -export function deserializeCreateClassificationTemplateRequestBodyArgFieldsField( +export function deserializeCreateClassificationTemplateRequestBodyFieldsField( val: any -): CreateClassificationTemplateRequestBodyArgFieldsField { - const type: CreateClassificationTemplateRequestBodyArgFieldsFieldTypeField = - deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldTypeField( - val.type - ); - const key: CreateClassificationTemplateRequestBodyArgFieldsFieldKeyField = - deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldKeyField( - val.key - ); - const displayName: CreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField = - deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField( +): CreateClassificationTemplateRequestBodyFieldsField { + const type: CreateClassificationTemplateRequestBodyFieldsTypeField = + deserializeCreateClassificationTemplateRequestBodyFieldsTypeField(val.type); + const key: CreateClassificationTemplateRequestBodyFieldsKeyField = + deserializeCreateClassificationTemplateRequestBodyFieldsKeyField(val.key); + const displayName: CreateClassificationTemplateRequestBodyFieldsDisplayNameField = + deserializeCreateClassificationTemplateRequestBodyFieldsDisplayNameField( val.displayName ); const hidden: undefined | boolean = val.hidden == void 0 ? void 0 : val.hidden; - const options: readonly CreateClassificationTemplateRequestBodyArgFieldsFieldOptionsField[] = + const options: readonly CreateClassificationTemplateRequestBodyFieldsOptionsField[] = sdIsList(val.options) ? (val.options.map(function (itm: SerializedData): any { - return deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldOptionsField( + return deserializeCreateClassificationTemplateRequestBodyFieldsOptionsField( itm ); }) as readonly any[]) @@ -784,21 +782,21 @@ export function deserializeCreateClassificationTemplateRequestBodyArgFieldsField displayName: displayName, hidden: hidden, options: options, - } satisfies CreateClassificationTemplateRequestBodyArgFieldsField; + } satisfies CreateClassificationTemplateRequestBodyFieldsField; } -export function serializeCreateClassificationTemplateRequestBodyArg( - val: CreateClassificationTemplateRequestBodyArg +export function serializeCreateClassificationTemplateRequestBody( + val: CreateClassificationTemplateRequestBody ): SerializedData { return { - ['scope']: serializeCreateClassificationTemplateRequestBodyArgScopeField( + ['scope']: serializeCreateClassificationTemplateRequestBodyScopeField( val.scope ), ['templateKey']: - serializeCreateClassificationTemplateRequestBodyArgTemplateKeyField( + serializeCreateClassificationTemplateRequestBodyTemplateKeyField( val.templateKey ), ['displayName']: - serializeCreateClassificationTemplateRequestBodyArgDisplayNameField( + serializeCreateClassificationTemplateRequestBodyDisplayNameField( val.displayName ), ['hidden']: val.hidden == void 0 ? void 0 : val.hidden, @@ -807,35 +805,33 @@ export function serializeCreateClassificationTemplateRequestBodyArg( ? void 0 : val.copyInstanceOnItemCopy, ['fields']: val.fields.map(function ( - item: CreateClassificationTemplateRequestBodyArgFieldsField + item: CreateClassificationTemplateRequestBodyFieldsField ): any { - return serializeCreateClassificationTemplateRequestBodyArgFieldsField( - item - ); + return serializeCreateClassificationTemplateRequestBodyFieldsField(item); }) as readonly any[], }; } -export function deserializeCreateClassificationTemplateRequestBodyArg( +export function deserializeCreateClassificationTemplateRequestBody( val: any -): CreateClassificationTemplateRequestBodyArg { - const scope: CreateClassificationTemplateRequestBodyArgScopeField = - deserializeCreateClassificationTemplateRequestBodyArgScopeField(val.scope); - const templateKey: CreateClassificationTemplateRequestBodyArgTemplateKeyField = - deserializeCreateClassificationTemplateRequestBodyArgTemplateKeyField( +): CreateClassificationTemplateRequestBody { + const scope: CreateClassificationTemplateRequestBodyScopeField = + deserializeCreateClassificationTemplateRequestBodyScopeField(val.scope); + const templateKey: CreateClassificationTemplateRequestBodyTemplateKeyField = + deserializeCreateClassificationTemplateRequestBodyTemplateKeyField( val.templateKey ); - const displayName: CreateClassificationTemplateRequestBodyArgDisplayNameField = - deserializeCreateClassificationTemplateRequestBodyArgDisplayNameField( + const displayName: CreateClassificationTemplateRequestBodyDisplayNameField = + deserializeCreateClassificationTemplateRequestBodyDisplayNameField( val.displayName ); const hidden: undefined | boolean = val.hidden == void 0 ? void 0 : val.hidden; const copyInstanceOnItemCopy: undefined | boolean = val.copyInstanceOnItemCopy == void 0 ? void 0 : val.copyInstanceOnItemCopy; - const fields: readonly CreateClassificationTemplateRequestBodyArgFieldsField[] = + const fields: readonly CreateClassificationTemplateRequestBodyFieldsField[] = sdIsList(val.fields) ? (val.fields.map(function (itm: SerializedData): any { - return deserializeCreateClassificationTemplateRequestBodyArgFieldsField( + return deserializeCreateClassificationTemplateRequestBodyFieldsField( itm ); }) as readonly any[]) @@ -847,5 +843,5 @@ export function deserializeCreateClassificationTemplateRequestBodyArg( hidden: hidden, copyInstanceOnItemCopy: copyInstanceOnItemCopy, fields: fields, - } satisfies CreateClassificationTemplateRequestBodyArg; + } satisfies CreateClassificationTemplateRequestBody; } diff --git a/src/managers/collaborationAllowlistEntries.generated.ts b/src/managers/collaborationAllowlistEntries.generated.ts index 9a8557d7..95257377 100644 --- a/src/managers/collaborationAllowlistEntries.generated.ts +++ b/src/managers/collaborationAllowlistEntries.generated.ts @@ -24,69 +24,63 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetCollaborationWhitelistEntriesQueryParamsArg { +export interface GetCollaborationWhitelistEntriesQueryParams { readonly marker?: string; readonly limit?: number; } -export class GetCollaborationWhitelistEntriesHeadersArg { +export class GetCollaborationWhitelistEntriesHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial< - Pick - > + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateCollaborationWhitelistEntryRequestBodyArgDirectionField = +export type CreateCollaborationWhitelistEntryRequestBodyDirectionField = | 'inbound' | 'outbound' | 'both'; -export interface CreateCollaborationWhitelistEntryRequestBodyArg { +export interface CreateCollaborationWhitelistEntryRequestBody { readonly domain: string; - readonly direction: CreateCollaborationWhitelistEntryRequestBodyArgDirectionField; + readonly direction: CreateCollaborationWhitelistEntryRequestBodyDirectionField; } -export class CreateCollaborationWhitelistEntryHeadersArg { +export class CreateCollaborationWhitelistEntryHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial< - Pick - > + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class GetCollaborationWhitelistEntryByIdHeadersArg { +export class GetCollaborationWhitelistEntryByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial< - Pick - > + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteCollaborationWhitelistEntryByIdHeadersArg { +export class DeleteCollaborationWhitelistEntryByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit + | Omit | Partial< - Pick + Pick > ) { Object.assign(this, fields); @@ -94,21 +88,24 @@ export class DeleteCollaborationWhitelistEntryByIdHeadersArg { } export class CollaborationAllowlistEntriesManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - CollaborationAllowlistEntriesManager, - | 'getCollaborationWhitelistEntries' - | 'createCollaborationWhitelistEntry' - | 'getCollaborationWhitelistEntryById' - | 'deleteCollaborationWhitelistEntryById' - > + fields: + | Omit< + CollaborationAllowlistEntriesManager, + | 'networkSession' + | 'getCollaborationWhitelistEntries' + | 'createCollaborationWhitelistEntry' + | 'getCollaborationWhitelistEntryById' + | 'deleteCollaborationWhitelistEntryById' + > + | Partial> ) { Object.assign(this, fields); } async getCollaborationWhitelistEntries( - queryParams: GetCollaborationWhitelistEntriesQueryParamsArg = {} satisfies GetCollaborationWhitelistEntriesQueryParamsArg, - headers: GetCollaborationWhitelistEntriesHeadersArg = new GetCollaborationWhitelistEntriesHeadersArg( + queryParams: GetCollaborationWhitelistEntriesQueryParams = {} satisfies GetCollaborationWhitelistEntriesQueryParams, + headers: GetCollaborationWhitelistEntriesHeaders = new GetCollaborationWhitelistEntriesHeaders( {} ), cancellationToken?: CancellationToken @@ -124,7 +121,8 @@ export class CollaborationAllowlistEntriesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/collaboration_whitelist_entries' + this.networkSession.baseUrls.baseUrl, + '/collaboration_whitelist_entries' ) as string, { method: 'GET', @@ -139,8 +137,8 @@ export class CollaborationAllowlistEntriesManager { return deserializeCollaborationAllowlistEntries(response.data); } async createCollaborationWhitelistEntry( - requestBody: CreateCollaborationWhitelistEntryRequestBodyArg, - headers: CreateCollaborationWhitelistEntryHeadersArg = new CreateCollaborationWhitelistEntryHeadersArg( + requestBody: CreateCollaborationWhitelistEntryRequestBody, + headers: CreateCollaborationWhitelistEntryHeaders = new CreateCollaborationWhitelistEntryHeaders( {} ), cancellationToken?: CancellationToken @@ -150,12 +148,13 @@ export class CollaborationAllowlistEntriesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/collaboration_whitelist_entries' + this.networkSession.baseUrls.baseUrl, + '/collaboration_whitelist_entries' ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateCollaborationWhitelistEntryRequestBodyArg( + data: serializeCreateCollaborationWhitelistEntryRequestBody( requestBody ), contentType: 'application/json', @@ -169,7 +168,7 @@ export class CollaborationAllowlistEntriesManager { } async getCollaborationWhitelistEntryById( collaborationWhitelistEntryId: string, - headers: GetCollaborationWhitelistEntryByIdHeadersArg = new GetCollaborationWhitelistEntryByIdHeadersArg( + headers: GetCollaborationWhitelistEntryByIdHeaders = new GetCollaborationWhitelistEntryByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -179,7 +178,8 @@ export class CollaborationAllowlistEntriesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/collaboration_whitelist_entries/', + this.networkSession.baseUrls.baseUrl, + '/collaboration_whitelist_entries/', toString(collaborationWhitelistEntryId) as string ) as string, { @@ -195,7 +195,7 @@ export class CollaborationAllowlistEntriesManager { } async deleteCollaborationWhitelistEntryById( collaborationWhitelistEntryId: string, - headers: DeleteCollaborationWhitelistEntryByIdHeadersArg = new DeleteCollaborationWhitelistEntryByIdHeadersArg( + headers: DeleteCollaborationWhitelistEntryByIdHeaders = new DeleteCollaborationWhitelistEntryByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -205,7 +205,8 @@ export class CollaborationAllowlistEntriesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/collaboration_whitelist_entries/', + this.networkSession.baseUrls.baseUrl, + '/collaboration_whitelist_entries/', toString(collaborationWhitelistEntryId) as string ) as string, { @@ -220,16 +221,16 @@ export class CollaborationAllowlistEntriesManager { return void 0; } } -export function serializeCreateCollaborationWhitelistEntryRequestBodyArgDirectionField( - val: CreateCollaborationWhitelistEntryRequestBodyArgDirectionField +export function serializeCreateCollaborationWhitelistEntryRequestBodyDirectionField( + val: CreateCollaborationWhitelistEntryRequestBodyDirectionField ): SerializedData { return val; } -export function deserializeCreateCollaborationWhitelistEntryRequestBodyArgDirectionField( +export function deserializeCreateCollaborationWhitelistEntryRequestBodyDirectionField( val: any -): CreateCollaborationWhitelistEntryRequestBodyArgDirectionField { +): CreateCollaborationWhitelistEntryRequestBodyDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateCollaborationWhitelistEntryRequestBodyArgDirectionField"'; + throw 'Expecting a string for "CreateCollaborationWhitelistEntryRequestBodyDirectionField"'; } if (val == 'inbound') { return 'inbound'; @@ -242,27 +243,27 @@ export function deserializeCreateCollaborationWhitelistEntryRequestBodyArgDirect } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateCollaborationWhitelistEntryRequestBodyArg( - val: CreateCollaborationWhitelistEntryRequestBodyArg +export function serializeCreateCollaborationWhitelistEntryRequestBody( + val: CreateCollaborationWhitelistEntryRequestBody ): SerializedData { return { ['domain']: val.domain, ['direction']: - serializeCreateCollaborationWhitelistEntryRequestBodyArgDirectionField( + serializeCreateCollaborationWhitelistEntryRequestBodyDirectionField( val.direction ), }; } -export function deserializeCreateCollaborationWhitelistEntryRequestBodyArg( +export function deserializeCreateCollaborationWhitelistEntryRequestBody( val: any -): CreateCollaborationWhitelistEntryRequestBodyArg { +): CreateCollaborationWhitelistEntryRequestBody { const domain: string = val.domain; - const direction: CreateCollaborationWhitelistEntryRequestBodyArgDirectionField = - deserializeCreateCollaborationWhitelistEntryRequestBodyArgDirectionField( + const direction: CreateCollaborationWhitelistEntryRequestBodyDirectionField = + deserializeCreateCollaborationWhitelistEntryRequestBodyDirectionField( val.direction ); return { domain: domain, direction: direction, - } satisfies CreateCollaborationWhitelistEntryRequestBodyArg; + } satisfies CreateCollaborationWhitelistEntryRequestBody; } diff --git a/src/managers/collaborationAllowlistExemptTargets.generated.ts b/src/managers/collaborationAllowlistExemptTargets.generated.ts index 50919626..26711bba 100644 --- a/src/managers/collaborationAllowlistExemptTargets.generated.ts +++ b/src/managers/collaborationAllowlistExemptTargets.generated.ts @@ -24,80 +24,71 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetCollaborationWhitelistExemptTargetsQueryParamsArg { +export interface GetCollaborationWhitelistExemptTargetsQueryParams { readonly marker?: string; readonly limit?: number; } -export class GetCollaborationWhitelistExemptTargetsHeadersArg { +export class GetCollaborationWhitelistExemptTargetsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit + | Omit | Partial< - Pick + Pick > ) { Object.assign(this, fields); } } -export interface CreateCollaborationWhitelistExemptTargetRequestBodyArgUserField { +export interface CreateCollaborationWhitelistExemptTargetRequestBodyUserField { readonly id: string; } -export interface CreateCollaborationWhitelistExemptTargetRequestBodyArg { - readonly user: CreateCollaborationWhitelistExemptTargetRequestBodyArgUserField; +export interface CreateCollaborationWhitelistExemptTargetRequestBody { + readonly user: CreateCollaborationWhitelistExemptTargetRequestBodyUserField; } -export class CreateCollaborationWhitelistExemptTargetHeadersArg { +export class CreateCollaborationWhitelistExemptTargetHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit + | Omit | Partial< - Pick< - CreateCollaborationWhitelistExemptTargetHeadersArg, - 'extraHeaders' - > + Pick > ) { Object.assign(this, fields); } } -export class GetCollaborationWhitelistExemptTargetByIdHeadersArg { +export class GetCollaborationWhitelistExemptTargetByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit< - GetCollaborationWhitelistExemptTargetByIdHeadersArg, - 'extraHeaders' - > + | Omit | Partial< - Pick< - GetCollaborationWhitelistExemptTargetByIdHeadersArg, - 'extraHeaders' - > + Pick > ) { Object.assign(this, fields); } } -export class DeleteCollaborationWhitelistExemptTargetByIdHeadersArg { +export class DeleteCollaborationWhitelistExemptTargetByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: | Omit< - DeleteCollaborationWhitelistExemptTargetByIdHeadersArg, + DeleteCollaborationWhitelistExemptTargetByIdHeaders, 'extraHeaders' > | Partial< Pick< - DeleteCollaborationWhitelistExemptTargetByIdHeadersArg, + DeleteCollaborationWhitelistExemptTargetByIdHeaders, 'extraHeaders' > > @@ -107,21 +98,26 @@ export class DeleteCollaborationWhitelistExemptTargetByIdHeadersArg { } export class CollaborationAllowlistExemptTargetsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - CollaborationAllowlistExemptTargetsManager, - | 'getCollaborationWhitelistExemptTargets' - | 'createCollaborationWhitelistExemptTarget' - | 'getCollaborationWhitelistExemptTargetById' - | 'deleteCollaborationWhitelistExemptTargetById' - > + fields: + | Omit< + CollaborationAllowlistExemptTargetsManager, + | 'networkSession' + | 'getCollaborationWhitelistExemptTargets' + | 'createCollaborationWhitelistExemptTarget' + | 'getCollaborationWhitelistExemptTargetById' + | 'deleteCollaborationWhitelistExemptTargetById' + > + | Partial< + Pick + > ) { Object.assign(this, fields); } async getCollaborationWhitelistExemptTargets( - queryParams: GetCollaborationWhitelistExemptTargetsQueryParamsArg = {} satisfies GetCollaborationWhitelistExemptTargetsQueryParamsArg, - headers: GetCollaborationWhitelistExemptTargetsHeadersArg = new GetCollaborationWhitelistExemptTargetsHeadersArg( + queryParams: GetCollaborationWhitelistExemptTargetsQueryParams = {} satisfies GetCollaborationWhitelistExemptTargetsQueryParams, + headers: GetCollaborationWhitelistExemptTargetsHeaders = new GetCollaborationWhitelistExemptTargetsHeaders( {} ), cancellationToken?: CancellationToken @@ -137,7 +133,8 @@ export class CollaborationAllowlistExemptTargetsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/collaboration_whitelist_exempt_targets' + this.networkSession.baseUrls.baseUrl, + '/collaboration_whitelist_exempt_targets' ) as string, { method: 'GET', @@ -152,8 +149,8 @@ export class CollaborationAllowlistExemptTargetsManager { return deserializeCollaborationAllowlistExemptTargets(response.data); } async createCollaborationWhitelistExemptTarget( - requestBody: CreateCollaborationWhitelistExemptTargetRequestBodyArg, - headers: CreateCollaborationWhitelistExemptTargetHeadersArg = new CreateCollaborationWhitelistExemptTargetHeadersArg( + requestBody: CreateCollaborationWhitelistExemptTargetRequestBody, + headers: CreateCollaborationWhitelistExemptTargetHeaders = new CreateCollaborationWhitelistExemptTargetHeaders( {} ), cancellationToken?: CancellationToken @@ -163,12 +160,13 @@ export class CollaborationAllowlistExemptTargetsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/collaboration_whitelist_exempt_targets' + this.networkSession.baseUrls.baseUrl, + '/collaboration_whitelist_exempt_targets' ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateCollaborationWhitelistExemptTargetRequestBodyArg( + data: serializeCreateCollaborationWhitelistExemptTargetRequestBody( requestBody ), contentType: 'application/json', @@ -182,7 +180,7 @@ export class CollaborationAllowlistExemptTargetsManager { } async getCollaborationWhitelistExemptTargetById( collaborationWhitelistExemptTargetId: string, - headers: GetCollaborationWhitelistExemptTargetByIdHeadersArg = new GetCollaborationWhitelistExemptTargetByIdHeadersArg( + headers: GetCollaborationWhitelistExemptTargetByIdHeaders = new GetCollaborationWhitelistExemptTargetByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -192,7 +190,8 @@ export class CollaborationAllowlistExemptTargetsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/collaboration_whitelist_exempt_targets/', + this.networkSession.baseUrls.baseUrl, + '/collaboration_whitelist_exempt_targets/', toString(collaborationWhitelistExemptTargetId) as string ) as string, { @@ -208,7 +207,7 @@ export class CollaborationAllowlistExemptTargetsManager { } async deleteCollaborationWhitelistExemptTargetById( collaborationWhitelistExemptTargetId: string, - headers: DeleteCollaborationWhitelistExemptTargetByIdHeadersArg = new DeleteCollaborationWhitelistExemptTargetByIdHeadersArg( + headers: DeleteCollaborationWhitelistExemptTargetByIdHeaders = new DeleteCollaborationWhitelistExemptTargetByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -218,7 +217,8 @@ export class CollaborationAllowlistExemptTargetsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/collaboration_whitelist_exempt_targets/', + this.networkSession.baseUrls.baseUrl, + '/collaboration_whitelist_exempt_targets/', toString(collaborationWhitelistExemptTargetId) as string ) as string, { @@ -233,37 +233,37 @@ export class CollaborationAllowlistExemptTargetsManager { return void 0; } } -export function serializeCreateCollaborationWhitelistExemptTargetRequestBodyArgUserField( - val: CreateCollaborationWhitelistExemptTargetRequestBodyArgUserField +export function serializeCreateCollaborationWhitelistExemptTargetRequestBodyUserField( + val: CreateCollaborationWhitelistExemptTargetRequestBodyUserField ): SerializedData { return { ['id']: val.id }; } -export function deserializeCreateCollaborationWhitelistExemptTargetRequestBodyArgUserField( +export function deserializeCreateCollaborationWhitelistExemptTargetRequestBodyUserField( val: any -): CreateCollaborationWhitelistExemptTargetRequestBodyArgUserField { +): CreateCollaborationWhitelistExemptTargetRequestBodyUserField { const id: string = val.id; return { id: id, - } satisfies CreateCollaborationWhitelistExemptTargetRequestBodyArgUserField; + } satisfies CreateCollaborationWhitelistExemptTargetRequestBodyUserField; } -export function serializeCreateCollaborationWhitelistExemptTargetRequestBodyArg( - val: CreateCollaborationWhitelistExemptTargetRequestBodyArg +export function serializeCreateCollaborationWhitelistExemptTargetRequestBody( + val: CreateCollaborationWhitelistExemptTargetRequestBody ): SerializedData { return { ['user']: - serializeCreateCollaborationWhitelistExemptTargetRequestBodyArgUserField( + serializeCreateCollaborationWhitelistExemptTargetRequestBodyUserField( val.user ), }; } -export function deserializeCreateCollaborationWhitelistExemptTargetRequestBodyArg( +export function deserializeCreateCollaborationWhitelistExemptTargetRequestBody( val: any -): CreateCollaborationWhitelistExemptTargetRequestBodyArg { - const user: CreateCollaborationWhitelistExemptTargetRequestBodyArgUserField = - deserializeCreateCollaborationWhitelistExemptTargetRequestBodyArgUserField( +): CreateCollaborationWhitelistExemptTargetRequestBody { + const user: CreateCollaborationWhitelistExemptTargetRequestBodyUserField = + deserializeCreateCollaborationWhitelistExemptTargetRequestBodyUserField( val.user ); return { user: user, - } satisfies CreateCollaborationWhitelistExemptTargetRequestBodyArg; + } satisfies CreateCollaborationWhitelistExemptTargetRequestBody; } diff --git a/src/managers/collections.generated.ts b/src/managers/collections.generated.ts index b02378e8..cd1810b4 100644 --- a/src/managers/collections.generated.ts +++ b/src/managers/collections.generated.ts @@ -24,51 +24,56 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetCollectionsQueryParamsArg { +export interface GetCollectionsQueryParams { readonly fields?: readonly string[]; readonly offset?: number; readonly limit?: number; } -export class GetCollectionsHeadersArg { +export class GetCollectionsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetCollectionItemsQueryParamsArg { +export interface GetCollectionItemsQueryParams { readonly fields?: readonly string[]; readonly offset?: number; readonly limit?: number; } -export class GetCollectionItemsHeadersArg { +export class GetCollectionItemsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class CollectionsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit + fields: + | Omit< + CollectionsManager, + 'networkSession' | 'getCollections' | 'getCollectionItems' + > + | Partial> ) { Object.assign(this, fields); } async getCollections( - queryParams: GetCollectionsQueryParamsArg = {} satisfies GetCollectionsQueryParamsArg, - headers: GetCollectionsHeadersArg = new GetCollectionsHeadersArg({}), + queryParams: GetCollectionsQueryParams = {} satisfies GetCollectionsQueryParams, + headers: GetCollectionsHeaders = new GetCollectionsHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -84,7 +89,7 @@ export class CollectionsManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/collections') as string, + ''.concat(this.networkSession.baseUrls.baseUrl, '/collections') as string, { method: 'GET', params: queryParamsMap, @@ -99,10 +104,8 @@ export class CollectionsManager { } async getCollectionItems( collectionId: string, - queryParams: GetCollectionItemsQueryParamsArg = {} satisfies GetCollectionItemsQueryParamsArg, - headers: GetCollectionItemsHeadersArg = new GetCollectionItemsHeadersArg( - {} - ), + queryParams: GetCollectionItemsQueryParams = {} satisfies GetCollectionItemsQueryParams, + headers: GetCollectionItemsHeaders = new GetCollectionItemsHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -119,7 +122,8 @@ export class CollectionsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/collections/', + this.networkSession.baseUrls.baseUrl, + '/collections/', toString(collectionId) as string, '/items' ) as string, diff --git a/src/managers/comments.generated.ts b/src/managers/comments.generated.ts index 429f1b8b..8fd7d0a9 100644 --- a/src/managers/comments.generated.ts +++ b/src/managers/comments.generated.ts @@ -24,112 +24,115 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetFileCommentsQueryParamsArg { +export interface GetFileCommentsQueryParams { readonly fields?: readonly string[]; readonly limit?: number; readonly offset?: number; } -export class GetFileCommentsHeadersArg { +export class GetFileCommentsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetCommentByIdQueryParamsArg { +export interface GetCommentByIdQueryParams { readonly fields?: readonly string[]; } -export class GetCommentByIdHeadersArg { +export class GetCommentByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface UpdateCommentByIdRequestBodyArg { +export interface UpdateCommentByIdRequestBody { readonly message?: string; } -export interface UpdateCommentByIdQueryParamsArg { +export interface UpdateCommentByIdQueryParams { readonly fields?: readonly string[]; } -export class UpdateCommentByIdHeadersArg { +export class UpdateCommentByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteCommentByIdHeadersArg { +export class DeleteCommentByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateCommentRequestBodyArgItemFieldTypeField = 'file' | 'comment'; -export interface CreateCommentRequestBodyArgItemField { +export type CreateCommentRequestBodyItemTypeField = 'file' | 'comment'; +export interface CreateCommentRequestBodyItemField { readonly id: string; - readonly type: CreateCommentRequestBodyArgItemFieldTypeField; + readonly type: CreateCommentRequestBodyItemTypeField; } -export interface CreateCommentRequestBodyArg { +export interface CreateCommentRequestBody { readonly message: string; readonly taggedMessage?: string; - readonly item: CreateCommentRequestBodyArgItemField; + readonly item: CreateCommentRequestBodyItemField; } -export interface CreateCommentQueryParamsArg { +export interface CreateCommentQueryParams { readonly fields?: readonly string[]; } -export class CreateCommentHeadersArg { +export class CreateCommentHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class CommentsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - CommentsManager, - | 'getFileComments' - | 'getCommentById' - | 'updateCommentById' - | 'deleteCommentById' - | 'createComment' - > + fields: + | Omit< + CommentsManager, + | 'networkSession' + | 'getFileComments' + | 'getCommentById' + | 'updateCommentById' + | 'deleteCommentById' + | 'createComment' + > + | Partial> ) { Object.assign(this, fields); } async getFileComments( fileId: string, - queryParams: GetFileCommentsQueryParamsArg = {} satisfies GetFileCommentsQueryParamsArg, - headers: GetFileCommentsHeadersArg = new GetFileCommentsHeadersArg({}), + queryParams: GetFileCommentsQueryParams = {} satisfies GetFileCommentsQueryParams, + headers: GetFileCommentsHeaders = new GetFileCommentsHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -146,7 +149,8 @@ export class CommentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/comments' ) as string, @@ -164,8 +168,8 @@ export class CommentsManager { } async getCommentById( commentId: string, - queryParams: GetCommentByIdQueryParamsArg = {} satisfies GetCommentByIdQueryParamsArg, - headers: GetCommentByIdHeadersArg = new GetCommentByIdHeadersArg({}), + queryParams: GetCommentByIdQueryParams = {} satisfies GetCommentByIdQueryParams, + headers: GetCommentByIdHeaders = new GetCommentByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -180,7 +184,8 @@ export class CommentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/comments/', + this.networkSession.baseUrls.baseUrl, + '/comments/', toString(commentId) as string ) as string, { @@ -197,9 +202,9 @@ export class CommentsManager { } async updateCommentById( commentId: string, - requestBody: UpdateCommentByIdRequestBodyArg = {} satisfies UpdateCommentByIdRequestBodyArg, - queryParams: UpdateCommentByIdQueryParamsArg = {} satisfies UpdateCommentByIdQueryParamsArg, - headers: UpdateCommentByIdHeadersArg = new UpdateCommentByIdHeadersArg({}), + requestBody: UpdateCommentByIdRequestBody = {} satisfies UpdateCommentByIdRequestBody, + queryParams: UpdateCommentByIdQueryParams = {} satisfies UpdateCommentByIdQueryParams, + headers: UpdateCommentByIdHeaders = new UpdateCommentByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -214,14 +219,15 @@ export class CommentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/comments/', + this.networkSession.baseUrls.baseUrl, + '/comments/', toString(commentId) as string ) as string, { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateCommentByIdRequestBodyArg(requestBody), + data: serializeUpdateCommentByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -233,7 +239,7 @@ export class CommentsManager { } async deleteCommentById( commentId: string, - headers: DeleteCommentByIdHeadersArg = new DeleteCommentByIdHeadersArg({}), + headers: DeleteCommentByIdHeaders = new DeleteCommentByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -241,7 +247,8 @@ export class CommentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/comments/', + this.networkSession.baseUrls.baseUrl, + '/comments/', toString(commentId) as string ) as string, { @@ -256,9 +263,9 @@ export class CommentsManager { return void 0; } async createComment( - requestBody: CreateCommentRequestBodyArg, - queryParams: CreateCommentQueryParamsArg = {} satisfies CreateCommentQueryParamsArg, - headers: CreateCommentHeadersArg = new CreateCommentHeadersArg({}), + requestBody: CreateCommentRequestBody, + queryParams: CreateCommentQueryParams = {} satisfies CreateCommentQueryParams, + headers: CreateCommentHeaders = new CreateCommentHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -272,12 +279,12 @@ export class CommentsManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/comments') as string, + ''.concat(this.networkSession.baseUrls.baseUrl, '/comments') as string, { method: 'POST', params: queryParamsMap, headers: headersMap, - data: serializeCreateCommentRequestBodyArg(requestBody), + data: serializeCreateCommentRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -288,28 +295,28 @@ export class CommentsManager { return deserializeCommentFull(response.data); } } -export function serializeUpdateCommentByIdRequestBodyArg( - val: UpdateCommentByIdRequestBodyArg +export function serializeUpdateCommentByIdRequestBody( + val: UpdateCommentByIdRequestBody ): SerializedData { return { ['message']: val.message == void 0 ? void 0 : val.message }; } -export function deserializeUpdateCommentByIdRequestBodyArg( +export function deserializeUpdateCommentByIdRequestBody( val: any -): UpdateCommentByIdRequestBodyArg { +): UpdateCommentByIdRequestBody { const message: undefined | string = val.message == void 0 ? void 0 : val.message; - return { message: message } satisfies UpdateCommentByIdRequestBodyArg; + return { message: message } satisfies UpdateCommentByIdRequestBody; } -export function serializeCreateCommentRequestBodyArgItemFieldTypeField( - val: CreateCommentRequestBodyArgItemFieldTypeField +export function serializeCreateCommentRequestBodyItemTypeField( + val: CreateCommentRequestBodyItemTypeField ): SerializedData { return val; } -export function deserializeCreateCommentRequestBodyArgItemFieldTypeField( +export function deserializeCreateCommentRequestBodyItemTypeField( val: any -): CreateCommentRequestBodyArgItemFieldTypeField { +): CreateCommentRequestBodyItemTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateCommentRequestBodyArgItemFieldTypeField"'; + throw 'Expecting a string for "CreateCommentRequestBodyItemTypeField"'; } if (val == 'file') { return 'file'; @@ -319,43 +326,43 @@ export function deserializeCreateCommentRequestBodyArgItemFieldTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateCommentRequestBodyArgItemField( - val: CreateCommentRequestBodyArgItemField +export function serializeCreateCommentRequestBodyItemField( + val: CreateCommentRequestBodyItemField ): SerializedData { return { ['id']: val.id, - ['type']: serializeCreateCommentRequestBodyArgItemFieldTypeField(val.type), + ['type']: serializeCreateCommentRequestBodyItemTypeField(val.type), }; } -export function deserializeCreateCommentRequestBodyArgItemField( +export function deserializeCreateCommentRequestBodyItemField( val: any -): CreateCommentRequestBodyArgItemField { +): CreateCommentRequestBodyItemField { const id: string = val.id; - const type: CreateCommentRequestBodyArgItemFieldTypeField = - deserializeCreateCommentRequestBodyArgItemFieldTypeField(val.type); - return { id: id, type: type } satisfies CreateCommentRequestBodyArgItemField; + const type: CreateCommentRequestBodyItemTypeField = + deserializeCreateCommentRequestBodyItemTypeField(val.type); + return { id: id, type: type } satisfies CreateCommentRequestBodyItemField; } -export function serializeCreateCommentRequestBodyArg( - val: CreateCommentRequestBodyArg +export function serializeCreateCommentRequestBody( + val: CreateCommentRequestBody ): SerializedData { return { ['message']: val.message, ['tagged_message']: val.taggedMessage == void 0 ? void 0 : val.taggedMessage, - ['item']: serializeCreateCommentRequestBodyArgItemField(val.item), + ['item']: serializeCreateCommentRequestBodyItemField(val.item), }; } -export function deserializeCreateCommentRequestBodyArg( +export function deserializeCreateCommentRequestBody( val: any -): CreateCommentRequestBodyArg { +): CreateCommentRequestBody { const message: string = val.message; const taggedMessage: undefined | string = val.tagged_message == void 0 ? void 0 : val.tagged_message; - const item: CreateCommentRequestBodyArgItemField = - deserializeCreateCommentRequestBodyArgItemField(val.item); + const item: CreateCommentRequestBodyItemField = + deserializeCreateCommentRequestBodyItemField(val.item); return { message: message, taggedMessage: taggedMessage, item: item, - } satisfies CreateCommentRequestBodyArg; + } satisfies CreateCommentRequestBody; } diff --git a/src/managers/devicePinners.generated.ts b/src/managers/devicePinners.generated.ts index 5f5b4b67..d54953c3 100644 --- a/src/managers/devicePinners.generated.ts +++ b/src/managers/devicePinners.generated.ts @@ -24,68 +24,69 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetDevicePinnerByIdHeadersArg { +export class GetDevicePinnerByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteDevicePinnerByIdHeadersArg { +export class DeleteDevicePinnerByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type GetEnterpriseDevicePinnersQueryParamsArgDirectionField = +export type GetEnterpriseDevicePinnersQueryParamsDirectionField = | 'ASC' | 'DESC'; -export interface GetEnterpriseDevicePinnersQueryParamsArg { +export interface GetEnterpriseDevicePinnersQueryParams { readonly marker?: string; readonly limit?: number; - readonly direction?: GetEnterpriseDevicePinnersQueryParamsArgDirectionField; + readonly direction?: GetEnterpriseDevicePinnersQueryParamsDirectionField; } -export class GetEnterpriseDevicePinnersHeadersArg { +export class GetEnterpriseDevicePinnersHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class DevicePinnersManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - DevicePinnersManager, - | 'getDevicePinnerById' - | 'deleteDevicePinnerById' - | 'getEnterpriseDevicePinners' - > + fields: + | Omit< + DevicePinnersManager, + | 'networkSession' + | 'getDevicePinnerById' + | 'deleteDevicePinnerById' + | 'getEnterpriseDevicePinners' + > + | Partial> ) { Object.assign(this, fields); } async getDevicePinnerById( devicePinnerId: string, - headers: GetDevicePinnerByIdHeadersArg = new GetDevicePinnerByIdHeadersArg( - {} - ), + headers: GetDevicePinnerByIdHeaders = new GetDevicePinnerByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -93,7 +94,8 @@ export class DevicePinnersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/device_pinners/', + this.networkSession.baseUrls.baseUrl, + '/device_pinners/', toString(devicePinnerId) as string ) as string, { @@ -109,7 +111,7 @@ export class DevicePinnersManager { } async deleteDevicePinnerById( devicePinnerId: string, - headers: DeleteDevicePinnerByIdHeadersArg = new DeleteDevicePinnerByIdHeadersArg( + headers: DeleteDevicePinnerByIdHeaders = new DeleteDevicePinnerByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -119,7 +121,8 @@ export class DevicePinnersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/device_pinners/', + this.networkSession.baseUrls.baseUrl, + '/device_pinners/', toString(devicePinnerId) as string ) as string, { @@ -135,8 +138,8 @@ export class DevicePinnersManager { } async getEnterpriseDevicePinners( enterpriseId: string, - queryParams: GetEnterpriseDevicePinnersQueryParamsArg = {} satisfies GetEnterpriseDevicePinnersQueryParamsArg, - headers: GetEnterpriseDevicePinnersHeadersArg = new GetEnterpriseDevicePinnersHeadersArg( + queryParams: GetEnterpriseDevicePinnersQueryParams = {} satisfies GetEnterpriseDevicePinnersQueryParams, + headers: GetEnterpriseDevicePinnersHeaders = new GetEnterpriseDevicePinnersHeaders( {} ), cancellationToken?: CancellationToken @@ -153,7 +156,8 @@ export class DevicePinnersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/enterprises/', + this.networkSession.baseUrls.baseUrl, + '/enterprises/', toString(enterpriseId) as string, '/device_pinners' ) as string, @@ -170,16 +174,16 @@ export class DevicePinnersManager { return deserializeDevicePinners(response.data); } } -export function serializeGetEnterpriseDevicePinnersQueryParamsArgDirectionField( - val: GetEnterpriseDevicePinnersQueryParamsArgDirectionField +export function serializeGetEnterpriseDevicePinnersQueryParamsDirectionField( + val: GetEnterpriseDevicePinnersQueryParamsDirectionField ): SerializedData { return val; } -export function deserializeGetEnterpriseDevicePinnersQueryParamsArgDirectionField( +export function deserializeGetEnterpriseDevicePinnersQueryParamsDirectionField( val: any -): GetEnterpriseDevicePinnersQueryParamsArgDirectionField { +): GetEnterpriseDevicePinnersQueryParamsDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetEnterpriseDevicePinnersQueryParamsArgDirectionField"'; + throw 'Expecting a string for "GetEnterpriseDevicePinnersQueryParamsDirectionField"'; } if (val == 'ASC') { return 'ASC'; diff --git a/src/managers/downloads.generated.ts b/src/managers/downloads.generated.ts index 526d42e5..ec931277 100644 --- a/src/managers/downloads.generated.ts +++ b/src/managers/downloads.generated.ts @@ -18,11 +18,11 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface DownloadFileQueryParamsArg { +export interface DownloadFileQueryParams { readonly version?: string; readonly accessToken?: string; } -export class DownloadFileHeadersArg { +export class DownloadFileHeaders { readonly range?: string; readonly boxapi?: string; readonly extraHeaders?: { @@ -30,22 +30,26 @@ export class DownloadFileHeadersArg { } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class DownloadsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; - constructor(fields: Omit) { + readonly networkSession: NetworkSession = new NetworkSession({}); + constructor( + fields: + | Omit + | Partial> + ) { Object.assign(this, fields); } async downloadFile( fileId: string, - queryParams: DownloadFileQueryParamsArg = {} satisfies DownloadFileQueryParamsArg, - headers: DownloadFileHeadersArg = new DownloadFileHeadersArg({}), + queryParams: DownloadFileQueryParams = {} satisfies DownloadFileQueryParams, + headers: DownloadFileHeaders = new DownloadFileHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -65,7 +69,8 @@ export class DownloadsManager { }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/content' ) as string, diff --git a/src/managers/emailAliases.generated.ts b/src/managers/emailAliases.generated.ts index 0529f9ef..809b1cad 100644 --- a/src/managers/emailAliases.generated.ts +++ b/src/managers/emailAliases.generated.ts @@ -24,63 +24,64 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetUserEmailAliasesHeadersArg { +export class GetUserEmailAliasesHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface CreateUserEmailAliasRequestBodyArg { +export interface CreateUserEmailAliasRequestBody { readonly email: string; } -export class CreateUserEmailAliasHeadersArg { +export class CreateUserEmailAliasHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteUserEmailAliasByIdHeadersArg { +export class DeleteUserEmailAliasByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class EmailAliasesManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - EmailAliasesManager, - | 'getUserEmailAliases' - | 'createUserEmailAlias' - | 'deleteUserEmailAliasById' - > + fields: + | Omit< + EmailAliasesManager, + | 'networkSession' + | 'getUserEmailAliases' + | 'createUserEmailAlias' + | 'deleteUserEmailAliasById' + > + | Partial> ) { Object.assign(this, fields); } async getUserEmailAliases( userId: string, - headers: GetUserEmailAliasesHeadersArg = new GetUserEmailAliasesHeadersArg( - {} - ), + headers: GetUserEmailAliasesHeaders = new GetUserEmailAliasesHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -88,7 +89,8 @@ export class EmailAliasesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/users/', + this.networkSession.baseUrls.baseUrl, + '/users/', toString(userId) as string, '/email_aliases' ) as string, @@ -105,10 +107,8 @@ export class EmailAliasesManager { } async createUserEmailAlias( userId: string, - requestBody: CreateUserEmailAliasRequestBodyArg, - headers: CreateUserEmailAliasHeadersArg = new CreateUserEmailAliasHeadersArg( - {} - ), + requestBody: CreateUserEmailAliasRequestBody, + headers: CreateUserEmailAliasHeaders = new CreateUserEmailAliasHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -116,14 +116,15 @@ export class EmailAliasesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/users/', + this.networkSession.baseUrls.baseUrl, + '/users/', toString(userId) as string, '/email_aliases' ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateUserEmailAliasRequestBodyArg(requestBody), + data: serializeCreateUserEmailAliasRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -136,7 +137,7 @@ export class EmailAliasesManager { async deleteUserEmailAliasById( userId: string, emailAliasId: string, - headers: DeleteUserEmailAliasByIdHeadersArg = new DeleteUserEmailAliasByIdHeadersArg( + headers: DeleteUserEmailAliasByIdHeaders = new DeleteUserEmailAliasByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -146,7 +147,8 @@ export class EmailAliasesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/users/', + this.networkSession.baseUrls.baseUrl, + '/users/', toString(userId) as string, '/email_aliases/', toString(emailAliasId) as string @@ -163,14 +165,14 @@ export class EmailAliasesManager { return void 0; } } -export function serializeCreateUserEmailAliasRequestBodyArg( - val: CreateUserEmailAliasRequestBodyArg +export function serializeCreateUserEmailAliasRequestBody( + val: CreateUserEmailAliasRequestBody ): SerializedData { return { ['email']: val.email }; } -export function deserializeCreateUserEmailAliasRequestBodyArg( +export function deserializeCreateUserEmailAliasRequestBody( val: any -): CreateUserEmailAliasRequestBodyArg { +): CreateUserEmailAliasRequestBody { const email: string = val.email; - return { email: email } satisfies CreateUserEmailAliasRequestBodyArg; + return { email: email } satisfies CreateUserEmailAliasRequestBody; } diff --git a/src/managers/events.generated.ts b/src/managers/events.generated.ts index 491f3f59..a426ad57 100644 --- a/src/managers/events.generated.ts +++ b/src/managers/events.generated.ts @@ -24,13 +24,13 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export type GetEventsQueryParamsArgStreamTypeField = +export type GetEventsQueryParamsStreamTypeField = | 'all' | 'changes' | 'sync' | 'admin_logs' | 'admin_logs_streaming'; -export type GetEventsQueryParamsArgEventTypeField = +export type GetEventsQueryParamsEventTypeField = | 'ACCESS_GRANTED' | 'ACCESS_REVOKED' | 'ADD_DEVICE_ASSOCIATION' @@ -142,49 +142,54 @@ export type GetEventsQueryParamsArgEventTypeField = | 'USER_AUTHENTICATE_OAUTH2_ACCESS_TOKEN_CREATE' | 'WATERMARK_LABEL_CREATE' | 'WATERMARK_LABEL_DELETE'; -export interface GetEventsQueryParamsArg { - readonly streamType?: GetEventsQueryParamsArgStreamTypeField; +export interface GetEventsQueryParams { + readonly streamType?: GetEventsQueryParamsStreamTypeField; readonly streamPosition?: string; readonly limit?: number; - readonly eventType?: readonly GetEventsQueryParamsArgEventTypeField[]; + readonly eventType?: readonly GetEventsQueryParamsEventTypeField[]; readonly createdAfter?: string; readonly createdBefore?: string; } -export class GetEventsHeadersArg { +export class GetEventsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class GetEventsWithLongPollingHeadersArg { +export class GetEventsWithLongPollingHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class EventsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit + fields: + | Omit< + EventsManager, + 'networkSession' | 'getEvents' | 'getEventsWithLongPolling' + > + | Partial> ) { Object.assign(this, fields); } async getEvents( - queryParams: GetEventsQueryParamsArg = {} satisfies GetEventsQueryParamsArg, - headers: GetEventsHeadersArg = new GetEventsHeadersArg({}), + queryParams: GetEventsQueryParams = {} satisfies GetEventsQueryParams, + headers: GetEventsHeaders = new GetEventsHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -203,7 +208,7 @@ export class EventsManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/events') as string, + ''.concat(this.networkSession.baseUrls.baseUrl, '/events') as string, { method: 'GET', params: queryParamsMap, @@ -217,7 +222,7 @@ export class EventsManager { return deserializeEvents(response.data); } async getEventsWithLongPolling( - headers: GetEventsWithLongPollingHeadersArg = new GetEventsWithLongPollingHeadersArg( + headers: GetEventsWithLongPollingHeaders = new GetEventsWithLongPollingHeaders( {} ), cancellationToken?: CancellationToken @@ -226,7 +231,7 @@ export class EventsManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/events') as string, + ''.concat(this.networkSession.baseUrls.baseUrl, '/events') as string, { method: 'OPTIONS', headers: headersMap, @@ -239,16 +244,16 @@ export class EventsManager { return deserializeRealtimeServers(response.data); } } -export function serializeGetEventsQueryParamsArgStreamTypeField( - val: GetEventsQueryParamsArgStreamTypeField +export function serializeGetEventsQueryParamsStreamTypeField( + val: GetEventsQueryParamsStreamTypeField ): SerializedData { return val; } -export function deserializeGetEventsQueryParamsArgStreamTypeField( +export function deserializeGetEventsQueryParamsStreamTypeField( val: any -): GetEventsQueryParamsArgStreamTypeField { +): GetEventsQueryParamsStreamTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetEventsQueryParamsArgStreamTypeField"'; + throw 'Expecting a string for "GetEventsQueryParamsStreamTypeField"'; } if (val == 'all') { return 'all'; @@ -267,16 +272,16 @@ export function deserializeGetEventsQueryParamsArgStreamTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeGetEventsQueryParamsArgEventTypeField( - val: GetEventsQueryParamsArgEventTypeField +export function serializeGetEventsQueryParamsEventTypeField( + val: GetEventsQueryParamsEventTypeField ): SerializedData { return val; } -export function deserializeGetEventsQueryParamsArgEventTypeField( +export function deserializeGetEventsQueryParamsEventTypeField( val: any -): GetEventsQueryParamsArgEventTypeField { +): GetEventsQueryParamsEventTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetEventsQueryParamsArgEventTypeField"'; + throw 'Expecting a string for "GetEventsQueryParamsEventTypeField"'; } if (val == 'ACCESS_GRANTED') { return 'ACCESS_GRANTED'; diff --git a/src/managers/fileClassifications.generated.ts b/src/managers/fileClassifications.generated.ts index 669c5d84..d5225318 100644 --- a/src/managers/fileClassifications.generated.ts +++ b/src/managers/fileClassifications.generated.ts @@ -21,82 +21,85 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetClassificationOnFileHeadersArg { +export class GetClassificationOnFileHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface AddClassificationToFileRequestBodyArg { +export interface AddClassificationToFileRequestBody { readonly boxSecurityClassificationKey?: string; } -export class AddClassificationToFileHeadersArg { +export class AddClassificationToFileHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateClassificationOnFileRequestBodyArgOpField = 'replace'; -export type UpdateClassificationOnFileRequestBodyArgPathField = +export type UpdateClassificationOnFileRequestBodyOpField = 'replace'; +export type UpdateClassificationOnFileRequestBodyPathField = '/Box__Security__Classification__Key'; -export interface UpdateClassificationOnFileRequestBodyArg { - readonly op: UpdateClassificationOnFileRequestBodyArgOpField; - readonly path: UpdateClassificationOnFileRequestBodyArgPathField; +export interface UpdateClassificationOnFileRequestBody { + readonly op: UpdateClassificationOnFileRequestBodyOpField; + readonly path: UpdateClassificationOnFileRequestBodyPathField; readonly value: string; } -export class UpdateClassificationOnFileHeadersArg { +export class UpdateClassificationOnFileHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteClassificationFromFileHeadersArg { +export class DeleteClassificationFromFileHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class FileClassificationsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - FileClassificationsManager, - | 'getClassificationOnFile' - | 'addClassificationToFile' - | 'updateClassificationOnFile' - | 'deleteClassificationFromFile' - > + fields: + | Omit< + FileClassificationsManager, + | 'networkSession' + | 'getClassificationOnFile' + | 'addClassificationToFile' + | 'updateClassificationOnFile' + | 'deleteClassificationFromFile' + > + | Partial> ) { Object.assign(this, fields); } async getClassificationOnFile( fileId: string, - headers: GetClassificationOnFileHeadersArg = new GetClassificationOnFileHeadersArg( + headers: GetClassificationOnFileHeaders = new GetClassificationOnFileHeaders( {} ), cancellationToken?: CancellationToken @@ -106,7 +109,8 @@ export class FileClassificationsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/metadata/enterprise/securityClassification-6VMVochwUWo' ) as string, @@ -123,8 +127,8 @@ export class FileClassificationsManager { } async addClassificationToFile( fileId: string, - requestBody: AddClassificationToFileRequestBodyArg = {} satisfies AddClassificationToFileRequestBodyArg, - headers: AddClassificationToFileHeadersArg = new AddClassificationToFileHeadersArg( + requestBody: AddClassificationToFileRequestBody = {} satisfies AddClassificationToFileRequestBody, + headers: AddClassificationToFileHeaders = new AddClassificationToFileHeaders( {} ), cancellationToken?: CancellationToken @@ -134,14 +138,15 @@ export class FileClassificationsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/metadata/enterprise/securityClassification-6VMVochwUWo' ) as string, { method: 'POST', headers: headersMap, - data: serializeAddClassificationToFileRequestBodyArg(requestBody), + data: serializeAddClassificationToFileRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -153,8 +158,8 @@ export class FileClassificationsManager { } async updateClassificationOnFile( fileId: string, - requestBody: readonly UpdateClassificationOnFileRequestBodyArg[], - headers: UpdateClassificationOnFileHeadersArg = new UpdateClassificationOnFileHeadersArg( + requestBody: readonly UpdateClassificationOnFileRequestBody[], + headers: UpdateClassificationOnFileHeaders = new UpdateClassificationOnFileHeaders( {} ), cancellationToken?: CancellationToken @@ -164,7 +169,8 @@ export class FileClassificationsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/metadata/enterprise/securityClassification-6VMVochwUWo' ) as string, @@ -172,7 +178,7 @@ export class FileClassificationsManager { method: 'PUT', headers: headersMap, data: requestBody.map( - serializeUpdateClassificationOnFileRequestBodyArg + serializeUpdateClassificationOnFileRequestBody ) as readonly any[], contentType: 'application/json-patch+json', responseFormat: 'json', @@ -185,7 +191,7 @@ export class FileClassificationsManager { } async deleteClassificationFromFile( fileId: string, - headers: DeleteClassificationFromFileHeadersArg = new DeleteClassificationFromFileHeadersArg( + headers: DeleteClassificationFromFileHeaders = new DeleteClassificationFromFileHeaders( {} ), cancellationToken?: CancellationToken @@ -195,7 +201,8 @@ export class FileClassificationsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/metadata/enterprise/securityClassification-6VMVochwUWo' ) as string, @@ -211,8 +218,8 @@ export class FileClassificationsManager { return void 0; } } -export function serializeAddClassificationToFileRequestBodyArg( - val: AddClassificationToFileRequestBodyArg +export function serializeAddClassificationToFileRequestBody( + val: AddClassificationToFileRequestBody ): SerializedData { return { ['Box__Security__Classification__Key']: @@ -221,71 +228,69 @@ export function serializeAddClassificationToFileRequestBodyArg( : val.boxSecurityClassificationKey, }; } -export function deserializeAddClassificationToFileRequestBodyArg( +export function deserializeAddClassificationToFileRequestBody( val: any -): AddClassificationToFileRequestBodyArg { +): AddClassificationToFileRequestBody { const boxSecurityClassificationKey: undefined | string = val.Box__Security__Classification__Key == void 0 ? void 0 : val.Box__Security__Classification__Key; return { boxSecurityClassificationKey: boxSecurityClassificationKey, - } satisfies AddClassificationToFileRequestBodyArg; + } satisfies AddClassificationToFileRequestBody; } -export function serializeUpdateClassificationOnFileRequestBodyArgOpField( - val: UpdateClassificationOnFileRequestBodyArgOpField +export function serializeUpdateClassificationOnFileRequestBodyOpField( + val: UpdateClassificationOnFileRequestBodyOpField ): SerializedData { return val; } -export function deserializeUpdateClassificationOnFileRequestBodyArgOpField( +export function deserializeUpdateClassificationOnFileRequestBodyOpField( val: any -): UpdateClassificationOnFileRequestBodyArgOpField { +): UpdateClassificationOnFileRequestBodyOpField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateClassificationOnFileRequestBodyArgOpField"'; + throw 'Expecting a string for "UpdateClassificationOnFileRequestBodyOpField"'; } if (val == 'replace') { return 'replace'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateClassificationOnFileRequestBodyArgPathField( - val: UpdateClassificationOnFileRequestBodyArgPathField +export function serializeUpdateClassificationOnFileRequestBodyPathField( + val: UpdateClassificationOnFileRequestBodyPathField ): SerializedData { return val; } -export function deserializeUpdateClassificationOnFileRequestBodyArgPathField( +export function deserializeUpdateClassificationOnFileRequestBodyPathField( val: any -): UpdateClassificationOnFileRequestBodyArgPathField { +): UpdateClassificationOnFileRequestBodyPathField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateClassificationOnFileRequestBodyArgPathField"'; + throw 'Expecting a string for "UpdateClassificationOnFileRequestBodyPathField"'; } if (val == '/Box__Security__Classification__Key') { return '/Box__Security__Classification__Key'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateClassificationOnFileRequestBodyArg( - val: UpdateClassificationOnFileRequestBodyArg +export function serializeUpdateClassificationOnFileRequestBody( + val: UpdateClassificationOnFileRequestBody ): SerializedData { return { - ['op']: serializeUpdateClassificationOnFileRequestBodyArgOpField(val.op), - ['path']: serializeUpdateClassificationOnFileRequestBodyArgPathField( - val.path - ), + ['op']: serializeUpdateClassificationOnFileRequestBodyOpField(val.op), + ['path']: serializeUpdateClassificationOnFileRequestBodyPathField(val.path), ['value']: val.value, }; } -export function deserializeUpdateClassificationOnFileRequestBodyArg( +export function deserializeUpdateClassificationOnFileRequestBody( val: any -): UpdateClassificationOnFileRequestBodyArg { - const op: UpdateClassificationOnFileRequestBodyArgOpField = - deserializeUpdateClassificationOnFileRequestBodyArgOpField(val.op); - const path: UpdateClassificationOnFileRequestBodyArgPathField = - deserializeUpdateClassificationOnFileRequestBodyArgPathField(val.path); +): UpdateClassificationOnFileRequestBody { + const op: UpdateClassificationOnFileRequestBodyOpField = + deserializeUpdateClassificationOnFileRequestBodyOpField(val.op); + const path: UpdateClassificationOnFileRequestBodyPathField = + deserializeUpdateClassificationOnFileRequestBodyPathField(val.path); const value: string = val.value; return { op: op, path: path, value: value, - } satisfies UpdateClassificationOnFileRequestBodyArg; + } satisfies UpdateClassificationOnFileRequestBody; } diff --git a/src/managers/fileMetadata.generated.ts b/src/managers/fileMetadata.generated.ts index ba06fd09..7524b328 100644 --- a/src/managers/fileMetadata.generated.ts +++ b/src/managers/fileMetadata.generated.ts @@ -24,104 +24,107 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetFileMetadataHeadersArg { +export class GetFileMetadataHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type GetFileMetadataByIdScopeArg = 'global' | 'enterprise'; -export class GetFileMetadataByIdHeadersArg { +export type GetFileMetadataByIdScope = 'global' | 'enterprise'; +export class GetFileMetadataByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateFileMetadataByIdScopeArg = 'global' | 'enterprise'; -export type CreateFileMetadataByIdRequestBodyArg = { +export type CreateFileMetadataByIdScope = 'global' | 'enterprise'; +export type CreateFileMetadataByIdRequestBody = { readonly [key: string]: string; }; -export class CreateFileMetadataByIdHeadersArg { +export class CreateFileMetadataByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateFileMetadataByIdScopeArg = 'global' | 'enterprise'; -export type UpdateFileMetadataByIdRequestBodyArgOpField = +export type UpdateFileMetadataByIdScope = 'global' | 'enterprise'; +export type UpdateFileMetadataByIdRequestBodyOpField = | 'add' | 'replace' | 'remove' | 'test' | 'move' | 'copy'; -export interface UpdateFileMetadataByIdRequestBodyArg { - readonly op?: UpdateFileMetadataByIdRequestBodyArgOpField; +export interface UpdateFileMetadataByIdRequestBody { + readonly op?: UpdateFileMetadataByIdRequestBodyOpField; readonly path?: string; readonly value?: string; readonly from?: string; } -export class UpdateFileMetadataByIdHeadersArg { +export class UpdateFileMetadataByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type DeleteFileMetadataByIdScopeArg = 'global' | 'enterprise'; -export class DeleteFileMetadataByIdHeadersArg { +export type DeleteFileMetadataByIdScope = 'global' | 'enterprise'; +export class DeleteFileMetadataByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class FileMetadataManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - FileMetadataManager, - | 'getFileMetadata' - | 'getFileMetadataById' - | 'createFileMetadataById' - | 'updateFileMetadataById' - | 'deleteFileMetadataById' - > + fields: + | Omit< + FileMetadataManager, + | 'networkSession' + | 'getFileMetadata' + | 'getFileMetadataById' + | 'createFileMetadataById' + | 'updateFileMetadataById' + | 'deleteFileMetadataById' + > + | Partial> ) { Object.assign(this, fields); } async getFileMetadata( fileId: string, - headers: GetFileMetadataHeadersArg = new GetFileMetadataHeadersArg({}), + headers: GetFileMetadataHeaders = new GetFileMetadataHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -129,7 +132,8 @@ export class FileMetadataManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/metadata' ) as string, @@ -146,11 +150,9 @@ export class FileMetadataManager { } async getFileMetadataById( fileId: string, - scope: GetFileMetadataByIdScopeArg, + scope: GetFileMetadataByIdScope, templateKey: string, - headers: GetFileMetadataByIdHeadersArg = new GetFileMetadataByIdHeadersArg( - {} - ), + headers: GetFileMetadataByIdHeaders = new GetFileMetadataByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -158,7 +160,8 @@ export class FileMetadataManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/metadata/', toString(scope) as string, @@ -178,10 +181,10 @@ export class FileMetadataManager { } async createFileMetadataById( fileId: string, - scope: CreateFileMetadataByIdScopeArg, + scope: CreateFileMetadataByIdScope, templateKey: string, - requestBody: CreateFileMetadataByIdRequestBodyArg, - headers: CreateFileMetadataByIdHeadersArg = new CreateFileMetadataByIdHeadersArg( + requestBody: CreateFileMetadataByIdRequestBody, + headers: CreateFileMetadataByIdHeaders = new CreateFileMetadataByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -191,7 +194,8 @@ export class FileMetadataManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/metadata/', toString(scope) as string, @@ -201,7 +205,7 @@ export class FileMetadataManager { { method: 'POST', headers: headersMap, - data: serializeCreateFileMetadataByIdRequestBodyArg(requestBody), + data: serializeCreateFileMetadataByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -213,10 +217,10 @@ export class FileMetadataManager { } async updateFileMetadataById( fileId: string, - scope: UpdateFileMetadataByIdScopeArg, + scope: UpdateFileMetadataByIdScope, templateKey: string, - requestBody: readonly UpdateFileMetadataByIdRequestBodyArg[], - headers: UpdateFileMetadataByIdHeadersArg = new UpdateFileMetadataByIdHeadersArg( + requestBody: readonly UpdateFileMetadataByIdRequestBody[], + headers: UpdateFileMetadataByIdHeaders = new UpdateFileMetadataByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -226,7 +230,8 @@ export class FileMetadataManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/metadata/', toString(scope) as string, @@ -237,7 +242,7 @@ export class FileMetadataManager { method: 'PUT', headers: headersMap, data: requestBody.map( - serializeUpdateFileMetadataByIdRequestBodyArg + serializeUpdateFileMetadataByIdRequestBody ) as readonly any[], contentType: 'application/json-patch+json', responseFormat: 'json', @@ -250,9 +255,9 @@ export class FileMetadataManager { } async deleteFileMetadataById( fileId: string, - scope: DeleteFileMetadataByIdScopeArg, + scope: DeleteFileMetadataByIdScope, templateKey: string, - headers: DeleteFileMetadataByIdHeadersArg = new DeleteFileMetadataByIdHeadersArg( + headers: DeleteFileMetadataByIdHeaders = new DeleteFileMetadataByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -262,7 +267,8 @@ export class FileMetadataManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/metadata/', toString(scope) as string, @@ -281,16 +287,16 @@ export class FileMetadataManager { return void 0; } } -export function serializeGetFileMetadataByIdScopeArg( - val: GetFileMetadataByIdScopeArg +export function serializeGetFileMetadataByIdScope( + val: GetFileMetadataByIdScope ): SerializedData { return val; } -export function deserializeGetFileMetadataByIdScopeArg( +export function deserializeGetFileMetadataByIdScope( val: any -): GetFileMetadataByIdScopeArg { +): GetFileMetadataByIdScope { if (!sdIsString(val)) { - throw 'Expecting a string for "GetFileMetadataByIdScopeArg"'; + throw 'Expecting a string for "GetFileMetadataByIdScope"'; } if (val == 'global') { return 'global'; @@ -300,16 +306,16 @@ export function deserializeGetFileMetadataByIdScopeArg( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateFileMetadataByIdScopeArg( - val: CreateFileMetadataByIdScopeArg +export function serializeCreateFileMetadataByIdScope( + val: CreateFileMetadataByIdScope ): SerializedData { return val; } -export function deserializeCreateFileMetadataByIdScopeArg( +export function deserializeCreateFileMetadataByIdScope( val: any -): CreateFileMetadataByIdScopeArg { +): CreateFileMetadataByIdScope { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateFileMetadataByIdScopeArg"'; + throw 'Expecting a string for "CreateFileMetadataByIdScope"'; } if (val == 'global') { return 'global'; @@ -319,26 +325,26 @@ export function deserializeCreateFileMetadataByIdScopeArg( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateFileMetadataByIdRequestBodyArg( - val: CreateFileMetadataByIdRequestBodyArg +export function serializeCreateFileMetadataByIdRequestBody( + val: CreateFileMetadataByIdRequestBody ): SerializedData { return val; } -export function deserializeCreateFileMetadataByIdRequestBodyArg( +export function deserializeCreateFileMetadataByIdRequestBody( val: any -): CreateFileMetadataByIdRequestBodyArg { +): CreateFileMetadataByIdRequestBody { return val; } -export function serializeUpdateFileMetadataByIdScopeArg( - val: UpdateFileMetadataByIdScopeArg +export function serializeUpdateFileMetadataByIdScope( + val: UpdateFileMetadataByIdScope ): SerializedData { return val; } -export function deserializeUpdateFileMetadataByIdScopeArg( +export function deserializeUpdateFileMetadataByIdScope( val: any -): UpdateFileMetadataByIdScopeArg { +): UpdateFileMetadataByIdScope { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFileMetadataByIdScopeArg"'; + throw 'Expecting a string for "UpdateFileMetadataByIdScope"'; } if (val == 'global') { return 'global'; @@ -348,16 +354,16 @@ export function deserializeUpdateFileMetadataByIdScopeArg( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFileMetadataByIdRequestBodyArgOpField( - val: UpdateFileMetadataByIdRequestBodyArgOpField +export function serializeUpdateFileMetadataByIdRequestBodyOpField( + val: UpdateFileMetadataByIdRequestBodyOpField ): SerializedData { return val; } -export function deserializeUpdateFileMetadataByIdRequestBodyArgOpField( +export function deserializeUpdateFileMetadataByIdRequestBodyOpField( val: any -): UpdateFileMetadataByIdRequestBodyArgOpField { +): UpdateFileMetadataByIdRequestBodyOpField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFileMetadataByIdRequestBodyArgOpField"'; + throw 'Expecting a string for "UpdateFileMetadataByIdRequestBodyOpField"'; } if (val == 'add') { return 'add'; @@ -379,26 +385,26 @@ export function deserializeUpdateFileMetadataByIdRequestBodyArgOpField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFileMetadataByIdRequestBodyArg( - val: UpdateFileMetadataByIdRequestBodyArg +export function serializeUpdateFileMetadataByIdRequestBody( + val: UpdateFileMetadataByIdRequestBody ): SerializedData { return { ['op']: val.op == void 0 ? void 0 - : serializeUpdateFileMetadataByIdRequestBodyArgOpField(val.op), + : serializeUpdateFileMetadataByIdRequestBodyOpField(val.op), ['path']: val.path == void 0 ? void 0 : val.path, ['value']: val.value == void 0 ? void 0 : val.value, ['from']: val.from == void 0 ? void 0 : val.from, }; } -export function deserializeUpdateFileMetadataByIdRequestBodyArg( +export function deserializeUpdateFileMetadataByIdRequestBody( val: any -): UpdateFileMetadataByIdRequestBodyArg { - const op: undefined | UpdateFileMetadataByIdRequestBodyArgOpField = +): UpdateFileMetadataByIdRequestBody { + const op: undefined | UpdateFileMetadataByIdRequestBodyOpField = val.op == void 0 ? void 0 - : deserializeUpdateFileMetadataByIdRequestBodyArgOpField(val.op); + : deserializeUpdateFileMetadataByIdRequestBodyOpField(val.op); const path: undefined | string = val.path == void 0 ? void 0 : val.path; const value: undefined | string = val.value == void 0 ? void 0 : val.value; const from: undefined | string = val.from == void 0 ? void 0 : val.from; @@ -407,18 +413,18 @@ export function deserializeUpdateFileMetadataByIdRequestBodyArg( path: path, value: value, from: from, - } satisfies UpdateFileMetadataByIdRequestBodyArg; + } satisfies UpdateFileMetadataByIdRequestBody; } -export function serializeDeleteFileMetadataByIdScopeArg( - val: DeleteFileMetadataByIdScopeArg +export function serializeDeleteFileMetadataByIdScope( + val: DeleteFileMetadataByIdScope ): SerializedData { return val; } -export function deserializeDeleteFileMetadataByIdScopeArg( +export function deserializeDeleteFileMetadataByIdScope( val: any -): DeleteFileMetadataByIdScopeArg { +): DeleteFileMetadataByIdScope { if (!sdIsString(val)) { - throw 'Expecting a string for "DeleteFileMetadataByIdScopeArg"'; + throw 'Expecting a string for "DeleteFileMetadataByIdScope"'; } if (val == 'global') { return 'global'; diff --git a/src/managers/fileRequests.generated.ts b/src/managers/fileRequests.generated.ts index 699f340f..d2ebfd85 100644 --- a/src/managers/fileRequests.generated.ts +++ b/src/managers/fileRequests.generated.ts @@ -27,74 +27,75 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetFileRequestByIdHeadersArg { +export class GetFileRequestByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class UpdateFileRequestByIdHeadersArg { +export class UpdateFileRequestByIdHeaders { readonly ifMatch?: string; readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteFileRequestByIdHeadersArg { +export class DeleteFileRequestByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class CreateFileRequestCopyHeadersArg { +export class CreateFileRequestCopyHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class FileRequestsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - FileRequestsManager, - | 'getFileRequestById' - | 'updateFileRequestById' - | 'deleteFileRequestById' - | 'createFileRequestCopy' - > + fields: + | Omit< + FileRequestsManager, + | 'networkSession' + | 'getFileRequestById' + | 'updateFileRequestById' + | 'deleteFileRequestById' + | 'createFileRequestCopy' + > + | Partial> ) { Object.assign(this, fields); } async getFileRequestById( fileRequestId: string, - headers: GetFileRequestByIdHeadersArg = new GetFileRequestByIdHeadersArg( - {} - ), + headers: GetFileRequestByIdHeaders = new GetFileRequestByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -102,7 +103,8 @@ export class FileRequestsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/file_requests/', + this.networkSession.baseUrls.baseUrl, + '/file_requests/', toString(fileRequestId) as string ) as string, { @@ -119,7 +121,7 @@ export class FileRequestsManager { async updateFileRequestById( fileRequestId: string, requestBody: FileRequestUpdateRequest, - headers: UpdateFileRequestByIdHeadersArg = new UpdateFileRequestByIdHeadersArg( + headers: UpdateFileRequestByIdHeaders = new UpdateFileRequestByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -132,7 +134,8 @@ export class FileRequestsManager { }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/file_requests/', + this.networkSession.baseUrls.baseUrl, + '/file_requests/', toString(fileRequestId) as string ) as string, { @@ -150,7 +153,7 @@ export class FileRequestsManager { } async deleteFileRequestById( fileRequestId: string, - headers: DeleteFileRequestByIdHeadersArg = new DeleteFileRequestByIdHeadersArg( + headers: DeleteFileRequestByIdHeaders = new DeleteFileRequestByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -160,7 +163,8 @@ export class FileRequestsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/file_requests/', + this.networkSession.baseUrls.baseUrl, + '/file_requests/', toString(fileRequestId) as string ) as string, { @@ -177,7 +181,7 @@ export class FileRequestsManager { async createFileRequestCopy( fileRequestId: string, requestBody: FileRequestCopyRequest, - headers: CreateFileRequestCopyHeadersArg = new CreateFileRequestCopyHeadersArg( + headers: CreateFileRequestCopyHeaders = new CreateFileRequestCopyHeaders( {} ), cancellationToken?: CancellationToken @@ -187,7 +191,8 @@ export class FileRequestsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/file_requests/', + this.networkSession.baseUrls.baseUrl, + '/file_requests/', toString(fileRequestId) as string, '/copy' ) as string, diff --git a/src/managers/fileVersionLegalHolds.generated.ts b/src/managers/fileVersionLegalHolds.generated.ts index c09ff9c6..fabf55fd 100644 --- a/src/managers/fileVersionLegalHolds.generated.ts +++ b/src/managers/fileVersionLegalHolds.generated.ts @@ -24,49 +24,53 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetFileVersionLegalHoldByIdHeadersArg { +export class GetFileVersionLegalHoldByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetFileVersionLegalHoldsQueryParamsArg { +export interface GetFileVersionLegalHoldsQueryParams { readonly policyId: string; readonly marker?: string; readonly limit?: number; } -export class GetFileVersionLegalHoldsHeadersArg { +export class GetFileVersionLegalHoldsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class FileVersionLegalHoldsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - FileVersionLegalHoldsManager, - 'getFileVersionLegalHoldById' | 'getFileVersionLegalHolds' - > + fields: + | Omit< + FileVersionLegalHoldsManager, + | 'networkSession' + | 'getFileVersionLegalHoldById' + | 'getFileVersionLegalHolds' + > + | Partial> ) { Object.assign(this, fields); } async getFileVersionLegalHoldById( fileVersionLegalHoldId: string, - headers: GetFileVersionLegalHoldByIdHeadersArg = new GetFileVersionLegalHoldByIdHeadersArg( + headers: GetFileVersionLegalHoldByIdHeaders = new GetFileVersionLegalHoldByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -76,7 +80,8 @@ export class FileVersionLegalHoldsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/file_version_legal_holds/', + this.networkSession.baseUrls.baseUrl, + '/file_version_legal_holds/', toString(fileVersionLegalHoldId) as string ) as string, { @@ -91,8 +96,8 @@ export class FileVersionLegalHoldsManager { return deserializeFileVersionLegalHold(response.data); } async getFileVersionLegalHolds( - queryParams: GetFileVersionLegalHoldsQueryParamsArg, - headers: GetFileVersionLegalHoldsHeadersArg = new GetFileVersionLegalHoldsHeadersArg( + queryParams: GetFileVersionLegalHoldsQueryParams, + headers: GetFileVersionLegalHoldsHeaders = new GetFileVersionLegalHoldsHeaders( {} ), cancellationToken?: CancellationToken @@ -108,7 +113,10 @@ export class FileVersionLegalHoldsManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/file_version_legal_holds') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/file_version_legal_holds' + ) as string, { method: 'GET', params: queryParamsMap, diff --git a/src/managers/fileVersionRetentions.generated.ts b/src/managers/fileVersionRetentions.generated.ts index 1dea266d..32a364ca 100644 --- a/src/managers/fileVersionRetentions.generated.ts +++ b/src/managers/fileVersionRetentions.generated.ts @@ -24,57 +24,61 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export type GetFileVersionRetentionsQueryParamsArgDispositionActionField = +export type GetFileVersionRetentionsQueryParamsDispositionActionField = | 'permanently_delete' | 'remove_retention'; -export interface GetFileVersionRetentionsQueryParamsArg { +export interface GetFileVersionRetentionsQueryParams { readonly fileId?: string; readonly fileVersionId?: string; readonly policyId?: string; - readonly dispositionAction?: GetFileVersionRetentionsQueryParamsArgDispositionActionField; + readonly dispositionAction?: GetFileVersionRetentionsQueryParamsDispositionActionField; readonly dispositionBefore?: string; readonly dispositionAfter?: string; readonly limit?: number; readonly marker?: string; } -export class GetFileVersionRetentionsHeadersArg { +export class GetFileVersionRetentionsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class GetFileVersionRetentionByIdHeadersArg { +export class GetFileVersionRetentionByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class FileVersionRetentionsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - FileVersionRetentionsManager, - 'getFileVersionRetentions' | 'getFileVersionRetentionById' - > + fields: + | Omit< + FileVersionRetentionsManager, + | 'networkSession' + | 'getFileVersionRetentions' + | 'getFileVersionRetentionById' + > + | Partial> ) { Object.assign(this, fields); } async getFileVersionRetentions( - queryParams: GetFileVersionRetentionsQueryParamsArg = {} satisfies GetFileVersionRetentionsQueryParamsArg, - headers: GetFileVersionRetentionsHeadersArg = new GetFileVersionRetentionsHeadersArg( + queryParams: GetFileVersionRetentionsQueryParams = {} satisfies GetFileVersionRetentionsQueryParams, + headers: GetFileVersionRetentionsHeaders = new GetFileVersionRetentionsHeaders( {} ), cancellationToken?: CancellationToken @@ -95,7 +99,10 @@ export class FileVersionRetentionsManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/file_version_retentions') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/file_version_retentions' + ) as string, { method: 'GET', params: queryParamsMap, @@ -110,7 +117,7 @@ export class FileVersionRetentionsManager { } async getFileVersionRetentionById( fileVersionRetentionId: string, - headers: GetFileVersionRetentionByIdHeadersArg = new GetFileVersionRetentionByIdHeadersArg( + headers: GetFileVersionRetentionByIdHeaders = new GetFileVersionRetentionByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -120,7 +127,8 @@ export class FileVersionRetentionsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/file_version_retentions/', + this.networkSession.baseUrls.baseUrl, + '/file_version_retentions/', toString(fileVersionRetentionId) as string ) as string, { @@ -135,16 +143,16 @@ export class FileVersionRetentionsManager { return deserializeFileVersionRetention(response.data); } } -export function serializeGetFileVersionRetentionsQueryParamsArgDispositionActionField( - val: GetFileVersionRetentionsQueryParamsArgDispositionActionField +export function serializeGetFileVersionRetentionsQueryParamsDispositionActionField( + val: GetFileVersionRetentionsQueryParamsDispositionActionField ): SerializedData { return val; } -export function deserializeGetFileVersionRetentionsQueryParamsArgDispositionActionField( +export function deserializeGetFileVersionRetentionsQueryParamsDispositionActionField( val: any -): GetFileVersionRetentionsQueryParamsArgDispositionActionField { +): GetFileVersionRetentionsQueryParamsDispositionActionField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetFileVersionRetentionsQueryParamsArgDispositionActionField"'; + throw 'Expecting a string for "GetFileVersionRetentionsQueryParamsDispositionActionField"'; } if (val == 'permanently_delete') { return 'permanently_delete'; diff --git a/src/managers/fileVersions.generated.ts b/src/managers/fileVersions.generated.ts index 41563294..790a41bf 100644 --- a/src/managers/fileVersions.generated.ts +++ b/src/managers/fileVersions.generated.ts @@ -24,105 +24,108 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetFileVersionsQueryParamsArg { +export interface GetFileVersionsQueryParams { readonly fields?: readonly string[]; readonly limit?: number; readonly offset?: number; } -export class GetFileVersionsHeadersArg { +export class GetFileVersionsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetFileVersionByIdQueryParamsArg { +export interface GetFileVersionByIdQueryParams { readonly fields?: readonly string[]; } -export class GetFileVersionByIdHeadersArg { +export class GetFileVersionByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface UpdateFileVersionByIdRequestBodyArg { +export interface UpdateFileVersionByIdRequestBody { readonly trashedAt?: string; } -export class UpdateFileVersionByIdHeadersArg { +export class UpdateFileVersionByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteFileVersionByIdHeadersArg { +export class DeleteFileVersionByIdHeaders { readonly ifMatch?: string; readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type PromoteFileVersionRequestBodyArgTypeField = 'file_version'; -export interface PromoteFileVersionRequestBodyArg { +export type PromoteFileVersionRequestBodyTypeField = 'file_version'; +export interface PromoteFileVersionRequestBody { readonly id?: string; - readonly type?: PromoteFileVersionRequestBodyArgTypeField; + readonly type?: PromoteFileVersionRequestBodyTypeField; } -export interface PromoteFileVersionQueryParamsArg { +export interface PromoteFileVersionQueryParams { readonly fields?: readonly string[]; } -export class PromoteFileVersionHeadersArg { +export class PromoteFileVersionHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class FileVersionsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - FileVersionsManager, - | 'getFileVersions' - | 'getFileVersionById' - | 'updateFileVersionById' - | 'deleteFileVersionById' - | 'promoteFileVersion' - > + fields: + | Omit< + FileVersionsManager, + | 'networkSession' + | 'getFileVersions' + | 'getFileVersionById' + | 'updateFileVersionById' + | 'deleteFileVersionById' + | 'promoteFileVersion' + > + | Partial> ) { Object.assign(this, fields); } async getFileVersions( fileId: string, - queryParams: GetFileVersionsQueryParamsArg = {} satisfies GetFileVersionsQueryParamsArg, - headers: GetFileVersionsHeadersArg = new GetFileVersionsHeadersArg({}), + queryParams: GetFileVersionsQueryParams = {} satisfies GetFileVersionsQueryParams, + headers: GetFileVersionsHeaders = new GetFileVersionsHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -139,7 +142,8 @@ export class FileVersionsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/versions' ) as string, @@ -158,10 +162,8 @@ export class FileVersionsManager { async getFileVersionById( fileId: string, fileVersionId: string, - queryParams: GetFileVersionByIdQueryParamsArg = {} satisfies GetFileVersionByIdQueryParamsArg, - headers: GetFileVersionByIdHeadersArg = new GetFileVersionByIdHeadersArg( - {} - ), + queryParams: GetFileVersionByIdQueryParams = {} satisfies GetFileVersionByIdQueryParams, + headers: GetFileVersionByIdHeaders = new GetFileVersionByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -176,7 +178,8 @@ export class FileVersionsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/versions/', toString(fileVersionId) as string @@ -196,8 +199,8 @@ export class FileVersionsManager { async updateFileVersionById( fileId: string, fileVersionId: string, - requestBody: UpdateFileVersionByIdRequestBodyArg = {} satisfies UpdateFileVersionByIdRequestBodyArg, - headers: UpdateFileVersionByIdHeadersArg = new UpdateFileVersionByIdHeadersArg( + requestBody: UpdateFileVersionByIdRequestBody = {} satisfies UpdateFileVersionByIdRequestBody, + headers: UpdateFileVersionByIdHeaders = new UpdateFileVersionByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -207,7 +210,8 @@ export class FileVersionsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/versions/', toString(fileVersionId) as string @@ -215,7 +219,7 @@ export class FileVersionsManager { { method: 'PUT', headers: headersMap, - data: serializeUpdateFileVersionByIdRequestBodyArg(requestBody), + data: serializeUpdateFileVersionByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -228,7 +232,7 @@ export class FileVersionsManager { async deleteFileVersionById( fileId: string, fileVersionId: string, - headers: DeleteFileVersionByIdHeadersArg = new DeleteFileVersionByIdHeadersArg( + headers: DeleteFileVersionByIdHeaders = new DeleteFileVersionByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -241,7 +245,8 @@ export class FileVersionsManager { }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/versions/', toString(fileVersionId) as string @@ -259,11 +264,9 @@ export class FileVersionsManager { } async promoteFileVersion( fileId: string, - requestBody: PromoteFileVersionRequestBodyArg = {} satisfies PromoteFileVersionRequestBodyArg, - queryParams: PromoteFileVersionQueryParamsArg = {} satisfies PromoteFileVersionQueryParamsArg, - headers: PromoteFileVersionHeadersArg = new PromoteFileVersionHeadersArg( - {} - ), + requestBody: PromoteFileVersionRequestBody = {} satisfies PromoteFileVersionRequestBody, + queryParams: PromoteFileVersionQueryParams = {} satisfies PromoteFileVersionQueryParams, + headers: PromoteFileVersionHeaders = new PromoteFileVersionHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -278,7 +281,8 @@ export class FileVersionsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/versions/current' ) as string, @@ -286,7 +290,7 @@ export class FileVersionsManager { method: 'POST', params: queryParamsMap, headers: headersMap, - data: serializePromoteFileVersionRequestBodyArg(requestBody), + data: serializePromoteFileVersionRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -297,52 +301,52 @@ export class FileVersionsManager { return deserializeFileVersionFull(response.data); } } -export function serializeUpdateFileVersionByIdRequestBodyArg( - val: UpdateFileVersionByIdRequestBodyArg +export function serializeUpdateFileVersionByIdRequestBody( + val: UpdateFileVersionByIdRequestBody ): SerializedData { return { ['trashed_at']: val.trashedAt == void 0 ? void 0 : val.trashedAt }; } -export function deserializeUpdateFileVersionByIdRequestBodyArg( +export function deserializeUpdateFileVersionByIdRequestBody( val: any -): UpdateFileVersionByIdRequestBodyArg { +): UpdateFileVersionByIdRequestBody { const trashedAt: undefined | string = val.trashed_at == void 0 ? void 0 : val.trashed_at; - return { trashedAt: trashedAt } satisfies UpdateFileVersionByIdRequestBodyArg; + return { trashedAt: trashedAt } satisfies UpdateFileVersionByIdRequestBody; } -export function serializePromoteFileVersionRequestBodyArgTypeField( - val: PromoteFileVersionRequestBodyArgTypeField +export function serializePromoteFileVersionRequestBodyTypeField( + val: PromoteFileVersionRequestBodyTypeField ): SerializedData { return val; } -export function deserializePromoteFileVersionRequestBodyArgTypeField( +export function deserializePromoteFileVersionRequestBodyTypeField( val: any -): PromoteFileVersionRequestBodyArgTypeField { +): PromoteFileVersionRequestBodyTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "PromoteFileVersionRequestBodyArgTypeField"'; + throw 'Expecting a string for "PromoteFileVersionRequestBodyTypeField"'; } if (val == 'file_version') { return 'file_version'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializePromoteFileVersionRequestBodyArg( - val: PromoteFileVersionRequestBodyArg +export function serializePromoteFileVersionRequestBody( + val: PromoteFileVersionRequestBody ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id, ['type']: val.type == void 0 ? void 0 - : serializePromoteFileVersionRequestBodyArgTypeField(val.type), + : serializePromoteFileVersionRequestBodyTypeField(val.type), }; } -export function deserializePromoteFileVersionRequestBodyArg( +export function deserializePromoteFileVersionRequestBody( val: any -): PromoteFileVersionRequestBodyArg { +): PromoteFileVersionRequestBody { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: undefined | PromoteFileVersionRequestBodyArgTypeField = + const type: undefined | PromoteFileVersionRequestBodyTypeField = val.type == void 0 ? void 0 - : deserializePromoteFileVersionRequestBodyArgTypeField(val.type); - return { id: id, type: type } satisfies PromoteFileVersionRequestBodyArg; + : deserializePromoteFileVersionRequestBodyTypeField(val.type); + return { id: id, type: type } satisfies PromoteFileVersionRequestBody; } diff --git a/src/managers/fileWatermarks.generated.ts b/src/managers/fileWatermarks.generated.ts index 96809a86..3b4a9002 100644 --- a/src/managers/fileWatermarks.generated.ts +++ b/src/managers/fileWatermarks.generated.ts @@ -21,64 +21,68 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetFileWatermarkHeadersArg { +export class GetFileWatermarkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateFileWatermarkRequestBodyArgWatermarkFieldImprintField = - 'default'; -export interface UpdateFileWatermarkRequestBodyArgWatermarkField { - readonly imprint: UpdateFileWatermarkRequestBodyArgWatermarkFieldImprintField; +export type UpdateFileWatermarkRequestBodyWatermarkImprintField = 'default'; +export interface UpdateFileWatermarkRequestBodyWatermarkField { + readonly imprint: UpdateFileWatermarkRequestBodyWatermarkImprintField; } -export interface UpdateFileWatermarkRequestBodyArg { - readonly watermark: UpdateFileWatermarkRequestBodyArgWatermarkField; +export interface UpdateFileWatermarkRequestBody { + readonly watermark: UpdateFileWatermarkRequestBodyWatermarkField; } -export class UpdateFileWatermarkHeadersArg { +export class UpdateFileWatermarkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteFileWatermarkHeadersArg { +export class DeleteFileWatermarkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class FileWatermarksManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - FileWatermarksManager, - 'getFileWatermark' | 'updateFileWatermark' | 'deleteFileWatermark' - > + fields: + | Omit< + FileWatermarksManager, + | 'networkSession' + | 'getFileWatermark' + | 'updateFileWatermark' + | 'deleteFileWatermark' + > + | Partial> ) { Object.assign(this, fields); } async getFileWatermark( fileId: string, - headers: GetFileWatermarkHeadersArg = new GetFileWatermarkHeadersArg({}), + headers: GetFileWatermarkHeaders = new GetFileWatermarkHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -86,7 +90,8 @@ export class FileWatermarksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/watermark' ) as string, @@ -103,10 +108,8 @@ export class FileWatermarksManager { } async updateFileWatermark( fileId: string, - requestBody: UpdateFileWatermarkRequestBodyArg, - headers: UpdateFileWatermarkHeadersArg = new UpdateFileWatermarkHeadersArg( - {} - ), + requestBody: UpdateFileWatermarkRequestBody, + headers: UpdateFileWatermarkHeaders = new UpdateFileWatermarkHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -114,14 +117,15 @@ export class FileWatermarksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/watermark' ) as string, { method: 'PUT', headers: headersMap, - data: serializeUpdateFileWatermarkRequestBodyArg(requestBody), + data: serializeUpdateFileWatermarkRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -133,9 +137,7 @@ export class FileWatermarksManager { } async deleteFileWatermark( fileId: string, - headers: DeleteFileWatermarkHeadersArg = new DeleteFileWatermarkHeadersArg( - {} - ), + headers: DeleteFileWatermarkHeaders = new DeleteFileWatermarkHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -143,7 +145,8 @@ export class FileWatermarksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/watermark' ) as string, @@ -159,56 +162,53 @@ export class FileWatermarksManager { return void 0; } } -export function serializeUpdateFileWatermarkRequestBodyArgWatermarkFieldImprintField( - val: UpdateFileWatermarkRequestBodyArgWatermarkFieldImprintField +export function serializeUpdateFileWatermarkRequestBodyWatermarkImprintField( + val: UpdateFileWatermarkRequestBodyWatermarkImprintField ): SerializedData { return val; } -export function deserializeUpdateFileWatermarkRequestBodyArgWatermarkFieldImprintField( +export function deserializeUpdateFileWatermarkRequestBodyWatermarkImprintField( val: any -): UpdateFileWatermarkRequestBodyArgWatermarkFieldImprintField { +): UpdateFileWatermarkRequestBodyWatermarkImprintField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFileWatermarkRequestBodyArgWatermarkFieldImprintField"'; + throw 'Expecting a string for "UpdateFileWatermarkRequestBodyWatermarkImprintField"'; } if (val == 'default') { return 'default'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFileWatermarkRequestBodyArgWatermarkField( - val: UpdateFileWatermarkRequestBodyArgWatermarkField +export function serializeUpdateFileWatermarkRequestBodyWatermarkField( + val: UpdateFileWatermarkRequestBodyWatermarkField ): SerializedData { return { - ['imprint']: - serializeUpdateFileWatermarkRequestBodyArgWatermarkFieldImprintField( - val.imprint - ), + ['imprint']: serializeUpdateFileWatermarkRequestBodyWatermarkImprintField( + val.imprint + ), }; } -export function deserializeUpdateFileWatermarkRequestBodyArgWatermarkField( +export function deserializeUpdateFileWatermarkRequestBodyWatermarkField( val: any -): UpdateFileWatermarkRequestBodyArgWatermarkField { - const imprint: UpdateFileWatermarkRequestBodyArgWatermarkFieldImprintField = - deserializeUpdateFileWatermarkRequestBodyArgWatermarkFieldImprintField( - val.imprint - ); +): UpdateFileWatermarkRequestBodyWatermarkField { + const imprint: UpdateFileWatermarkRequestBodyWatermarkImprintField = + deserializeUpdateFileWatermarkRequestBodyWatermarkImprintField(val.imprint); return { imprint: imprint, - } satisfies UpdateFileWatermarkRequestBodyArgWatermarkField; + } satisfies UpdateFileWatermarkRequestBodyWatermarkField; } -export function serializeUpdateFileWatermarkRequestBodyArg( - val: UpdateFileWatermarkRequestBodyArg +export function serializeUpdateFileWatermarkRequestBody( + val: UpdateFileWatermarkRequestBody ): SerializedData { return { - ['watermark']: serializeUpdateFileWatermarkRequestBodyArgWatermarkField( + ['watermark']: serializeUpdateFileWatermarkRequestBodyWatermarkField( val.watermark ), }; } -export function deserializeUpdateFileWatermarkRequestBodyArg( +export function deserializeUpdateFileWatermarkRequestBody( val: any -): UpdateFileWatermarkRequestBodyArg { - const watermark: UpdateFileWatermarkRequestBodyArgWatermarkField = - deserializeUpdateFileWatermarkRequestBodyArgWatermarkField(val.watermark); - return { watermark: watermark } satisfies UpdateFileWatermarkRequestBodyArg; +): UpdateFileWatermarkRequestBody { + const watermark: UpdateFileWatermarkRequestBodyWatermarkField = + deserializeUpdateFileWatermarkRequestBodyWatermarkField(val.watermark); + return { watermark: watermark } satisfies UpdateFileWatermarkRequestBody; } diff --git a/src/managers/files.generated.ts b/src/managers/files.generated.ts index ffd8db4a..ceadf680 100644 --- a/src/managers/files.generated.ts +++ b/src/managers/files.generated.ts @@ -21,10 +21,10 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetFileByIdQueryParamsArg { +export interface GetFileByIdQueryParams { readonly fields?: readonly string[]; } -export class GetFileByIdHeadersArg { +export class GetFileByIdHeaders { readonly ifNoneMatch?: string; readonly boxapi?: string; readonly xRepHints?: string; @@ -33,146 +33,149 @@ export class GetFileByIdHeadersArg { } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface UpdateFileByIdRequestBodyArgParentField { +export interface UpdateFileByIdRequestBodyParentField { readonly id?: string; } -export type UpdateFileByIdRequestBodyArgSharedLinkFieldAccessField = +export type UpdateFileByIdRequestBodySharedLinkAccessField = | 'open' | 'company' | 'collaborators'; -export interface UpdateFileByIdRequestBodyArgSharedLinkFieldPermissionsField { +export interface UpdateFileByIdRequestBodySharedLinkPermissionsField { readonly canDownload?: boolean; } -export interface UpdateFileByIdRequestBodyArgSharedLinkField { - readonly access?: UpdateFileByIdRequestBodyArgSharedLinkFieldAccessField; +export interface UpdateFileByIdRequestBodySharedLinkField { + readonly access?: UpdateFileByIdRequestBodySharedLinkAccessField; readonly password?: string; readonly vanityName?: string; readonly unsharedAt?: string; - readonly permissions?: UpdateFileByIdRequestBodyArgSharedLinkFieldPermissionsField; + readonly permissions?: UpdateFileByIdRequestBodySharedLinkPermissionsField; } -export type UpdateFileByIdRequestBodyArgLockFieldAccessField = 'lock'; -export interface UpdateFileByIdRequestBodyArgLockField { - readonly access?: UpdateFileByIdRequestBodyArgLockFieldAccessField; +export type UpdateFileByIdRequestBodyLockAccessField = 'lock'; +export interface UpdateFileByIdRequestBodyLockField { + readonly access?: UpdateFileByIdRequestBodyLockAccessField; readonly expiresAt?: string; readonly isDownloadPrevented?: boolean; } -export type UpdateFileByIdRequestBodyArgPermissionsFieldCanDownloadField = +export type UpdateFileByIdRequestBodyPermissionsCanDownloadField = | 'open' | 'company'; -export interface UpdateFileByIdRequestBodyArgPermissionsField { - readonly canDownload?: UpdateFileByIdRequestBodyArgPermissionsFieldCanDownloadField; +export interface UpdateFileByIdRequestBodyPermissionsField { + readonly canDownload?: UpdateFileByIdRequestBodyPermissionsCanDownloadField; } -export interface UpdateFileByIdRequestBodyArgCollectionsField { +export interface UpdateFileByIdRequestBodyCollectionsField { readonly id?: string; readonly type?: string; } -export interface UpdateFileByIdRequestBodyArg { +export interface UpdateFileByIdRequestBody { readonly name?: string; readonly description?: string; - readonly parent?: UpdateFileByIdRequestBodyArgParentField; - readonly sharedLink?: UpdateFileByIdRequestBodyArgSharedLinkField; - readonly lock?: UpdateFileByIdRequestBodyArgLockField; + readonly parent?: UpdateFileByIdRequestBodyParentField; + readonly sharedLink?: UpdateFileByIdRequestBodySharedLinkField; + readonly lock?: UpdateFileByIdRequestBodyLockField; readonly dispositionAt?: string; - readonly permissions?: UpdateFileByIdRequestBodyArgPermissionsField; - readonly collections?: readonly UpdateFileByIdRequestBodyArgCollectionsField[]; + readonly permissions?: UpdateFileByIdRequestBodyPermissionsField; + readonly collections?: readonly UpdateFileByIdRequestBodyCollectionsField[]; readonly tags?: readonly string[]; } -export interface UpdateFileByIdQueryParamsArg { +export interface UpdateFileByIdQueryParams { readonly fields?: readonly string[]; } -export class UpdateFileByIdHeadersArg { +export class UpdateFileByIdHeaders { readonly ifMatch?: string; readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteFileByIdHeadersArg { +export class DeleteFileByIdHeaders { readonly ifMatch?: string; readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface CopyFileRequestBodyArgParentField { +export interface CopyFileRequestBodyParentField { readonly id: string; } -export interface CopyFileRequestBodyArg { +export interface CopyFileRequestBody { readonly name?: string; readonly version?: string; - readonly parent: CopyFileRequestBodyArgParentField; + readonly parent: CopyFileRequestBodyParentField; } -export interface CopyFileQueryParamsArg { +export interface CopyFileQueryParams { readonly fields?: readonly string[]; } -export class CopyFileHeadersArg { +export class CopyFileHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type GetFileThumbnailByIdExtensionArg = 'png' | 'jpg'; -export interface GetFileThumbnailByIdQueryParamsArg { +export type GetFileThumbnailByIdExtension = 'png' | 'jpg'; +export interface GetFileThumbnailByIdQueryParams { readonly minHeight?: number; readonly minWidth?: number; readonly maxHeight?: number; readonly maxWidth?: number; } -export class GetFileThumbnailByIdHeadersArg { +export class GetFileThumbnailByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class FilesManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - FilesManager, - | 'getFileById' - | 'updateFileById' - | 'deleteFileById' - | 'copyFile' - | 'getFileThumbnailById' - > + fields: + | Omit< + FilesManager, + | 'networkSession' + | 'getFileById' + | 'updateFileById' + | 'deleteFileById' + | 'copyFile' + | 'getFileThumbnailById' + > + | Partial> ) { Object.assign(this, fields); } async getFileById( fileId: string, - queryParams: GetFileByIdQueryParamsArg = {} satisfies GetFileByIdQueryParamsArg, - headers: GetFileByIdHeadersArg = new GetFileByIdHeadersArg({}), + queryParams: GetFileByIdQueryParams = {} satisfies GetFileByIdQueryParams, + headers: GetFileByIdHeaders = new GetFileByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -194,7 +197,8 @@ export class FilesManager { }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string ) as string, { @@ -211,9 +215,9 @@ export class FilesManager { } async updateFileById( fileId: string, - requestBody: UpdateFileByIdRequestBodyArg = {} satisfies UpdateFileByIdRequestBodyArg, - queryParams: UpdateFileByIdQueryParamsArg = {} satisfies UpdateFileByIdQueryParamsArg, - headers: UpdateFileByIdHeadersArg = new UpdateFileByIdHeadersArg({}), + requestBody: UpdateFileByIdRequestBody = {} satisfies UpdateFileByIdRequestBody, + queryParams: UpdateFileByIdQueryParams = {} satisfies UpdateFileByIdQueryParams, + headers: UpdateFileByIdHeaders = new UpdateFileByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -231,14 +235,15 @@ export class FilesManager { }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string ) as string, { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateFileByIdRequestBodyArg(requestBody), + data: serializeUpdateFileByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -250,7 +255,7 @@ export class FilesManager { } async deleteFileById( fileId: string, - headers: DeleteFileByIdHeadersArg = new DeleteFileByIdHeadersArg({}), + headers: DeleteFileByIdHeaders = new DeleteFileByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -261,7 +266,8 @@ export class FilesManager { }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string ) as string, { @@ -277,9 +283,9 @@ export class FilesManager { } async copyFile( fileId: string, - requestBody: CopyFileRequestBodyArg, - queryParams: CopyFileQueryParamsArg = {} satisfies CopyFileQueryParamsArg, - headers: CopyFileHeadersArg = new CopyFileHeadersArg({}), + requestBody: CopyFileRequestBody, + queryParams: CopyFileQueryParams = {} satisfies CopyFileQueryParams, + headers: CopyFileHeaders = new CopyFileHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -294,7 +300,8 @@ export class FilesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/copy' ) as string, @@ -302,7 +309,7 @@ export class FilesManager { method: 'POST', params: queryParamsMap, headers: headersMap, - data: serializeCopyFileRequestBodyArg(requestBody), + data: serializeCopyFileRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -314,11 +321,9 @@ export class FilesManager { } async getFileThumbnailById( fileId: string, - extension: GetFileThumbnailByIdExtensionArg, - queryParams: GetFileThumbnailByIdQueryParamsArg = {} satisfies GetFileThumbnailByIdQueryParamsArg, - headers: GetFileThumbnailByIdHeadersArg = new GetFileThumbnailByIdHeadersArg( - {} - ), + extension: GetFileThumbnailByIdExtension, + queryParams: GetFileThumbnailByIdQueryParams = {} satisfies GetFileThumbnailByIdQueryParams, + headers: GetFileThumbnailByIdHeaders = new GetFileThumbnailByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -334,7 +339,8 @@ export class FilesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/thumbnail.', toString(extension) as string @@ -352,27 +358,27 @@ export class FilesManager { return response.content; } } -export function serializeUpdateFileByIdRequestBodyArgParentField( - val: UpdateFileByIdRequestBodyArgParentField +export function serializeUpdateFileByIdRequestBodyParentField( + val: UpdateFileByIdRequestBodyParentField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id }; } -export function deserializeUpdateFileByIdRequestBodyArgParentField( +export function deserializeUpdateFileByIdRequestBodyParentField( val: any -): UpdateFileByIdRequestBodyArgParentField { +): UpdateFileByIdRequestBodyParentField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - return { id: id } satisfies UpdateFileByIdRequestBodyArgParentField; + return { id: id } satisfies UpdateFileByIdRequestBodyParentField; } -export function serializeUpdateFileByIdRequestBodyArgSharedLinkFieldAccessField( - val: UpdateFileByIdRequestBodyArgSharedLinkFieldAccessField +export function serializeUpdateFileByIdRequestBodySharedLinkAccessField( + val: UpdateFileByIdRequestBodySharedLinkAccessField ): SerializedData { return val; } -export function deserializeUpdateFileByIdRequestBodyArgSharedLinkFieldAccessField( +export function deserializeUpdateFileByIdRequestBodySharedLinkAccessField( val: any -): UpdateFileByIdRequestBodyArgSharedLinkFieldAccessField { +): UpdateFileByIdRequestBodySharedLinkAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFileByIdRequestBodyArgSharedLinkFieldAccessField"'; + throw 'Expecting a string for "UpdateFileByIdRequestBodySharedLinkAccessField"'; } if (val == 'open') { return 'open'; @@ -385,54 +391,48 @@ export function deserializeUpdateFileByIdRequestBodyArgSharedLinkFieldAccessFiel } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFileByIdRequestBodyArgSharedLinkFieldPermissionsField( - val: UpdateFileByIdRequestBodyArgSharedLinkFieldPermissionsField +export function serializeUpdateFileByIdRequestBodySharedLinkPermissionsField( + val: UpdateFileByIdRequestBodySharedLinkPermissionsField ): SerializedData { return { ['can_download']: val.canDownload == void 0 ? void 0 : val.canDownload, }; } -export function deserializeUpdateFileByIdRequestBodyArgSharedLinkFieldPermissionsField( +export function deserializeUpdateFileByIdRequestBodySharedLinkPermissionsField( val: any -): UpdateFileByIdRequestBodyArgSharedLinkFieldPermissionsField { +): UpdateFileByIdRequestBodySharedLinkPermissionsField { const canDownload: undefined | boolean = val.can_download == void 0 ? void 0 : val.can_download; return { canDownload: canDownload, - } satisfies UpdateFileByIdRequestBodyArgSharedLinkFieldPermissionsField; + } satisfies UpdateFileByIdRequestBodySharedLinkPermissionsField; } -export function serializeUpdateFileByIdRequestBodyArgSharedLinkField( - val: UpdateFileByIdRequestBodyArgSharedLinkField +export function serializeUpdateFileByIdRequestBodySharedLinkField( + val: UpdateFileByIdRequestBodySharedLinkField ): SerializedData { return { ['access']: val.access == void 0 ? void 0 - : serializeUpdateFileByIdRequestBodyArgSharedLinkFieldAccessField( - val.access - ), + : serializeUpdateFileByIdRequestBodySharedLinkAccessField(val.access), ['password']: val.password == void 0 ? void 0 : val.password, ['vanity_name']: val.vanityName == void 0 ? void 0 : val.vanityName, ['unshared_at']: val.unsharedAt == void 0 ? void 0 : val.unsharedAt, ['permissions']: val.permissions == void 0 ? void 0 - : serializeUpdateFileByIdRequestBodyArgSharedLinkFieldPermissionsField( + : serializeUpdateFileByIdRequestBodySharedLinkPermissionsField( val.permissions ), }; } -export function deserializeUpdateFileByIdRequestBodyArgSharedLinkField( +export function deserializeUpdateFileByIdRequestBodySharedLinkField( val: any -): UpdateFileByIdRequestBodyArgSharedLinkField { - const access: - | undefined - | UpdateFileByIdRequestBodyArgSharedLinkFieldAccessField = +): UpdateFileByIdRequestBodySharedLinkField { + const access: undefined | UpdateFileByIdRequestBodySharedLinkAccessField = val.access == void 0 ? void 0 - : deserializeUpdateFileByIdRequestBodyArgSharedLinkFieldAccessField( - val.access - ); + : deserializeUpdateFileByIdRequestBodySharedLinkAccessField(val.access); const password: undefined | string = val.password == void 0 ? void 0 : val.password; const vanityName: undefined | string = @@ -441,10 +441,10 @@ export function deserializeUpdateFileByIdRequestBodyArgSharedLinkField( val.unshared_at == void 0 ? void 0 : val.unshared_at; const permissions: | undefined - | UpdateFileByIdRequestBodyArgSharedLinkFieldPermissionsField = + | UpdateFileByIdRequestBodySharedLinkPermissionsField = val.permissions == void 0 ? void 0 - : deserializeUpdateFileByIdRequestBodyArgSharedLinkFieldPermissionsField( + : deserializeUpdateFileByIdRequestBodySharedLinkPermissionsField( val.permissions ); return { @@ -453,44 +453,44 @@ export function deserializeUpdateFileByIdRequestBodyArgSharedLinkField( vanityName: vanityName, unsharedAt: unsharedAt, permissions: permissions, - } satisfies UpdateFileByIdRequestBodyArgSharedLinkField; + } satisfies UpdateFileByIdRequestBodySharedLinkField; } -export function serializeUpdateFileByIdRequestBodyArgLockFieldAccessField( - val: UpdateFileByIdRequestBodyArgLockFieldAccessField +export function serializeUpdateFileByIdRequestBodyLockAccessField( + val: UpdateFileByIdRequestBodyLockAccessField ): SerializedData { return val; } -export function deserializeUpdateFileByIdRequestBodyArgLockFieldAccessField( +export function deserializeUpdateFileByIdRequestBodyLockAccessField( val: any -): UpdateFileByIdRequestBodyArgLockFieldAccessField { +): UpdateFileByIdRequestBodyLockAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFileByIdRequestBodyArgLockFieldAccessField"'; + throw 'Expecting a string for "UpdateFileByIdRequestBodyLockAccessField"'; } if (val == 'lock') { return 'lock'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFileByIdRequestBodyArgLockField( - val: UpdateFileByIdRequestBodyArgLockField +export function serializeUpdateFileByIdRequestBodyLockField( + val: UpdateFileByIdRequestBodyLockField ): SerializedData { return { ['access']: val.access == void 0 ? void 0 - : serializeUpdateFileByIdRequestBodyArgLockFieldAccessField(val.access), + : serializeUpdateFileByIdRequestBodyLockAccessField(val.access), ['expires_at']: val.expiresAt == void 0 ? void 0 : val.expiresAt, ['is_download_prevented']: val.isDownloadPrevented == void 0 ? void 0 : val.isDownloadPrevented, }; } -export function deserializeUpdateFileByIdRequestBodyArgLockField( +export function deserializeUpdateFileByIdRequestBodyLockField( val: any -): UpdateFileByIdRequestBodyArgLockField { - const access: undefined | UpdateFileByIdRequestBodyArgLockFieldAccessField = +): UpdateFileByIdRequestBodyLockField { + const access: undefined | UpdateFileByIdRequestBodyLockAccessField = val.access == void 0 ? void 0 - : deserializeUpdateFileByIdRequestBodyArgLockFieldAccessField(val.access); + : deserializeUpdateFileByIdRequestBodyLockAccessField(val.access); const expiresAt: undefined | string = val.expires_at == void 0 ? void 0 : val.expires_at; const isDownloadPrevented: undefined | boolean = @@ -499,18 +499,18 @@ export function deserializeUpdateFileByIdRequestBodyArgLockField( access: access, expiresAt: expiresAt, isDownloadPrevented: isDownloadPrevented, - } satisfies UpdateFileByIdRequestBodyArgLockField; + } satisfies UpdateFileByIdRequestBodyLockField; } -export function serializeUpdateFileByIdRequestBodyArgPermissionsFieldCanDownloadField( - val: UpdateFileByIdRequestBodyArgPermissionsFieldCanDownloadField +export function serializeUpdateFileByIdRequestBodyPermissionsCanDownloadField( + val: UpdateFileByIdRequestBodyPermissionsCanDownloadField ): SerializedData { return val; } -export function deserializeUpdateFileByIdRequestBodyArgPermissionsFieldCanDownloadField( +export function deserializeUpdateFileByIdRequestBodyPermissionsCanDownloadField( val: any -): UpdateFileByIdRequestBodyArgPermissionsFieldCanDownloadField { +): UpdateFileByIdRequestBodyPermissionsCanDownloadField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFileByIdRequestBodyArgPermissionsFieldCanDownloadField"'; + throw 'Expecting a string for "UpdateFileByIdRequestBodyPermissionsCanDownloadField"'; } if (val == 'open') { return 'open'; @@ -520,53 +520,53 @@ export function deserializeUpdateFileByIdRequestBodyArgPermissionsFieldCanDownlo } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFileByIdRequestBodyArgPermissionsField( - val: UpdateFileByIdRequestBodyArgPermissionsField +export function serializeUpdateFileByIdRequestBodyPermissionsField( + val: UpdateFileByIdRequestBodyPermissionsField ): SerializedData { return { ['can_download']: val.canDownload == void 0 ? void 0 - : serializeUpdateFileByIdRequestBodyArgPermissionsFieldCanDownloadField( + : serializeUpdateFileByIdRequestBodyPermissionsCanDownloadField( val.canDownload ), }; } -export function deserializeUpdateFileByIdRequestBodyArgPermissionsField( +export function deserializeUpdateFileByIdRequestBodyPermissionsField( val: any -): UpdateFileByIdRequestBodyArgPermissionsField { +): UpdateFileByIdRequestBodyPermissionsField { const canDownload: | undefined - | UpdateFileByIdRequestBodyArgPermissionsFieldCanDownloadField = + | UpdateFileByIdRequestBodyPermissionsCanDownloadField = val.can_download == void 0 ? void 0 - : deserializeUpdateFileByIdRequestBodyArgPermissionsFieldCanDownloadField( + : deserializeUpdateFileByIdRequestBodyPermissionsCanDownloadField( val.can_download ); return { canDownload: canDownload, - } satisfies UpdateFileByIdRequestBodyArgPermissionsField; + } satisfies UpdateFileByIdRequestBodyPermissionsField; } -export function serializeUpdateFileByIdRequestBodyArgCollectionsField( - val: UpdateFileByIdRequestBodyArgCollectionsField +export function serializeUpdateFileByIdRequestBodyCollectionsField( + val: UpdateFileByIdRequestBodyCollectionsField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id, ['type']: val.type == void 0 ? void 0 : val.type, }; } -export function deserializeUpdateFileByIdRequestBodyArgCollectionsField( +export function deserializeUpdateFileByIdRequestBodyCollectionsField( val: any -): UpdateFileByIdRequestBodyArgCollectionsField { +): UpdateFileByIdRequestBodyCollectionsField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; const type: undefined | string = val.type == void 0 ? void 0 : val.type; return { id: id, type: type, - } satisfies UpdateFileByIdRequestBodyArgCollectionsField; + } satisfies UpdateFileByIdRequestBodyCollectionsField; } -export function serializeUpdateFileByIdRequestBodyArg( - val: UpdateFileByIdRequestBodyArg +export function serializeUpdateFileByIdRequestBody( + val: UpdateFileByIdRequestBody ): SerializedData { return { ['name']: val.name == void 0 ? void 0 : val.name, @@ -574,30 +574,28 @@ export function serializeUpdateFileByIdRequestBodyArg( ['parent']: val.parent == void 0 ? void 0 - : serializeUpdateFileByIdRequestBodyArgParentField(val.parent), + : serializeUpdateFileByIdRequestBodyParentField(val.parent), ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateFileByIdRequestBodyArgSharedLinkField(val.sharedLink), + : serializeUpdateFileByIdRequestBodySharedLinkField(val.sharedLink), ['lock']: val.lock == void 0 ? void 0 - : serializeUpdateFileByIdRequestBodyArgLockField(val.lock), + : serializeUpdateFileByIdRequestBodyLockField(val.lock), ['disposition_at']: val.dispositionAt == void 0 ? void 0 : val.dispositionAt, ['permissions']: val.permissions == void 0 ? void 0 - : serializeUpdateFileByIdRequestBodyArgPermissionsField( - val.permissions - ), + : serializeUpdateFileByIdRequestBodyPermissionsField(val.permissions), ['collections']: val.collections == void 0 ? void 0 : (val.collections.map(function ( - item: UpdateFileByIdRequestBodyArgCollectionsField + item: UpdateFileByIdRequestBodyCollectionsField ): any { - return serializeUpdateFileByIdRequestBodyArgCollectionsField(item); + return serializeUpdateFileByIdRequestBodyCollectionsField(item); }) as readonly any[]), ['tags']: val.tags == void 0 @@ -607,40 +605,38 @@ export function serializeUpdateFileByIdRequestBodyArg( }) as readonly any[]), }; } -export function deserializeUpdateFileByIdRequestBodyArg( +export function deserializeUpdateFileByIdRequestBody( val: any -): UpdateFileByIdRequestBodyArg { +): UpdateFileByIdRequestBody { const name: undefined | string = val.name == void 0 ? void 0 : val.name; const description: undefined | string = val.description == void 0 ? void 0 : val.description; - const parent: undefined | UpdateFileByIdRequestBodyArgParentField = + const parent: undefined | UpdateFileByIdRequestBodyParentField = val.parent == void 0 ? void 0 - : deserializeUpdateFileByIdRequestBodyArgParentField(val.parent); - const sharedLink: undefined | UpdateFileByIdRequestBodyArgSharedLinkField = + : deserializeUpdateFileByIdRequestBodyParentField(val.parent); + const sharedLink: undefined | UpdateFileByIdRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateFileByIdRequestBodyArgSharedLinkField(val.shared_link); - const lock: undefined | UpdateFileByIdRequestBodyArgLockField = + : deserializeUpdateFileByIdRequestBodySharedLinkField(val.shared_link); + const lock: undefined | UpdateFileByIdRequestBodyLockField = val.lock == void 0 ? void 0 - : deserializeUpdateFileByIdRequestBodyArgLockField(val.lock); + : deserializeUpdateFileByIdRequestBodyLockField(val.lock); const dispositionAt: undefined | string = val.disposition_at == void 0 ? void 0 : val.disposition_at; - const permissions: undefined | UpdateFileByIdRequestBodyArgPermissionsField = + const permissions: undefined | UpdateFileByIdRequestBodyPermissionsField = val.permissions == void 0 ? void 0 - : deserializeUpdateFileByIdRequestBodyArgPermissionsField( - val.permissions - ); + : deserializeUpdateFileByIdRequestBodyPermissionsField(val.permissions); const collections: | undefined - | readonly UpdateFileByIdRequestBodyArgCollectionsField[] = + | readonly UpdateFileByIdRequestBodyCollectionsField[] = val.collections == void 0 ? void 0 : sdIsList(val.collections) ? (val.collections.map(function (itm: SerializedData): any { - return deserializeUpdateFileByIdRequestBodyArgCollectionsField(itm); + return deserializeUpdateFileByIdRequestBodyCollectionsField(itm); }) as readonly any[]) : []; const tags: undefined | readonly string[] = @@ -661,52 +657,50 @@ export function deserializeUpdateFileByIdRequestBodyArg( permissions: permissions, collections: collections, tags: tags, - } satisfies UpdateFileByIdRequestBodyArg; + } satisfies UpdateFileByIdRequestBody; } -export function serializeCopyFileRequestBodyArgParentField( - val: CopyFileRequestBodyArgParentField +export function serializeCopyFileRequestBodyParentField( + val: CopyFileRequestBodyParentField ): SerializedData { return { ['id']: val.id }; } -export function deserializeCopyFileRequestBodyArgParentField( +export function deserializeCopyFileRequestBodyParentField( val: any -): CopyFileRequestBodyArgParentField { +): CopyFileRequestBodyParentField { const id: string = val.id; - return { id: id } satisfies CopyFileRequestBodyArgParentField; + return { id: id } satisfies CopyFileRequestBodyParentField; } -export function serializeCopyFileRequestBodyArg( - val: CopyFileRequestBodyArg +export function serializeCopyFileRequestBody( + val: CopyFileRequestBody ): SerializedData { return { ['name']: val.name == void 0 ? void 0 : val.name, ['version']: val.version == void 0 ? void 0 : val.version, - ['parent']: serializeCopyFileRequestBodyArgParentField(val.parent), + ['parent']: serializeCopyFileRequestBodyParentField(val.parent), }; } -export function deserializeCopyFileRequestBodyArg( - val: any -): CopyFileRequestBodyArg { +export function deserializeCopyFileRequestBody(val: any): CopyFileRequestBody { const name: undefined | string = val.name == void 0 ? void 0 : val.name; const version: undefined | string = val.version == void 0 ? void 0 : val.version; - const parent: CopyFileRequestBodyArgParentField = - deserializeCopyFileRequestBodyArgParentField(val.parent); + const parent: CopyFileRequestBodyParentField = + deserializeCopyFileRequestBodyParentField(val.parent); return { name: name, version: version, parent: parent, - } satisfies CopyFileRequestBodyArg; + } satisfies CopyFileRequestBody; } -export function serializeGetFileThumbnailByIdExtensionArg( - val: GetFileThumbnailByIdExtensionArg +export function serializeGetFileThumbnailByIdExtension( + val: GetFileThumbnailByIdExtension ): SerializedData { return val; } -export function deserializeGetFileThumbnailByIdExtensionArg( +export function deserializeGetFileThumbnailByIdExtension( val: any -): GetFileThumbnailByIdExtensionArg { +): GetFileThumbnailByIdExtension { if (!sdIsString(val)) { - throw 'Expecting a string for "GetFileThumbnailByIdExtensionArg"'; + throw 'Expecting a string for "GetFileThumbnailByIdExtension"'; } if (val == 'png') { return 'png'; diff --git a/src/managers/folderClassifications.generated.ts b/src/managers/folderClassifications.generated.ts index ae941233..b51c2174 100644 --- a/src/managers/folderClassifications.generated.ts +++ b/src/managers/folderClassifications.generated.ts @@ -21,82 +21,85 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetClassificationOnFolderHeadersArg { +export class GetClassificationOnFolderHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface AddClassificationToFolderRequestBodyArg { +export interface AddClassificationToFolderRequestBody { readonly boxSecurityClassificationKey?: string; } -export class AddClassificationToFolderHeadersArg { +export class AddClassificationToFolderHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateClassificationOnFolderRequestBodyArgOpField = 'replace'; -export type UpdateClassificationOnFolderRequestBodyArgPathField = +export type UpdateClassificationOnFolderRequestBodyOpField = 'replace'; +export type UpdateClassificationOnFolderRequestBodyPathField = '/Box__Security__Classification__Key'; -export interface UpdateClassificationOnFolderRequestBodyArg { - readonly op: UpdateClassificationOnFolderRequestBodyArgOpField; - readonly path: UpdateClassificationOnFolderRequestBodyArgPathField; +export interface UpdateClassificationOnFolderRequestBody { + readonly op: UpdateClassificationOnFolderRequestBodyOpField; + readonly path: UpdateClassificationOnFolderRequestBodyPathField; readonly value: string; } -export class UpdateClassificationOnFolderHeadersArg { +export class UpdateClassificationOnFolderHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteClassificationFromFolderHeadersArg { +export class DeleteClassificationFromFolderHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class FolderClassificationsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - FolderClassificationsManager, - | 'getClassificationOnFolder' - | 'addClassificationToFolder' - | 'updateClassificationOnFolder' - | 'deleteClassificationFromFolder' - > + fields: + | Omit< + FolderClassificationsManager, + | 'networkSession' + | 'getClassificationOnFolder' + | 'addClassificationToFolder' + | 'updateClassificationOnFolder' + | 'deleteClassificationFromFolder' + > + | Partial> ) { Object.assign(this, fields); } async getClassificationOnFolder( folderId: string, - headers: GetClassificationOnFolderHeadersArg = new GetClassificationOnFolderHeadersArg( + headers: GetClassificationOnFolderHeaders = new GetClassificationOnFolderHeaders( {} ), cancellationToken?: CancellationToken @@ -106,7 +109,8 @@ export class FolderClassificationsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '/metadata/enterprise/securityClassification-6VMVochwUWo' ) as string, @@ -123,8 +127,8 @@ export class FolderClassificationsManager { } async addClassificationToFolder( folderId: string, - requestBody: AddClassificationToFolderRequestBodyArg = {} satisfies AddClassificationToFolderRequestBodyArg, - headers: AddClassificationToFolderHeadersArg = new AddClassificationToFolderHeadersArg( + requestBody: AddClassificationToFolderRequestBody = {} satisfies AddClassificationToFolderRequestBody, + headers: AddClassificationToFolderHeaders = new AddClassificationToFolderHeaders( {} ), cancellationToken?: CancellationToken @@ -134,14 +138,15 @@ export class FolderClassificationsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '/metadata/enterprise/securityClassification-6VMVochwUWo' ) as string, { method: 'POST', headers: headersMap, - data: serializeAddClassificationToFolderRequestBodyArg(requestBody), + data: serializeAddClassificationToFolderRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -153,8 +158,8 @@ export class FolderClassificationsManager { } async updateClassificationOnFolder( folderId: string, - requestBody: readonly UpdateClassificationOnFolderRequestBodyArg[], - headers: UpdateClassificationOnFolderHeadersArg = new UpdateClassificationOnFolderHeadersArg( + requestBody: readonly UpdateClassificationOnFolderRequestBody[], + headers: UpdateClassificationOnFolderHeaders = new UpdateClassificationOnFolderHeaders( {} ), cancellationToken?: CancellationToken @@ -164,7 +169,8 @@ export class FolderClassificationsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '/metadata/enterprise/securityClassification-6VMVochwUWo' ) as string, @@ -172,7 +178,7 @@ export class FolderClassificationsManager { method: 'PUT', headers: headersMap, data: requestBody.map( - serializeUpdateClassificationOnFolderRequestBodyArg + serializeUpdateClassificationOnFolderRequestBody ) as readonly any[], contentType: 'application/json-patch+json', responseFormat: 'json', @@ -185,7 +191,7 @@ export class FolderClassificationsManager { } async deleteClassificationFromFolder( folderId: string, - headers: DeleteClassificationFromFolderHeadersArg = new DeleteClassificationFromFolderHeadersArg( + headers: DeleteClassificationFromFolderHeaders = new DeleteClassificationFromFolderHeaders( {} ), cancellationToken?: CancellationToken @@ -195,7 +201,8 @@ export class FolderClassificationsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '/metadata/enterprise/securityClassification-6VMVochwUWo' ) as string, @@ -211,8 +218,8 @@ export class FolderClassificationsManager { return void 0; } } -export function serializeAddClassificationToFolderRequestBodyArg( - val: AddClassificationToFolderRequestBodyArg +export function serializeAddClassificationToFolderRequestBody( + val: AddClassificationToFolderRequestBody ): SerializedData { return { ['Box__Security__Classification__Key']: @@ -221,71 +228,71 @@ export function serializeAddClassificationToFolderRequestBodyArg( : val.boxSecurityClassificationKey, }; } -export function deserializeAddClassificationToFolderRequestBodyArg( +export function deserializeAddClassificationToFolderRequestBody( val: any -): AddClassificationToFolderRequestBodyArg { +): AddClassificationToFolderRequestBody { const boxSecurityClassificationKey: undefined | string = val.Box__Security__Classification__Key == void 0 ? void 0 : val.Box__Security__Classification__Key; return { boxSecurityClassificationKey: boxSecurityClassificationKey, - } satisfies AddClassificationToFolderRequestBodyArg; + } satisfies AddClassificationToFolderRequestBody; } -export function serializeUpdateClassificationOnFolderRequestBodyArgOpField( - val: UpdateClassificationOnFolderRequestBodyArgOpField +export function serializeUpdateClassificationOnFolderRequestBodyOpField( + val: UpdateClassificationOnFolderRequestBodyOpField ): SerializedData { return val; } -export function deserializeUpdateClassificationOnFolderRequestBodyArgOpField( +export function deserializeUpdateClassificationOnFolderRequestBodyOpField( val: any -): UpdateClassificationOnFolderRequestBodyArgOpField { +): UpdateClassificationOnFolderRequestBodyOpField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateClassificationOnFolderRequestBodyArgOpField"'; + throw 'Expecting a string for "UpdateClassificationOnFolderRequestBodyOpField"'; } if (val == 'replace') { return 'replace'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateClassificationOnFolderRequestBodyArgPathField( - val: UpdateClassificationOnFolderRequestBodyArgPathField +export function serializeUpdateClassificationOnFolderRequestBodyPathField( + val: UpdateClassificationOnFolderRequestBodyPathField ): SerializedData { return val; } -export function deserializeUpdateClassificationOnFolderRequestBodyArgPathField( +export function deserializeUpdateClassificationOnFolderRequestBodyPathField( val: any -): UpdateClassificationOnFolderRequestBodyArgPathField { +): UpdateClassificationOnFolderRequestBodyPathField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateClassificationOnFolderRequestBodyArgPathField"'; + throw 'Expecting a string for "UpdateClassificationOnFolderRequestBodyPathField"'; } if (val == '/Box__Security__Classification__Key') { return '/Box__Security__Classification__Key'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateClassificationOnFolderRequestBodyArg( - val: UpdateClassificationOnFolderRequestBodyArg +export function serializeUpdateClassificationOnFolderRequestBody( + val: UpdateClassificationOnFolderRequestBody ): SerializedData { return { - ['op']: serializeUpdateClassificationOnFolderRequestBodyArgOpField(val.op), - ['path']: serializeUpdateClassificationOnFolderRequestBodyArgPathField( + ['op']: serializeUpdateClassificationOnFolderRequestBodyOpField(val.op), + ['path']: serializeUpdateClassificationOnFolderRequestBodyPathField( val.path ), ['value']: val.value, }; } -export function deserializeUpdateClassificationOnFolderRequestBodyArg( +export function deserializeUpdateClassificationOnFolderRequestBody( val: any -): UpdateClassificationOnFolderRequestBodyArg { - const op: UpdateClassificationOnFolderRequestBodyArgOpField = - deserializeUpdateClassificationOnFolderRequestBodyArgOpField(val.op); - const path: UpdateClassificationOnFolderRequestBodyArgPathField = - deserializeUpdateClassificationOnFolderRequestBodyArgPathField(val.path); +): UpdateClassificationOnFolderRequestBody { + const op: UpdateClassificationOnFolderRequestBodyOpField = + deserializeUpdateClassificationOnFolderRequestBodyOpField(val.op); + const path: UpdateClassificationOnFolderRequestBodyPathField = + deserializeUpdateClassificationOnFolderRequestBodyPathField(val.path); const value: string = val.value; return { op: op, path: path, value: value, - } satisfies UpdateClassificationOnFolderRequestBodyArg; + } satisfies UpdateClassificationOnFolderRequestBody; } diff --git a/src/managers/folderLocks.generated.ts b/src/managers/folderLocks.generated.ts index 1f559be3..ff914600 100644 --- a/src/managers/folderLocks.generated.ts +++ b/src/managers/folderLocks.generated.ts @@ -24,71 +24,76 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetFolderLocksQueryParamsArg { +export interface GetFolderLocksQueryParams { readonly folderId: string; } -export class GetFolderLocksHeadersArg { +export class GetFolderLocksHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface CreateFolderLockRequestBodyArgLockedOperationsField { +export interface CreateFolderLockRequestBodyLockedOperationsField { readonly move: boolean; readonly delete: boolean; } -export interface CreateFolderLockRequestBodyArgFolderField { +export interface CreateFolderLockRequestBodyFolderField { readonly type: string; readonly id: string; } -export interface CreateFolderLockRequestBodyArg { - readonly lockedOperations?: CreateFolderLockRequestBodyArgLockedOperationsField; - readonly folder: CreateFolderLockRequestBodyArgFolderField; +export interface CreateFolderLockRequestBody { + readonly lockedOperations?: CreateFolderLockRequestBodyLockedOperationsField; + readonly folder: CreateFolderLockRequestBodyFolderField; } -export class CreateFolderLockHeadersArg { +export class CreateFolderLockHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteFolderLockByIdHeadersArg { +export class DeleteFolderLockByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class FolderLocksManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - FolderLocksManager, - 'getFolderLocks' | 'createFolderLock' | 'deleteFolderLockById' - > + fields: + | Omit< + FolderLocksManager, + | 'networkSession' + | 'getFolderLocks' + | 'createFolderLock' + | 'deleteFolderLockById' + > + | Partial> ) { Object.assign(this, fields); } async getFolderLocks( - queryParams: GetFolderLocksQueryParamsArg, - headers: GetFolderLocksHeadersArg = new GetFolderLocksHeadersArg({}), + queryParams: GetFolderLocksQueryParams, + headers: GetFolderLocksHeaders = new GetFolderLocksHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -100,7 +105,10 @@ export class FolderLocksManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/folder_locks') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/folder_locks' + ) as string, { method: 'GET', params: queryParamsMap, @@ -114,19 +122,22 @@ export class FolderLocksManager { return deserializeFolderLocks(response.data); } async createFolderLock( - requestBody: CreateFolderLockRequestBodyArg, - headers: CreateFolderLockHeadersArg = new CreateFolderLockHeadersArg({}), + requestBody: CreateFolderLockRequestBody, + headers: CreateFolderLockHeaders = new CreateFolderLockHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/folder_locks') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/folder_locks' + ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateFolderLockRequestBodyArg(requestBody), + data: serializeCreateFolderLockRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -138,9 +149,7 @@ export class FolderLocksManager { } async deleteFolderLockById( folderLockId: string, - headers: DeleteFolderLockByIdHeadersArg = new DeleteFolderLockByIdHeadersArg( - {} - ), + headers: DeleteFolderLockByIdHeaders = new DeleteFolderLockByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -148,7 +157,8 @@ export class FolderLocksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folder_locks/', + this.networkSession.baseUrls.baseUrl, + '/folder_locks/', toString(folderLockId) as string ) as string, { @@ -163,64 +173,64 @@ export class FolderLocksManager { return void 0; } } -export function serializeCreateFolderLockRequestBodyArgLockedOperationsField( - val: CreateFolderLockRequestBodyArgLockedOperationsField +export function serializeCreateFolderLockRequestBodyLockedOperationsField( + val: CreateFolderLockRequestBodyLockedOperationsField ): SerializedData { return { ['move']: val.move, ['delete']: val.delete }; } -export function deserializeCreateFolderLockRequestBodyArgLockedOperationsField( +export function deserializeCreateFolderLockRequestBodyLockedOperationsField( val: any -): CreateFolderLockRequestBodyArgLockedOperationsField { +): CreateFolderLockRequestBodyLockedOperationsField { const move: boolean = val.move; const _delete: boolean = val.delete; return { move: move, delete: _delete, - } satisfies CreateFolderLockRequestBodyArgLockedOperationsField; + } satisfies CreateFolderLockRequestBodyLockedOperationsField; } -export function serializeCreateFolderLockRequestBodyArgFolderField( - val: CreateFolderLockRequestBodyArgFolderField +export function serializeCreateFolderLockRequestBodyFolderField( + val: CreateFolderLockRequestBodyFolderField ): SerializedData { return { ['type']: val.type, ['id']: val.id }; } -export function deserializeCreateFolderLockRequestBodyArgFolderField( +export function deserializeCreateFolderLockRequestBodyFolderField( val: any -): CreateFolderLockRequestBodyArgFolderField { +): CreateFolderLockRequestBodyFolderField { const type: string = val.type; const id: string = val.id; return { type: type, id: id, - } satisfies CreateFolderLockRequestBodyArgFolderField; + } satisfies CreateFolderLockRequestBodyFolderField; } -export function serializeCreateFolderLockRequestBodyArg( - val: CreateFolderLockRequestBodyArg +export function serializeCreateFolderLockRequestBody( + val: CreateFolderLockRequestBody ): SerializedData { return { ['locked_operations']: val.lockedOperations == void 0 ? void 0 - : serializeCreateFolderLockRequestBodyArgLockedOperationsField( + : serializeCreateFolderLockRequestBodyLockedOperationsField( val.lockedOperations ), - ['folder']: serializeCreateFolderLockRequestBodyArgFolderField(val.folder), + ['folder']: serializeCreateFolderLockRequestBodyFolderField(val.folder), }; } -export function deserializeCreateFolderLockRequestBodyArg( +export function deserializeCreateFolderLockRequestBody( val: any -): CreateFolderLockRequestBodyArg { +): CreateFolderLockRequestBody { const lockedOperations: | undefined - | CreateFolderLockRequestBodyArgLockedOperationsField = + | CreateFolderLockRequestBodyLockedOperationsField = val.locked_operations == void 0 ? void 0 - : deserializeCreateFolderLockRequestBodyArgLockedOperationsField( + : deserializeCreateFolderLockRequestBodyLockedOperationsField( val.locked_operations ); - const folder: CreateFolderLockRequestBodyArgFolderField = - deserializeCreateFolderLockRequestBodyArgFolderField(val.folder); + const folder: CreateFolderLockRequestBodyFolderField = + deserializeCreateFolderLockRequestBodyFolderField(val.folder); return { lockedOperations: lockedOperations, folder: folder, - } satisfies CreateFolderLockRequestBodyArg; + } satisfies CreateFolderLockRequestBody; } diff --git a/src/managers/folderMetadata.generated.ts b/src/managers/folderMetadata.generated.ts index 5a28ee79..d3931d3c 100644 --- a/src/managers/folderMetadata.generated.ts +++ b/src/managers/folderMetadata.generated.ts @@ -24,104 +24,107 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetFolderMetadataHeadersArg { +export class GetFolderMetadataHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type GetFolderMetadataByIdScopeArg = 'global' | 'enterprise'; -export class GetFolderMetadataByIdHeadersArg { +export type GetFolderMetadataByIdScope = 'global' | 'enterprise'; +export class GetFolderMetadataByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateFolderMetadataByIdScopeArg = 'global' | 'enterprise'; -export type CreateFolderMetadataByIdRequestBodyArg = { +export type CreateFolderMetadataByIdScope = 'global' | 'enterprise'; +export type CreateFolderMetadataByIdRequestBody = { readonly [key: string]: string; }; -export class CreateFolderMetadataByIdHeadersArg { +export class CreateFolderMetadataByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateFolderMetadataByIdScopeArg = 'global' | 'enterprise'; -export type UpdateFolderMetadataByIdRequestBodyArgOpField = +export type UpdateFolderMetadataByIdScope = 'global' | 'enterprise'; +export type UpdateFolderMetadataByIdRequestBodyOpField = | 'add' | 'replace' | 'remove' | 'test' | 'move' | 'copy'; -export interface UpdateFolderMetadataByIdRequestBodyArg { - readonly op?: UpdateFolderMetadataByIdRequestBodyArgOpField; +export interface UpdateFolderMetadataByIdRequestBody { + readonly op?: UpdateFolderMetadataByIdRequestBodyOpField; readonly path?: string; readonly value?: string; readonly from?: string; } -export class UpdateFolderMetadataByIdHeadersArg { +export class UpdateFolderMetadataByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type DeleteFolderMetadataByIdScopeArg = 'global' | 'enterprise'; -export class DeleteFolderMetadataByIdHeadersArg { +export type DeleteFolderMetadataByIdScope = 'global' | 'enterprise'; +export class DeleteFolderMetadataByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class FolderMetadataManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - FolderMetadataManager, - | 'getFolderMetadata' - | 'getFolderMetadataById' - | 'createFolderMetadataById' - | 'updateFolderMetadataById' - | 'deleteFolderMetadataById' - > + fields: + | Omit< + FolderMetadataManager, + | 'networkSession' + | 'getFolderMetadata' + | 'getFolderMetadataById' + | 'createFolderMetadataById' + | 'updateFolderMetadataById' + | 'deleteFolderMetadataById' + > + | Partial> ) { Object.assign(this, fields); } async getFolderMetadata( folderId: string, - headers: GetFolderMetadataHeadersArg = new GetFolderMetadataHeadersArg({}), + headers: GetFolderMetadataHeaders = new GetFolderMetadataHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -129,7 +132,8 @@ export class FolderMetadataManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '/metadata' ) as string, @@ -146,9 +150,9 @@ export class FolderMetadataManager { } async getFolderMetadataById( folderId: string, - scope: GetFolderMetadataByIdScopeArg, + scope: GetFolderMetadataByIdScope, templateKey: string, - headers: GetFolderMetadataByIdHeadersArg = new GetFolderMetadataByIdHeadersArg( + headers: GetFolderMetadataByIdHeaders = new GetFolderMetadataByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -158,7 +162,8 @@ export class FolderMetadataManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '/metadata/', toString(scope) as string, @@ -178,10 +183,10 @@ export class FolderMetadataManager { } async createFolderMetadataById( folderId: string, - scope: CreateFolderMetadataByIdScopeArg, + scope: CreateFolderMetadataByIdScope, templateKey: string, - requestBody: CreateFolderMetadataByIdRequestBodyArg, - headers: CreateFolderMetadataByIdHeadersArg = new CreateFolderMetadataByIdHeadersArg( + requestBody: CreateFolderMetadataByIdRequestBody, + headers: CreateFolderMetadataByIdHeaders = new CreateFolderMetadataByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -191,7 +196,8 @@ export class FolderMetadataManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '/metadata/', toString(scope) as string, @@ -201,7 +207,7 @@ export class FolderMetadataManager { { method: 'POST', headers: headersMap, - data: serializeCreateFolderMetadataByIdRequestBodyArg(requestBody), + data: serializeCreateFolderMetadataByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -213,10 +219,10 @@ export class FolderMetadataManager { } async updateFolderMetadataById( folderId: string, - scope: UpdateFolderMetadataByIdScopeArg, + scope: UpdateFolderMetadataByIdScope, templateKey: string, - requestBody: readonly UpdateFolderMetadataByIdRequestBodyArg[], - headers: UpdateFolderMetadataByIdHeadersArg = new UpdateFolderMetadataByIdHeadersArg( + requestBody: readonly UpdateFolderMetadataByIdRequestBody[], + headers: UpdateFolderMetadataByIdHeaders = new UpdateFolderMetadataByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -226,7 +232,8 @@ export class FolderMetadataManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '/metadata/', toString(scope) as string, @@ -237,7 +244,7 @@ export class FolderMetadataManager { method: 'PUT', headers: headersMap, data: requestBody.map( - serializeUpdateFolderMetadataByIdRequestBodyArg + serializeUpdateFolderMetadataByIdRequestBody ) as readonly any[], contentType: 'application/json-patch+json', responseFormat: 'json', @@ -250,9 +257,9 @@ export class FolderMetadataManager { } async deleteFolderMetadataById( folderId: string, - scope: DeleteFolderMetadataByIdScopeArg, + scope: DeleteFolderMetadataByIdScope, templateKey: string, - headers: DeleteFolderMetadataByIdHeadersArg = new DeleteFolderMetadataByIdHeadersArg( + headers: DeleteFolderMetadataByIdHeaders = new DeleteFolderMetadataByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -262,7 +269,8 @@ export class FolderMetadataManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '/metadata/', toString(scope) as string, @@ -281,16 +289,16 @@ export class FolderMetadataManager { return void 0; } } -export function serializeGetFolderMetadataByIdScopeArg( - val: GetFolderMetadataByIdScopeArg +export function serializeGetFolderMetadataByIdScope( + val: GetFolderMetadataByIdScope ): SerializedData { return val; } -export function deserializeGetFolderMetadataByIdScopeArg( +export function deserializeGetFolderMetadataByIdScope( val: any -): GetFolderMetadataByIdScopeArg { +): GetFolderMetadataByIdScope { if (!sdIsString(val)) { - throw 'Expecting a string for "GetFolderMetadataByIdScopeArg"'; + throw 'Expecting a string for "GetFolderMetadataByIdScope"'; } if (val == 'global') { return 'global'; @@ -300,16 +308,16 @@ export function deserializeGetFolderMetadataByIdScopeArg( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateFolderMetadataByIdScopeArg( - val: CreateFolderMetadataByIdScopeArg +export function serializeCreateFolderMetadataByIdScope( + val: CreateFolderMetadataByIdScope ): SerializedData { return val; } -export function deserializeCreateFolderMetadataByIdScopeArg( +export function deserializeCreateFolderMetadataByIdScope( val: any -): CreateFolderMetadataByIdScopeArg { +): CreateFolderMetadataByIdScope { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateFolderMetadataByIdScopeArg"'; + throw 'Expecting a string for "CreateFolderMetadataByIdScope"'; } if (val == 'global') { return 'global'; @@ -319,26 +327,26 @@ export function deserializeCreateFolderMetadataByIdScopeArg( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateFolderMetadataByIdRequestBodyArg( - val: CreateFolderMetadataByIdRequestBodyArg +export function serializeCreateFolderMetadataByIdRequestBody( + val: CreateFolderMetadataByIdRequestBody ): SerializedData { return val; } -export function deserializeCreateFolderMetadataByIdRequestBodyArg( +export function deserializeCreateFolderMetadataByIdRequestBody( val: any -): CreateFolderMetadataByIdRequestBodyArg { +): CreateFolderMetadataByIdRequestBody { return val; } -export function serializeUpdateFolderMetadataByIdScopeArg( - val: UpdateFolderMetadataByIdScopeArg +export function serializeUpdateFolderMetadataByIdScope( + val: UpdateFolderMetadataByIdScope ): SerializedData { return val; } -export function deserializeUpdateFolderMetadataByIdScopeArg( +export function deserializeUpdateFolderMetadataByIdScope( val: any -): UpdateFolderMetadataByIdScopeArg { +): UpdateFolderMetadataByIdScope { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFolderMetadataByIdScopeArg"'; + throw 'Expecting a string for "UpdateFolderMetadataByIdScope"'; } if (val == 'global') { return 'global'; @@ -348,16 +356,16 @@ export function deserializeUpdateFolderMetadataByIdScopeArg( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFolderMetadataByIdRequestBodyArgOpField( - val: UpdateFolderMetadataByIdRequestBodyArgOpField +export function serializeUpdateFolderMetadataByIdRequestBodyOpField( + val: UpdateFolderMetadataByIdRequestBodyOpField ): SerializedData { return val; } -export function deserializeUpdateFolderMetadataByIdRequestBodyArgOpField( +export function deserializeUpdateFolderMetadataByIdRequestBodyOpField( val: any -): UpdateFolderMetadataByIdRequestBodyArgOpField { +): UpdateFolderMetadataByIdRequestBodyOpField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFolderMetadataByIdRequestBodyArgOpField"'; + throw 'Expecting a string for "UpdateFolderMetadataByIdRequestBodyOpField"'; } if (val == 'add') { return 'add'; @@ -379,26 +387,26 @@ export function deserializeUpdateFolderMetadataByIdRequestBodyArgOpField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFolderMetadataByIdRequestBodyArg( - val: UpdateFolderMetadataByIdRequestBodyArg +export function serializeUpdateFolderMetadataByIdRequestBody( + val: UpdateFolderMetadataByIdRequestBody ): SerializedData { return { ['op']: val.op == void 0 ? void 0 - : serializeUpdateFolderMetadataByIdRequestBodyArgOpField(val.op), + : serializeUpdateFolderMetadataByIdRequestBodyOpField(val.op), ['path']: val.path == void 0 ? void 0 : val.path, ['value']: val.value == void 0 ? void 0 : val.value, ['from']: val.from == void 0 ? void 0 : val.from, }; } -export function deserializeUpdateFolderMetadataByIdRequestBodyArg( +export function deserializeUpdateFolderMetadataByIdRequestBody( val: any -): UpdateFolderMetadataByIdRequestBodyArg { - const op: undefined | UpdateFolderMetadataByIdRequestBodyArgOpField = +): UpdateFolderMetadataByIdRequestBody { + const op: undefined | UpdateFolderMetadataByIdRequestBodyOpField = val.op == void 0 ? void 0 - : deserializeUpdateFolderMetadataByIdRequestBodyArgOpField(val.op); + : deserializeUpdateFolderMetadataByIdRequestBodyOpField(val.op); const path: undefined | string = val.path == void 0 ? void 0 : val.path; const value: undefined | string = val.value == void 0 ? void 0 : val.value; const from: undefined | string = val.from == void 0 ? void 0 : val.from; @@ -407,18 +415,18 @@ export function deserializeUpdateFolderMetadataByIdRequestBodyArg( path: path, value: value, from: from, - } satisfies UpdateFolderMetadataByIdRequestBodyArg; + } satisfies UpdateFolderMetadataByIdRequestBody; } -export function serializeDeleteFolderMetadataByIdScopeArg( - val: DeleteFolderMetadataByIdScopeArg +export function serializeDeleteFolderMetadataByIdScope( + val: DeleteFolderMetadataByIdScope ): SerializedData { return val; } -export function deserializeDeleteFolderMetadataByIdScopeArg( +export function deserializeDeleteFolderMetadataByIdScope( val: any -): DeleteFolderMetadataByIdScopeArg { +): DeleteFolderMetadataByIdScope { if (!sdIsString(val)) { - throw 'Expecting a string for "DeleteFolderMetadataByIdScopeArg"'; + throw 'Expecting a string for "DeleteFolderMetadataByIdScope"'; } if (val == 'global') { return 'global'; diff --git a/src/managers/folderWatermarks.generated.ts b/src/managers/folderWatermarks.generated.ts index ef2a6239..fdb0bff6 100644 --- a/src/managers/folderWatermarks.generated.ts +++ b/src/managers/folderWatermarks.generated.ts @@ -21,66 +21,68 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetFolderWatermarkHeadersArg { +export class GetFolderWatermarkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateFolderWatermarkRequestBodyArgWatermarkFieldImprintField = - 'default'; -export interface UpdateFolderWatermarkRequestBodyArgWatermarkField { - readonly imprint: UpdateFolderWatermarkRequestBodyArgWatermarkFieldImprintField; +export type UpdateFolderWatermarkRequestBodyWatermarkImprintField = 'default'; +export interface UpdateFolderWatermarkRequestBodyWatermarkField { + readonly imprint: UpdateFolderWatermarkRequestBodyWatermarkImprintField; } -export interface UpdateFolderWatermarkRequestBodyArg { - readonly watermark: UpdateFolderWatermarkRequestBodyArgWatermarkField; +export interface UpdateFolderWatermarkRequestBody { + readonly watermark: UpdateFolderWatermarkRequestBodyWatermarkField; } -export class UpdateFolderWatermarkHeadersArg { +export class UpdateFolderWatermarkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteFolderWatermarkHeadersArg { +export class DeleteFolderWatermarkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class FolderWatermarksManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - FolderWatermarksManager, - 'getFolderWatermark' | 'updateFolderWatermark' | 'deleteFolderWatermark' - > + fields: + | Omit< + FolderWatermarksManager, + | 'networkSession' + | 'getFolderWatermark' + | 'updateFolderWatermark' + | 'deleteFolderWatermark' + > + | Partial> ) { Object.assign(this, fields); } async getFolderWatermark( folderId: string, - headers: GetFolderWatermarkHeadersArg = new GetFolderWatermarkHeadersArg( - {} - ), + headers: GetFolderWatermarkHeaders = new GetFolderWatermarkHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -88,7 +90,8 @@ export class FolderWatermarksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '/watermark' ) as string, @@ -105,8 +108,8 @@ export class FolderWatermarksManager { } async updateFolderWatermark( folderId: string, - requestBody: UpdateFolderWatermarkRequestBodyArg, - headers: UpdateFolderWatermarkHeadersArg = new UpdateFolderWatermarkHeadersArg( + requestBody: UpdateFolderWatermarkRequestBody, + headers: UpdateFolderWatermarkHeaders = new UpdateFolderWatermarkHeaders( {} ), cancellationToken?: CancellationToken @@ -116,14 +119,15 @@ export class FolderWatermarksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '/watermark' ) as string, { method: 'PUT', headers: headersMap, - data: serializeUpdateFolderWatermarkRequestBodyArg(requestBody), + data: serializeUpdateFolderWatermarkRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -135,7 +139,7 @@ export class FolderWatermarksManager { } async deleteFolderWatermark( folderId: string, - headers: DeleteFolderWatermarkHeadersArg = new DeleteFolderWatermarkHeadersArg( + headers: DeleteFolderWatermarkHeaders = new DeleteFolderWatermarkHeaders( {} ), cancellationToken?: CancellationToken @@ -145,7 +149,8 @@ export class FolderWatermarksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '/watermark' ) as string, @@ -161,56 +166,55 @@ export class FolderWatermarksManager { return void 0; } } -export function serializeUpdateFolderWatermarkRequestBodyArgWatermarkFieldImprintField( - val: UpdateFolderWatermarkRequestBodyArgWatermarkFieldImprintField +export function serializeUpdateFolderWatermarkRequestBodyWatermarkImprintField( + val: UpdateFolderWatermarkRequestBodyWatermarkImprintField ): SerializedData { return val; } -export function deserializeUpdateFolderWatermarkRequestBodyArgWatermarkFieldImprintField( +export function deserializeUpdateFolderWatermarkRequestBodyWatermarkImprintField( val: any -): UpdateFolderWatermarkRequestBodyArgWatermarkFieldImprintField { +): UpdateFolderWatermarkRequestBodyWatermarkImprintField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFolderWatermarkRequestBodyArgWatermarkFieldImprintField"'; + throw 'Expecting a string for "UpdateFolderWatermarkRequestBodyWatermarkImprintField"'; } if (val == 'default') { return 'default'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFolderWatermarkRequestBodyArgWatermarkField( - val: UpdateFolderWatermarkRequestBodyArgWatermarkField +export function serializeUpdateFolderWatermarkRequestBodyWatermarkField( + val: UpdateFolderWatermarkRequestBodyWatermarkField ): SerializedData { return { - ['imprint']: - serializeUpdateFolderWatermarkRequestBodyArgWatermarkFieldImprintField( - val.imprint - ), + ['imprint']: serializeUpdateFolderWatermarkRequestBodyWatermarkImprintField( + val.imprint + ), }; } -export function deserializeUpdateFolderWatermarkRequestBodyArgWatermarkField( +export function deserializeUpdateFolderWatermarkRequestBodyWatermarkField( val: any -): UpdateFolderWatermarkRequestBodyArgWatermarkField { - const imprint: UpdateFolderWatermarkRequestBodyArgWatermarkFieldImprintField = - deserializeUpdateFolderWatermarkRequestBodyArgWatermarkFieldImprintField( +): UpdateFolderWatermarkRequestBodyWatermarkField { + const imprint: UpdateFolderWatermarkRequestBodyWatermarkImprintField = + deserializeUpdateFolderWatermarkRequestBodyWatermarkImprintField( val.imprint ); return { imprint: imprint, - } satisfies UpdateFolderWatermarkRequestBodyArgWatermarkField; + } satisfies UpdateFolderWatermarkRequestBodyWatermarkField; } -export function serializeUpdateFolderWatermarkRequestBodyArg( - val: UpdateFolderWatermarkRequestBodyArg +export function serializeUpdateFolderWatermarkRequestBody( + val: UpdateFolderWatermarkRequestBody ): SerializedData { return { - ['watermark']: serializeUpdateFolderWatermarkRequestBodyArgWatermarkField( + ['watermark']: serializeUpdateFolderWatermarkRequestBodyWatermarkField( val.watermark ), }; } -export function deserializeUpdateFolderWatermarkRequestBodyArg( +export function deserializeUpdateFolderWatermarkRequestBody( val: any -): UpdateFolderWatermarkRequestBodyArg { - const watermark: UpdateFolderWatermarkRequestBodyArgWatermarkField = - deserializeUpdateFolderWatermarkRequestBodyArgWatermarkField(val.watermark); - return { watermark: watermark } satisfies UpdateFolderWatermarkRequestBodyArg; +): UpdateFolderWatermarkRequestBody { + const watermark: UpdateFolderWatermarkRequestBodyWatermarkField = + deserializeUpdateFolderWatermarkRequestBodyWatermarkField(val.watermark); + return { watermark: watermark } satisfies UpdateFolderWatermarkRequestBody; } diff --git a/src/managers/folders.generated.ts b/src/managers/folders.generated.ts index 95591ab6..42369c19 100644 --- a/src/managers/folders.generated.ts +++ b/src/managers/folders.generated.ts @@ -24,20 +24,16 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export type GetFolderByIdQueryParamsArgSortField = - | 'id' - | 'name' - | 'date' - | 'size'; -export type GetFolderByIdQueryParamsArgDirectionField = 'ASC' | 'DESC'; -export interface GetFolderByIdQueryParamsArg { +export type GetFolderByIdQueryParamsSortField = 'id' | 'name' | 'date' | 'size'; +export type GetFolderByIdQueryParamsDirectionField = 'ASC' | 'DESC'; +export interface GetFolderByIdQueryParams { readonly fields?: readonly string[]; - readonly sort?: GetFolderByIdQueryParamsArgSortField; - readonly direction?: GetFolderByIdQueryParamsArgDirectionField; + readonly sort?: GetFolderByIdQueryParamsSortField; + readonly direction?: GetFolderByIdQueryParamsDirectionField; readonly offset?: number; readonly limit?: number; } -export class GetFolderByIdHeadersArg { +export class GetFolderByIdHeaders { readonly ifNoneMatch?: string; readonly boxapi?: string; readonly extraHeaders?: { @@ -45,192 +41,195 @@ export class GetFolderByIdHeadersArg { } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateFolderByIdRequestBodyArgSyncStateField = +export type UpdateFolderByIdRequestBodySyncStateField = | 'synced' | 'not_synced' | 'partially_synced'; -export interface UpdateFolderByIdRequestBodyArgParentField { +export interface UpdateFolderByIdRequestBodyParentField { readonly id?: string; } -export type UpdateFolderByIdRequestBodyArgSharedLinkFieldAccessField = +export type UpdateFolderByIdRequestBodySharedLinkAccessField = | 'open' | 'company' | 'collaborators'; -export interface UpdateFolderByIdRequestBodyArgSharedLinkFieldPermissionsField { +export interface UpdateFolderByIdRequestBodySharedLinkPermissionsField { readonly canDownload?: boolean; } -export interface UpdateFolderByIdRequestBodyArgSharedLinkField { - readonly access?: UpdateFolderByIdRequestBodyArgSharedLinkFieldAccessField; +export interface UpdateFolderByIdRequestBodySharedLinkField { + readonly access?: UpdateFolderByIdRequestBodySharedLinkAccessField; readonly password?: string; readonly vanityName?: string; readonly unsharedAt?: string; - readonly permissions?: UpdateFolderByIdRequestBodyArgSharedLinkFieldPermissionsField; + readonly permissions?: UpdateFolderByIdRequestBodySharedLinkPermissionsField; } -export type UpdateFolderByIdRequestBodyArgFolderUploadEmailFieldAccessField = +export type UpdateFolderByIdRequestBodyFolderUploadEmailAccessField = | 'open' | 'collaborators'; -export interface UpdateFolderByIdRequestBodyArgFolderUploadEmailField { - readonly access?: UpdateFolderByIdRequestBodyArgFolderUploadEmailFieldAccessField; +export interface UpdateFolderByIdRequestBodyFolderUploadEmailField { + readonly access?: UpdateFolderByIdRequestBodyFolderUploadEmailAccessField; } -export interface UpdateFolderByIdRequestBodyArgCollectionsField { +export interface UpdateFolderByIdRequestBodyCollectionsField { readonly id?: string; readonly type?: string; } -export interface UpdateFolderByIdRequestBodyArg { +export interface UpdateFolderByIdRequestBody { readonly name?: string; readonly description?: string; - readonly syncState?: UpdateFolderByIdRequestBodyArgSyncStateField; + readonly syncState?: UpdateFolderByIdRequestBodySyncStateField; readonly canNonOwnersInvite?: boolean; - readonly parent?: UpdateFolderByIdRequestBodyArgParentField; - readonly sharedLink?: UpdateFolderByIdRequestBodyArgSharedLinkField; - readonly folderUploadEmail?: UpdateFolderByIdRequestBodyArgFolderUploadEmailField; + readonly parent?: UpdateFolderByIdRequestBodyParentField; + readonly sharedLink?: UpdateFolderByIdRequestBodySharedLinkField; + readonly folderUploadEmail?: UpdateFolderByIdRequestBodyFolderUploadEmailField; readonly tags?: readonly string[]; readonly isCollaborationRestrictedToEnterprise?: boolean; - readonly collections?: readonly UpdateFolderByIdRequestBodyArgCollectionsField[]; + readonly collections?: readonly UpdateFolderByIdRequestBodyCollectionsField[]; readonly canNonOwnersViewCollaborators?: boolean; } -export interface UpdateFolderByIdQueryParamsArg { +export interface UpdateFolderByIdQueryParams { readonly fields?: readonly string[]; } -export class UpdateFolderByIdHeadersArg { +export class UpdateFolderByIdHeaders { readonly ifMatch?: string; readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface DeleteFolderByIdQueryParamsArg { +export interface DeleteFolderByIdQueryParams { readonly recursive?: boolean; } -export class DeleteFolderByIdHeadersArg { +export class DeleteFolderByIdHeaders { readonly ifMatch?: string; readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type GetFolderItemsQueryParamsArgSortField = +export type GetFolderItemsQueryParamsSortField = | 'id' | 'name' | 'date' | 'size'; -export type GetFolderItemsQueryParamsArgDirectionField = 'ASC' | 'DESC'; -export interface GetFolderItemsQueryParamsArg { +export type GetFolderItemsQueryParamsDirectionField = 'ASC' | 'DESC'; +export interface GetFolderItemsQueryParams { readonly fields?: readonly string[]; readonly usemarker?: boolean; readonly marker?: string; readonly offset?: number; readonly limit?: number; - readonly sort?: GetFolderItemsQueryParamsArgSortField; - readonly direction?: GetFolderItemsQueryParamsArgDirectionField; + readonly sort?: GetFolderItemsQueryParamsSortField; + readonly direction?: GetFolderItemsQueryParamsDirectionField; } -export class GetFolderItemsHeadersArg { +export class GetFolderItemsHeaders { readonly boxapi?: string; readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface CreateFolderRequestBodyArgParentField { +export interface CreateFolderRequestBodyParentField { readonly id: string; } -export type CreateFolderRequestBodyArgFolderUploadEmailFieldAccessField = +export type CreateFolderRequestBodyFolderUploadEmailAccessField = | 'open' | 'collaborators'; -export interface CreateFolderRequestBodyArgFolderUploadEmailField { - readonly access?: CreateFolderRequestBodyArgFolderUploadEmailFieldAccessField; +export interface CreateFolderRequestBodyFolderUploadEmailField { + readonly access?: CreateFolderRequestBodyFolderUploadEmailAccessField; } -export type CreateFolderRequestBodyArgSyncStateField = +export type CreateFolderRequestBodySyncStateField = | 'synced' | 'not_synced' | 'partially_synced'; -export interface CreateFolderRequestBodyArg { +export interface CreateFolderRequestBody { readonly name: string; - readonly parent: CreateFolderRequestBodyArgParentField; - readonly folderUploadEmail?: CreateFolderRequestBodyArgFolderUploadEmailField; - readonly syncState?: CreateFolderRequestBodyArgSyncStateField; + readonly parent: CreateFolderRequestBodyParentField; + readonly folderUploadEmail?: CreateFolderRequestBodyFolderUploadEmailField; + readonly syncState?: CreateFolderRequestBodySyncStateField; } -export interface CreateFolderQueryParamsArg { +export interface CreateFolderQueryParams { readonly fields?: readonly string[]; } -export class CreateFolderHeadersArg { +export class CreateFolderHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface CopyFolderRequestBodyArgParentField { +export interface CopyFolderRequestBodyParentField { readonly id: string; } -export interface CopyFolderRequestBodyArg { +export interface CopyFolderRequestBody { readonly name?: string; - readonly parent: CopyFolderRequestBodyArgParentField; + readonly parent: CopyFolderRequestBodyParentField; } -export interface CopyFolderQueryParamsArg { +export interface CopyFolderQueryParams { readonly fields?: readonly string[]; } -export class CopyFolderHeadersArg { +export class CopyFolderHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class FoldersManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - FoldersManager, - | 'getFolderById' - | 'updateFolderById' - | 'deleteFolderById' - | 'getFolderItems' - | 'createFolder' - | 'copyFolder' - > + fields: + | Omit< + FoldersManager, + | 'networkSession' + | 'getFolderById' + | 'updateFolderById' + | 'deleteFolderById' + | 'getFolderItems' + | 'createFolder' + | 'copyFolder' + > + | Partial> ) { Object.assign(this, fields); } async getFolderById( folderId: string, - queryParams: GetFolderByIdQueryParamsArg = {} satisfies GetFolderByIdQueryParamsArg, - headers: GetFolderByIdHeadersArg = new GetFolderByIdHeadersArg({}), + queryParams: GetFolderByIdQueryParams = {} satisfies GetFolderByIdQueryParams, + headers: GetFolderByIdHeaders = new GetFolderByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -255,7 +254,8 @@ export class FoldersManager { }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string ) as string, { @@ -272,9 +272,9 @@ export class FoldersManager { } async updateFolderById( folderId: string, - requestBody: UpdateFolderByIdRequestBodyArg = {} satisfies UpdateFolderByIdRequestBodyArg, - queryParams: UpdateFolderByIdQueryParamsArg = {} satisfies UpdateFolderByIdQueryParamsArg, - headers: UpdateFolderByIdHeadersArg = new UpdateFolderByIdHeadersArg({}), + requestBody: UpdateFolderByIdRequestBody = {} satisfies UpdateFolderByIdRequestBody, + queryParams: UpdateFolderByIdQueryParams = {} satisfies UpdateFolderByIdQueryParams, + headers: UpdateFolderByIdHeaders = new UpdateFolderByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -292,14 +292,15 @@ export class FoldersManager { }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string ) as string, { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateFolderByIdRequestBodyArg(requestBody), + data: serializeUpdateFolderByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -311,8 +312,8 @@ export class FoldersManager { } async deleteFolderById( folderId: string, - queryParams: DeleteFolderByIdQueryParamsArg = {} satisfies DeleteFolderByIdQueryParamsArg, - headers: DeleteFolderByIdHeadersArg = new DeleteFolderByIdHeadersArg({}), + queryParams: DeleteFolderByIdQueryParams = {} satisfies DeleteFolderByIdQueryParams, + headers: DeleteFolderByIdHeaders = new DeleteFolderByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -328,7 +329,8 @@ export class FoldersManager { }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string ) as string, { @@ -345,8 +347,8 @@ export class FoldersManager { } async getFolderItems( folderId: string, - queryParams: GetFolderItemsQueryParamsArg = {} satisfies GetFolderItemsQueryParamsArg, - headers: GetFolderItemsHeadersArg = new GetFolderItemsHeadersArg({}), + queryParams: GetFolderItemsQueryParams = {} satisfies GetFolderItemsQueryParams, + headers: GetFolderItemsHeaders = new GetFolderItemsHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -370,7 +372,8 @@ export class FoldersManager { }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '/items' ) as string, @@ -387,9 +390,9 @@ export class FoldersManager { return deserializeItems(response.data); } async createFolder( - requestBody: CreateFolderRequestBodyArg, - queryParams: CreateFolderQueryParamsArg = {} satisfies CreateFolderQueryParamsArg, - headers: CreateFolderHeadersArg = new CreateFolderHeadersArg({}), + requestBody: CreateFolderRequestBody, + queryParams: CreateFolderQueryParams = {} satisfies CreateFolderQueryParams, + headers: CreateFolderHeaders = new CreateFolderHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -403,12 +406,12 @@ export class FoldersManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/folders') as string, + ''.concat(this.networkSession.baseUrls.baseUrl, '/folders') as string, { method: 'POST', params: queryParamsMap, headers: headersMap, - data: serializeCreateFolderRequestBodyArg(requestBody), + data: serializeCreateFolderRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -420,9 +423,9 @@ export class FoldersManager { } async copyFolder( folderId: string, - requestBody: CopyFolderRequestBodyArg, - queryParams: CopyFolderQueryParamsArg = {} satisfies CopyFolderQueryParamsArg, - headers: CopyFolderHeadersArg = new CopyFolderHeadersArg({}), + requestBody: CopyFolderRequestBody, + queryParams: CopyFolderQueryParams = {} satisfies CopyFolderQueryParams, + headers: CopyFolderHeaders = new CopyFolderHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -437,7 +440,8 @@ export class FoldersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '/copy' ) as string, @@ -445,7 +449,7 @@ export class FoldersManager { method: 'POST', params: queryParamsMap, headers: headersMap, - data: serializeCopyFolderRequestBodyArg(requestBody), + data: serializeCopyFolderRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -456,16 +460,16 @@ export class FoldersManager { return deserializeFolderFull(response.data); } } -export function serializeGetFolderByIdQueryParamsArgSortField( - val: GetFolderByIdQueryParamsArgSortField +export function serializeGetFolderByIdQueryParamsSortField( + val: GetFolderByIdQueryParamsSortField ): SerializedData { return val; } -export function deserializeGetFolderByIdQueryParamsArgSortField( +export function deserializeGetFolderByIdQueryParamsSortField( val: any -): GetFolderByIdQueryParamsArgSortField { +): GetFolderByIdQueryParamsSortField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetFolderByIdQueryParamsArgSortField"'; + throw 'Expecting a string for "GetFolderByIdQueryParamsSortField"'; } if (val == 'id') { return 'id'; @@ -481,16 +485,16 @@ export function deserializeGetFolderByIdQueryParamsArgSortField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeGetFolderByIdQueryParamsArgDirectionField( - val: GetFolderByIdQueryParamsArgDirectionField +export function serializeGetFolderByIdQueryParamsDirectionField( + val: GetFolderByIdQueryParamsDirectionField ): SerializedData { return val; } -export function deserializeGetFolderByIdQueryParamsArgDirectionField( +export function deserializeGetFolderByIdQueryParamsDirectionField( val: any -): GetFolderByIdQueryParamsArgDirectionField { +): GetFolderByIdQueryParamsDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetFolderByIdQueryParamsArgDirectionField"'; + throw 'Expecting a string for "GetFolderByIdQueryParamsDirectionField"'; } if (val == 'ASC') { return 'ASC'; @@ -500,16 +504,16 @@ export function deserializeGetFolderByIdQueryParamsArgDirectionField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFolderByIdRequestBodyArgSyncStateField( - val: UpdateFolderByIdRequestBodyArgSyncStateField +export function serializeUpdateFolderByIdRequestBodySyncStateField( + val: UpdateFolderByIdRequestBodySyncStateField ): SerializedData { return val; } -export function deserializeUpdateFolderByIdRequestBodyArgSyncStateField( +export function deserializeUpdateFolderByIdRequestBodySyncStateField( val: any -): UpdateFolderByIdRequestBodyArgSyncStateField { +): UpdateFolderByIdRequestBodySyncStateField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFolderByIdRequestBodyArgSyncStateField"'; + throw 'Expecting a string for "UpdateFolderByIdRequestBodySyncStateField"'; } if (val == 'synced') { return 'synced'; @@ -522,27 +526,27 @@ export function deserializeUpdateFolderByIdRequestBodyArgSyncStateField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFolderByIdRequestBodyArgParentField( - val: UpdateFolderByIdRequestBodyArgParentField +export function serializeUpdateFolderByIdRequestBodyParentField( + val: UpdateFolderByIdRequestBodyParentField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id }; } -export function deserializeUpdateFolderByIdRequestBodyArgParentField( +export function deserializeUpdateFolderByIdRequestBodyParentField( val: any -): UpdateFolderByIdRequestBodyArgParentField { +): UpdateFolderByIdRequestBodyParentField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - return { id: id } satisfies UpdateFolderByIdRequestBodyArgParentField; + return { id: id } satisfies UpdateFolderByIdRequestBodyParentField; } -export function serializeUpdateFolderByIdRequestBodyArgSharedLinkFieldAccessField( - val: UpdateFolderByIdRequestBodyArgSharedLinkFieldAccessField +export function serializeUpdateFolderByIdRequestBodySharedLinkAccessField( + val: UpdateFolderByIdRequestBodySharedLinkAccessField ): SerializedData { return val; } -export function deserializeUpdateFolderByIdRequestBodyArgSharedLinkFieldAccessField( +export function deserializeUpdateFolderByIdRequestBodySharedLinkAccessField( val: any -): UpdateFolderByIdRequestBodyArgSharedLinkFieldAccessField { +): UpdateFolderByIdRequestBodySharedLinkAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFolderByIdRequestBodyArgSharedLinkFieldAccessField"'; + throw 'Expecting a string for "UpdateFolderByIdRequestBodySharedLinkAccessField"'; } if (val == 'open') { return 'open'; @@ -555,54 +559,48 @@ export function deserializeUpdateFolderByIdRequestBodyArgSharedLinkFieldAccessFi } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFolderByIdRequestBodyArgSharedLinkFieldPermissionsField( - val: UpdateFolderByIdRequestBodyArgSharedLinkFieldPermissionsField +export function serializeUpdateFolderByIdRequestBodySharedLinkPermissionsField( + val: UpdateFolderByIdRequestBodySharedLinkPermissionsField ): SerializedData { return { ['can_download']: val.canDownload == void 0 ? void 0 : val.canDownload, }; } -export function deserializeUpdateFolderByIdRequestBodyArgSharedLinkFieldPermissionsField( +export function deserializeUpdateFolderByIdRequestBodySharedLinkPermissionsField( val: any -): UpdateFolderByIdRequestBodyArgSharedLinkFieldPermissionsField { +): UpdateFolderByIdRequestBodySharedLinkPermissionsField { const canDownload: undefined | boolean = val.can_download == void 0 ? void 0 : val.can_download; return { canDownload: canDownload, - } satisfies UpdateFolderByIdRequestBodyArgSharedLinkFieldPermissionsField; + } satisfies UpdateFolderByIdRequestBodySharedLinkPermissionsField; } -export function serializeUpdateFolderByIdRequestBodyArgSharedLinkField( - val: UpdateFolderByIdRequestBodyArgSharedLinkField +export function serializeUpdateFolderByIdRequestBodySharedLinkField( + val: UpdateFolderByIdRequestBodySharedLinkField ): SerializedData { return { ['access']: val.access == void 0 ? void 0 - : serializeUpdateFolderByIdRequestBodyArgSharedLinkFieldAccessField( - val.access - ), + : serializeUpdateFolderByIdRequestBodySharedLinkAccessField(val.access), ['password']: val.password == void 0 ? void 0 : val.password, ['vanity_name']: val.vanityName == void 0 ? void 0 : val.vanityName, ['unshared_at']: val.unsharedAt == void 0 ? void 0 : val.unsharedAt, ['permissions']: val.permissions == void 0 ? void 0 - : serializeUpdateFolderByIdRequestBodyArgSharedLinkFieldPermissionsField( + : serializeUpdateFolderByIdRequestBodySharedLinkPermissionsField( val.permissions ), }; } -export function deserializeUpdateFolderByIdRequestBodyArgSharedLinkField( +export function deserializeUpdateFolderByIdRequestBodySharedLinkField( val: any -): UpdateFolderByIdRequestBodyArgSharedLinkField { - const access: - | undefined - | UpdateFolderByIdRequestBodyArgSharedLinkFieldAccessField = +): UpdateFolderByIdRequestBodySharedLinkField { + const access: undefined | UpdateFolderByIdRequestBodySharedLinkAccessField = val.access == void 0 ? void 0 - : deserializeUpdateFolderByIdRequestBodyArgSharedLinkFieldAccessField( - val.access - ); + : deserializeUpdateFolderByIdRequestBodySharedLinkAccessField(val.access); const password: undefined | string = val.password == void 0 ? void 0 : val.password; const vanityName: undefined | string = @@ -611,10 +609,10 @@ export function deserializeUpdateFolderByIdRequestBodyArgSharedLinkField( val.unshared_at == void 0 ? void 0 : val.unshared_at; const permissions: | undefined - | UpdateFolderByIdRequestBodyArgSharedLinkFieldPermissionsField = + | UpdateFolderByIdRequestBodySharedLinkPermissionsField = val.permissions == void 0 ? void 0 - : deserializeUpdateFolderByIdRequestBodyArgSharedLinkFieldPermissionsField( + : deserializeUpdateFolderByIdRequestBodySharedLinkPermissionsField( val.permissions ); return { @@ -623,18 +621,18 @@ export function deserializeUpdateFolderByIdRequestBodyArgSharedLinkField( vanityName: vanityName, unsharedAt: unsharedAt, permissions: permissions, - } satisfies UpdateFolderByIdRequestBodyArgSharedLinkField; + } satisfies UpdateFolderByIdRequestBodySharedLinkField; } -export function serializeUpdateFolderByIdRequestBodyArgFolderUploadEmailFieldAccessField( - val: UpdateFolderByIdRequestBodyArgFolderUploadEmailFieldAccessField +export function serializeUpdateFolderByIdRequestBodyFolderUploadEmailAccessField( + val: UpdateFolderByIdRequestBodyFolderUploadEmailAccessField ): SerializedData { return val; } -export function deserializeUpdateFolderByIdRequestBodyArgFolderUploadEmailFieldAccessField( +export function deserializeUpdateFolderByIdRequestBodyFolderUploadEmailAccessField( val: any -): UpdateFolderByIdRequestBodyArgFolderUploadEmailFieldAccessField { +): UpdateFolderByIdRequestBodyFolderUploadEmailAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFolderByIdRequestBodyArgFolderUploadEmailFieldAccessField"'; + throw 'Expecting a string for "UpdateFolderByIdRequestBodyFolderUploadEmailAccessField"'; } if (val == 'open') { return 'open'; @@ -644,53 +642,53 @@ export function deserializeUpdateFolderByIdRequestBodyArgFolderUploadEmailFieldA } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFolderByIdRequestBodyArgFolderUploadEmailField( - val: UpdateFolderByIdRequestBodyArgFolderUploadEmailField +export function serializeUpdateFolderByIdRequestBodyFolderUploadEmailField( + val: UpdateFolderByIdRequestBodyFolderUploadEmailField ): SerializedData { return { ['access']: val.access == void 0 ? void 0 - : serializeUpdateFolderByIdRequestBodyArgFolderUploadEmailFieldAccessField( + : serializeUpdateFolderByIdRequestBodyFolderUploadEmailAccessField( val.access ), }; } -export function deserializeUpdateFolderByIdRequestBodyArgFolderUploadEmailField( +export function deserializeUpdateFolderByIdRequestBodyFolderUploadEmailField( val: any -): UpdateFolderByIdRequestBodyArgFolderUploadEmailField { +): UpdateFolderByIdRequestBodyFolderUploadEmailField { const access: | undefined - | UpdateFolderByIdRequestBodyArgFolderUploadEmailFieldAccessField = + | UpdateFolderByIdRequestBodyFolderUploadEmailAccessField = val.access == void 0 ? void 0 - : deserializeUpdateFolderByIdRequestBodyArgFolderUploadEmailFieldAccessField( + : deserializeUpdateFolderByIdRequestBodyFolderUploadEmailAccessField( val.access ); return { access: access, - } satisfies UpdateFolderByIdRequestBodyArgFolderUploadEmailField; + } satisfies UpdateFolderByIdRequestBodyFolderUploadEmailField; } -export function serializeUpdateFolderByIdRequestBodyArgCollectionsField( - val: UpdateFolderByIdRequestBodyArgCollectionsField +export function serializeUpdateFolderByIdRequestBodyCollectionsField( + val: UpdateFolderByIdRequestBodyCollectionsField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id, ['type']: val.type == void 0 ? void 0 : val.type, }; } -export function deserializeUpdateFolderByIdRequestBodyArgCollectionsField( +export function deserializeUpdateFolderByIdRequestBodyCollectionsField( val: any -): UpdateFolderByIdRequestBodyArgCollectionsField { +): UpdateFolderByIdRequestBodyCollectionsField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; const type: undefined | string = val.type == void 0 ? void 0 : val.type; return { id: id, type: type, - } satisfies UpdateFolderByIdRequestBodyArgCollectionsField; + } satisfies UpdateFolderByIdRequestBodyCollectionsField; } -export function serializeUpdateFolderByIdRequestBodyArg( - val: UpdateFolderByIdRequestBodyArg +export function serializeUpdateFolderByIdRequestBody( + val: UpdateFolderByIdRequestBody ): SerializedData { return { ['name']: val.name == void 0 ? void 0 : val.name, @@ -698,23 +696,21 @@ export function serializeUpdateFolderByIdRequestBodyArg( ['sync_state']: val.syncState == void 0 ? void 0 - : serializeUpdateFolderByIdRequestBodyArgSyncStateField(val.syncState), + : serializeUpdateFolderByIdRequestBodySyncStateField(val.syncState), ['can_non_owners_invite']: val.canNonOwnersInvite == void 0 ? void 0 : val.canNonOwnersInvite, ['parent']: val.parent == void 0 ? void 0 - : serializeUpdateFolderByIdRequestBodyArgParentField(val.parent), + : serializeUpdateFolderByIdRequestBodyParentField(val.parent), ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateFolderByIdRequestBodyArgSharedLinkField( - val.sharedLink - ), + : serializeUpdateFolderByIdRequestBodySharedLinkField(val.sharedLink), ['folder_upload_email']: val.folderUploadEmail == void 0 ? void 0 - : serializeUpdateFolderByIdRequestBodyArgFolderUploadEmailField( + : serializeUpdateFolderByIdRequestBodyFolderUploadEmailField( val.folderUploadEmail ), ['tags']: @@ -731,11 +727,9 @@ export function serializeUpdateFolderByIdRequestBodyArg( val.collections == void 0 ? void 0 : (val.collections.map(function ( - item: UpdateFolderByIdRequestBodyArgCollectionsField + item: UpdateFolderByIdRequestBodyCollectionsField ): any { - return serializeUpdateFolderByIdRequestBodyArgCollectionsField( - item - ); + return serializeUpdateFolderByIdRequestBodyCollectionsField(item); }) as readonly any[]), ['can_non_owners_view_collaborators']: val.canNonOwnersViewCollaborators == void 0 @@ -743,34 +737,32 @@ export function serializeUpdateFolderByIdRequestBodyArg( : val.canNonOwnersViewCollaborators, }; } -export function deserializeUpdateFolderByIdRequestBodyArg( +export function deserializeUpdateFolderByIdRequestBody( val: any -): UpdateFolderByIdRequestBodyArg { +): UpdateFolderByIdRequestBody { const name: undefined | string = val.name == void 0 ? void 0 : val.name; const description: undefined | string = val.description == void 0 ? void 0 : val.description; - const syncState: undefined | UpdateFolderByIdRequestBodyArgSyncStateField = + const syncState: undefined | UpdateFolderByIdRequestBodySyncStateField = val.sync_state == void 0 ? void 0 - : deserializeUpdateFolderByIdRequestBodyArgSyncStateField(val.sync_state); + : deserializeUpdateFolderByIdRequestBodySyncStateField(val.sync_state); const canNonOwnersInvite: undefined | boolean = val.can_non_owners_invite == void 0 ? void 0 : val.can_non_owners_invite; - const parent: undefined | UpdateFolderByIdRequestBodyArgParentField = + const parent: undefined | UpdateFolderByIdRequestBodyParentField = val.parent == void 0 ? void 0 - : deserializeUpdateFolderByIdRequestBodyArgParentField(val.parent); - const sharedLink: undefined | UpdateFolderByIdRequestBodyArgSharedLinkField = + : deserializeUpdateFolderByIdRequestBodyParentField(val.parent); + const sharedLink: undefined | UpdateFolderByIdRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateFolderByIdRequestBodyArgSharedLinkField( - val.shared_link - ); + : deserializeUpdateFolderByIdRequestBodySharedLinkField(val.shared_link); const folderUploadEmail: | undefined - | UpdateFolderByIdRequestBodyArgFolderUploadEmailField = + | UpdateFolderByIdRequestBodyFolderUploadEmailField = val.folder_upload_email == void 0 ? void 0 - : deserializeUpdateFolderByIdRequestBodyArgFolderUploadEmailField( + : deserializeUpdateFolderByIdRequestBodyFolderUploadEmailField( val.folder_upload_email ); const tags: undefined | readonly string[] = @@ -787,12 +779,12 @@ export function deserializeUpdateFolderByIdRequestBodyArg( : val.is_collaboration_restricted_to_enterprise; const collections: | undefined - | readonly UpdateFolderByIdRequestBodyArgCollectionsField[] = + | readonly UpdateFolderByIdRequestBodyCollectionsField[] = val.collections == void 0 ? void 0 : sdIsList(val.collections) ? (val.collections.map(function (itm: SerializedData): any { - return deserializeUpdateFolderByIdRequestBodyArgCollectionsField(itm); + return deserializeUpdateFolderByIdRequestBodyCollectionsField(itm); }) as readonly any[]) : []; const canNonOwnersViewCollaborators: undefined | boolean = @@ -812,18 +804,18 @@ export function deserializeUpdateFolderByIdRequestBodyArg( isCollaborationRestrictedToEnterprise, collections: collections, canNonOwnersViewCollaborators: canNonOwnersViewCollaborators, - } satisfies UpdateFolderByIdRequestBodyArg; + } satisfies UpdateFolderByIdRequestBody; } -export function serializeGetFolderItemsQueryParamsArgSortField( - val: GetFolderItemsQueryParamsArgSortField +export function serializeGetFolderItemsQueryParamsSortField( + val: GetFolderItemsQueryParamsSortField ): SerializedData { return val; } -export function deserializeGetFolderItemsQueryParamsArgSortField( +export function deserializeGetFolderItemsQueryParamsSortField( val: any -): GetFolderItemsQueryParamsArgSortField { +): GetFolderItemsQueryParamsSortField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetFolderItemsQueryParamsArgSortField"'; + throw 'Expecting a string for "GetFolderItemsQueryParamsSortField"'; } if (val == 'id') { return 'id'; @@ -839,16 +831,16 @@ export function deserializeGetFolderItemsQueryParamsArgSortField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeGetFolderItemsQueryParamsArgDirectionField( - val: GetFolderItemsQueryParamsArgDirectionField +export function serializeGetFolderItemsQueryParamsDirectionField( + val: GetFolderItemsQueryParamsDirectionField ): SerializedData { return val; } -export function deserializeGetFolderItemsQueryParamsArgDirectionField( +export function deserializeGetFolderItemsQueryParamsDirectionField( val: any -): GetFolderItemsQueryParamsArgDirectionField { +): GetFolderItemsQueryParamsDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetFolderItemsQueryParamsArgDirectionField"'; + throw 'Expecting a string for "GetFolderItemsQueryParamsDirectionField"'; } if (val == 'ASC') { return 'ASC'; @@ -858,27 +850,27 @@ export function deserializeGetFolderItemsQueryParamsArgDirectionField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateFolderRequestBodyArgParentField( - val: CreateFolderRequestBodyArgParentField +export function serializeCreateFolderRequestBodyParentField( + val: CreateFolderRequestBodyParentField ): SerializedData { return { ['id']: val.id }; } -export function deserializeCreateFolderRequestBodyArgParentField( +export function deserializeCreateFolderRequestBodyParentField( val: any -): CreateFolderRequestBodyArgParentField { +): CreateFolderRequestBodyParentField { const id: string = val.id; - return { id: id } satisfies CreateFolderRequestBodyArgParentField; + return { id: id } satisfies CreateFolderRequestBodyParentField; } -export function serializeCreateFolderRequestBodyArgFolderUploadEmailFieldAccessField( - val: CreateFolderRequestBodyArgFolderUploadEmailFieldAccessField +export function serializeCreateFolderRequestBodyFolderUploadEmailAccessField( + val: CreateFolderRequestBodyFolderUploadEmailAccessField ): SerializedData { return val; } -export function deserializeCreateFolderRequestBodyArgFolderUploadEmailFieldAccessField( +export function deserializeCreateFolderRequestBodyFolderUploadEmailAccessField( val: any -): CreateFolderRequestBodyArgFolderUploadEmailFieldAccessField { +): CreateFolderRequestBodyFolderUploadEmailAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateFolderRequestBodyArgFolderUploadEmailFieldAccessField"'; + throw 'Expecting a string for "CreateFolderRequestBodyFolderUploadEmailAccessField"'; } if (val == 'open') { return 'open'; @@ -888,43 +880,43 @@ export function deserializeCreateFolderRequestBodyArgFolderUploadEmailFieldAcces } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateFolderRequestBodyArgFolderUploadEmailField( - val: CreateFolderRequestBodyArgFolderUploadEmailField +export function serializeCreateFolderRequestBodyFolderUploadEmailField( + val: CreateFolderRequestBodyFolderUploadEmailField ): SerializedData { return { ['access']: val.access == void 0 ? void 0 - : serializeCreateFolderRequestBodyArgFolderUploadEmailFieldAccessField( + : serializeCreateFolderRequestBodyFolderUploadEmailAccessField( val.access ), }; } -export function deserializeCreateFolderRequestBodyArgFolderUploadEmailField( +export function deserializeCreateFolderRequestBodyFolderUploadEmailField( val: any -): CreateFolderRequestBodyArgFolderUploadEmailField { +): CreateFolderRequestBodyFolderUploadEmailField { const access: | undefined - | CreateFolderRequestBodyArgFolderUploadEmailFieldAccessField = + | CreateFolderRequestBodyFolderUploadEmailAccessField = val.access == void 0 ? void 0 - : deserializeCreateFolderRequestBodyArgFolderUploadEmailFieldAccessField( + : deserializeCreateFolderRequestBodyFolderUploadEmailAccessField( val.access ); return { access: access, - } satisfies CreateFolderRequestBodyArgFolderUploadEmailField; + } satisfies CreateFolderRequestBodyFolderUploadEmailField; } -export function serializeCreateFolderRequestBodyArgSyncStateField( - val: CreateFolderRequestBodyArgSyncStateField +export function serializeCreateFolderRequestBodySyncStateField( + val: CreateFolderRequestBodySyncStateField ): SerializedData { return val; } -export function deserializeCreateFolderRequestBodyArgSyncStateField( +export function deserializeCreateFolderRequestBodySyncStateField( val: any -): CreateFolderRequestBodyArgSyncStateField { +): CreateFolderRequestBodySyncStateField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateFolderRequestBodyArgSyncStateField"'; + throw 'Expecting a string for "CreateFolderRequestBodySyncStateField"'; } if (val == 'synced') { return 'synced'; @@ -937,73 +929,73 @@ export function deserializeCreateFolderRequestBodyArgSyncStateField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateFolderRequestBodyArg( - val: CreateFolderRequestBodyArg +export function serializeCreateFolderRequestBody( + val: CreateFolderRequestBody ): SerializedData { return { ['name']: val.name, - ['parent']: serializeCreateFolderRequestBodyArgParentField(val.parent), + ['parent']: serializeCreateFolderRequestBodyParentField(val.parent), ['folder_upload_email']: val.folderUploadEmail == void 0 ? void 0 - : serializeCreateFolderRequestBodyArgFolderUploadEmailField( + : serializeCreateFolderRequestBodyFolderUploadEmailField( val.folderUploadEmail ), ['sync_state']: val.syncState == void 0 ? void 0 - : serializeCreateFolderRequestBodyArgSyncStateField(val.syncState), + : serializeCreateFolderRequestBodySyncStateField(val.syncState), }; } -export function deserializeCreateFolderRequestBodyArg( +export function deserializeCreateFolderRequestBody( val: any -): CreateFolderRequestBodyArg { +): CreateFolderRequestBody { const name: string = val.name; - const parent: CreateFolderRequestBodyArgParentField = - deserializeCreateFolderRequestBodyArgParentField(val.parent); + const parent: CreateFolderRequestBodyParentField = + deserializeCreateFolderRequestBodyParentField(val.parent); const folderUploadEmail: | undefined - | CreateFolderRequestBodyArgFolderUploadEmailField = + | CreateFolderRequestBodyFolderUploadEmailField = val.folder_upload_email == void 0 ? void 0 - : deserializeCreateFolderRequestBodyArgFolderUploadEmailField( + : deserializeCreateFolderRequestBodyFolderUploadEmailField( val.folder_upload_email ); - const syncState: undefined | CreateFolderRequestBodyArgSyncStateField = + const syncState: undefined | CreateFolderRequestBodySyncStateField = val.sync_state == void 0 ? void 0 - : deserializeCreateFolderRequestBodyArgSyncStateField(val.sync_state); + : deserializeCreateFolderRequestBodySyncStateField(val.sync_state); return { name: name, parent: parent, folderUploadEmail: folderUploadEmail, syncState: syncState, - } satisfies CreateFolderRequestBodyArg; + } satisfies CreateFolderRequestBody; } -export function serializeCopyFolderRequestBodyArgParentField( - val: CopyFolderRequestBodyArgParentField +export function serializeCopyFolderRequestBodyParentField( + val: CopyFolderRequestBodyParentField ): SerializedData { return { ['id']: val.id }; } -export function deserializeCopyFolderRequestBodyArgParentField( +export function deserializeCopyFolderRequestBodyParentField( val: any -): CopyFolderRequestBodyArgParentField { +): CopyFolderRequestBodyParentField { const id: string = val.id; - return { id: id } satisfies CopyFolderRequestBodyArgParentField; + return { id: id } satisfies CopyFolderRequestBodyParentField; } -export function serializeCopyFolderRequestBodyArg( - val: CopyFolderRequestBodyArg +export function serializeCopyFolderRequestBody( + val: CopyFolderRequestBody ): SerializedData { return { ['name']: val.name == void 0 ? void 0 : val.name, - ['parent']: serializeCopyFolderRequestBodyArgParentField(val.parent), + ['parent']: serializeCopyFolderRequestBodyParentField(val.parent), }; } -export function deserializeCopyFolderRequestBodyArg( +export function deserializeCopyFolderRequestBody( val: any -): CopyFolderRequestBodyArg { +): CopyFolderRequestBody { const name: undefined | string = val.name == void 0 ? void 0 : val.name; - const parent: CopyFolderRequestBodyArgParentField = - deserializeCopyFolderRequestBodyArgParentField(val.parent); - return { name: name, parent: parent } satisfies CopyFolderRequestBodyArg; + const parent: CopyFolderRequestBodyParentField = + deserializeCopyFolderRequestBodyParentField(val.parent); + return { name: name, parent: parent } satisfies CopyFolderRequestBody; } diff --git a/src/managers/groups.generated.ts b/src/managers/groups.generated.ts index 5a05a2d8..4e82a295 100644 --- a/src/managers/groups.generated.ts +++ b/src/managers/groups.generated.ts @@ -24,131 +24,134 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetGroupsQueryParamsArg { +export interface GetGroupsQueryParams { readonly filterTerm?: string; readonly fields?: readonly string[]; readonly limit?: number; readonly offset?: number; } -export class GetGroupsHeadersArg { +export class GetGroupsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateGroupRequestBodyArgInvitabilityLevelField = +export type CreateGroupRequestBodyInvitabilityLevelField = | 'admins_only' | 'admins_and_members' | 'all_managed_users'; -export type CreateGroupRequestBodyArgMemberViewabilityLevelField = +export type CreateGroupRequestBodyMemberViewabilityLevelField = | 'admins_only' | 'admins_and_members' | 'all_managed_users'; -export interface CreateGroupRequestBodyArg { +export interface CreateGroupRequestBody { readonly name: string; readonly provenance?: string; readonly externalSyncIdentifier?: string; readonly description?: string; - readonly invitabilityLevel?: CreateGroupRequestBodyArgInvitabilityLevelField; - readonly memberViewabilityLevel?: CreateGroupRequestBodyArgMemberViewabilityLevelField; + readonly invitabilityLevel?: CreateGroupRequestBodyInvitabilityLevelField; + readonly memberViewabilityLevel?: CreateGroupRequestBodyMemberViewabilityLevelField; } -export interface CreateGroupQueryParamsArg { +export interface CreateGroupQueryParams { readonly fields?: readonly string[]; } -export class CreateGroupHeadersArg { +export class CreateGroupHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetGroupByIdQueryParamsArg { +export interface GetGroupByIdQueryParams { readonly fields?: readonly string[]; } -export class GetGroupByIdHeadersArg { +export class GetGroupByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateGroupByIdRequestBodyArgInvitabilityLevelField = +export type UpdateGroupByIdRequestBodyInvitabilityLevelField = | 'admins_only' | 'admins_and_members' | 'all_managed_users'; -export type UpdateGroupByIdRequestBodyArgMemberViewabilityLevelField = +export type UpdateGroupByIdRequestBodyMemberViewabilityLevelField = | 'admins_only' | 'admins_and_members' | 'all_managed_users'; -export interface UpdateGroupByIdRequestBodyArg { +export interface UpdateGroupByIdRequestBody { readonly name?: string; readonly provenance?: string; readonly externalSyncIdentifier?: string; readonly description?: string; - readonly invitabilityLevel?: UpdateGroupByIdRequestBodyArgInvitabilityLevelField; - readonly memberViewabilityLevel?: UpdateGroupByIdRequestBodyArgMemberViewabilityLevelField; + readonly invitabilityLevel?: UpdateGroupByIdRequestBodyInvitabilityLevelField; + readonly memberViewabilityLevel?: UpdateGroupByIdRequestBodyMemberViewabilityLevelField; } -export interface UpdateGroupByIdQueryParamsArg { +export interface UpdateGroupByIdQueryParams { readonly fields?: readonly string[]; } -export class UpdateGroupByIdHeadersArg { +export class UpdateGroupByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteGroupByIdHeadersArg { +export class DeleteGroupByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class GroupsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - GroupsManager, - | 'getGroups' - | 'createGroup' - | 'getGroupById' - | 'updateGroupById' - | 'deleteGroupById' - > + fields: + | Omit< + GroupsManager, + | 'networkSession' + | 'getGroups' + | 'createGroup' + | 'getGroupById' + | 'updateGroupById' + | 'deleteGroupById' + > + | Partial> ) { Object.assign(this, fields); } async getGroups( - queryParams: GetGroupsQueryParamsArg = {} satisfies GetGroupsQueryParamsArg, - headers: GetGroupsHeadersArg = new GetGroupsHeadersArg({}), + queryParams: GetGroupsQueryParams = {} satisfies GetGroupsQueryParams, + headers: GetGroupsHeaders = new GetGroupsHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -165,7 +168,7 @@ export class GroupsManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/groups') as string, + ''.concat(this.networkSession.baseUrls.baseUrl, '/groups') as string, { method: 'GET', params: queryParamsMap, @@ -179,9 +182,9 @@ export class GroupsManager { return deserializeGroups(response.data); } async createGroup( - requestBody: CreateGroupRequestBodyArg, - queryParams: CreateGroupQueryParamsArg = {} satisfies CreateGroupQueryParamsArg, - headers: CreateGroupHeadersArg = new CreateGroupHeadersArg({}), + requestBody: CreateGroupRequestBody, + queryParams: CreateGroupQueryParams = {} satisfies CreateGroupQueryParams, + headers: CreateGroupHeaders = new CreateGroupHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -195,12 +198,12 @@ export class GroupsManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/groups') as string, + ''.concat(this.networkSession.baseUrls.baseUrl, '/groups') as string, { method: 'POST', params: queryParamsMap, headers: headersMap, - data: serializeCreateGroupRequestBodyArg(requestBody), + data: serializeCreateGroupRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -212,8 +215,8 @@ export class GroupsManager { } async getGroupById( groupId: string, - queryParams: GetGroupByIdQueryParamsArg = {} satisfies GetGroupByIdQueryParamsArg, - headers: GetGroupByIdHeadersArg = new GetGroupByIdHeadersArg({}), + queryParams: GetGroupByIdQueryParams = {} satisfies GetGroupByIdQueryParams, + headers: GetGroupByIdHeaders = new GetGroupByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -228,7 +231,8 @@ export class GroupsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/groups/', + this.networkSession.baseUrls.baseUrl, + '/groups/', toString(groupId) as string ) as string, { @@ -245,9 +249,9 @@ export class GroupsManager { } async updateGroupById( groupId: string, - requestBody: UpdateGroupByIdRequestBodyArg = {} satisfies UpdateGroupByIdRequestBodyArg, - queryParams: UpdateGroupByIdQueryParamsArg = {} satisfies UpdateGroupByIdQueryParamsArg, - headers: UpdateGroupByIdHeadersArg = new UpdateGroupByIdHeadersArg({}), + requestBody: UpdateGroupByIdRequestBody = {} satisfies UpdateGroupByIdRequestBody, + queryParams: UpdateGroupByIdQueryParams = {} satisfies UpdateGroupByIdQueryParams, + headers: UpdateGroupByIdHeaders = new UpdateGroupByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -262,14 +266,15 @@ export class GroupsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/groups/', + this.networkSession.baseUrls.baseUrl, + '/groups/', toString(groupId) as string ) as string, { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateGroupByIdRequestBodyArg(requestBody), + data: serializeUpdateGroupByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -281,7 +286,7 @@ export class GroupsManager { } async deleteGroupById( groupId: string, - headers: DeleteGroupByIdHeadersArg = new DeleteGroupByIdHeadersArg({}), + headers: DeleteGroupByIdHeaders = new DeleteGroupByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -289,7 +294,8 @@ export class GroupsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/groups/', + this.networkSession.baseUrls.baseUrl, + '/groups/', toString(groupId) as string ) as string, { @@ -304,16 +310,16 @@ export class GroupsManager { return void 0; } } -export function serializeCreateGroupRequestBodyArgInvitabilityLevelField( - val: CreateGroupRequestBodyArgInvitabilityLevelField +export function serializeCreateGroupRequestBodyInvitabilityLevelField( + val: CreateGroupRequestBodyInvitabilityLevelField ): SerializedData { return val; } -export function deserializeCreateGroupRequestBodyArgInvitabilityLevelField( +export function deserializeCreateGroupRequestBodyInvitabilityLevelField( val: any -): CreateGroupRequestBodyArgInvitabilityLevelField { +): CreateGroupRequestBodyInvitabilityLevelField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateGroupRequestBodyArgInvitabilityLevelField"'; + throw 'Expecting a string for "CreateGroupRequestBodyInvitabilityLevelField"'; } if (val == 'admins_only') { return 'admins_only'; @@ -326,16 +332,16 @@ export function deserializeCreateGroupRequestBodyArgInvitabilityLevelField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateGroupRequestBodyArgMemberViewabilityLevelField( - val: CreateGroupRequestBodyArgMemberViewabilityLevelField +export function serializeCreateGroupRequestBodyMemberViewabilityLevelField( + val: CreateGroupRequestBodyMemberViewabilityLevelField ): SerializedData { return val; } -export function deserializeCreateGroupRequestBodyArgMemberViewabilityLevelField( +export function deserializeCreateGroupRequestBodyMemberViewabilityLevelField( val: any -): CreateGroupRequestBodyArgMemberViewabilityLevelField { +): CreateGroupRequestBodyMemberViewabilityLevelField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateGroupRequestBodyArgMemberViewabilityLevelField"'; + throw 'Expecting a string for "CreateGroupRequestBodyMemberViewabilityLevelField"'; } if (val == 'admins_only') { return 'admins_only'; @@ -348,8 +354,8 @@ export function deserializeCreateGroupRequestBodyArgMemberViewabilityLevelField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateGroupRequestBodyArg( - val: CreateGroupRequestBodyArg +export function serializeCreateGroupRequestBody( + val: CreateGroupRequestBody ): SerializedData { return { ['name']: val.name, @@ -362,20 +368,20 @@ export function serializeCreateGroupRequestBodyArg( ['invitability_level']: val.invitabilityLevel == void 0 ? void 0 - : serializeCreateGroupRequestBodyArgInvitabilityLevelField( + : serializeCreateGroupRequestBodyInvitabilityLevelField( val.invitabilityLevel ), ['member_viewability_level']: val.memberViewabilityLevel == void 0 ? void 0 - : serializeCreateGroupRequestBodyArgMemberViewabilityLevelField( + : serializeCreateGroupRequestBodyMemberViewabilityLevelField( val.memberViewabilityLevel ), }; } -export function deserializeCreateGroupRequestBodyArg( +export function deserializeCreateGroupRequestBody( val: any -): CreateGroupRequestBodyArg { +): CreateGroupRequestBody { const name: string = val.name; const provenance: undefined | string = val.provenance == void 0 ? void 0 : val.provenance; @@ -387,18 +393,18 @@ export function deserializeCreateGroupRequestBodyArg( val.description == void 0 ? void 0 : val.description; const invitabilityLevel: | undefined - | CreateGroupRequestBodyArgInvitabilityLevelField = + | CreateGroupRequestBodyInvitabilityLevelField = val.invitability_level == void 0 ? void 0 - : deserializeCreateGroupRequestBodyArgInvitabilityLevelField( + : deserializeCreateGroupRequestBodyInvitabilityLevelField( val.invitability_level ); const memberViewabilityLevel: | undefined - | CreateGroupRequestBodyArgMemberViewabilityLevelField = + | CreateGroupRequestBodyMemberViewabilityLevelField = val.member_viewability_level == void 0 ? void 0 - : deserializeCreateGroupRequestBodyArgMemberViewabilityLevelField( + : deserializeCreateGroupRequestBodyMemberViewabilityLevelField( val.member_viewability_level ); return { @@ -408,18 +414,18 @@ export function deserializeCreateGroupRequestBodyArg( description: description, invitabilityLevel: invitabilityLevel, memberViewabilityLevel: memberViewabilityLevel, - } satisfies CreateGroupRequestBodyArg; + } satisfies CreateGroupRequestBody; } -export function serializeUpdateGroupByIdRequestBodyArgInvitabilityLevelField( - val: UpdateGroupByIdRequestBodyArgInvitabilityLevelField +export function serializeUpdateGroupByIdRequestBodyInvitabilityLevelField( + val: UpdateGroupByIdRequestBodyInvitabilityLevelField ): SerializedData { return val; } -export function deserializeUpdateGroupByIdRequestBodyArgInvitabilityLevelField( +export function deserializeUpdateGroupByIdRequestBodyInvitabilityLevelField( val: any -): UpdateGroupByIdRequestBodyArgInvitabilityLevelField { +): UpdateGroupByIdRequestBodyInvitabilityLevelField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateGroupByIdRequestBodyArgInvitabilityLevelField"'; + throw 'Expecting a string for "UpdateGroupByIdRequestBodyInvitabilityLevelField"'; } if (val == 'admins_only') { return 'admins_only'; @@ -432,16 +438,16 @@ export function deserializeUpdateGroupByIdRequestBodyArgInvitabilityLevelField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateGroupByIdRequestBodyArgMemberViewabilityLevelField( - val: UpdateGroupByIdRequestBodyArgMemberViewabilityLevelField +export function serializeUpdateGroupByIdRequestBodyMemberViewabilityLevelField( + val: UpdateGroupByIdRequestBodyMemberViewabilityLevelField ): SerializedData { return val; } -export function deserializeUpdateGroupByIdRequestBodyArgMemberViewabilityLevelField( +export function deserializeUpdateGroupByIdRequestBodyMemberViewabilityLevelField( val: any -): UpdateGroupByIdRequestBodyArgMemberViewabilityLevelField { +): UpdateGroupByIdRequestBodyMemberViewabilityLevelField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateGroupByIdRequestBodyArgMemberViewabilityLevelField"'; + throw 'Expecting a string for "UpdateGroupByIdRequestBodyMemberViewabilityLevelField"'; } if (val == 'admins_only') { return 'admins_only'; @@ -454,8 +460,8 @@ export function deserializeUpdateGroupByIdRequestBodyArgMemberViewabilityLevelFi } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateGroupByIdRequestBodyArg( - val: UpdateGroupByIdRequestBodyArg +export function serializeUpdateGroupByIdRequestBody( + val: UpdateGroupByIdRequestBody ): SerializedData { return { ['name']: val.name == void 0 ? void 0 : val.name, @@ -468,20 +474,20 @@ export function serializeUpdateGroupByIdRequestBodyArg( ['invitability_level']: val.invitabilityLevel == void 0 ? void 0 - : serializeUpdateGroupByIdRequestBodyArgInvitabilityLevelField( + : serializeUpdateGroupByIdRequestBodyInvitabilityLevelField( val.invitabilityLevel ), ['member_viewability_level']: val.memberViewabilityLevel == void 0 ? void 0 - : serializeUpdateGroupByIdRequestBodyArgMemberViewabilityLevelField( + : serializeUpdateGroupByIdRequestBodyMemberViewabilityLevelField( val.memberViewabilityLevel ), }; } -export function deserializeUpdateGroupByIdRequestBodyArg( +export function deserializeUpdateGroupByIdRequestBody( val: any -): UpdateGroupByIdRequestBodyArg { +): UpdateGroupByIdRequestBody { const name: undefined | string = val.name == void 0 ? void 0 : val.name; const provenance: undefined | string = val.provenance == void 0 ? void 0 : val.provenance; @@ -493,18 +499,18 @@ export function deserializeUpdateGroupByIdRequestBodyArg( val.description == void 0 ? void 0 : val.description; const invitabilityLevel: | undefined - | UpdateGroupByIdRequestBodyArgInvitabilityLevelField = + | UpdateGroupByIdRequestBodyInvitabilityLevelField = val.invitability_level == void 0 ? void 0 - : deserializeUpdateGroupByIdRequestBodyArgInvitabilityLevelField( + : deserializeUpdateGroupByIdRequestBodyInvitabilityLevelField( val.invitability_level ); const memberViewabilityLevel: | undefined - | UpdateGroupByIdRequestBodyArgMemberViewabilityLevelField = + | UpdateGroupByIdRequestBodyMemberViewabilityLevelField = val.member_viewability_level == void 0 ? void 0 - : deserializeUpdateGroupByIdRequestBodyArgMemberViewabilityLevelField( + : deserializeUpdateGroupByIdRequestBodyMemberViewabilityLevelField( val.member_viewability_level ); return { @@ -514,5 +520,5 @@ export function deserializeUpdateGroupByIdRequestBodyArg( description: description, invitabilityLevel: invitabilityLevel, memberViewabilityLevel: memberViewabilityLevel, - } satisfies UpdateGroupByIdRequestBodyArg; + } satisfies UpdateGroupByIdRequestBody; } diff --git a/src/managers/integrationMappings.generated.ts b/src/managers/integrationMappings.generated.ts index 9a386bbf..8b3e55ba 100644 --- a/src/managers/integrationMappings.generated.ts +++ b/src/managers/integrationMappings.generated.ts @@ -33,91 +33,90 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export type GetIntegrationMappingSlackQueryParamsArgPartnerItemTypeField = +export type GetIntegrationMappingSlackQueryParamsPartnerItemTypeField = 'channel'; -export type GetIntegrationMappingSlackQueryParamsArgBoxItemTypeField = 'folder'; -export interface GetIntegrationMappingSlackQueryParamsArg { +export type GetIntegrationMappingSlackQueryParamsBoxItemTypeField = 'folder'; +export interface GetIntegrationMappingSlackQueryParams { readonly marker?: string; readonly limit?: number; - readonly partnerItemType?: GetIntegrationMappingSlackQueryParamsArgPartnerItemTypeField; + readonly partnerItemType?: GetIntegrationMappingSlackQueryParamsPartnerItemTypeField; readonly partnerItemId?: string; readonly boxItemId?: string; - readonly boxItemType?: GetIntegrationMappingSlackQueryParamsArgBoxItemTypeField; + readonly boxItemType?: GetIntegrationMappingSlackQueryParamsBoxItemTypeField; readonly isManuallyCreated?: boolean; } -export class GetIntegrationMappingSlackHeadersArg { +export class GetIntegrationMappingSlackHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class CreateIntegrationMappingSlackHeadersArg { +export class CreateIntegrationMappingSlackHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface UpdateIntegrationMappingSlackByIdRequestBodyArg { +export interface UpdateIntegrationMappingSlackByIdRequestBody { readonly boxItem?: IntegrationMappingBoxItemSlack; readonly options?: IntegrationMappingSlackOptions; } -export class UpdateIntegrationMappingSlackByIdHeadersArg { +export class UpdateIntegrationMappingSlackByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial< - Pick - > + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteIntegrationMappingSlackByIdHeadersArg { +export class DeleteIntegrationMappingSlackByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial< - Pick - > + | Omit + | Partial> ) { Object.assign(this, fields); } } export class IntegrationMappingsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - IntegrationMappingsManager, - | 'getIntegrationMappingSlack' - | 'createIntegrationMappingSlack' - | 'updateIntegrationMappingSlackById' - | 'deleteIntegrationMappingSlackById' - > + fields: + | Omit< + IntegrationMappingsManager, + | 'networkSession' + | 'getIntegrationMappingSlack' + | 'createIntegrationMappingSlack' + | 'updateIntegrationMappingSlackById' + | 'deleteIntegrationMappingSlackById' + > + | Partial> ) { Object.assign(this, fields); } async getIntegrationMappingSlack( - queryParams: GetIntegrationMappingSlackQueryParamsArg = {} satisfies GetIntegrationMappingSlackQueryParamsArg, - headers: GetIntegrationMappingSlackHeadersArg = new GetIntegrationMappingSlackHeadersArg( + queryParams: GetIntegrationMappingSlackQueryParams = {} satisfies GetIntegrationMappingSlackQueryParams, + headers: GetIntegrationMappingSlackHeaders = new GetIntegrationMappingSlackHeaders( {} ), cancellationToken?: CancellationToken @@ -139,7 +138,10 @@ export class IntegrationMappingsManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/integration_mappings/slack') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/integration_mappings/slack' + ) as string, { method: 'GET', params: queryParamsMap, @@ -154,7 +156,7 @@ export class IntegrationMappingsManager { } async createIntegrationMappingSlack( requestBody: IntegrationMappingSlackCreateRequest, - headers: CreateIntegrationMappingSlackHeadersArg = new CreateIntegrationMappingSlackHeadersArg( + headers: CreateIntegrationMappingSlackHeaders = new CreateIntegrationMappingSlackHeaders( {} ), cancellationToken?: CancellationToken @@ -163,7 +165,10 @@ export class IntegrationMappingsManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/integration_mappings/slack') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/integration_mappings/slack' + ) as string, { method: 'POST', headers: headersMap, @@ -179,8 +184,8 @@ export class IntegrationMappingsManager { } async updateIntegrationMappingSlackById( integrationMappingId: string, - requestBody: UpdateIntegrationMappingSlackByIdRequestBodyArg = {} satisfies UpdateIntegrationMappingSlackByIdRequestBodyArg, - headers: UpdateIntegrationMappingSlackByIdHeadersArg = new UpdateIntegrationMappingSlackByIdHeadersArg( + requestBody: UpdateIntegrationMappingSlackByIdRequestBody = {} satisfies UpdateIntegrationMappingSlackByIdRequestBody, + headers: UpdateIntegrationMappingSlackByIdHeaders = new UpdateIntegrationMappingSlackByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -190,13 +195,14 @@ export class IntegrationMappingsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/integration_mappings/slack/', + this.networkSession.baseUrls.baseUrl, + '/integration_mappings/slack/', toString(integrationMappingId) as string ) as string, { method: 'PUT', headers: headersMap, - data: serializeUpdateIntegrationMappingSlackByIdRequestBodyArg( + data: serializeUpdateIntegrationMappingSlackByIdRequestBody( requestBody ), contentType: 'application/json', @@ -210,7 +216,7 @@ export class IntegrationMappingsManager { } async deleteIntegrationMappingSlackById( integrationMappingId: string, - headers: DeleteIntegrationMappingSlackByIdHeadersArg = new DeleteIntegrationMappingSlackByIdHeadersArg( + headers: DeleteIntegrationMappingSlackByIdHeaders = new DeleteIntegrationMappingSlackByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -220,7 +226,8 @@ export class IntegrationMappingsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/integration_mappings/slack/', + this.networkSession.baseUrls.baseUrl, + '/integration_mappings/slack/', toString(integrationMappingId) as string ) as string, { @@ -235,40 +242,40 @@ export class IntegrationMappingsManager { return void 0; } } -export function serializeGetIntegrationMappingSlackQueryParamsArgPartnerItemTypeField( - val: GetIntegrationMappingSlackQueryParamsArgPartnerItemTypeField +export function serializeGetIntegrationMappingSlackQueryParamsPartnerItemTypeField( + val: GetIntegrationMappingSlackQueryParamsPartnerItemTypeField ): SerializedData { return val; } -export function deserializeGetIntegrationMappingSlackQueryParamsArgPartnerItemTypeField( +export function deserializeGetIntegrationMappingSlackQueryParamsPartnerItemTypeField( val: any -): GetIntegrationMappingSlackQueryParamsArgPartnerItemTypeField { +): GetIntegrationMappingSlackQueryParamsPartnerItemTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetIntegrationMappingSlackQueryParamsArgPartnerItemTypeField"'; + throw 'Expecting a string for "GetIntegrationMappingSlackQueryParamsPartnerItemTypeField"'; } if (val == 'channel') { return 'channel'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeGetIntegrationMappingSlackQueryParamsArgBoxItemTypeField( - val: GetIntegrationMappingSlackQueryParamsArgBoxItemTypeField +export function serializeGetIntegrationMappingSlackQueryParamsBoxItemTypeField( + val: GetIntegrationMappingSlackQueryParamsBoxItemTypeField ): SerializedData { return val; } -export function deserializeGetIntegrationMappingSlackQueryParamsArgBoxItemTypeField( +export function deserializeGetIntegrationMappingSlackQueryParamsBoxItemTypeField( val: any -): GetIntegrationMappingSlackQueryParamsArgBoxItemTypeField { +): GetIntegrationMappingSlackQueryParamsBoxItemTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetIntegrationMappingSlackQueryParamsArgBoxItemTypeField"'; + throw 'Expecting a string for "GetIntegrationMappingSlackQueryParamsBoxItemTypeField"'; } if (val == 'folder') { return 'folder'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateIntegrationMappingSlackByIdRequestBodyArg( - val: UpdateIntegrationMappingSlackByIdRequestBodyArg +export function serializeUpdateIntegrationMappingSlackByIdRequestBody( + val: UpdateIntegrationMappingSlackByIdRequestBody ): SerializedData { return { ['box_item']: @@ -281,9 +288,9 @@ export function serializeUpdateIntegrationMappingSlackByIdRequestBodyArg( : serializeIntegrationMappingSlackOptions(val.options), }; } -export function deserializeUpdateIntegrationMappingSlackByIdRequestBodyArg( +export function deserializeUpdateIntegrationMappingSlackByIdRequestBody( val: any -): UpdateIntegrationMappingSlackByIdRequestBodyArg { +): UpdateIntegrationMappingSlackByIdRequestBody { const boxItem: undefined | IntegrationMappingBoxItemSlack = val.box_item == void 0 ? void 0 @@ -295,5 +302,5 @@ export function deserializeUpdateIntegrationMappingSlackByIdRequestBodyArg( return { boxItem: boxItem, options: options, - } satisfies UpdateIntegrationMappingSlackByIdRequestBodyArg; + } satisfies UpdateIntegrationMappingSlackByIdRequestBody; } diff --git a/src/managers/invites.generated.ts b/src/managers/invites.generated.ts index 0d874a49..b0e43336 100644 --- a/src/managers/invites.generated.ts +++ b/src/managers/invites.generated.ts @@ -21,56 +21,63 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface CreateInviteRequestBodyArgEnterpriseField { +export interface CreateInviteRequestBodyEnterpriseField { readonly id: string; } -export interface CreateInviteRequestBodyArgActionableByField { +export interface CreateInviteRequestBodyActionableByField { readonly login?: string; } -export interface CreateInviteRequestBodyArg { - readonly enterprise: CreateInviteRequestBodyArgEnterpriseField; - readonly actionableBy: CreateInviteRequestBodyArgActionableByField; +export interface CreateInviteRequestBody { + readonly enterprise: CreateInviteRequestBodyEnterpriseField; + readonly actionableBy: CreateInviteRequestBodyActionableByField; } -export interface CreateInviteQueryParamsArg { +export interface CreateInviteQueryParams { readonly fields?: readonly string[]; } -export class CreateInviteHeadersArg { +export class CreateInviteHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetInviteByIdQueryParamsArg { +export interface GetInviteByIdQueryParams { readonly fields?: readonly string[]; } -export class GetInviteByIdHeadersArg { +export class GetInviteByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class InvitesManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; - constructor(fields: Omit) { + readonly networkSession: NetworkSession = new NetworkSession({}); + constructor( + fields: + | Omit< + InvitesManager, + 'networkSession' | 'createInvite' | 'getInviteById' + > + | Partial> + ) { Object.assign(this, fields); } async createInvite( - requestBody: CreateInviteRequestBodyArg, - queryParams: CreateInviteQueryParamsArg = {} satisfies CreateInviteQueryParamsArg, - headers: CreateInviteHeadersArg = new CreateInviteHeadersArg({}), + requestBody: CreateInviteRequestBody, + queryParams: CreateInviteQueryParams = {} satisfies CreateInviteQueryParams, + headers: CreateInviteHeaders = new CreateInviteHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -84,12 +91,12 @@ export class InvitesManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/invites') as string, + ''.concat(this.networkSession.baseUrls.baseUrl, '/invites') as string, { method: 'POST', params: queryParamsMap, headers: headersMap, - data: serializeCreateInviteRequestBodyArg(requestBody), + data: serializeCreateInviteRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -101,8 +108,8 @@ export class InvitesManager { } async getInviteById( inviteId: string, - queryParams: GetInviteByIdQueryParamsArg = {} satisfies GetInviteByIdQueryParamsArg, - headers: GetInviteByIdHeadersArg = new GetInviteByIdHeadersArg({}), + queryParams: GetInviteByIdQueryParams = {} satisfies GetInviteByIdQueryParams, + headers: GetInviteByIdHeaders = new GetInviteByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -117,7 +124,8 @@ export class InvitesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/invites/', + this.networkSession.baseUrls.baseUrl, + '/invites/', toString(inviteId) as string ) as string, { @@ -133,49 +141,49 @@ export class InvitesManager { return deserializeInvite(response.data); } } -export function serializeCreateInviteRequestBodyArgEnterpriseField( - val: CreateInviteRequestBodyArgEnterpriseField +export function serializeCreateInviteRequestBodyEnterpriseField( + val: CreateInviteRequestBodyEnterpriseField ): SerializedData { return { ['id']: val.id }; } -export function deserializeCreateInviteRequestBodyArgEnterpriseField( +export function deserializeCreateInviteRequestBodyEnterpriseField( val: any -): CreateInviteRequestBodyArgEnterpriseField { +): CreateInviteRequestBodyEnterpriseField { const id: string = val.id; - return { id: id } satisfies CreateInviteRequestBodyArgEnterpriseField; + return { id: id } satisfies CreateInviteRequestBodyEnterpriseField; } -export function serializeCreateInviteRequestBodyArgActionableByField( - val: CreateInviteRequestBodyArgActionableByField +export function serializeCreateInviteRequestBodyActionableByField( + val: CreateInviteRequestBodyActionableByField ): SerializedData { return { ['login']: val.login == void 0 ? void 0 : val.login }; } -export function deserializeCreateInviteRequestBodyArgActionableByField( +export function deserializeCreateInviteRequestBodyActionableByField( val: any -): CreateInviteRequestBodyArgActionableByField { +): CreateInviteRequestBodyActionableByField { const login: undefined | string = val.login == void 0 ? void 0 : val.login; - return { login: login } satisfies CreateInviteRequestBodyArgActionableByField; + return { login: login } satisfies CreateInviteRequestBodyActionableByField; } -export function serializeCreateInviteRequestBodyArg( - val: CreateInviteRequestBodyArg +export function serializeCreateInviteRequestBody( + val: CreateInviteRequestBody ): SerializedData { return { - ['enterprise']: serializeCreateInviteRequestBodyArgEnterpriseField( + ['enterprise']: serializeCreateInviteRequestBodyEnterpriseField( val.enterprise ), - ['actionable_by']: serializeCreateInviteRequestBodyArgActionableByField( + ['actionable_by']: serializeCreateInviteRequestBodyActionableByField( val.actionableBy ), }; } -export function deserializeCreateInviteRequestBodyArg( +export function deserializeCreateInviteRequestBody( val: any -): CreateInviteRequestBodyArg { - const enterprise: CreateInviteRequestBodyArgEnterpriseField = - deserializeCreateInviteRequestBodyArgEnterpriseField(val.enterprise); - const actionableBy: CreateInviteRequestBodyArgActionableByField = - deserializeCreateInviteRequestBodyArgActionableByField(val.actionable_by); +): CreateInviteRequestBody { + const enterprise: CreateInviteRequestBodyEnterpriseField = + deserializeCreateInviteRequestBodyEnterpriseField(val.enterprise); + const actionableBy: CreateInviteRequestBodyActionableByField = + deserializeCreateInviteRequestBodyActionableByField(val.actionable_by); return { enterprise: enterprise, actionableBy: actionableBy, - } satisfies CreateInviteRequestBodyArg; + } satisfies CreateInviteRequestBody; } diff --git a/src/managers/legalHoldPolicies.generated.ts b/src/managers/legalHoldPolicies.generated.ts index 9e734970..a8abd5e9 100644 --- a/src/managers/legalHoldPolicies.generated.ts +++ b/src/managers/legalHoldPolicies.generated.ts @@ -24,104 +24,105 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetLegalHoldPoliciesQueryParamsArg { +export interface GetLegalHoldPoliciesQueryParams { readonly policyName?: string; readonly fields?: readonly string[]; readonly marker?: string; readonly limit?: number; } -export class GetLegalHoldPoliciesHeadersArg { +export class GetLegalHoldPoliciesHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface CreateLegalHoldPolicyRequestBodyArg { +export interface CreateLegalHoldPolicyRequestBody { readonly policyName: string; readonly description?: string; readonly filterStartedAt?: string; readonly filterEndedAt?: string; readonly isOngoing?: boolean; } -export class CreateLegalHoldPolicyHeadersArg { +export class CreateLegalHoldPolicyHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class GetLegalHoldPolicyByIdHeadersArg { +export class GetLegalHoldPolicyByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface UpdateLegalHoldPolicyByIdRequestBodyArg { +export interface UpdateLegalHoldPolicyByIdRequestBody { readonly policyName?: string; readonly description?: string; readonly releaseNotes?: string; } -export class UpdateLegalHoldPolicyByIdHeadersArg { +export class UpdateLegalHoldPolicyByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteLegalHoldPolicyByIdHeadersArg { +export class DeleteLegalHoldPolicyByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class LegalHoldPoliciesManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - LegalHoldPoliciesManager, - | 'getLegalHoldPolicies' - | 'createLegalHoldPolicy' - | 'getLegalHoldPolicyById' - | 'updateLegalHoldPolicyById' - | 'deleteLegalHoldPolicyById' - > + fields: + | Omit< + LegalHoldPoliciesManager, + | 'networkSession' + | 'getLegalHoldPolicies' + | 'createLegalHoldPolicy' + | 'getLegalHoldPolicyById' + | 'updateLegalHoldPolicyById' + | 'deleteLegalHoldPolicyById' + > + | Partial> ) { Object.assign(this, fields); } async getLegalHoldPolicies( - queryParams: GetLegalHoldPoliciesQueryParamsArg = {} satisfies GetLegalHoldPoliciesQueryParamsArg, - headers: GetLegalHoldPoliciesHeadersArg = new GetLegalHoldPoliciesHeadersArg( - {} - ), + queryParams: GetLegalHoldPoliciesQueryParams = {} satisfies GetLegalHoldPoliciesQueryParams, + headers: GetLegalHoldPoliciesHeaders = new GetLegalHoldPoliciesHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -138,7 +139,10 @@ export class LegalHoldPoliciesManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/legal_hold_policies') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/legal_hold_policies' + ) as string, { method: 'GET', params: queryParamsMap, @@ -152,8 +156,8 @@ export class LegalHoldPoliciesManager { return deserializeLegalHoldPolicies(response.data); } async createLegalHoldPolicy( - requestBody: CreateLegalHoldPolicyRequestBodyArg, - headers: CreateLegalHoldPolicyHeadersArg = new CreateLegalHoldPolicyHeadersArg( + requestBody: CreateLegalHoldPolicyRequestBody, + headers: CreateLegalHoldPolicyHeaders = new CreateLegalHoldPolicyHeaders( {} ), cancellationToken?: CancellationToken @@ -162,11 +166,14 @@ export class LegalHoldPoliciesManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/legal_hold_policies') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/legal_hold_policies' + ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateLegalHoldPolicyRequestBodyArg(requestBody), + data: serializeCreateLegalHoldPolicyRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -178,7 +185,7 @@ export class LegalHoldPoliciesManager { } async getLegalHoldPolicyById( legalHoldPolicyId: string, - headers: GetLegalHoldPolicyByIdHeadersArg = new GetLegalHoldPolicyByIdHeadersArg( + headers: GetLegalHoldPolicyByIdHeaders = new GetLegalHoldPolicyByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -188,7 +195,8 @@ export class LegalHoldPoliciesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/legal_hold_policies/', + this.networkSession.baseUrls.baseUrl, + '/legal_hold_policies/', toString(legalHoldPolicyId) as string ) as string, { @@ -204,8 +212,8 @@ export class LegalHoldPoliciesManager { } async updateLegalHoldPolicyById( legalHoldPolicyId: string, - requestBody: UpdateLegalHoldPolicyByIdRequestBodyArg = {} satisfies UpdateLegalHoldPolicyByIdRequestBodyArg, - headers: UpdateLegalHoldPolicyByIdHeadersArg = new UpdateLegalHoldPolicyByIdHeadersArg( + requestBody: UpdateLegalHoldPolicyByIdRequestBody = {} satisfies UpdateLegalHoldPolicyByIdRequestBody, + headers: UpdateLegalHoldPolicyByIdHeaders = new UpdateLegalHoldPolicyByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -215,13 +223,14 @@ export class LegalHoldPoliciesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/legal_hold_policies/', + this.networkSession.baseUrls.baseUrl, + '/legal_hold_policies/', toString(legalHoldPolicyId) as string ) as string, { method: 'PUT', headers: headersMap, - data: serializeUpdateLegalHoldPolicyByIdRequestBodyArg(requestBody), + data: serializeUpdateLegalHoldPolicyByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -233,7 +242,7 @@ export class LegalHoldPoliciesManager { } async deleteLegalHoldPolicyById( legalHoldPolicyId: string, - headers: DeleteLegalHoldPolicyByIdHeadersArg = new DeleteLegalHoldPolicyByIdHeadersArg( + headers: DeleteLegalHoldPolicyByIdHeaders = new DeleteLegalHoldPolicyByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -243,7 +252,8 @@ export class LegalHoldPoliciesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/legal_hold_policies/', + this.networkSession.baseUrls.baseUrl, + '/legal_hold_policies/', toString(legalHoldPolicyId) as string ) as string, { @@ -258,8 +268,8 @@ export class LegalHoldPoliciesManager { return void 0; } } -export function serializeCreateLegalHoldPolicyRequestBodyArg( - val: CreateLegalHoldPolicyRequestBodyArg +export function serializeCreateLegalHoldPolicyRequestBody( + val: CreateLegalHoldPolicyRequestBody ): SerializedData { return { ['policy_name']: val.policyName, @@ -271,9 +281,9 @@ export function serializeCreateLegalHoldPolicyRequestBodyArg( ['is_ongoing']: val.isOngoing == void 0 ? void 0 : val.isOngoing, }; } -export function deserializeCreateLegalHoldPolicyRequestBodyArg( +export function deserializeCreateLegalHoldPolicyRequestBody( val: any -): CreateLegalHoldPolicyRequestBodyArg { +): CreateLegalHoldPolicyRequestBody { const policyName: string = val.policy_name; const description: undefined | string = val.description == void 0 ? void 0 : val.description; @@ -289,10 +299,10 @@ export function deserializeCreateLegalHoldPolicyRequestBodyArg( filterStartedAt: filterStartedAt, filterEndedAt: filterEndedAt, isOngoing: isOngoing, - } satisfies CreateLegalHoldPolicyRequestBodyArg; + } satisfies CreateLegalHoldPolicyRequestBody; } -export function serializeUpdateLegalHoldPolicyByIdRequestBodyArg( - val: UpdateLegalHoldPolicyByIdRequestBodyArg +export function serializeUpdateLegalHoldPolicyByIdRequestBody( + val: UpdateLegalHoldPolicyByIdRequestBody ): SerializedData { return { ['policy_name']: val.policyName == void 0 ? void 0 : val.policyName, @@ -300,9 +310,9 @@ export function serializeUpdateLegalHoldPolicyByIdRequestBodyArg( ['release_notes']: val.releaseNotes == void 0 ? void 0 : val.releaseNotes, }; } -export function deserializeUpdateLegalHoldPolicyByIdRequestBodyArg( +export function deserializeUpdateLegalHoldPolicyByIdRequestBody( val: any -): UpdateLegalHoldPolicyByIdRequestBodyArg { +): UpdateLegalHoldPolicyByIdRequestBody { const policyName: undefined | string = val.policy_name == void 0 ? void 0 : val.policy_name; const description: undefined | string = @@ -313,5 +323,5 @@ export function deserializeUpdateLegalHoldPolicyByIdRequestBodyArg( policyName: policyName, description: description, releaseNotes: releaseNotes, - } satisfies UpdateLegalHoldPolicyByIdRequestBodyArg; + } satisfies UpdateLegalHoldPolicyByIdRequestBody; } diff --git a/src/managers/legalHoldPolicyAssignments.generated.ts b/src/managers/legalHoldPolicyAssignments.generated.ts index e06b2f1e..32a9527e 100644 --- a/src/managers/legalHoldPolicyAssignments.generated.ts +++ b/src/managers/legalHoldPolicyAssignments.generated.ts @@ -27,118 +27,119 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export type GetLegalHoldPolicyAssignmentsQueryParamsArgAssignToTypeField = +export type GetLegalHoldPolicyAssignmentsQueryParamsAssignToTypeField = | 'file' | 'file_version' | 'folder' | 'user'; -export interface GetLegalHoldPolicyAssignmentsQueryParamsArg { +export interface GetLegalHoldPolicyAssignmentsQueryParams { readonly policyId: string; - readonly assignToType?: GetLegalHoldPolicyAssignmentsQueryParamsArgAssignToTypeField; + readonly assignToType?: GetLegalHoldPolicyAssignmentsQueryParamsAssignToTypeField; readonly assignToId?: string; readonly marker?: string; readonly limit?: number; readonly fields?: readonly string[]; } -export class GetLegalHoldPolicyAssignmentsHeadersArg { +export class GetLegalHoldPolicyAssignmentsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateLegalHoldPolicyAssignmentRequestBodyArgAssignToFieldTypeField = - 'file' | 'file_version' | 'folder' | 'user'; -export interface CreateLegalHoldPolicyAssignmentRequestBodyArgAssignToField { - readonly type: CreateLegalHoldPolicyAssignmentRequestBodyArgAssignToFieldTypeField; +export type CreateLegalHoldPolicyAssignmentRequestBodyAssignToTypeField = + | 'file' + | 'file_version' + | 'folder' + | 'user'; +export interface CreateLegalHoldPolicyAssignmentRequestBodyAssignToField { + readonly type: CreateLegalHoldPolicyAssignmentRequestBodyAssignToTypeField; readonly id: string; } -export interface CreateLegalHoldPolicyAssignmentRequestBodyArg { +export interface CreateLegalHoldPolicyAssignmentRequestBody { readonly policyId: string; - readonly assignTo: CreateLegalHoldPolicyAssignmentRequestBodyArgAssignToField; + readonly assignTo: CreateLegalHoldPolicyAssignmentRequestBodyAssignToField; } -export class CreateLegalHoldPolicyAssignmentHeadersArg { +export class CreateLegalHoldPolicyAssignmentHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class GetLegalHoldPolicyAssignmentByIdHeadersArg { +export class GetLegalHoldPolicyAssignmentByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial< - Pick - > + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteLegalHoldPolicyAssignmentByIdHeadersArg { +export class DeleteLegalHoldPolicyAssignmentByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit + | Omit | Partial< - Pick + Pick > ) { Object.assign(this, fields); } } -export interface GetLegalHoldPolicyAssignmentFileOnHoldQueryParamsArg { +export interface GetLegalHoldPolicyAssignmentFileOnHoldQueryParams { readonly marker?: string; readonly limit?: number; readonly fields?: readonly string[]; } -export class GetLegalHoldPolicyAssignmentFileOnHoldHeadersArg { +export class GetLegalHoldPolicyAssignmentFileOnHoldHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit + | Omit | Partial< - Pick + Pick > ) { Object.assign(this, fields); } } -export interface GetLegalHoldPolicyAssignmentFileVersionOnHoldQueryParamsArg { +export interface GetLegalHoldPolicyAssignmentFileVersionOnHoldQueryParams { readonly marker?: string; readonly limit?: number; readonly fields?: readonly string[]; } -export class GetLegalHoldPolicyAssignmentFileVersionOnHoldHeadersArg { +export class GetLegalHoldPolicyAssignmentFileVersionOnHoldHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: | Omit< - GetLegalHoldPolicyAssignmentFileVersionOnHoldHeadersArg, + GetLegalHoldPolicyAssignmentFileVersionOnHoldHeaders, 'extraHeaders' > | Partial< Pick< - GetLegalHoldPolicyAssignmentFileVersionOnHoldHeadersArg, + GetLegalHoldPolicyAssignmentFileVersionOnHoldHeaders, 'extraHeaders' > > @@ -148,23 +149,26 @@ export class GetLegalHoldPolicyAssignmentFileVersionOnHoldHeadersArg { } export class LegalHoldPolicyAssignmentsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - LegalHoldPolicyAssignmentsManager, - | 'getLegalHoldPolicyAssignments' - | 'createLegalHoldPolicyAssignment' - | 'getLegalHoldPolicyAssignmentById' - | 'deleteLegalHoldPolicyAssignmentById' - | 'getLegalHoldPolicyAssignmentFileOnHold' - | 'getLegalHoldPolicyAssignmentFileVersionOnHold' - > + fields: + | Omit< + LegalHoldPolicyAssignmentsManager, + | 'networkSession' + | 'getLegalHoldPolicyAssignments' + | 'createLegalHoldPolicyAssignment' + | 'getLegalHoldPolicyAssignmentById' + | 'deleteLegalHoldPolicyAssignmentById' + | 'getLegalHoldPolicyAssignmentFileOnHold' + | 'getLegalHoldPolicyAssignmentFileVersionOnHold' + > + | Partial> ) { Object.assign(this, fields); } async getLegalHoldPolicyAssignments( - queryParams: GetLegalHoldPolicyAssignmentsQueryParamsArg, - headers: GetLegalHoldPolicyAssignmentsHeadersArg = new GetLegalHoldPolicyAssignmentsHeadersArg( + queryParams: GetLegalHoldPolicyAssignmentsQueryParams, + headers: GetLegalHoldPolicyAssignmentsHeaders = new GetLegalHoldPolicyAssignmentsHeaders( {} ), cancellationToken?: CancellationToken @@ -186,7 +190,8 @@ export class LegalHoldPolicyAssignmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/legal_hold_policy_assignments' + this.networkSession.baseUrls.baseUrl, + '/legal_hold_policy_assignments' ) as string, { method: 'GET', @@ -201,8 +206,8 @@ export class LegalHoldPolicyAssignmentsManager { return deserializeLegalHoldPolicyAssignments(response.data); } async createLegalHoldPolicyAssignment( - requestBody: CreateLegalHoldPolicyAssignmentRequestBodyArg, - headers: CreateLegalHoldPolicyAssignmentHeadersArg = new CreateLegalHoldPolicyAssignmentHeadersArg( + requestBody: CreateLegalHoldPolicyAssignmentRequestBody, + headers: CreateLegalHoldPolicyAssignmentHeaders = new CreateLegalHoldPolicyAssignmentHeaders( {} ), cancellationToken?: CancellationToken @@ -212,14 +217,13 @@ export class LegalHoldPolicyAssignmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/legal_hold_policy_assignments' + this.networkSession.baseUrls.baseUrl, + '/legal_hold_policy_assignments' ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateLegalHoldPolicyAssignmentRequestBodyArg( - requestBody - ), + data: serializeCreateLegalHoldPolicyAssignmentRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -231,7 +235,7 @@ export class LegalHoldPolicyAssignmentsManager { } async getLegalHoldPolicyAssignmentById( legalHoldPolicyAssignmentId: string, - headers: GetLegalHoldPolicyAssignmentByIdHeadersArg = new GetLegalHoldPolicyAssignmentByIdHeadersArg( + headers: GetLegalHoldPolicyAssignmentByIdHeaders = new GetLegalHoldPolicyAssignmentByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -241,7 +245,8 @@ export class LegalHoldPolicyAssignmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/legal_hold_policy_assignments/', + this.networkSession.baseUrls.baseUrl, + '/legal_hold_policy_assignments/', toString(legalHoldPolicyAssignmentId) as string ) as string, { @@ -257,7 +262,7 @@ export class LegalHoldPolicyAssignmentsManager { } async deleteLegalHoldPolicyAssignmentById( legalHoldPolicyAssignmentId: string, - headers: DeleteLegalHoldPolicyAssignmentByIdHeadersArg = new DeleteLegalHoldPolicyAssignmentByIdHeadersArg( + headers: DeleteLegalHoldPolicyAssignmentByIdHeaders = new DeleteLegalHoldPolicyAssignmentByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -267,7 +272,8 @@ export class LegalHoldPolicyAssignmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/legal_hold_policy_assignments/', + this.networkSession.baseUrls.baseUrl, + '/legal_hold_policy_assignments/', toString(legalHoldPolicyAssignmentId) as string ) as string, { @@ -283,8 +289,8 @@ export class LegalHoldPolicyAssignmentsManager { } async getLegalHoldPolicyAssignmentFileOnHold( legalHoldPolicyAssignmentId: string, - queryParams: GetLegalHoldPolicyAssignmentFileOnHoldQueryParamsArg = {} satisfies GetLegalHoldPolicyAssignmentFileOnHoldQueryParamsArg, - headers: GetLegalHoldPolicyAssignmentFileOnHoldHeadersArg = new GetLegalHoldPolicyAssignmentFileOnHoldHeadersArg( + queryParams: GetLegalHoldPolicyAssignmentFileOnHoldQueryParams = {} satisfies GetLegalHoldPolicyAssignmentFileOnHoldQueryParams, + headers: GetLegalHoldPolicyAssignmentFileOnHoldHeaders = new GetLegalHoldPolicyAssignmentFileOnHoldHeaders( {} ), cancellationToken?: CancellationToken @@ -303,7 +309,8 @@ export class LegalHoldPolicyAssignmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/legal_hold_policy_assignments/', + this.networkSession.baseUrls.baseUrl, + '/legal_hold_policy_assignments/', toString(legalHoldPolicyAssignmentId) as string, '/files_on_hold' ) as string, @@ -321,8 +328,8 @@ export class LegalHoldPolicyAssignmentsManager { } async getLegalHoldPolicyAssignmentFileVersionOnHold( legalHoldPolicyAssignmentId: string, - queryParams: GetLegalHoldPolicyAssignmentFileVersionOnHoldQueryParamsArg = {} satisfies GetLegalHoldPolicyAssignmentFileVersionOnHoldQueryParamsArg, - headers: GetLegalHoldPolicyAssignmentFileVersionOnHoldHeadersArg = new GetLegalHoldPolicyAssignmentFileVersionOnHoldHeadersArg( + queryParams: GetLegalHoldPolicyAssignmentFileVersionOnHoldQueryParams = {} satisfies GetLegalHoldPolicyAssignmentFileVersionOnHoldQueryParams, + headers: GetLegalHoldPolicyAssignmentFileVersionOnHoldHeaders = new GetLegalHoldPolicyAssignmentFileVersionOnHoldHeaders( {} ), cancellationToken?: CancellationToken @@ -341,7 +348,8 @@ export class LegalHoldPolicyAssignmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/legal_hold_policy_assignments/', + this.networkSession.baseUrls.baseUrl, + '/legal_hold_policy_assignments/', toString(legalHoldPolicyAssignmentId) as string, '/file_versions_on_hold' ) as string, @@ -358,16 +366,16 @@ export class LegalHoldPolicyAssignmentsManager { return deserializeFileVersionLegalHolds(response.data); } } -export function serializeGetLegalHoldPolicyAssignmentsQueryParamsArgAssignToTypeField( - val: GetLegalHoldPolicyAssignmentsQueryParamsArgAssignToTypeField +export function serializeGetLegalHoldPolicyAssignmentsQueryParamsAssignToTypeField( + val: GetLegalHoldPolicyAssignmentsQueryParamsAssignToTypeField ): SerializedData { return val; } -export function deserializeGetLegalHoldPolicyAssignmentsQueryParamsArgAssignToTypeField( +export function deserializeGetLegalHoldPolicyAssignmentsQueryParamsAssignToTypeField( val: any -): GetLegalHoldPolicyAssignmentsQueryParamsArgAssignToTypeField { +): GetLegalHoldPolicyAssignmentsQueryParamsAssignToTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetLegalHoldPolicyAssignmentsQueryParamsArgAssignToTypeField"'; + throw 'Expecting a string for "GetLegalHoldPolicyAssignmentsQueryParamsAssignToTypeField"'; } if (val == 'file') { return 'file'; @@ -383,16 +391,16 @@ export function deserializeGetLegalHoldPolicyAssignmentsQueryParamsArgAssignToTy } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateLegalHoldPolicyAssignmentRequestBodyArgAssignToFieldTypeField( - val: CreateLegalHoldPolicyAssignmentRequestBodyArgAssignToFieldTypeField +export function serializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToTypeField( + val: CreateLegalHoldPolicyAssignmentRequestBodyAssignToTypeField ): SerializedData { return val; } -export function deserializeCreateLegalHoldPolicyAssignmentRequestBodyArgAssignToFieldTypeField( +export function deserializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToTypeField( val: any -): CreateLegalHoldPolicyAssignmentRequestBodyArgAssignToFieldTypeField { +): CreateLegalHoldPolicyAssignmentRequestBodyAssignToTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateLegalHoldPolicyAssignmentRequestBodyArgAssignToFieldTypeField"'; + throw 'Expecting a string for "CreateLegalHoldPolicyAssignmentRequestBodyAssignToTypeField"'; } if (val == 'file') { return 'file'; @@ -408,51 +416,51 @@ export function deserializeCreateLegalHoldPolicyAssignmentRequestBodyArgAssignTo } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateLegalHoldPolicyAssignmentRequestBodyArgAssignToField( - val: CreateLegalHoldPolicyAssignmentRequestBodyArgAssignToField +export function serializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToField( + val: CreateLegalHoldPolicyAssignmentRequestBodyAssignToField ): SerializedData { return { ['type']: - serializeCreateLegalHoldPolicyAssignmentRequestBodyArgAssignToFieldTypeField( + serializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToTypeField( val.type ), ['id']: val.id, }; } -export function deserializeCreateLegalHoldPolicyAssignmentRequestBodyArgAssignToField( +export function deserializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToField( val: any -): CreateLegalHoldPolicyAssignmentRequestBodyArgAssignToField { - const type: CreateLegalHoldPolicyAssignmentRequestBodyArgAssignToFieldTypeField = - deserializeCreateLegalHoldPolicyAssignmentRequestBodyArgAssignToFieldTypeField( +): CreateLegalHoldPolicyAssignmentRequestBodyAssignToField { + const type: CreateLegalHoldPolicyAssignmentRequestBodyAssignToTypeField = + deserializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToTypeField( val.type ); const id: string = val.id; return { type: type, id: id, - } satisfies CreateLegalHoldPolicyAssignmentRequestBodyArgAssignToField; + } satisfies CreateLegalHoldPolicyAssignmentRequestBodyAssignToField; } -export function serializeCreateLegalHoldPolicyAssignmentRequestBodyArg( - val: CreateLegalHoldPolicyAssignmentRequestBodyArg +export function serializeCreateLegalHoldPolicyAssignmentRequestBody( + val: CreateLegalHoldPolicyAssignmentRequestBody ): SerializedData { return { ['policy_id']: val.policyId, ['assign_to']: - serializeCreateLegalHoldPolicyAssignmentRequestBodyArgAssignToField( + serializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToField( val.assignTo ), }; } -export function deserializeCreateLegalHoldPolicyAssignmentRequestBodyArg( +export function deserializeCreateLegalHoldPolicyAssignmentRequestBody( val: any -): CreateLegalHoldPolicyAssignmentRequestBodyArg { +): CreateLegalHoldPolicyAssignmentRequestBody { const policyId: string = val.policy_id; - const assignTo: CreateLegalHoldPolicyAssignmentRequestBodyArgAssignToField = - deserializeCreateLegalHoldPolicyAssignmentRequestBodyArgAssignToField( + const assignTo: CreateLegalHoldPolicyAssignmentRequestBodyAssignToField = + deserializeCreateLegalHoldPolicyAssignmentRequestBodyAssignToField( val.assign_to ); return { policyId: policyId, assignTo: assignTo, - } satisfies CreateLegalHoldPolicyAssignmentRequestBodyArg; + } satisfies CreateLegalHoldPolicyAssignmentRequestBody; } diff --git a/src/managers/listCollaborations.generated.ts b/src/managers/listCollaborations.generated.ts index e1cb8f13..20977084 100644 --- a/src/managers/listCollaborations.generated.ts +++ b/src/managers/listCollaborations.generated.ts @@ -21,91 +21,94 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetFileCollaborationsQueryParamsArg { +export interface GetFileCollaborationsQueryParams { readonly fields?: readonly string[]; readonly limit?: number; readonly marker?: string; } -export class GetFileCollaborationsHeadersArg { +export class GetFileCollaborationsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetFolderCollaborationsQueryParamsArg { +export interface GetFolderCollaborationsQueryParams { readonly fields?: readonly string[]; } -export class GetFolderCollaborationsHeadersArg { +export class GetFolderCollaborationsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type GetCollaborationsQueryParamsArgStatusField = 'pending'; -export interface GetCollaborationsQueryParamsArg { - readonly status: GetCollaborationsQueryParamsArgStatusField; +export type GetCollaborationsQueryParamsStatusField = 'pending'; +export interface GetCollaborationsQueryParams { + readonly status: GetCollaborationsQueryParamsStatusField; readonly fields?: readonly string[]; readonly offset?: number; readonly limit?: number; } -export class GetCollaborationsHeadersArg { +export class GetCollaborationsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetGroupCollaborationsQueryParamsArg { +export interface GetGroupCollaborationsQueryParams { readonly limit?: number; readonly offset?: number; } -export class GetGroupCollaborationsHeadersArg { +export class GetGroupCollaborationsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class ListCollaborationsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - ListCollaborationsManager, - | 'getFileCollaborations' - | 'getFolderCollaborations' - | 'getCollaborations' - | 'getGroupCollaborations' - > + fields: + | Omit< + ListCollaborationsManager, + | 'networkSession' + | 'getFileCollaborations' + | 'getFolderCollaborations' + | 'getCollaborations' + | 'getGroupCollaborations' + > + | Partial> ) { Object.assign(this, fields); } async getFileCollaborations( fileId: string, - queryParams: GetFileCollaborationsQueryParamsArg = {} satisfies GetFileCollaborationsQueryParamsArg, - headers: GetFileCollaborationsHeadersArg = new GetFileCollaborationsHeadersArg( + queryParams: GetFileCollaborationsQueryParams = {} satisfies GetFileCollaborationsQueryParams, + headers: GetFileCollaborationsHeaders = new GetFileCollaborationsHeaders( {} ), cancellationToken?: CancellationToken @@ -124,7 +127,8 @@ export class ListCollaborationsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/collaborations' ) as string, @@ -142,8 +146,8 @@ export class ListCollaborationsManager { } async getFolderCollaborations( folderId: string, - queryParams: GetFolderCollaborationsQueryParamsArg = {} satisfies GetFolderCollaborationsQueryParamsArg, - headers: GetFolderCollaborationsHeadersArg = new GetFolderCollaborationsHeadersArg( + queryParams: GetFolderCollaborationsQueryParams = {} satisfies GetFolderCollaborationsQueryParams, + headers: GetFolderCollaborationsHeaders = new GetFolderCollaborationsHeaders( {} ), cancellationToken?: CancellationToken @@ -160,7 +164,8 @@ export class ListCollaborationsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '/collaborations' ) as string, @@ -177,8 +182,8 @@ export class ListCollaborationsManager { return deserializeCollaborations(response.data); } async getCollaborations( - queryParams: GetCollaborationsQueryParamsArg, - headers: GetCollaborationsHeadersArg = new GetCollaborationsHeadersArg({}), + queryParams: GetCollaborationsQueryParams, + headers: GetCollaborationsHeaders = new GetCollaborationsHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -195,7 +200,10 @@ export class ListCollaborationsManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/collaborations') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/collaborations' + ) as string, { method: 'GET', params: queryParamsMap, @@ -210,8 +218,8 @@ export class ListCollaborationsManager { } async getGroupCollaborations( groupId: string, - queryParams: GetGroupCollaborationsQueryParamsArg = {} satisfies GetGroupCollaborationsQueryParamsArg, - headers: GetGroupCollaborationsHeadersArg = new GetGroupCollaborationsHeadersArg( + queryParams: GetGroupCollaborationsQueryParams = {} satisfies GetGroupCollaborationsQueryParams, + headers: GetGroupCollaborationsHeaders = new GetGroupCollaborationsHeaders( {} ), cancellationToken?: CancellationToken @@ -227,7 +235,8 @@ export class ListCollaborationsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/groups/', + this.networkSession.baseUrls.baseUrl, + '/groups/', toString(groupId) as string, '/collaborations' ) as string, @@ -244,16 +253,16 @@ export class ListCollaborationsManager { return deserializeCollaborations(response.data); } } -export function serializeGetCollaborationsQueryParamsArgStatusField( - val: GetCollaborationsQueryParamsArgStatusField +export function serializeGetCollaborationsQueryParamsStatusField( + val: GetCollaborationsQueryParamsStatusField ): SerializedData { return val; } -export function deserializeGetCollaborationsQueryParamsArgStatusField( +export function deserializeGetCollaborationsQueryParamsStatusField( val: any -): GetCollaborationsQueryParamsArgStatusField { +): GetCollaborationsQueryParamsStatusField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetCollaborationsQueryParamsArgStatusField"'; + throw 'Expecting a string for "GetCollaborationsQueryParamsStatusField"'; } if (val == 'pending') { return 'pending'; diff --git a/src/managers/memberships.generated.ts b/src/managers/memberships.generated.ts index 42f3c178..d16a6ee6 100644 --- a/src/managers/memberships.generated.ts +++ b/src/managers/memberships.generated.ts @@ -24,141 +24,140 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetUserMembershipsQueryParamsArg { +export interface GetUserMembershipsQueryParams { readonly limit?: number; readonly offset?: number; } -export class GetUserMembershipsHeadersArg { +export class GetUserMembershipsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetGroupMembershipsQueryParamsArg { +export interface GetGroupMembershipsQueryParams { readonly limit?: number; readonly offset?: number; } -export class GetGroupMembershipsHeadersArg { +export class GetGroupMembershipsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface CreateGroupMembershipRequestBodyArgUserField { +export interface CreateGroupMembershipRequestBodyUserField { readonly id: string; } -export interface CreateGroupMembershipRequestBodyArgGroupField { +export interface CreateGroupMembershipRequestBodyGroupField { readonly id: string; } -export type CreateGroupMembershipRequestBodyArgRoleField = 'member' | 'admin'; -export interface CreateGroupMembershipRequestBodyArg { - readonly user: CreateGroupMembershipRequestBodyArgUserField; - readonly group: CreateGroupMembershipRequestBodyArgGroupField; - readonly role?: CreateGroupMembershipRequestBodyArgRoleField; +export type CreateGroupMembershipRequestBodyRoleField = 'member' | 'admin'; +export interface CreateGroupMembershipRequestBody { + readonly user: CreateGroupMembershipRequestBodyUserField; + readonly group: CreateGroupMembershipRequestBodyGroupField; + readonly role?: CreateGroupMembershipRequestBodyRoleField; readonly configurablePermissions?: { readonly [key: string]: boolean; }; } -export interface CreateGroupMembershipQueryParamsArg { +export interface CreateGroupMembershipQueryParams { readonly fields?: readonly string[]; } -export class CreateGroupMembershipHeadersArg { +export class CreateGroupMembershipHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetGroupMembershipByIdQueryParamsArg { +export interface GetGroupMembershipByIdQueryParams { readonly fields?: readonly string[]; } -export class GetGroupMembershipByIdHeadersArg { +export class GetGroupMembershipByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateGroupMembershipByIdRequestBodyArgRoleField = - | 'member' - | 'admin'; -export interface UpdateGroupMembershipByIdRequestBodyArg { - readonly role?: UpdateGroupMembershipByIdRequestBodyArgRoleField; +export type UpdateGroupMembershipByIdRequestBodyRoleField = 'member' | 'admin'; +export interface UpdateGroupMembershipByIdRequestBody { + readonly role?: UpdateGroupMembershipByIdRequestBodyRoleField; readonly configurablePermissions?: { readonly [key: string]: boolean; }; } -export interface UpdateGroupMembershipByIdQueryParamsArg { +export interface UpdateGroupMembershipByIdQueryParams { readonly fields?: readonly string[]; } -export class UpdateGroupMembershipByIdHeadersArg { +export class UpdateGroupMembershipByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteGroupMembershipByIdHeadersArg { +export class DeleteGroupMembershipByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class MembershipsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - MembershipsManager, - | 'getUserMemberships' - | 'getGroupMemberships' - | 'createGroupMembership' - | 'getGroupMembershipById' - | 'updateGroupMembershipById' - | 'deleteGroupMembershipById' - > + fields: + | Omit< + MembershipsManager, + | 'networkSession' + | 'getUserMemberships' + | 'getGroupMemberships' + | 'createGroupMembership' + | 'getGroupMembershipById' + | 'updateGroupMembershipById' + | 'deleteGroupMembershipById' + > + | Partial> ) { Object.assign(this, fields); } async getUserMemberships( userId: string, - queryParams: GetUserMembershipsQueryParamsArg = {} satisfies GetUserMembershipsQueryParamsArg, - headers: GetUserMembershipsHeadersArg = new GetUserMembershipsHeadersArg( - {} - ), + queryParams: GetUserMembershipsQueryParams = {} satisfies GetUserMembershipsQueryParams, + headers: GetUserMembershipsHeaders = new GetUserMembershipsHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -172,7 +171,8 @@ export class MembershipsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/users/', + this.networkSession.baseUrls.baseUrl, + '/users/', toString(userId) as string, '/memberships' ) as string, @@ -190,10 +190,8 @@ export class MembershipsManager { } async getGroupMemberships( groupId: string, - queryParams: GetGroupMembershipsQueryParamsArg = {} satisfies GetGroupMembershipsQueryParamsArg, - headers: GetGroupMembershipsHeadersArg = new GetGroupMembershipsHeadersArg( - {} - ), + queryParams: GetGroupMembershipsQueryParams = {} satisfies GetGroupMembershipsQueryParams, + headers: GetGroupMembershipsHeaders = new GetGroupMembershipsHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -207,7 +205,8 @@ export class MembershipsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/groups/', + this.networkSession.baseUrls.baseUrl, + '/groups/', toString(groupId) as string, '/memberships' ) as string, @@ -224,9 +223,9 @@ export class MembershipsManager { return deserializeGroupMemberships(response.data); } async createGroupMembership( - requestBody: CreateGroupMembershipRequestBodyArg, - queryParams: CreateGroupMembershipQueryParamsArg = {} satisfies CreateGroupMembershipQueryParamsArg, - headers: CreateGroupMembershipHeadersArg = new CreateGroupMembershipHeadersArg( + requestBody: CreateGroupMembershipRequestBody, + queryParams: CreateGroupMembershipQueryParams = {} satisfies CreateGroupMembershipQueryParams, + headers: CreateGroupMembershipHeaders = new CreateGroupMembershipHeaders( {} ), cancellationToken?: CancellationToken @@ -242,12 +241,15 @@ export class MembershipsManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/group_memberships') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/group_memberships' + ) as string, { method: 'POST', params: queryParamsMap, headers: headersMap, - data: serializeCreateGroupMembershipRequestBodyArg(requestBody), + data: serializeCreateGroupMembershipRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -259,8 +261,8 @@ export class MembershipsManager { } async getGroupMembershipById( groupMembershipId: string, - queryParams: GetGroupMembershipByIdQueryParamsArg = {} satisfies GetGroupMembershipByIdQueryParamsArg, - headers: GetGroupMembershipByIdHeadersArg = new GetGroupMembershipByIdHeadersArg( + queryParams: GetGroupMembershipByIdQueryParams = {} satisfies GetGroupMembershipByIdQueryParams, + headers: GetGroupMembershipByIdHeaders = new GetGroupMembershipByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -277,7 +279,8 @@ export class MembershipsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/group_memberships/', + this.networkSession.baseUrls.baseUrl, + '/group_memberships/', toString(groupMembershipId) as string ) as string, { @@ -294,9 +297,9 @@ export class MembershipsManager { } async updateGroupMembershipById( groupMembershipId: string, - requestBody: UpdateGroupMembershipByIdRequestBodyArg = {} satisfies UpdateGroupMembershipByIdRequestBodyArg, - queryParams: UpdateGroupMembershipByIdQueryParamsArg = {} satisfies UpdateGroupMembershipByIdQueryParamsArg, - headers: UpdateGroupMembershipByIdHeadersArg = new UpdateGroupMembershipByIdHeadersArg( + requestBody: UpdateGroupMembershipByIdRequestBody = {} satisfies UpdateGroupMembershipByIdRequestBody, + queryParams: UpdateGroupMembershipByIdQueryParams = {} satisfies UpdateGroupMembershipByIdQueryParams, + headers: UpdateGroupMembershipByIdHeaders = new UpdateGroupMembershipByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -313,14 +316,15 @@ export class MembershipsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/group_memberships/', + this.networkSession.baseUrls.baseUrl, + '/group_memberships/', toString(groupMembershipId) as string ) as string, { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateGroupMembershipByIdRequestBodyArg(requestBody), + data: serializeUpdateGroupMembershipByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -332,7 +336,7 @@ export class MembershipsManager { } async deleteGroupMembershipById( groupMembershipId: string, - headers: DeleteGroupMembershipByIdHeadersArg = new DeleteGroupMembershipByIdHeadersArg( + headers: DeleteGroupMembershipByIdHeaders = new DeleteGroupMembershipByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -342,7 +346,8 @@ export class MembershipsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/group_memberships/', + this.networkSession.baseUrls.baseUrl, + '/group_memberships/', toString(groupMembershipId) as string ) as string, { @@ -357,38 +362,38 @@ export class MembershipsManager { return void 0; } } -export function serializeCreateGroupMembershipRequestBodyArgUserField( - val: CreateGroupMembershipRequestBodyArgUserField +export function serializeCreateGroupMembershipRequestBodyUserField( + val: CreateGroupMembershipRequestBodyUserField ): SerializedData { return { ['id']: val.id }; } -export function deserializeCreateGroupMembershipRequestBodyArgUserField( +export function deserializeCreateGroupMembershipRequestBodyUserField( val: any -): CreateGroupMembershipRequestBodyArgUserField { +): CreateGroupMembershipRequestBodyUserField { const id: string = val.id; - return { id: id } satisfies CreateGroupMembershipRequestBodyArgUserField; + return { id: id } satisfies CreateGroupMembershipRequestBodyUserField; } -export function serializeCreateGroupMembershipRequestBodyArgGroupField( - val: CreateGroupMembershipRequestBodyArgGroupField +export function serializeCreateGroupMembershipRequestBodyGroupField( + val: CreateGroupMembershipRequestBodyGroupField ): SerializedData { return { ['id']: val.id }; } -export function deserializeCreateGroupMembershipRequestBodyArgGroupField( +export function deserializeCreateGroupMembershipRequestBodyGroupField( val: any -): CreateGroupMembershipRequestBodyArgGroupField { +): CreateGroupMembershipRequestBodyGroupField { const id: string = val.id; - return { id: id } satisfies CreateGroupMembershipRequestBodyArgGroupField; + return { id: id } satisfies CreateGroupMembershipRequestBodyGroupField; } -export function serializeCreateGroupMembershipRequestBodyArgRoleField( - val: CreateGroupMembershipRequestBodyArgRoleField +export function serializeCreateGroupMembershipRequestBodyRoleField( + val: CreateGroupMembershipRequestBodyRoleField ): SerializedData { return val; } -export function deserializeCreateGroupMembershipRequestBodyArgRoleField( +export function deserializeCreateGroupMembershipRequestBodyRoleField( val: any -): CreateGroupMembershipRequestBodyArgRoleField { +): CreateGroupMembershipRequestBodyRoleField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateGroupMembershipRequestBodyArgRoleField"'; + throw 'Expecting a string for "CreateGroupMembershipRequestBodyRoleField"'; } if (val == 'member') { return 'member'; @@ -398,35 +403,33 @@ export function deserializeCreateGroupMembershipRequestBodyArgRoleField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateGroupMembershipRequestBodyArg( - val: CreateGroupMembershipRequestBodyArg +export function serializeCreateGroupMembershipRequestBody( + val: CreateGroupMembershipRequestBody ): SerializedData { return { - ['user']: serializeCreateGroupMembershipRequestBodyArgUserField(val.user), - ['group']: serializeCreateGroupMembershipRequestBodyArgGroupField( - val.group - ), + ['user']: serializeCreateGroupMembershipRequestBodyUserField(val.user), + ['group']: serializeCreateGroupMembershipRequestBodyGroupField(val.group), ['role']: val.role == void 0 ? void 0 - : serializeCreateGroupMembershipRequestBodyArgRoleField(val.role), + : serializeCreateGroupMembershipRequestBodyRoleField(val.role), ['configurable_permissions']: val.configurablePermissions == void 0 ? void 0 : val.configurablePermissions, }; } -export function deserializeCreateGroupMembershipRequestBodyArg( +export function deserializeCreateGroupMembershipRequestBody( val: any -): CreateGroupMembershipRequestBodyArg { - const user: CreateGroupMembershipRequestBodyArgUserField = - deserializeCreateGroupMembershipRequestBodyArgUserField(val.user); - const group: CreateGroupMembershipRequestBodyArgGroupField = - deserializeCreateGroupMembershipRequestBodyArgGroupField(val.group); - const role: undefined | CreateGroupMembershipRequestBodyArgRoleField = +): CreateGroupMembershipRequestBody { + const user: CreateGroupMembershipRequestBodyUserField = + deserializeCreateGroupMembershipRequestBodyUserField(val.user); + const group: CreateGroupMembershipRequestBodyGroupField = + deserializeCreateGroupMembershipRequestBodyGroupField(val.group); + const role: undefined | CreateGroupMembershipRequestBodyRoleField = val.role == void 0 ? void 0 - : deserializeCreateGroupMembershipRequestBodyArgRoleField(val.role); + : deserializeCreateGroupMembershipRequestBodyRoleField(val.role); const configurablePermissions: | undefined | { @@ -440,18 +443,18 @@ export function deserializeCreateGroupMembershipRequestBodyArg( group: group, role: role, configurablePermissions: configurablePermissions, - } satisfies CreateGroupMembershipRequestBodyArg; + } satisfies CreateGroupMembershipRequestBody; } -export function serializeUpdateGroupMembershipByIdRequestBodyArgRoleField( - val: UpdateGroupMembershipByIdRequestBodyArgRoleField +export function serializeUpdateGroupMembershipByIdRequestBodyRoleField( + val: UpdateGroupMembershipByIdRequestBodyRoleField ): SerializedData { return val; } -export function deserializeUpdateGroupMembershipByIdRequestBodyArgRoleField( +export function deserializeUpdateGroupMembershipByIdRequestBodyRoleField( val: any -): UpdateGroupMembershipByIdRequestBodyArgRoleField { +): UpdateGroupMembershipByIdRequestBodyRoleField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateGroupMembershipByIdRequestBodyArgRoleField"'; + throw 'Expecting a string for "UpdateGroupMembershipByIdRequestBodyRoleField"'; } if (val == 'member') { return 'member'; @@ -461,27 +464,27 @@ export function deserializeUpdateGroupMembershipByIdRequestBodyArgRoleField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateGroupMembershipByIdRequestBodyArg( - val: UpdateGroupMembershipByIdRequestBodyArg +export function serializeUpdateGroupMembershipByIdRequestBody( + val: UpdateGroupMembershipByIdRequestBody ): SerializedData { return { ['role']: val.role == void 0 ? void 0 - : serializeUpdateGroupMembershipByIdRequestBodyArgRoleField(val.role), + : serializeUpdateGroupMembershipByIdRequestBodyRoleField(val.role), ['configurable_permissions']: val.configurablePermissions == void 0 ? void 0 : val.configurablePermissions, }; } -export function deserializeUpdateGroupMembershipByIdRequestBodyArg( +export function deserializeUpdateGroupMembershipByIdRequestBody( val: any -): UpdateGroupMembershipByIdRequestBodyArg { - const role: undefined | UpdateGroupMembershipByIdRequestBodyArgRoleField = +): UpdateGroupMembershipByIdRequestBody { + const role: undefined | UpdateGroupMembershipByIdRequestBodyRoleField = val.role == void 0 ? void 0 - : deserializeUpdateGroupMembershipByIdRequestBodyArgRoleField(val.role); + : deserializeUpdateGroupMembershipByIdRequestBodyRoleField(val.role); const configurablePermissions: | undefined | { @@ -493,5 +496,5 @@ export function deserializeUpdateGroupMembershipByIdRequestBodyArg( return { role: role, configurablePermissions: configurablePermissions, - } satisfies UpdateGroupMembershipByIdRequestBodyArg; + } satisfies UpdateGroupMembershipByIdRequestBody; } diff --git a/src/managers/metadataCascadePolicies.generated.ts b/src/managers/metadataCascadePolicies.generated.ts index 89f9ddf7..f50d78cd 100644 --- a/src/managers/metadataCascadePolicies.generated.ts +++ b/src/managers/metadataCascadePolicies.generated.ts @@ -27,105 +27,106 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetMetadataCascadePoliciesQueryParamsArg { +export interface GetMetadataCascadePoliciesQueryParams { readonly folderId: string; readonly ownerEnterpriseId?: string; readonly marker?: string; readonly offset?: number; } -export class GetMetadataCascadePoliciesHeadersArg { +export class GetMetadataCascadePoliciesHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateMetadataCascadePolicyRequestBodyArgScopeField = +export type CreateMetadataCascadePolicyRequestBodyScopeField = | 'global' | 'enterprise'; -export interface CreateMetadataCascadePolicyRequestBodyArg { +export interface CreateMetadataCascadePolicyRequestBody { readonly folderId: string; - readonly scope: CreateMetadataCascadePolicyRequestBodyArgScopeField; + readonly scope: CreateMetadataCascadePolicyRequestBodyScopeField; readonly templateKey: string; } -export class CreateMetadataCascadePolicyHeadersArg { +export class CreateMetadataCascadePolicyHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class GetMetadataCascadePolicyByIdHeadersArg { +export class GetMetadataCascadePolicyByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteMetadataCascadePolicyByIdHeadersArg { +export class DeleteMetadataCascadePolicyByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateMetadataCascadePolicyApplyRequestBodyArgConflictResolutionField = +export type CreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField = 'none' | 'overwrite'; -export interface CreateMetadataCascadePolicyApplyRequestBodyArg { - readonly conflictResolution: CreateMetadataCascadePolicyApplyRequestBodyArgConflictResolutionField; +export interface CreateMetadataCascadePolicyApplyRequestBody { + readonly conflictResolution: CreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField; } -export class CreateMetadataCascadePolicyApplyHeadersArg { +export class CreateMetadataCascadePolicyApplyHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial< - Pick - > + | Omit + | Partial> ) { Object.assign(this, fields); } } export class MetadataCascadePoliciesManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - MetadataCascadePoliciesManager, - | 'getMetadataCascadePolicies' - | 'createMetadataCascadePolicy' - | 'getMetadataCascadePolicyById' - | 'deleteMetadataCascadePolicyById' - | 'createMetadataCascadePolicyApply' - > + fields: + | Omit< + MetadataCascadePoliciesManager, + | 'networkSession' + | 'getMetadataCascadePolicies' + | 'createMetadataCascadePolicy' + | 'getMetadataCascadePolicyById' + | 'deleteMetadataCascadePolicyById' + | 'createMetadataCascadePolicyApply' + > + | Partial> ) { Object.assign(this, fields); } async getMetadataCascadePolicies( - queryParams: GetMetadataCascadePoliciesQueryParamsArg, - headers: GetMetadataCascadePoliciesHeadersArg = new GetMetadataCascadePoliciesHeadersArg( + queryParams: GetMetadataCascadePoliciesQueryParams, + headers: GetMetadataCascadePoliciesHeaders = new GetMetadataCascadePoliciesHeaders( {} ), cancellationToken?: CancellationToken @@ -144,7 +145,10 @@ export class MetadataCascadePoliciesManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/metadata_cascade_policies') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/metadata_cascade_policies' + ) as string, { method: 'GET', params: queryParamsMap, @@ -158,8 +162,8 @@ export class MetadataCascadePoliciesManager { return deserializeMetadataCascadePolicies(response.data); } async createMetadataCascadePolicy( - requestBody: CreateMetadataCascadePolicyRequestBodyArg, - headers: CreateMetadataCascadePolicyHeadersArg = new CreateMetadataCascadePolicyHeadersArg( + requestBody: CreateMetadataCascadePolicyRequestBody, + headers: CreateMetadataCascadePolicyHeaders = new CreateMetadataCascadePolicyHeaders( {} ), cancellationToken?: CancellationToken @@ -168,11 +172,14 @@ export class MetadataCascadePoliciesManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/metadata_cascade_policies') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/metadata_cascade_policies' + ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateMetadataCascadePolicyRequestBodyArg(requestBody), + data: serializeCreateMetadataCascadePolicyRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -184,7 +191,7 @@ export class MetadataCascadePoliciesManager { } async getMetadataCascadePolicyById( metadataCascadePolicyId: string, - headers: GetMetadataCascadePolicyByIdHeadersArg = new GetMetadataCascadePolicyByIdHeadersArg( + headers: GetMetadataCascadePolicyByIdHeaders = new GetMetadataCascadePolicyByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -194,7 +201,8 @@ export class MetadataCascadePoliciesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/metadata_cascade_policies/', + this.networkSession.baseUrls.baseUrl, + '/metadata_cascade_policies/', toString(metadataCascadePolicyId) as string ) as string, { @@ -210,7 +218,7 @@ export class MetadataCascadePoliciesManager { } async deleteMetadataCascadePolicyById( metadataCascadePolicyId: string, - headers: DeleteMetadataCascadePolicyByIdHeadersArg = new DeleteMetadataCascadePolicyByIdHeadersArg( + headers: DeleteMetadataCascadePolicyByIdHeaders = new DeleteMetadataCascadePolicyByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -220,7 +228,8 @@ export class MetadataCascadePoliciesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/metadata_cascade_policies/', + this.networkSession.baseUrls.baseUrl, + '/metadata_cascade_policies/', toString(metadataCascadePolicyId) as string ) as string, { @@ -236,8 +245,8 @@ export class MetadataCascadePoliciesManager { } async createMetadataCascadePolicyApply( metadataCascadePolicyId: string, - requestBody: CreateMetadataCascadePolicyApplyRequestBodyArg, - headers: CreateMetadataCascadePolicyApplyHeadersArg = new CreateMetadataCascadePolicyApplyHeadersArg( + requestBody: CreateMetadataCascadePolicyApplyRequestBody, + headers: CreateMetadataCascadePolicyApplyHeaders = new CreateMetadataCascadePolicyApplyHeaders( {} ), cancellationToken?: CancellationToken @@ -247,16 +256,15 @@ export class MetadataCascadePoliciesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/metadata_cascade_policies/', + this.networkSession.baseUrls.baseUrl, + '/metadata_cascade_policies/', toString(metadataCascadePolicyId) as string, '/apply' ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateMetadataCascadePolicyApplyRequestBodyArg( - requestBody - ), + data: serializeCreateMetadataCascadePolicyApplyRequestBody(requestBody), contentType: 'application/json', responseFormat: void 0, auth: this.auth, @@ -267,16 +275,16 @@ export class MetadataCascadePoliciesManager { return void 0; } } -export function serializeCreateMetadataCascadePolicyRequestBodyArgScopeField( - val: CreateMetadataCascadePolicyRequestBodyArgScopeField +export function serializeCreateMetadataCascadePolicyRequestBodyScopeField( + val: CreateMetadataCascadePolicyRequestBodyScopeField ): SerializedData { return val; } -export function deserializeCreateMetadataCascadePolicyRequestBodyArgScopeField( +export function deserializeCreateMetadataCascadePolicyRequestBodyScopeField( val: any -): CreateMetadataCascadePolicyRequestBodyArgScopeField { +): CreateMetadataCascadePolicyRequestBodyScopeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateMetadataCascadePolicyRequestBodyArgScopeField"'; + throw 'Expecting a string for "CreateMetadataCascadePolicyRequestBodyScopeField"'; } if (val == 'global') { return 'global'; @@ -286,40 +294,40 @@ export function deserializeCreateMetadataCascadePolicyRequestBodyArgScopeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateMetadataCascadePolicyRequestBodyArg( - val: CreateMetadataCascadePolicyRequestBodyArg +export function serializeCreateMetadataCascadePolicyRequestBody( + val: CreateMetadataCascadePolicyRequestBody ): SerializedData { return { ['folder_id']: val.folderId, - ['scope']: serializeCreateMetadataCascadePolicyRequestBodyArgScopeField( + ['scope']: serializeCreateMetadataCascadePolicyRequestBodyScopeField( val.scope ), ['templateKey']: val.templateKey, }; } -export function deserializeCreateMetadataCascadePolicyRequestBodyArg( +export function deserializeCreateMetadataCascadePolicyRequestBody( val: any -): CreateMetadataCascadePolicyRequestBodyArg { +): CreateMetadataCascadePolicyRequestBody { const folderId: string = val.folder_id; - const scope: CreateMetadataCascadePolicyRequestBodyArgScopeField = - deserializeCreateMetadataCascadePolicyRequestBodyArgScopeField(val.scope); + const scope: CreateMetadataCascadePolicyRequestBodyScopeField = + deserializeCreateMetadataCascadePolicyRequestBodyScopeField(val.scope); const templateKey: string = val.templateKey; return { folderId: folderId, scope: scope, templateKey: templateKey, - } satisfies CreateMetadataCascadePolicyRequestBodyArg; + } satisfies CreateMetadataCascadePolicyRequestBody; } -export function serializeCreateMetadataCascadePolicyApplyRequestBodyArgConflictResolutionField( - val: CreateMetadataCascadePolicyApplyRequestBodyArgConflictResolutionField +export function serializeCreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField( + val: CreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField ): SerializedData { return val; } -export function deserializeCreateMetadataCascadePolicyApplyRequestBodyArgConflictResolutionField( +export function deserializeCreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField( val: any -): CreateMetadataCascadePolicyApplyRequestBodyArgConflictResolutionField { +): CreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateMetadataCascadePolicyApplyRequestBodyArgConflictResolutionField"'; + throw 'Expecting a string for "CreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField"'; } if (val == 'none') { return 'none'; @@ -329,24 +337,24 @@ export function deserializeCreateMetadataCascadePolicyApplyRequestBodyArgConflic } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateMetadataCascadePolicyApplyRequestBodyArg( - val: CreateMetadataCascadePolicyApplyRequestBodyArg +export function serializeCreateMetadataCascadePolicyApplyRequestBody( + val: CreateMetadataCascadePolicyApplyRequestBody ): SerializedData { return { ['conflict_resolution']: - serializeCreateMetadataCascadePolicyApplyRequestBodyArgConflictResolutionField( + serializeCreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField( val.conflictResolution ), }; } -export function deserializeCreateMetadataCascadePolicyApplyRequestBodyArg( +export function deserializeCreateMetadataCascadePolicyApplyRequestBody( val: any -): CreateMetadataCascadePolicyApplyRequestBodyArg { - const conflictResolution: CreateMetadataCascadePolicyApplyRequestBodyArgConflictResolutionField = - deserializeCreateMetadataCascadePolicyApplyRequestBodyArgConflictResolutionField( +): CreateMetadataCascadePolicyApplyRequestBody { + const conflictResolution: CreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField = + deserializeCreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField( val.conflict_resolution ); return { conflictResolution: conflictResolution, - } satisfies CreateMetadataCascadePolicyApplyRequestBodyArg; + } satisfies CreateMetadataCascadePolicyApplyRequestBody; } diff --git a/src/managers/metadataTemplates.generated.ts b/src/managers/metadataTemplates.generated.ts index 1e27394a..c3c10908 100644 --- a/src/managers/metadataTemplates.generated.ts +++ b/src/managers/metadataTemplates.generated.ts @@ -24,38 +24,36 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetMetadataTemplatesByInstanceIdQueryParamsArg { +export interface GetMetadataTemplatesByInstanceIdQueryParams { readonly metadataInstanceId: string; } -export class GetMetadataTemplatesByInstanceIdHeadersArg { +export class GetMetadataTemplatesByInstanceIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial< - Pick - > + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type GetMetadataTemplateScopeArg = 'global' | 'enterprise'; -export class GetMetadataTemplateHeadersArg { +export type GetMetadataTemplateScope = 'global' | 'enterprise'; +export class GetMetadataTemplateHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateMetadataTemplateScopeArg = 'global' | 'enterprise'; -export type UpdateMetadataTemplateRequestBodyArgOpField = +export type UpdateMetadataTemplateScope = 'global' | 'enterprise'; +export type UpdateMetadataTemplateRequestBodyOpField = | 'editTemplate' | 'addField' | 'reorderFields' @@ -69,8 +67,8 @@ export type UpdateMetadataTemplateRequestBodyArgOpField = | 'removeEnumOption' | 'editMultiSelectOption' | 'removeMultiSelectOption'; -export interface UpdateMetadataTemplateRequestBodyArg { - readonly op: UpdateMetadataTemplateRequestBodyArgOpField; +export interface UpdateMetadataTemplateRequestBody { + readonly op: UpdateMetadataTemplateRequestBodyOpField; readonly data?: { readonly [key: string]: string; }; @@ -81,133 +79,136 @@ export interface UpdateMetadataTemplateRequestBodyArg { readonly multiSelectOptionKey?: string; readonly multiSelectOptionKeys?: readonly string[]; } -export class UpdateMetadataTemplateHeadersArg { +export class UpdateMetadataTemplateHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type DeleteMetadataTemplateScopeArg = 'global' | 'enterprise'; -export class DeleteMetadataTemplateHeadersArg { +export type DeleteMetadataTemplateScope = 'global' | 'enterprise'; +export class DeleteMetadataTemplateHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class GetMetadataTemplateByIdHeadersArg { +export class GetMetadataTemplateByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetGlobalMetadataTemplatesQueryParamsArg { +export interface GetGlobalMetadataTemplatesQueryParams { readonly marker?: string; readonly limit?: number; } -export class GetGlobalMetadataTemplatesHeadersArg { +export class GetGlobalMetadataTemplatesHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetEnterpriseMetadataTemplatesQueryParamsArg { +export interface GetEnterpriseMetadataTemplatesQueryParams { readonly marker?: string; readonly limit?: number; } -export class GetEnterpriseMetadataTemplatesHeadersArg { +export class GetEnterpriseMetadataTemplatesHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateMetadataTemplateRequestBodyArgFieldsFieldTypeField = +export type CreateMetadataTemplateRequestBodyFieldsTypeField = | 'string' | 'float' | 'date' | 'enum' | 'multiSelect'; -export interface CreateMetadataTemplateRequestBodyArgFieldsFieldOptionsField { +export interface CreateMetadataTemplateRequestBodyFieldsOptionsField { readonly key: string; } -export interface CreateMetadataTemplateRequestBodyArgFieldsField { - readonly type: CreateMetadataTemplateRequestBodyArgFieldsFieldTypeField; +export interface CreateMetadataTemplateRequestBodyFieldsField { + readonly type: CreateMetadataTemplateRequestBodyFieldsTypeField; readonly key: string; readonly displayName: string; readonly description?: string; readonly hidden?: boolean; - readonly options?: readonly CreateMetadataTemplateRequestBodyArgFieldsFieldOptionsField[]; + readonly options?: readonly CreateMetadataTemplateRequestBodyFieldsOptionsField[]; } -export interface CreateMetadataTemplateRequestBodyArg { +export interface CreateMetadataTemplateRequestBody { readonly scope: string; readonly templateKey?: string; readonly displayName: string; readonly hidden?: boolean; - readonly fields?: readonly CreateMetadataTemplateRequestBodyArgFieldsField[]; + readonly fields?: readonly CreateMetadataTemplateRequestBodyFieldsField[]; readonly copyInstanceOnItemCopy?: boolean; } -export class CreateMetadataTemplateHeadersArg { +export class CreateMetadataTemplateHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class MetadataTemplatesManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - MetadataTemplatesManager, - | 'getMetadataTemplatesByInstanceId' - | 'getMetadataTemplate' - | 'updateMetadataTemplate' - | 'deleteMetadataTemplate' - | 'getMetadataTemplateById' - | 'getGlobalMetadataTemplates' - | 'getEnterpriseMetadataTemplates' - | 'createMetadataTemplate' - > + fields: + | Omit< + MetadataTemplatesManager, + | 'networkSession' + | 'getMetadataTemplatesByInstanceId' + | 'getMetadataTemplate' + | 'updateMetadataTemplate' + | 'deleteMetadataTemplate' + | 'getMetadataTemplateById' + | 'getGlobalMetadataTemplates' + | 'getEnterpriseMetadataTemplates' + | 'createMetadataTemplate' + > + | Partial> ) { Object.assign(this, fields); } async getMetadataTemplatesByInstanceId( - queryParams: GetMetadataTemplatesByInstanceIdQueryParamsArg, - headers: GetMetadataTemplatesByInstanceIdHeadersArg = new GetMetadataTemplatesByInstanceIdHeadersArg( + queryParams: GetMetadataTemplatesByInstanceIdQueryParams, + headers: GetMetadataTemplatesByInstanceIdHeaders = new GetMetadataTemplatesByInstanceIdHeaders( {} ), cancellationToken?: CancellationToken @@ -223,7 +224,10 @@ export class MetadataTemplatesManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/metadata_templates') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/metadata_templates' + ) as string, { method: 'GET', params: queryParamsMap, @@ -237,11 +241,9 @@ export class MetadataTemplatesManager { return deserializeMetadataTemplates(response.data); } async getMetadataTemplate( - scope: GetMetadataTemplateScopeArg, + scope: GetMetadataTemplateScope, templateKey: string, - headers: GetMetadataTemplateHeadersArg = new GetMetadataTemplateHeadersArg( - {} - ), + headers: GetMetadataTemplateHeaders = new GetMetadataTemplateHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -249,7 +251,8 @@ export class MetadataTemplatesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/metadata_templates/', + this.networkSession.baseUrls.baseUrl, + '/metadata_templates/', toString(scope) as string, '/', toString(templateKey) as string, @@ -267,10 +270,10 @@ export class MetadataTemplatesManager { return deserializeMetadataTemplate(response.data); } async updateMetadataTemplate( - scope: UpdateMetadataTemplateScopeArg, + scope: UpdateMetadataTemplateScope, templateKey: string, - requestBody: readonly UpdateMetadataTemplateRequestBodyArg[], - headers: UpdateMetadataTemplateHeadersArg = new UpdateMetadataTemplateHeadersArg( + requestBody: readonly UpdateMetadataTemplateRequestBody[], + headers: UpdateMetadataTemplateHeaders = new UpdateMetadataTemplateHeaders( {} ), cancellationToken?: CancellationToken @@ -280,7 +283,8 @@ export class MetadataTemplatesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/metadata_templates/', + this.networkSession.baseUrls.baseUrl, + '/metadata_templates/', toString(scope) as string, '/', toString(templateKey) as string, @@ -290,7 +294,7 @@ export class MetadataTemplatesManager { method: 'PUT', headers: headersMap, data: requestBody.map( - serializeUpdateMetadataTemplateRequestBodyArg + serializeUpdateMetadataTemplateRequestBody ) as readonly any[], contentType: 'application/json-patch+json', responseFormat: 'json', @@ -302,9 +306,9 @@ export class MetadataTemplatesManager { return deserializeMetadataTemplate(response.data); } async deleteMetadataTemplate( - scope: DeleteMetadataTemplateScopeArg, + scope: DeleteMetadataTemplateScope, templateKey: string, - headers: DeleteMetadataTemplateHeadersArg = new DeleteMetadataTemplateHeadersArg( + headers: DeleteMetadataTemplateHeaders = new DeleteMetadataTemplateHeaders( {} ), cancellationToken?: CancellationToken @@ -314,7 +318,8 @@ export class MetadataTemplatesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/metadata_templates/', + this.networkSession.baseUrls.baseUrl, + '/metadata_templates/', toString(scope) as string, '/', toString(templateKey) as string, @@ -333,7 +338,7 @@ export class MetadataTemplatesManager { } async getMetadataTemplateById( templateId: string, - headers: GetMetadataTemplateByIdHeadersArg = new GetMetadataTemplateByIdHeadersArg( + headers: GetMetadataTemplateByIdHeaders = new GetMetadataTemplateByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -343,7 +348,8 @@ export class MetadataTemplatesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/metadata_templates/', + this.networkSession.baseUrls.baseUrl, + '/metadata_templates/', toString(templateId) as string ) as string, { @@ -358,8 +364,8 @@ export class MetadataTemplatesManager { return deserializeMetadataTemplate(response.data); } async getGlobalMetadataTemplates( - queryParams: GetGlobalMetadataTemplatesQueryParamsArg = {} satisfies GetGlobalMetadataTemplatesQueryParamsArg, - headers: GetGlobalMetadataTemplatesHeadersArg = new GetGlobalMetadataTemplatesHeadersArg( + queryParams: GetGlobalMetadataTemplatesQueryParams = {} satisfies GetGlobalMetadataTemplatesQueryParams, + headers: GetGlobalMetadataTemplatesHeaders = new GetGlobalMetadataTemplatesHeaders( {} ), cancellationToken?: CancellationToken @@ -374,7 +380,10 @@ export class MetadataTemplatesManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/metadata_templates/global') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/metadata_templates/global' + ) as string, { method: 'GET', params: queryParamsMap, @@ -388,8 +397,8 @@ export class MetadataTemplatesManager { return deserializeMetadataTemplates(response.data); } async getEnterpriseMetadataTemplates( - queryParams: GetEnterpriseMetadataTemplatesQueryParamsArg = {} satisfies GetEnterpriseMetadataTemplatesQueryParamsArg, - headers: GetEnterpriseMetadataTemplatesHeadersArg = new GetEnterpriseMetadataTemplatesHeadersArg( + queryParams: GetEnterpriseMetadataTemplatesQueryParams = {} satisfies GetEnterpriseMetadataTemplatesQueryParams, + headers: GetEnterpriseMetadataTemplatesHeaders = new GetEnterpriseMetadataTemplatesHeaders( {} ), cancellationToken?: CancellationToken @@ -405,7 +414,8 @@ export class MetadataTemplatesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/metadata_templates/enterprise' + this.networkSession.baseUrls.baseUrl, + '/metadata_templates/enterprise' ) as string, { method: 'GET', @@ -420,8 +430,8 @@ export class MetadataTemplatesManager { return deserializeMetadataTemplates(response.data); } async createMetadataTemplate( - requestBody: CreateMetadataTemplateRequestBodyArg, - headers: CreateMetadataTemplateHeadersArg = new CreateMetadataTemplateHeadersArg( + requestBody: CreateMetadataTemplateRequestBody, + headers: CreateMetadataTemplateHeaders = new CreateMetadataTemplateHeaders( {} ), cancellationToken?: CancellationToken @@ -430,11 +440,14 @@ export class MetadataTemplatesManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/metadata_templates/schema') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/metadata_templates/schema' + ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateMetadataTemplateRequestBodyArg(requestBody), + data: serializeCreateMetadataTemplateRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -445,16 +458,16 @@ export class MetadataTemplatesManager { return deserializeMetadataTemplate(response.data); } } -export function serializeGetMetadataTemplateScopeArg( - val: GetMetadataTemplateScopeArg +export function serializeGetMetadataTemplateScope( + val: GetMetadataTemplateScope ): SerializedData { return val; } -export function deserializeGetMetadataTemplateScopeArg( +export function deserializeGetMetadataTemplateScope( val: any -): GetMetadataTemplateScopeArg { +): GetMetadataTemplateScope { if (!sdIsString(val)) { - throw 'Expecting a string for "GetMetadataTemplateScopeArg"'; + throw 'Expecting a string for "GetMetadataTemplateScope"'; } if (val == 'global') { return 'global'; @@ -464,16 +477,16 @@ export function deserializeGetMetadataTemplateScopeArg( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateMetadataTemplateScopeArg( - val: UpdateMetadataTemplateScopeArg +export function serializeUpdateMetadataTemplateScope( + val: UpdateMetadataTemplateScope ): SerializedData { return val; } -export function deserializeUpdateMetadataTemplateScopeArg( +export function deserializeUpdateMetadataTemplateScope( val: any -): UpdateMetadataTemplateScopeArg { +): UpdateMetadataTemplateScope { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateMetadataTemplateScopeArg"'; + throw 'Expecting a string for "UpdateMetadataTemplateScope"'; } if (val == 'global') { return 'global'; @@ -483,16 +496,16 @@ export function deserializeUpdateMetadataTemplateScopeArg( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateMetadataTemplateRequestBodyArgOpField( - val: UpdateMetadataTemplateRequestBodyArgOpField +export function serializeUpdateMetadataTemplateRequestBodyOpField( + val: UpdateMetadataTemplateRequestBodyOpField ): SerializedData { return val; } -export function deserializeUpdateMetadataTemplateRequestBodyArgOpField( +export function deserializeUpdateMetadataTemplateRequestBodyOpField( val: any -): UpdateMetadataTemplateRequestBodyArgOpField { +): UpdateMetadataTemplateRequestBodyOpField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateMetadataTemplateRequestBodyArgOpField"'; + throw 'Expecting a string for "UpdateMetadataTemplateRequestBodyOpField"'; } if (val == 'editTemplate') { return 'editTemplate'; @@ -535,11 +548,11 @@ export function deserializeUpdateMetadataTemplateRequestBodyArgOpField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateMetadataTemplateRequestBodyArg( - val: UpdateMetadataTemplateRequestBodyArg +export function serializeUpdateMetadataTemplateRequestBody( + val: UpdateMetadataTemplateRequestBody ): SerializedData { return { - ['op']: serializeUpdateMetadataTemplateRequestBodyArgOpField(val.op), + ['op']: serializeUpdateMetadataTemplateRequestBodyOpField(val.op), ['data']: val.data == void 0 ? void 0 : val.data, ['fieldKey']: val.fieldKey == void 0 ? void 0 : val.fieldKey, ['fieldKeys']: @@ -565,11 +578,11 @@ export function serializeUpdateMetadataTemplateRequestBodyArg( }) as readonly any[]), }; } -export function deserializeUpdateMetadataTemplateRequestBodyArg( +export function deserializeUpdateMetadataTemplateRequestBody( val: any -): UpdateMetadataTemplateRequestBodyArg { - const op: UpdateMetadataTemplateRequestBodyArgOpField = - deserializeUpdateMetadataTemplateRequestBodyArgOpField(val.op); +): UpdateMetadataTemplateRequestBody { + const op: UpdateMetadataTemplateRequestBodyOpField = + deserializeUpdateMetadataTemplateRequestBodyOpField(val.op); const data: | undefined | { @@ -614,18 +627,18 @@ export function deserializeUpdateMetadataTemplateRequestBodyArg( enumOptionKeys: enumOptionKeys, multiSelectOptionKey: multiSelectOptionKey, multiSelectOptionKeys: multiSelectOptionKeys, - } satisfies UpdateMetadataTemplateRequestBodyArg; + } satisfies UpdateMetadataTemplateRequestBody; } -export function serializeDeleteMetadataTemplateScopeArg( - val: DeleteMetadataTemplateScopeArg +export function serializeDeleteMetadataTemplateScope( + val: DeleteMetadataTemplateScope ): SerializedData { return val; } -export function deserializeDeleteMetadataTemplateScopeArg( +export function deserializeDeleteMetadataTemplateScope( val: any -): DeleteMetadataTemplateScopeArg { +): DeleteMetadataTemplateScope { if (!sdIsString(val)) { - throw 'Expecting a string for "DeleteMetadataTemplateScopeArg"'; + throw 'Expecting a string for "DeleteMetadataTemplateScope"'; } if (val == 'global') { return 'global'; @@ -635,16 +648,16 @@ export function deserializeDeleteMetadataTemplateScopeArg( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateMetadataTemplateRequestBodyArgFieldsFieldTypeField( - val: CreateMetadataTemplateRequestBodyArgFieldsFieldTypeField +export function serializeCreateMetadataTemplateRequestBodyFieldsTypeField( + val: CreateMetadataTemplateRequestBodyFieldsTypeField ): SerializedData { return val; } -export function deserializeCreateMetadataTemplateRequestBodyArgFieldsFieldTypeField( +export function deserializeCreateMetadataTemplateRequestBodyFieldsTypeField( val: any -): CreateMetadataTemplateRequestBodyArgFieldsFieldTypeField { +): CreateMetadataTemplateRequestBodyFieldsTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateMetadataTemplateRequestBodyArgFieldsFieldTypeField"'; + throw 'Expecting a string for "CreateMetadataTemplateRequestBodyFieldsTypeField"'; } if (val == 'string') { return 'string'; @@ -663,24 +676,24 @@ export function deserializeCreateMetadataTemplateRequestBodyArgFieldsFieldTypeFi } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateMetadataTemplateRequestBodyArgFieldsFieldOptionsField( - val: CreateMetadataTemplateRequestBodyArgFieldsFieldOptionsField +export function serializeCreateMetadataTemplateRequestBodyFieldsOptionsField( + val: CreateMetadataTemplateRequestBodyFieldsOptionsField ): SerializedData { return { ['key']: val.key }; } -export function deserializeCreateMetadataTemplateRequestBodyArgFieldsFieldOptionsField( +export function deserializeCreateMetadataTemplateRequestBodyFieldsOptionsField( val: any -): CreateMetadataTemplateRequestBodyArgFieldsFieldOptionsField { +): CreateMetadataTemplateRequestBodyFieldsOptionsField { const key: string = val.key; return { key: key, - } satisfies CreateMetadataTemplateRequestBodyArgFieldsFieldOptionsField; + } satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField; } -export function serializeCreateMetadataTemplateRequestBodyArgFieldsField( - val: CreateMetadataTemplateRequestBodyArgFieldsField +export function serializeCreateMetadataTemplateRequestBodyFieldsField( + val: CreateMetadataTemplateRequestBodyFieldsField ): SerializedData { return { - ['type']: serializeCreateMetadataTemplateRequestBodyArgFieldsFieldTypeField( + ['type']: serializeCreateMetadataTemplateRequestBodyFieldsTypeField( val.type ), ['key']: val.key, @@ -691,21 +704,19 @@ export function serializeCreateMetadataTemplateRequestBodyArgFieldsField( val.options == void 0 ? void 0 : (val.options.map(function ( - item: CreateMetadataTemplateRequestBodyArgFieldsFieldOptionsField + item: CreateMetadataTemplateRequestBodyFieldsOptionsField ): any { - return serializeCreateMetadataTemplateRequestBodyArgFieldsFieldOptionsField( + return serializeCreateMetadataTemplateRequestBodyFieldsOptionsField( item ); }) as readonly any[]), }; } -export function deserializeCreateMetadataTemplateRequestBodyArgFieldsField( +export function deserializeCreateMetadataTemplateRequestBodyFieldsField( val: any -): CreateMetadataTemplateRequestBodyArgFieldsField { - const type: CreateMetadataTemplateRequestBodyArgFieldsFieldTypeField = - deserializeCreateMetadataTemplateRequestBodyArgFieldsFieldTypeField( - val.type - ); +): CreateMetadataTemplateRequestBodyFieldsField { + const type: CreateMetadataTemplateRequestBodyFieldsTypeField = + deserializeCreateMetadataTemplateRequestBodyFieldsTypeField(val.type); const key: string = val.key; const displayName: string = val.displayName; const description: undefined | string = @@ -714,12 +725,12 @@ export function deserializeCreateMetadataTemplateRequestBodyArgFieldsField( val.hidden == void 0 ? void 0 : val.hidden; const options: | undefined - | readonly CreateMetadataTemplateRequestBodyArgFieldsFieldOptionsField[] = + | readonly CreateMetadataTemplateRequestBodyFieldsOptionsField[] = val.options == void 0 ? void 0 : sdIsList(val.options) ? (val.options.map(function (itm: SerializedData): any { - return deserializeCreateMetadataTemplateRequestBodyArgFieldsFieldOptionsField( + return deserializeCreateMetadataTemplateRequestBodyFieldsOptionsField( itm ); }) as readonly any[]) @@ -731,10 +742,10 @@ export function deserializeCreateMetadataTemplateRequestBodyArgFieldsField( description: description, hidden: hidden, options: options, - } satisfies CreateMetadataTemplateRequestBodyArgFieldsField; + } satisfies CreateMetadataTemplateRequestBodyFieldsField; } -export function serializeCreateMetadataTemplateRequestBodyArg( - val: CreateMetadataTemplateRequestBodyArg +export function serializeCreateMetadataTemplateRequestBody( + val: CreateMetadataTemplateRequestBody ): SerializedData { return { ['scope']: val.scope, @@ -745,11 +756,9 @@ export function serializeCreateMetadataTemplateRequestBodyArg( val.fields == void 0 ? void 0 : (val.fields.map(function ( - item: CreateMetadataTemplateRequestBodyArgFieldsField + item: CreateMetadataTemplateRequestBodyFieldsField ): any { - return serializeCreateMetadataTemplateRequestBodyArgFieldsField( - item - ); + return serializeCreateMetadataTemplateRequestBodyFieldsField(item); }) as readonly any[]), ['copyInstanceOnItemCopy']: val.copyInstanceOnItemCopy == void 0 @@ -757,9 +766,9 @@ export function serializeCreateMetadataTemplateRequestBodyArg( : val.copyInstanceOnItemCopy, }; } -export function deserializeCreateMetadataTemplateRequestBodyArg( +export function deserializeCreateMetadataTemplateRequestBody( val: any -): CreateMetadataTemplateRequestBodyArg { +): CreateMetadataTemplateRequestBody { const scope: string = val.scope; const templateKey: undefined | string = val.templateKey == void 0 ? void 0 : val.templateKey; @@ -768,14 +777,12 @@ export function deserializeCreateMetadataTemplateRequestBodyArg( val.hidden == void 0 ? void 0 : val.hidden; const fields: | undefined - | readonly CreateMetadataTemplateRequestBodyArgFieldsField[] = + | readonly CreateMetadataTemplateRequestBodyFieldsField[] = val.fields == void 0 ? void 0 : sdIsList(val.fields) ? (val.fields.map(function (itm: SerializedData): any { - return deserializeCreateMetadataTemplateRequestBodyArgFieldsField( - itm - ); + return deserializeCreateMetadataTemplateRequestBodyFieldsField(itm); }) as readonly any[]) : []; const copyInstanceOnItemCopy: undefined | boolean = @@ -787,5 +794,5 @@ export function deserializeCreateMetadataTemplateRequestBodyArg( hidden: hidden, fields: fields, copyInstanceOnItemCopy: copyInstanceOnItemCopy, - } satisfies CreateMetadataTemplateRequestBodyArg; + } satisfies CreateMetadataTemplateRequestBody; } diff --git a/src/managers/recentItems.generated.ts b/src/managers/recentItems.generated.ts index a929d647..7fbbbff9 100644 --- a/src/managers/recentItems.generated.ts +++ b/src/managers/recentItems.generated.ts @@ -21,32 +21,36 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetRecentItemsQueryParamsArg { +export interface GetRecentItemsQueryParams { readonly fields?: readonly string[]; readonly limit?: number; readonly marker?: string; } -export class GetRecentItemsHeadersArg { +export class GetRecentItemsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class RecentItemsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; - constructor(fields: Omit) { + readonly networkSession: NetworkSession = new NetworkSession({}); + constructor( + fields: + | Omit + | Partial> + ) { Object.assign(this, fields); } async getRecentItems( - queryParams: GetRecentItemsQueryParamsArg = {} satisfies GetRecentItemsQueryParamsArg, - headers: GetRecentItemsHeadersArg = new GetRecentItemsHeadersArg({}), + queryParams: GetRecentItemsQueryParams = {} satisfies GetRecentItemsQueryParams, + headers: GetRecentItemsHeaders = new GetRecentItemsHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -62,7 +66,10 @@ export class RecentItemsManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/recent_items') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/recent_items' + ) as string, { method: 'GET', params: queryParamsMap, diff --git a/src/managers/retentionPolicies.generated.ts b/src/managers/retentionPolicies.generated.ts index 7efdd4f8..f6e2eb8d 100644 --- a/src/managers/retentionPolicies.generated.ts +++ b/src/managers/retentionPolicies.generated.ts @@ -30,77 +30,77 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export type GetRetentionPoliciesQueryParamsArgPolicyTypeField = +export type GetRetentionPoliciesQueryParamsPolicyTypeField = | 'finite' | 'indefinite'; -export interface GetRetentionPoliciesQueryParamsArg { +export interface GetRetentionPoliciesQueryParams { readonly policyName?: string; - readonly policyType?: GetRetentionPoliciesQueryParamsArgPolicyTypeField; + readonly policyType?: GetRetentionPoliciesQueryParamsPolicyTypeField; readonly createdByUserId?: string; readonly fields?: readonly string[]; readonly limit?: number; readonly marker?: string; } -export class GetRetentionPoliciesHeadersArg { +export class GetRetentionPoliciesHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateRetentionPolicyRequestBodyArgPolicyTypeField = +export type CreateRetentionPolicyRequestBodyPolicyTypeField = | 'finite' | 'indefinite'; -export type CreateRetentionPolicyRequestBodyArgDispositionActionField = +export type CreateRetentionPolicyRequestBodyDispositionActionField = | 'permanently_delete' | 'remove_retention'; -export type CreateRetentionPolicyRequestBodyArgRetentionTypeField = +export type CreateRetentionPolicyRequestBodyRetentionTypeField = | 'modifiable' | 'non_modifiable'; -export interface CreateRetentionPolicyRequestBodyArg { +export interface CreateRetentionPolicyRequestBody { readonly policyName: string; readonly description?: string; - readonly policyType: CreateRetentionPolicyRequestBodyArgPolicyTypeField; - readonly dispositionAction: CreateRetentionPolicyRequestBodyArgDispositionActionField; + readonly policyType: CreateRetentionPolicyRequestBodyPolicyTypeField; + readonly dispositionAction: CreateRetentionPolicyRequestBodyDispositionActionField; readonly retentionLength?: string; - readonly retentionType?: CreateRetentionPolicyRequestBodyArgRetentionTypeField; + readonly retentionType?: CreateRetentionPolicyRequestBodyRetentionTypeField; readonly canOwnerExtendRetention?: boolean; readonly areOwnersNotified?: boolean; readonly customNotificationRecipients?: readonly UserMini[]; } -export class CreateRetentionPolicyHeadersArg { +export class CreateRetentionPolicyHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetRetentionPolicyByIdQueryParamsArg { +export interface GetRetentionPolicyByIdQueryParams { readonly fields?: readonly string[]; } -export class GetRetentionPolicyByIdHeadersArg { +export class GetRetentionPolicyByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface UpdateRetentionPolicyByIdRequestBodyArg { +export interface UpdateRetentionPolicyByIdRequestBody { readonly policyName?: string; readonly description?: string; readonly dispositionAction?: string; @@ -111,50 +111,51 @@ export interface UpdateRetentionPolicyByIdRequestBodyArg { readonly areOwnersNotified?: boolean; readonly customNotificationRecipients?: readonly UserBase[]; } -export class UpdateRetentionPolicyByIdHeadersArg { +export class UpdateRetentionPolicyByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteRetentionPolicyByIdHeadersArg { +export class DeleteRetentionPolicyByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class RetentionPoliciesManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - RetentionPoliciesManager, - | 'getRetentionPolicies' - | 'createRetentionPolicy' - | 'getRetentionPolicyById' - | 'updateRetentionPolicyById' - | 'deleteRetentionPolicyById' - > + fields: + | Omit< + RetentionPoliciesManager, + | 'networkSession' + | 'getRetentionPolicies' + | 'createRetentionPolicy' + | 'getRetentionPolicyById' + | 'updateRetentionPolicyById' + | 'deleteRetentionPolicyById' + > + | Partial> ) { Object.assign(this, fields); } async getRetentionPolicies( - queryParams: GetRetentionPoliciesQueryParamsArg = {} satisfies GetRetentionPoliciesQueryParamsArg, - headers: GetRetentionPoliciesHeadersArg = new GetRetentionPoliciesHeadersArg( - {} - ), + queryParams: GetRetentionPoliciesQueryParams = {} satisfies GetRetentionPoliciesQueryParams, + headers: GetRetentionPoliciesHeaders = new GetRetentionPoliciesHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -173,7 +174,10 @@ export class RetentionPoliciesManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/retention_policies') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/retention_policies' + ) as string, { method: 'GET', params: queryParamsMap, @@ -187,8 +191,8 @@ export class RetentionPoliciesManager { return deserializeRetentionPolicies(response.data); } async createRetentionPolicy( - requestBody: CreateRetentionPolicyRequestBodyArg, - headers: CreateRetentionPolicyHeadersArg = new CreateRetentionPolicyHeadersArg( + requestBody: CreateRetentionPolicyRequestBody, + headers: CreateRetentionPolicyHeaders = new CreateRetentionPolicyHeaders( {} ), cancellationToken?: CancellationToken @@ -197,11 +201,14 @@ export class RetentionPoliciesManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/retention_policies') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/retention_policies' + ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateRetentionPolicyRequestBodyArg(requestBody), + data: serializeCreateRetentionPolicyRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -213,8 +220,8 @@ export class RetentionPoliciesManager { } async getRetentionPolicyById( retentionPolicyId: string, - queryParams: GetRetentionPolicyByIdQueryParamsArg = {} satisfies GetRetentionPolicyByIdQueryParamsArg, - headers: GetRetentionPolicyByIdHeadersArg = new GetRetentionPolicyByIdHeadersArg( + queryParams: GetRetentionPolicyByIdQueryParams = {} satisfies GetRetentionPolicyByIdQueryParams, + headers: GetRetentionPolicyByIdHeaders = new GetRetentionPolicyByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -231,7 +238,8 @@ export class RetentionPoliciesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/retention_policies/', + this.networkSession.baseUrls.baseUrl, + '/retention_policies/', toString(retentionPolicyId) as string ) as string, { @@ -248,8 +256,8 @@ export class RetentionPoliciesManager { } async updateRetentionPolicyById( retentionPolicyId: string, - requestBody: UpdateRetentionPolicyByIdRequestBodyArg = {} satisfies UpdateRetentionPolicyByIdRequestBodyArg, - headers: UpdateRetentionPolicyByIdHeadersArg = new UpdateRetentionPolicyByIdHeadersArg( + requestBody: UpdateRetentionPolicyByIdRequestBody = {} satisfies UpdateRetentionPolicyByIdRequestBody, + headers: UpdateRetentionPolicyByIdHeaders = new UpdateRetentionPolicyByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -259,13 +267,14 @@ export class RetentionPoliciesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/retention_policies/', + this.networkSession.baseUrls.baseUrl, + '/retention_policies/', toString(retentionPolicyId) as string ) as string, { method: 'PUT', headers: headersMap, - data: serializeUpdateRetentionPolicyByIdRequestBodyArg(requestBody), + data: serializeUpdateRetentionPolicyByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -277,7 +286,7 @@ export class RetentionPoliciesManager { } async deleteRetentionPolicyById( retentionPolicyId: string, - headers: DeleteRetentionPolicyByIdHeadersArg = new DeleteRetentionPolicyByIdHeadersArg( + headers: DeleteRetentionPolicyByIdHeaders = new DeleteRetentionPolicyByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -287,7 +296,8 @@ export class RetentionPoliciesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/retention_policies/', + this.networkSession.baseUrls.baseUrl, + '/retention_policies/', toString(retentionPolicyId) as string ) as string, { @@ -302,16 +312,16 @@ export class RetentionPoliciesManager { return void 0; } } -export function serializeGetRetentionPoliciesQueryParamsArgPolicyTypeField( - val: GetRetentionPoliciesQueryParamsArgPolicyTypeField +export function serializeGetRetentionPoliciesQueryParamsPolicyTypeField( + val: GetRetentionPoliciesQueryParamsPolicyTypeField ): SerializedData { return val; } -export function deserializeGetRetentionPoliciesQueryParamsArgPolicyTypeField( +export function deserializeGetRetentionPoliciesQueryParamsPolicyTypeField( val: any -): GetRetentionPoliciesQueryParamsArgPolicyTypeField { +): GetRetentionPoliciesQueryParamsPolicyTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetRetentionPoliciesQueryParamsArgPolicyTypeField"'; + throw 'Expecting a string for "GetRetentionPoliciesQueryParamsPolicyTypeField"'; } if (val == 'finite') { return 'finite'; @@ -321,16 +331,16 @@ export function deserializeGetRetentionPoliciesQueryParamsArgPolicyTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateRetentionPolicyRequestBodyArgPolicyTypeField( - val: CreateRetentionPolicyRequestBodyArgPolicyTypeField +export function serializeCreateRetentionPolicyRequestBodyPolicyTypeField( + val: CreateRetentionPolicyRequestBodyPolicyTypeField ): SerializedData { return val; } -export function deserializeCreateRetentionPolicyRequestBodyArgPolicyTypeField( +export function deserializeCreateRetentionPolicyRequestBodyPolicyTypeField( val: any -): CreateRetentionPolicyRequestBodyArgPolicyTypeField { +): CreateRetentionPolicyRequestBodyPolicyTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateRetentionPolicyRequestBodyArgPolicyTypeField"'; + throw 'Expecting a string for "CreateRetentionPolicyRequestBodyPolicyTypeField"'; } if (val == 'finite') { return 'finite'; @@ -340,16 +350,16 @@ export function deserializeCreateRetentionPolicyRequestBodyArgPolicyTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateRetentionPolicyRequestBodyArgDispositionActionField( - val: CreateRetentionPolicyRequestBodyArgDispositionActionField +export function serializeCreateRetentionPolicyRequestBodyDispositionActionField( + val: CreateRetentionPolicyRequestBodyDispositionActionField ): SerializedData { return val; } -export function deserializeCreateRetentionPolicyRequestBodyArgDispositionActionField( +export function deserializeCreateRetentionPolicyRequestBodyDispositionActionField( val: any -): CreateRetentionPolicyRequestBodyArgDispositionActionField { +): CreateRetentionPolicyRequestBodyDispositionActionField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateRetentionPolicyRequestBodyArgDispositionActionField"'; + throw 'Expecting a string for "CreateRetentionPolicyRequestBodyDispositionActionField"'; } if (val == 'permanently_delete') { return 'permanently_delete'; @@ -359,16 +369,16 @@ export function deserializeCreateRetentionPolicyRequestBodyArgDispositionActionF } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateRetentionPolicyRequestBodyArgRetentionTypeField( - val: CreateRetentionPolicyRequestBodyArgRetentionTypeField +export function serializeCreateRetentionPolicyRequestBodyRetentionTypeField( + val: CreateRetentionPolicyRequestBodyRetentionTypeField ): SerializedData { return val; } -export function deserializeCreateRetentionPolicyRequestBodyArgRetentionTypeField( +export function deserializeCreateRetentionPolicyRequestBodyRetentionTypeField( val: any -): CreateRetentionPolicyRequestBodyArgRetentionTypeField { +): CreateRetentionPolicyRequestBodyRetentionTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateRetentionPolicyRequestBodyArgRetentionTypeField"'; + throw 'Expecting a string for "CreateRetentionPolicyRequestBodyRetentionTypeField"'; } if (val == 'modifiable') { return 'modifiable'; @@ -378,18 +388,17 @@ export function deserializeCreateRetentionPolicyRequestBodyArgRetentionTypeField } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateRetentionPolicyRequestBodyArg( - val: CreateRetentionPolicyRequestBodyArg +export function serializeCreateRetentionPolicyRequestBody( + val: CreateRetentionPolicyRequestBody ): SerializedData { return { ['policy_name']: val.policyName, ['description']: val.description == void 0 ? void 0 : val.description, - ['policy_type']: - serializeCreateRetentionPolicyRequestBodyArgPolicyTypeField( - val.policyType - ), + ['policy_type']: serializeCreateRetentionPolicyRequestBodyPolicyTypeField( + val.policyType + ), ['disposition_action']: - serializeCreateRetentionPolicyRequestBodyArgDispositionActionField( + serializeCreateRetentionPolicyRequestBodyDispositionActionField( val.dispositionAction ), ['retention_length']: @@ -397,7 +406,7 @@ export function serializeCreateRetentionPolicyRequestBodyArg( ['retention_type']: val.retentionType == void 0 ? void 0 - : serializeCreateRetentionPolicyRequestBodyArgRetentionTypeField( + : serializeCreateRetentionPolicyRequestBodyRetentionTypeField( val.retentionType ), ['can_owner_extend_retention']: @@ -414,28 +423,26 @@ export function serializeCreateRetentionPolicyRequestBodyArg( }) as readonly any[]), }; } -export function deserializeCreateRetentionPolicyRequestBodyArg( +export function deserializeCreateRetentionPolicyRequestBody( val: any -): CreateRetentionPolicyRequestBodyArg { +): CreateRetentionPolicyRequestBody { const policyName: string = val.policy_name; const description: undefined | string = val.description == void 0 ? void 0 : val.description; - const policyType: CreateRetentionPolicyRequestBodyArgPolicyTypeField = - deserializeCreateRetentionPolicyRequestBodyArgPolicyTypeField( - val.policy_type - ); - const dispositionAction: CreateRetentionPolicyRequestBodyArgDispositionActionField = - deserializeCreateRetentionPolicyRequestBodyArgDispositionActionField( + const policyType: CreateRetentionPolicyRequestBodyPolicyTypeField = + deserializeCreateRetentionPolicyRequestBodyPolicyTypeField(val.policy_type); + const dispositionAction: CreateRetentionPolicyRequestBodyDispositionActionField = + deserializeCreateRetentionPolicyRequestBodyDispositionActionField( val.disposition_action ); const retentionLength: undefined | string = val.retention_length == void 0 ? void 0 : val.retention_length; const retentionType: | undefined - | CreateRetentionPolicyRequestBodyArgRetentionTypeField = + | CreateRetentionPolicyRequestBodyRetentionTypeField = val.retention_type == void 0 ? void 0 - : deserializeCreateRetentionPolicyRequestBodyArgRetentionTypeField( + : deserializeCreateRetentionPolicyRequestBodyRetentionTypeField( val.retention_type ); const canOwnerExtendRetention: undefined | boolean = @@ -464,10 +471,10 @@ export function deserializeCreateRetentionPolicyRequestBodyArg( canOwnerExtendRetention: canOwnerExtendRetention, areOwnersNotified: areOwnersNotified, customNotificationRecipients: customNotificationRecipients, - } satisfies CreateRetentionPolicyRequestBodyArg; + } satisfies CreateRetentionPolicyRequestBody; } -export function serializeUpdateRetentionPolicyByIdRequestBodyArg( - val: UpdateRetentionPolicyByIdRequestBodyArg +export function serializeUpdateRetentionPolicyByIdRequestBody( + val: UpdateRetentionPolicyByIdRequestBody ): SerializedData { return { ['policy_name']: val.policyName == void 0 ? void 0 : val.policyName, @@ -493,9 +500,9 @@ export function serializeUpdateRetentionPolicyByIdRequestBodyArg( }) as readonly any[]), }; } -export function deserializeUpdateRetentionPolicyByIdRequestBodyArg( +export function deserializeUpdateRetentionPolicyByIdRequestBody( val: any -): UpdateRetentionPolicyByIdRequestBodyArg { +): UpdateRetentionPolicyByIdRequestBody { const policyName: undefined | string = val.policy_name == void 0 ? void 0 : val.policy_name; const description: undefined | string = @@ -533,5 +540,5 @@ export function deserializeUpdateRetentionPolicyByIdRequestBodyArg( canOwnerExtendRetention: canOwnerExtendRetention, areOwnersNotified: areOwnersNotified, customNotificationRecipients: customNotificationRecipients, - } satisfies UpdateRetentionPolicyByIdRequestBodyArg; + } satisfies UpdateRetentionPolicyByIdRequestBody; } diff --git a/src/managers/retentionPolicyAssignments.generated.ts b/src/managers/retentionPolicyAssignments.generated.ts index e3e0c9f9..40000f49 100644 --- a/src/managers/retentionPolicyAssignments.generated.ts +++ b/src/managers/retentionPolicyAssignments.generated.ts @@ -27,104 +27,104 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export type GetRetentionPolicyAssignmentsQueryParamsArgTypeField = +export type GetRetentionPolicyAssignmentsQueryParamsTypeField = | 'folder' | 'enterprise' | 'metadata_template'; -export interface GetRetentionPolicyAssignmentsQueryParamsArg { - readonly type?: GetRetentionPolicyAssignmentsQueryParamsArgTypeField; +export interface GetRetentionPolicyAssignmentsQueryParams { + readonly type?: GetRetentionPolicyAssignmentsQueryParamsTypeField; readonly fields?: readonly string[]; readonly marker?: string; readonly limit?: number; } -export class GetRetentionPolicyAssignmentsHeadersArg { +export class GetRetentionPolicyAssignmentsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateRetentionPolicyAssignmentRequestBodyArgAssignToFieldTypeField = - 'enterprise' | 'folder' | 'metadata_template'; -export interface CreateRetentionPolicyAssignmentRequestBodyArgAssignToField { - readonly type: CreateRetentionPolicyAssignmentRequestBodyArgAssignToFieldTypeField; +export type CreateRetentionPolicyAssignmentRequestBodyAssignToTypeField = + | 'enterprise' + | 'folder' + | 'metadata_template'; +export interface CreateRetentionPolicyAssignmentRequestBodyAssignToField { + readonly type: CreateRetentionPolicyAssignmentRequestBodyAssignToTypeField; readonly id?: string; } -export interface CreateRetentionPolicyAssignmentRequestBodyArgFilterFieldsField { +export interface CreateRetentionPolicyAssignmentRequestBodyFilterFieldsField { readonly field?: string; readonly value?: string; } -export interface CreateRetentionPolicyAssignmentRequestBodyArg { +export interface CreateRetentionPolicyAssignmentRequestBody { readonly policyId: string; - readonly assignTo: CreateRetentionPolicyAssignmentRequestBodyArgAssignToField; - readonly filterFields?: readonly CreateRetentionPolicyAssignmentRequestBodyArgFilterFieldsField[]; + readonly assignTo: CreateRetentionPolicyAssignmentRequestBodyAssignToField; + readonly filterFields?: readonly CreateRetentionPolicyAssignmentRequestBodyFilterFieldsField[]; readonly startDateField?: string; } -export class CreateRetentionPolicyAssignmentHeadersArg { +export class CreateRetentionPolicyAssignmentHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetRetentionPolicyAssignmentByIdQueryParamsArg { +export interface GetRetentionPolicyAssignmentByIdQueryParams { readonly fields?: readonly string[]; } -export class GetRetentionPolicyAssignmentByIdHeadersArg { +export class GetRetentionPolicyAssignmentByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial< - Pick - > + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteRetentionPolicyAssignmentByIdHeadersArg { +export class DeleteRetentionPolicyAssignmentByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit + | Omit | Partial< - Pick + Pick > ) { Object.assign(this, fields); } } -export interface GetRetentionPolicyAssignmentFileUnderRetentionQueryParamsArg { +export interface GetRetentionPolicyAssignmentFileUnderRetentionQueryParams { readonly marker?: string; readonly limit?: number; } -export class GetRetentionPolicyAssignmentFileUnderRetentionHeadersArg { +export class GetRetentionPolicyAssignmentFileUnderRetentionHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: | Omit< - GetRetentionPolicyAssignmentFileUnderRetentionHeadersArg, + GetRetentionPolicyAssignmentFileUnderRetentionHeaders, 'extraHeaders' > | Partial< Pick< - GetRetentionPolicyAssignmentFileUnderRetentionHeadersArg, + GetRetentionPolicyAssignmentFileUnderRetentionHeaders, 'extraHeaders' > > @@ -132,23 +132,23 @@ export class GetRetentionPolicyAssignmentFileUnderRetentionHeadersArg { Object.assign(this, fields); } } -export interface GetRetentionPolicyAssignmentFileVersionUnderRetentionQueryParamsArg { +export interface GetRetentionPolicyAssignmentFileVersionUnderRetentionQueryParams { readonly marker?: string; readonly limit?: number; } -export class GetRetentionPolicyAssignmentFileVersionUnderRetentionHeadersArg { +export class GetRetentionPolicyAssignmentFileVersionUnderRetentionHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: | Omit< - GetRetentionPolicyAssignmentFileVersionUnderRetentionHeadersArg, + GetRetentionPolicyAssignmentFileVersionUnderRetentionHeaders, 'extraHeaders' > | Partial< Pick< - GetRetentionPolicyAssignmentFileVersionUnderRetentionHeadersArg, + GetRetentionPolicyAssignmentFileVersionUnderRetentionHeaders, 'extraHeaders' > > @@ -158,24 +158,27 @@ export class GetRetentionPolicyAssignmentFileVersionUnderRetentionHeadersArg { } export class RetentionPolicyAssignmentsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - RetentionPolicyAssignmentsManager, - | 'getRetentionPolicyAssignments' - | 'createRetentionPolicyAssignment' - | 'getRetentionPolicyAssignmentById' - | 'deleteRetentionPolicyAssignmentById' - | 'getRetentionPolicyAssignmentFileUnderRetention' - | 'getRetentionPolicyAssignmentFileVersionUnderRetention' - > + fields: + | Omit< + RetentionPolicyAssignmentsManager, + | 'networkSession' + | 'getRetentionPolicyAssignments' + | 'createRetentionPolicyAssignment' + | 'getRetentionPolicyAssignmentById' + | 'deleteRetentionPolicyAssignmentById' + | 'getRetentionPolicyAssignmentFileUnderRetention' + | 'getRetentionPolicyAssignmentFileVersionUnderRetention' + > + | Partial> ) { Object.assign(this, fields); } async getRetentionPolicyAssignments( retentionPolicyId: string, - queryParams: GetRetentionPolicyAssignmentsQueryParamsArg = {} satisfies GetRetentionPolicyAssignmentsQueryParamsArg, - headers: GetRetentionPolicyAssignmentsHeadersArg = new GetRetentionPolicyAssignmentsHeadersArg( + queryParams: GetRetentionPolicyAssignmentsQueryParams = {} satisfies GetRetentionPolicyAssignmentsQueryParams, + headers: GetRetentionPolicyAssignmentsHeaders = new GetRetentionPolicyAssignmentsHeaders( {} ), cancellationToken?: CancellationToken @@ -195,7 +198,8 @@ export class RetentionPolicyAssignmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/retention_policies/', + this.networkSession.baseUrls.baseUrl, + '/retention_policies/', toString(retentionPolicyId) as string, '/assignments' ) as string, @@ -212,8 +216,8 @@ export class RetentionPolicyAssignmentsManager { return deserializeRetentionPolicyAssignments(response.data); } async createRetentionPolicyAssignment( - requestBody: CreateRetentionPolicyAssignmentRequestBodyArg, - headers: CreateRetentionPolicyAssignmentHeadersArg = new CreateRetentionPolicyAssignmentHeadersArg( + requestBody: CreateRetentionPolicyAssignmentRequestBody, + headers: CreateRetentionPolicyAssignmentHeaders = new CreateRetentionPolicyAssignmentHeaders( {} ), cancellationToken?: CancellationToken @@ -223,14 +227,13 @@ export class RetentionPolicyAssignmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/retention_policy_assignments' + this.networkSession.baseUrls.baseUrl, + '/retention_policy_assignments' ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateRetentionPolicyAssignmentRequestBodyArg( - requestBody - ), + data: serializeCreateRetentionPolicyAssignmentRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -242,8 +245,8 @@ export class RetentionPolicyAssignmentsManager { } async getRetentionPolicyAssignmentById( retentionPolicyAssignmentId: string, - queryParams: GetRetentionPolicyAssignmentByIdQueryParamsArg = {} satisfies GetRetentionPolicyAssignmentByIdQueryParamsArg, - headers: GetRetentionPolicyAssignmentByIdHeadersArg = new GetRetentionPolicyAssignmentByIdHeadersArg( + queryParams: GetRetentionPolicyAssignmentByIdQueryParams = {} satisfies GetRetentionPolicyAssignmentByIdQueryParams, + headers: GetRetentionPolicyAssignmentByIdHeaders = new GetRetentionPolicyAssignmentByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -260,7 +263,8 @@ export class RetentionPolicyAssignmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/retention_policy_assignments/', + this.networkSession.baseUrls.baseUrl, + '/retention_policy_assignments/', toString(retentionPolicyAssignmentId) as string ) as string, { @@ -277,7 +281,7 @@ export class RetentionPolicyAssignmentsManager { } async deleteRetentionPolicyAssignmentById( retentionPolicyAssignmentId: string, - headers: DeleteRetentionPolicyAssignmentByIdHeadersArg = new DeleteRetentionPolicyAssignmentByIdHeadersArg( + headers: DeleteRetentionPolicyAssignmentByIdHeaders = new DeleteRetentionPolicyAssignmentByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -287,7 +291,8 @@ export class RetentionPolicyAssignmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/retention_policy_assignments/', + this.networkSession.baseUrls.baseUrl, + '/retention_policy_assignments/', toString(retentionPolicyAssignmentId) as string ) as string, { @@ -303,8 +308,8 @@ export class RetentionPolicyAssignmentsManager { } async getRetentionPolicyAssignmentFileUnderRetention( retentionPolicyAssignmentId: string, - queryParams: GetRetentionPolicyAssignmentFileUnderRetentionQueryParamsArg = {} satisfies GetRetentionPolicyAssignmentFileUnderRetentionQueryParamsArg, - headers: GetRetentionPolicyAssignmentFileUnderRetentionHeadersArg = new GetRetentionPolicyAssignmentFileUnderRetentionHeadersArg( + queryParams: GetRetentionPolicyAssignmentFileUnderRetentionQueryParams = {} satisfies GetRetentionPolicyAssignmentFileUnderRetentionQueryParams, + headers: GetRetentionPolicyAssignmentFileUnderRetentionHeaders = new GetRetentionPolicyAssignmentFileUnderRetentionHeaders( {} ), cancellationToken?: CancellationToken @@ -320,7 +325,8 @@ export class RetentionPolicyAssignmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/retention_policy_assignments/', + this.networkSession.baseUrls.baseUrl, + '/retention_policy_assignments/', toString(retentionPolicyAssignmentId) as string, '/files_under_retention' ) as string, @@ -338,8 +344,8 @@ export class RetentionPolicyAssignmentsManager { } async getRetentionPolicyAssignmentFileVersionUnderRetention( retentionPolicyAssignmentId: string, - queryParams: GetRetentionPolicyAssignmentFileVersionUnderRetentionQueryParamsArg = {} satisfies GetRetentionPolicyAssignmentFileVersionUnderRetentionQueryParamsArg, - headers: GetRetentionPolicyAssignmentFileVersionUnderRetentionHeadersArg = new GetRetentionPolicyAssignmentFileVersionUnderRetentionHeadersArg( + queryParams: GetRetentionPolicyAssignmentFileVersionUnderRetentionQueryParams = {} satisfies GetRetentionPolicyAssignmentFileVersionUnderRetentionQueryParams, + headers: GetRetentionPolicyAssignmentFileVersionUnderRetentionHeaders = new GetRetentionPolicyAssignmentFileVersionUnderRetentionHeaders( {} ), cancellationToken?: CancellationToken @@ -355,7 +361,8 @@ export class RetentionPolicyAssignmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/retention_policy_assignments/', + this.networkSession.baseUrls.baseUrl, + '/retention_policy_assignments/', toString(retentionPolicyAssignmentId) as string, '/file_versions_under_retention' ) as string, @@ -372,16 +379,16 @@ export class RetentionPolicyAssignmentsManager { return deserializeFilesUnderRetention(response.data); } } -export function serializeGetRetentionPolicyAssignmentsQueryParamsArgTypeField( - val: GetRetentionPolicyAssignmentsQueryParamsArgTypeField +export function serializeGetRetentionPolicyAssignmentsQueryParamsTypeField( + val: GetRetentionPolicyAssignmentsQueryParamsTypeField ): SerializedData { return val; } -export function deserializeGetRetentionPolicyAssignmentsQueryParamsArgTypeField( +export function deserializeGetRetentionPolicyAssignmentsQueryParamsTypeField( val: any -): GetRetentionPolicyAssignmentsQueryParamsArgTypeField { +): GetRetentionPolicyAssignmentsQueryParamsTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetRetentionPolicyAssignmentsQueryParamsArgTypeField"'; + throw 'Expecting a string for "GetRetentionPolicyAssignmentsQueryParamsTypeField"'; } if (val == 'folder') { return 'folder'; @@ -394,16 +401,16 @@ export function deserializeGetRetentionPolicyAssignmentsQueryParamsArgTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateRetentionPolicyAssignmentRequestBodyArgAssignToFieldTypeField( - val: CreateRetentionPolicyAssignmentRequestBodyArgAssignToFieldTypeField +export function serializeCreateRetentionPolicyAssignmentRequestBodyAssignToTypeField( + val: CreateRetentionPolicyAssignmentRequestBodyAssignToTypeField ): SerializedData { return val; } -export function deserializeCreateRetentionPolicyAssignmentRequestBodyArgAssignToFieldTypeField( +export function deserializeCreateRetentionPolicyAssignmentRequestBodyAssignToTypeField( val: any -): CreateRetentionPolicyAssignmentRequestBodyArgAssignToFieldTypeField { +): CreateRetentionPolicyAssignmentRequestBodyAssignToTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateRetentionPolicyAssignmentRequestBodyArgAssignToFieldTypeField"'; + throw 'Expecting a string for "CreateRetentionPolicyAssignmentRequestBodyAssignToTypeField"'; } if (val == 'enterprise') { return 'enterprise'; @@ -416,64 +423,64 @@ export function deserializeCreateRetentionPolicyAssignmentRequestBodyArgAssignTo } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateRetentionPolicyAssignmentRequestBodyArgAssignToField( - val: CreateRetentionPolicyAssignmentRequestBodyArgAssignToField +export function serializeCreateRetentionPolicyAssignmentRequestBodyAssignToField( + val: CreateRetentionPolicyAssignmentRequestBodyAssignToField ): SerializedData { return { ['type']: - serializeCreateRetentionPolicyAssignmentRequestBodyArgAssignToFieldTypeField( + serializeCreateRetentionPolicyAssignmentRequestBodyAssignToTypeField( val.type ), ['id']: val.id == void 0 ? void 0 : val.id, }; } -export function deserializeCreateRetentionPolicyAssignmentRequestBodyArgAssignToField( +export function deserializeCreateRetentionPolicyAssignmentRequestBodyAssignToField( val: any -): CreateRetentionPolicyAssignmentRequestBodyArgAssignToField { - const type: CreateRetentionPolicyAssignmentRequestBodyArgAssignToFieldTypeField = - deserializeCreateRetentionPolicyAssignmentRequestBodyArgAssignToFieldTypeField( +): CreateRetentionPolicyAssignmentRequestBodyAssignToField { + const type: CreateRetentionPolicyAssignmentRequestBodyAssignToTypeField = + deserializeCreateRetentionPolicyAssignmentRequestBodyAssignToTypeField( val.type ); const id: undefined | string = val.id == void 0 ? void 0 : val.id; return { type: type, id: id, - } satisfies CreateRetentionPolicyAssignmentRequestBodyArgAssignToField; + } satisfies CreateRetentionPolicyAssignmentRequestBodyAssignToField; } -export function serializeCreateRetentionPolicyAssignmentRequestBodyArgFilterFieldsField( - val: CreateRetentionPolicyAssignmentRequestBodyArgFilterFieldsField +export function serializeCreateRetentionPolicyAssignmentRequestBodyFilterFieldsField( + val: CreateRetentionPolicyAssignmentRequestBodyFilterFieldsField ): SerializedData { return { ['field']: val.field == void 0 ? void 0 : val.field, ['value']: val.value == void 0 ? void 0 : val.value, }; } -export function deserializeCreateRetentionPolicyAssignmentRequestBodyArgFilterFieldsField( +export function deserializeCreateRetentionPolicyAssignmentRequestBodyFilterFieldsField( val: any -): CreateRetentionPolicyAssignmentRequestBodyArgFilterFieldsField { +): CreateRetentionPolicyAssignmentRequestBodyFilterFieldsField { const field: undefined | string = val.field == void 0 ? void 0 : val.field; const value: undefined | string = val.value == void 0 ? void 0 : val.value; return { field: field, value: value, - } satisfies CreateRetentionPolicyAssignmentRequestBodyArgFilterFieldsField; + } satisfies CreateRetentionPolicyAssignmentRequestBodyFilterFieldsField; } -export function serializeCreateRetentionPolicyAssignmentRequestBodyArg( - val: CreateRetentionPolicyAssignmentRequestBodyArg +export function serializeCreateRetentionPolicyAssignmentRequestBody( + val: CreateRetentionPolicyAssignmentRequestBody ): SerializedData { return { ['policy_id']: val.policyId, ['assign_to']: - serializeCreateRetentionPolicyAssignmentRequestBodyArgAssignToField( + serializeCreateRetentionPolicyAssignmentRequestBodyAssignToField( val.assignTo ), ['filter_fields']: val.filterFields == void 0 ? void 0 : (val.filterFields.map(function ( - item: CreateRetentionPolicyAssignmentRequestBodyArgFilterFieldsField + item: CreateRetentionPolicyAssignmentRequestBodyFilterFieldsField ): any { - return serializeCreateRetentionPolicyAssignmentRequestBodyArgFilterFieldsField( + return serializeCreateRetentionPolicyAssignmentRequestBodyFilterFieldsField( item ); }) as readonly any[]), @@ -481,22 +488,22 @@ export function serializeCreateRetentionPolicyAssignmentRequestBodyArg( val.startDateField == void 0 ? void 0 : val.startDateField, }; } -export function deserializeCreateRetentionPolicyAssignmentRequestBodyArg( +export function deserializeCreateRetentionPolicyAssignmentRequestBody( val: any -): CreateRetentionPolicyAssignmentRequestBodyArg { +): CreateRetentionPolicyAssignmentRequestBody { const policyId: string = val.policy_id; - const assignTo: CreateRetentionPolicyAssignmentRequestBodyArgAssignToField = - deserializeCreateRetentionPolicyAssignmentRequestBodyArgAssignToField( + const assignTo: CreateRetentionPolicyAssignmentRequestBodyAssignToField = + deserializeCreateRetentionPolicyAssignmentRequestBodyAssignToField( val.assign_to ); const filterFields: | undefined - | readonly CreateRetentionPolicyAssignmentRequestBodyArgFilterFieldsField[] = + | readonly CreateRetentionPolicyAssignmentRequestBodyFilterFieldsField[] = val.filter_fields == void 0 ? void 0 : sdIsList(val.filter_fields) ? (val.filter_fields.map(function (itm: SerializedData): any { - return deserializeCreateRetentionPolicyAssignmentRequestBodyArgFilterFieldsField( + return deserializeCreateRetentionPolicyAssignmentRequestBodyFilterFieldsField( itm ); }) as readonly any[]) @@ -508,5 +515,5 @@ export function deserializeCreateRetentionPolicyAssignmentRequestBodyArg( assignTo: assignTo, filterFields: filterFields, startDateField: startDateField, - } satisfies CreateRetentionPolicyAssignmentRequestBodyArg; + } satisfies CreateRetentionPolicyAssignmentRequestBody; } diff --git a/src/managers/search.generated.ts b/src/managers/search.generated.ts index 3347b2ad..7773b604 100644 --- a/src/managers/search.generated.ts +++ b/src/managers/search.generated.ts @@ -33,56 +33,56 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class CreateMetadataQueryExecuteReadHeadersArg { +export class CreateMetadataQueryExecuteReadHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type GetMetadataQueryIndicesQueryParamsArgScopeField = +export type GetMetadataQueryIndicesQueryParamsScopeField = | 'global' | 'enterprise'; -export interface GetMetadataQueryIndicesQueryParamsArg { - readonly scope: GetMetadataQueryIndicesQueryParamsArgScopeField; +export interface GetMetadataQueryIndicesQueryParams { + readonly scope: GetMetadataQueryIndicesQueryParamsScopeField; readonly templateKey: string; } -export class GetMetadataQueryIndicesHeadersArg { +export class GetMetadataQueryIndicesHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type GetSearchQueryParamsArgScopeField = +export type GetSearchQueryParamsScopeField = | 'user_content' | 'enterprise_content'; -export type GetSearchQueryParamsArgContentTypesField = +export type GetSearchQueryParamsContentTypesField = | 'name' | 'description' | 'file_content' | 'comments' | 'tag'; -export type GetSearchQueryParamsArgTypeField = 'file' | 'folder' | 'web_link'; -export type GetSearchQueryParamsArgTrashContentField = +export type GetSearchQueryParamsTypeField = 'file' | 'folder' | 'web_link'; +export type GetSearchQueryParamsTrashContentField = | 'non_trashed_only' | 'trashed_only' | 'all_items'; -export type GetSearchQueryParamsArgSortField = 'modified_at' | 'relevance'; -export type GetSearchQueryParamsArgDirectionField = 'DESC' | 'ASC'; -export interface GetSearchQueryParamsArg { +export type GetSearchQueryParamsSortField = 'modified_at' | 'relevance'; +export type GetSearchQueryParamsDirectionField = 'DESC' | 'ASC'; +export interface GetSearchQueryParams { readonly query?: string; - readonly scope?: GetSearchQueryParamsArgScopeField; + readonly scope?: GetSearchQueryParamsScopeField; readonly fileExtensions?: readonly string[]; readonly createdAtRange?: readonly string[]; readonly updatedAtRange?: readonly string[]; @@ -90,12 +90,12 @@ export interface GetSearchQueryParamsArg { readonly ownerUserIds?: readonly string[]; readonly recentUpdaterUserIds?: readonly string[]; readonly ancestorFolderIds?: readonly string[]; - readonly contentTypes?: readonly GetSearchQueryParamsArgContentTypesField[]; - readonly type?: GetSearchQueryParamsArgTypeField; - readonly trashContent?: GetSearchQueryParamsArgTrashContentField; + readonly contentTypes?: readonly GetSearchQueryParamsContentTypesField[]; + readonly type?: GetSearchQueryParamsTypeField; + readonly trashContent?: GetSearchQueryParamsTrashContentField; readonly mdfilters?: readonly MetadataFilter[]; - readonly sort?: GetSearchQueryParamsArgSortField; - readonly direction?: GetSearchQueryParamsArgDirectionField; + readonly sort?: GetSearchQueryParamsSortField; + readonly direction?: GetSearchQueryParamsDirectionField; readonly limit?: number; readonly includeRecentSharedLinks?: boolean; readonly fields?: readonly string[]; @@ -103,32 +103,37 @@ export interface GetSearchQueryParamsArg { readonly deletedUserIds?: readonly string[]; readonly deletedAtRange?: readonly string[]; } -export class GetSearchHeadersArg { +export class GetSearchHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class SearchManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - SearchManager, - 'createMetadataQueryExecuteRead' | 'getMetadataQueryIndices' | 'getSearch' - > + fields: + | Omit< + SearchManager, + | 'networkSession' + | 'createMetadataQueryExecuteRead' + | 'getMetadataQueryIndices' + | 'getSearch' + > + | Partial> ) { Object.assign(this, fields); } async createMetadataQueryExecuteRead( requestBody: MetadataQuery, - headers: CreateMetadataQueryExecuteReadHeadersArg = new CreateMetadataQueryExecuteReadHeadersArg( + headers: CreateMetadataQueryExecuteReadHeaders = new CreateMetadataQueryExecuteReadHeaders( {} ), cancellationToken?: CancellationToken @@ -138,7 +143,8 @@ export class SearchManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/metadata_queries/execute_read' + this.networkSession.baseUrls.baseUrl, + '/metadata_queries/execute_read' ) as string, { method: 'POST', @@ -154,8 +160,8 @@ export class SearchManager { return deserializeMetadataQueryResults(response.data); } async getMetadataQueryIndices( - queryParams: GetMetadataQueryIndicesQueryParamsArg, - headers: GetMetadataQueryIndicesHeadersArg = new GetMetadataQueryIndicesHeadersArg( + queryParams: GetMetadataQueryIndicesQueryParams, + headers: GetMetadataQueryIndicesHeaders = new GetMetadataQueryIndicesHeaders( {} ), cancellationToken?: CancellationToken @@ -170,7 +176,10 @@ export class SearchManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/metadata_query_indices') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/metadata_query_indices' + ) as string, { method: 'GET', params: queryParamsMap, @@ -184,8 +193,8 @@ export class SearchManager { return deserializeMetadataQueryIndices(response.data); } async getSearch( - queryParams: GetSearchQueryParamsArg = {} satisfies GetSearchQueryParamsArg, - headers: GetSearchHeadersArg = new GetSearchHeadersArg({}), + queryParams: GetSearchQueryParams = {} satisfies GetSearchQueryParams, + headers: GetSearchHeaders = new GetSearchHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -243,7 +252,7 @@ export class SearchManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/search') as string, + ''.concat(this.networkSession.baseUrls.baseUrl, '/search') as string, { method: 'GET', params: queryParamsMap, @@ -259,16 +268,16 @@ export class SearchManager { ); } } -export function serializeGetMetadataQueryIndicesQueryParamsArgScopeField( - val: GetMetadataQueryIndicesQueryParamsArgScopeField +export function serializeGetMetadataQueryIndicesQueryParamsScopeField( + val: GetMetadataQueryIndicesQueryParamsScopeField ): SerializedData { return val; } -export function deserializeGetMetadataQueryIndicesQueryParamsArgScopeField( +export function deserializeGetMetadataQueryIndicesQueryParamsScopeField( val: any -): GetMetadataQueryIndicesQueryParamsArgScopeField { +): GetMetadataQueryIndicesQueryParamsScopeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetMetadataQueryIndicesQueryParamsArgScopeField"'; + throw 'Expecting a string for "GetMetadataQueryIndicesQueryParamsScopeField"'; } if (val == 'global') { return 'global'; @@ -278,16 +287,16 @@ export function deserializeGetMetadataQueryIndicesQueryParamsArgScopeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeGetSearchQueryParamsArgScopeField( - val: GetSearchQueryParamsArgScopeField +export function serializeGetSearchQueryParamsScopeField( + val: GetSearchQueryParamsScopeField ): SerializedData { return val; } -export function deserializeGetSearchQueryParamsArgScopeField( +export function deserializeGetSearchQueryParamsScopeField( val: any -): GetSearchQueryParamsArgScopeField { +): GetSearchQueryParamsScopeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetSearchQueryParamsArgScopeField"'; + throw 'Expecting a string for "GetSearchQueryParamsScopeField"'; } if (val == 'user_content') { return 'user_content'; @@ -297,16 +306,16 @@ export function deserializeGetSearchQueryParamsArgScopeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeGetSearchQueryParamsArgContentTypesField( - val: GetSearchQueryParamsArgContentTypesField +export function serializeGetSearchQueryParamsContentTypesField( + val: GetSearchQueryParamsContentTypesField ): SerializedData { return val; } -export function deserializeGetSearchQueryParamsArgContentTypesField( +export function deserializeGetSearchQueryParamsContentTypesField( val: any -): GetSearchQueryParamsArgContentTypesField { +): GetSearchQueryParamsContentTypesField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetSearchQueryParamsArgContentTypesField"'; + throw 'Expecting a string for "GetSearchQueryParamsContentTypesField"'; } if (val == 'name') { return 'name'; @@ -325,16 +334,16 @@ export function deserializeGetSearchQueryParamsArgContentTypesField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeGetSearchQueryParamsArgTypeField( - val: GetSearchQueryParamsArgTypeField +export function serializeGetSearchQueryParamsTypeField( + val: GetSearchQueryParamsTypeField ): SerializedData { return val; } -export function deserializeGetSearchQueryParamsArgTypeField( +export function deserializeGetSearchQueryParamsTypeField( val: any -): GetSearchQueryParamsArgTypeField { +): GetSearchQueryParamsTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetSearchQueryParamsArgTypeField"'; + throw 'Expecting a string for "GetSearchQueryParamsTypeField"'; } if (val == 'file') { return 'file'; @@ -347,16 +356,16 @@ export function deserializeGetSearchQueryParamsArgTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeGetSearchQueryParamsArgTrashContentField( - val: GetSearchQueryParamsArgTrashContentField +export function serializeGetSearchQueryParamsTrashContentField( + val: GetSearchQueryParamsTrashContentField ): SerializedData { return val; } -export function deserializeGetSearchQueryParamsArgTrashContentField( +export function deserializeGetSearchQueryParamsTrashContentField( val: any -): GetSearchQueryParamsArgTrashContentField { +): GetSearchQueryParamsTrashContentField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetSearchQueryParamsArgTrashContentField"'; + throw 'Expecting a string for "GetSearchQueryParamsTrashContentField"'; } if (val == 'non_trashed_only') { return 'non_trashed_only'; @@ -369,16 +378,16 @@ export function deserializeGetSearchQueryParamsArgTrashContentField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeGetSearchQueryParamsArgSortField( - val: GetSearchQueryParamsArgSortField +export function serializeGetSearchQueryParamsSortField( + val: GetSearchQueryParamsSortField ): SerializedData { return val; } -export function deserializeGetSearchQueryParamsArgSortField( +export function deserializeGetSearchQueryParamsSortField( val: any -): GetSearchQueryParamsArgSortField { +): GetSearchQueryParamsSortField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetSearchQueryParamsArgSortField"'; + throw 'Expecting a string for "GetSearchQueryParamsSortField"'; } if (val == 'modified_at') { return 'modified_at'; @@ -388,16 +397,16 @@ export function deserializeGetSearchQueryParamsArgSortField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeGetSearchQueryParamsArgDirectionField( - val: GetSearchQueryParamsArgDirectionField +export function serializeGetSearchQueryParamsDirectionField( + val: GetSearchQueryParamsDirectionField ): SerializedData { return val; } -export function deserializeGetSearchQueryParamsArgDirectionField( +export function deserializeGetSearchQueryParamsDirectionField( val: any -): GetSearchQueryParamsArgDirectionField { +): GetSearchQueryParamsDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetSearchQueryParamsArgDirectionField"'; + throw 'Expecting a string for "GetSearchQueryParamsDirectionField"'; } if (val == 'DESC') { return 'DESC'; diff --git a/src/managers/sessionTermination.generated.ts b/src/managers/sessionTermination.generated.ts index f3df8d55..d87e4813 100644 --- a/src/managers/sessionTermination.generated.ts +++ b/src/managers/sessionTermination.generated.ts @@ -20,51 +20,55 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface CreateUserTerminateSessionRequestBodyArg { +export interface CreateUserTerminateSessionRequestBody { readonly userIds: readonly string[]; readonly userLogins: readonly string[]; } -export class CreateUserTerminateSessionHeadersArg { +export class CreateUserTerminateSessionHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface CreateGroupTerminateSessionRequestBodyArg { +export interface CreateGroupTerminateSessionRequestBody { readonly groupIds: readonly string[]; } -export class CreateGroupTerminateSessionHeadersArg { +export class CreateGroupTerminateSessionHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class SessionTerminationManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - SessionTerminationManager, - 'createUserTerminateSession' | 'createGroupTerminateSession' - > + fields: + | Omit< + SessionTerminationManager, + | 'networkSession' + | 'createUserTerminateSession' + | 'createGroupTerminateSession' + > + | Partial> ) { Object.assign(this, fields); } async createUserTerminateSession( - requestBody: CreateUserTerminateSessionRequestBodyArg, - headers: CreateUserTerminateSessionHeadersArg = new CreateUserTerminateSessionHeadersArg( + requestBody: CreateUserTerminateSessionRequestBody, + headers: CreateUserTerminateSessionHeaders = new CreateUserTerminateSessionHeaders( {} ), cancellationToken?: CancellationToken @@ -73,11 +77,14 @@ export class SessionTerminationManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/users/terminate_sessions') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/users/terminate_sessions' + ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateUserTerminateSessionRequestBodyArg(requestBody), + data: serializeCreateUserTerminateSessionRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -88,8 +95,8 @@ export class SessionTerminationManager { return deserializeSessionTerminationMessage(response.data); } async createGroupTerminateSession( - requestBody: CreateGroupTerminateSessionRequestBodyArg, - headers: CreateGroupTerminateSessionHeadersArg = new CreateGroupTerminateSessionHeadersArg( + requestBody: CreateGroupTerminateSessionRequestBody, + headers: CreateGroupTerminateSessionHeaders = new CreateGroupTerminateSessionHeaders( {} ), cancellationToken?: CancellationToken @@ -98,11 +105,14 @@ export class SessionTerminationManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/groups/terminate_sessions') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/groups/terminate_sessions' + ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateGroupTerminateSessionRequestBodyArg(requestBody), + data: serializeCreateGroupTerminateSessionRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -113,8 +123,8 @@ export class SessionTerminationManager { return deserializeSessionTerminationMessage(response.data); } } -export function serializeCreateUserTerminateSessionRequestBodyArg( - val: CreateUserTerminateSessionRequestBodyArg +export function serializeCreateUserTerminateSessionRequestBody( + val: CreateUserTerminateSessionRequestBody ): SerializedData { return { ['user_ids']: val.userIds.map(function (item: string): any { @@ -125,9 +135,9 @@ export function serializeCreateUserTerminateSessionRequestBodyArg( }) as readonly any[], }; } -export function deserializeCreateUserTerminateSessionRequestBodyArg( +export function deserializeCreateUserTerminateSessionRequestBody( val: any -): CreateUserTerminateSessionRequestBodyArg { +): CreateUserTerminateSessionRequestBody { const userIds: readonly string[] = sdIsList(val.user_ids) ? (val.user_ids.map(function (itm: SerializedData): any { return itm; @@ -141,10 +151,10 @@ export function deserializeCreateUserTerminateSessionRequestBodyArg( return { userIds: userIds, userLogins: userLogins, - } satisfies CreateUserTerminateSessionRequestBodyArg; + } satisfies CreateUserTerminateSessionRequestBody; } -export function serializeCreateGroupTerminateSessionRequestBodyArg( - val: CreateGroupTerminateSessionRequestBodyArg +export function serializeCreateGroupTerminateSessionRequestBody( + val: CreateGroupTerminateSessionRequestBody ): SerializedData { return { ['group_ids']: val.groupIds.map(function (item: string): any { @@ -152,9 +162,9 @@ export function serializeCreateGroupTerminateSessionRequestBodyArg( }) as readonly any[], }; } -export function deserializeCreateGroupTerminateSessionRequestBodyArg( +export function deserializeCreateGroupTerminateSessionRequestBody( val: any -): CreateGroupTerminateSessionRequestBodyArg { +): CreateGroupTerminateSessionRequestBody { const groupIds: readonly string[] = sdIsList(val.group_ids) ? (val.group_ids.map(function (itm: SerializedData): any { return itm; @@ -162,5 +172,5 @@ export function deserializeCreateGroupTerminateSessionRequestBodyArg( : []; return { groupIds: groupIds, - } satisfies CreateGroupTerminateSessionRequestBodyArg; + } satisfies CreateGroupTerminateSessionRequestBody; } diff --git a/src/managers/sharedLinksFiles.generated.ts b/src/managers/sharedLinksFiles.generated.ts index 2f320793..ab6644a5 100644 --- a/src/managers/sharedLinksFiles.generated.ts +++ b/src/managers/sharedLinksFiles.generated.ts @@ -21,10 +21,10 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetSharedItemsQueryParamsArg { +export interface GetSharedItemsQueryParams { readonly fields?: readonly string[]; } -export class GetSharedItemsHeadersArg { +export class GetSharedItemsHeaders { readonly ifNoneMatch?: string; readonly boxapi!: string; readonly extraHeaders?: { @@ -32,130 +32,135 @@ export class GetSharedItemsHeadersArg { } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetFileGetSharedLinkQueryParamsArg { +export interface GetFileGetSharedLinkQueryParams { readonly fields: string; } -export class GetFileGetSharedLinkHeadersArg { +export class GetFileGetSharedLinkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldAccessField = +export type UpdateFileAddSharedLinkRequestBodySharedLinkAccessField = | 'open' | 'company' | 'collaborators'; -export interface UpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField { +export interface UpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField { readonly canDownload?: boolean; readonly canPreview?: boolean; readonly canEdit?: boolean; } -export interface UpdateFileAddSharedLinkRequestBodyArgSharedLinkField { - readonly access?: UpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldAccessField; +export interface UpdateFileAddSharedLinkRequestBodySharedLinkField { + readonly access?: UpdateFileAddSharedLinkRequestBodySharedLinkAccessField; readonly password?: string; readonly vanityName?: string; readonly unsharedAt?: string; - readonly permissions?: UpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField; + readonly permissions?: UpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField; } -export interface UpdateFileAddSharedLinkRequestBodyArg { - readonly sharedLink?: UpdateFileAddSharedLinkRequestBodyArgSharedLinkField; +export interface UpdateFileAddSharedLinkRequestBody { + readonly sharedLink?: UpdateFileAddSharedLinkRequestBodySharedLinkField; } -export interface UpdateFileAddSharedLinkQueryParamsArg { +export interface UpdateFileAddSharedLinkQueryParams { readonly fields: string; } -export class UpdateFileAddSharedLinkHeadersArg { +export class UpdateFileAddSharedLinkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField = - 'open' | 'company' | 'collaborators'; -export interface UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField { +export type UpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField = + | 'open' + | 'company' + | 'collaborators'; +export interface UpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField { readonly canDownload?: boolean; readonly canPreview?: boolean; readonly canEdit?: boolean; } -export interface UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkField { - readonly access?: UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField; +export interface UpdateFileUpdateSharedLinkRequestBodySharedLinkField { + readonly access?: UpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField; readonly password?: string; readonly vanityName?: string; readonly unsharedAt?: string; - readonly permissions?: UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField; + readonly permissions?: UpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField; } -export interface UpdateFileUpdateSharedLinkRequestBodyArg { - readonly sharedLink?: UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkField; +export interface UpdateFileUpdateSharedLinkRequestBody { + readonly sharedLink?: UpdateFileUpdateSharedLinkRequestBodySharedLinkField; } -export interface UpdateFileUpdateSharedLinkQueryParamsArg { +export interface UpdateFileUpdateSharedLinkQueryParams { readonly fields: string; } -export class UpdateFileUpdateSharedLinkHeadersArg { +export class UpdateFileUpdateSharedLinkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface UpdateFileRemoveSharedLinkRequestBodyArgSharedLinkField {} -export interface UpdateFileRemoveSharedLinkRequestBodyArg { - readonly sharedLink?: UpdateFileRemoveSharedLinkRequestBodyArgSharedLinkField; +export interface UpdateFileRemoveSharedLinkRequestBodySharedLinkField {} +export interface UpdateFileRemoveSharedLinkRequestBody { + readonly sharedLink?: UpdateFileRemoveSharedLinkRequestBodySharedLinkField; } -export interface UpdateFileRemoveSharedLinkQueryParamsArg { +export interface UpdateFileRemoveSharedLinkQueryParams { readonly fields: string; } -export class UpdateFileRemoveSharedLinkHeadersArg { +export class UpdateFileRemoveSharedLinkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class SharedLinksFilesManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - SharedLinksFilesManager, - | 'getSharedItems' - | 'getFileGetSharedLink' - | 'updateFileAddSharedLink' - | 'updateFileUpdateSharedLink' - | 'updateFileRemoveSharedLink' - > + fields: + | Omit< + SharedLinksFilesManager, + | 'networkSession' + | 'getSharedItems' + | 'getFileGetSharedLink' + | 'updateFileAddSharedLink' + | 'updateFileUpdateSharedLink' + | 'updateFileRemoveSharedLink' + > + | Partial> ) { Object.assign(this, fields); } async getSharedItems( - queryParams: GetSharedItemsQueryParamsArg = {} satisfies GetSharedItemsQueryParamsArg, - headers: GetSharedItemsHeadersArg, + queryParams: GetSharedItemsQueryParams = {} satisfies GetSharedItemsQueryParams, + headers: GetSharedItemsHeaders, cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -175,7 +180,10 @@ export class SharedLinksFilesManager { ...headers.extraHeaders, }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/shared_items') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/shared_items' + ) as string, { method: 'GET', params: queryParamsMap, @@ -190,10 +198,8 @@ export class SharedLinksFilesManager { } async getFileGetSharedLink( fileId: string, - queryParams: GetFileGetSharedLinkQueryParamsArg, - headers: GetFileGetSharedLinkHeadersArg = new GetFileGetSharedLinkHeadersArg( - {} - ), + queryParams: GetFileGetSharedLinkQueryParams, + headers: GetFileGetSharedLinkHeaders = new GetFileGetSharedLinkHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -204,7 +210,8 @@ export class SharedLinksFilesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '#get_shared_link' ) as string, @@ -222,9 +229,9 @@ export class SharedLinksFilesManager { } async updateFileAddSharedLink( fileId: string, - requestBody: UpdateFileAddSharedLinkRequestBodyArg = {} satisfies UpdateFileAddSharedLinkRequestBodyArg, - queryParams: UpdateFileAddSharedLinkQueryParamsArg, - headers: UpdateFileAddSharedLinkHeadersArg = new UpdateFileAddSharedLinkHeadersArg( + requestBody: UpdateFileAddSharedLinkRequestBody = {} satisfies UpdateFileAddSharedLinkRequestBody, + queryParams: UpdateFileAddSharedLinkQueryParams, + headers: UpdateFileAddSharedLinkHeaders = new UpdateFileAddSharedLinkHeaders( {} ), cancellationToken?: CancellationToken @@ -237,7 +244,8 @@ export class SharedLinksFilesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '#add_shared_link' ) as string, @@ -245,7 +253,7 @@ export class SharedLinksFilesManager { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateFileAddSharedLinkRequestBodyArg(requestBody), + data: serializeUpdateFileAddSharedLinkRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -257,9 +265,9 @@ export class SharedLinksFilesManager { } async updateFileUpdateSharedLink( fileId: string, - requestBody: UpdateFileUpdateSharedLinkRequestBodyArg = {} satisfies UpdateFileUpdateSharedLinkRequestBodyArg, - queryParams: UpdateFileUpdateSharedLinkQueryParamsArg, - headers: UpdateFileUpdateSharedLinkHeadersArg = new UpdateFileUpdateSharedLinkHeadersArg( + requestBody: UpdateFileUpdateSharedLinkRequestBody = {} satisfies UpdateFileUpdateSharedLinkRequestBody, + queryParams: UpdateFileUpdateSharedLinkQueryParams, + headers: UpdateFileUpdateSharedLinkHeaders = new UpdateFileUpdateSharedLinkHeaders( {} ), cancellationToken?: CancellationToken @@ -272,7 +280,8 @@ export class SharedLinksFilesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '#update_shared_link' ) as string, @@ -280,7 +289,7 @@ export class SharedLinksFilesManager { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateFileUpdateSharedLinkRequestBodyArg(requestBody), + data: serializeUpdateFileUpdateSharedLinkRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -292,9 +301,9 @@ export class SharedLinksFilesManager { } async updateFileRemoveSharedLink( fileId: string, - requestBody: UpdateFileRemoveSharedLinkRequestBodyArg = {} satisfies UpdateFileRemoveSharedLinkRequestBodyArg, - queryParams: UpdateFileRemoveSharedLinkQueryParamsArg, - headers: UpdateFileRemoveSharedLinkHeadersArg = new UpdateFileRemoveSharedLinkHeadersArg( + requestBody: UpdateFileRemoveSharedLinkRequestBody = {} satisfies UpdateFileRemoveSharedLinkRequestBody, + queryParams: UpdateFileRemoveSharedLinkQueryParams, + headers: UpdateFileRemoveSharedLinkHeaders = new UpdateFileRemoveSharedLinkHeaders( {} ), cancellationToken?: CancellationToken @@ -307,7 +316,8 @@ export class SharedLinksFilesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '#remove_shared_link' ) as string, @@ -315,7 +325,7 @@ export class SharedLinksFilesManager { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateFileRemoveSharedLinkRequestBodyArg(requestBody), + data: serializeUpdateFileRemoveSharedLinkRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -326,16 +336,16 @@ export class SharedLinksFilesManager { return deserializeFileFull(response.data); } } -export function serializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldAccessField( - val: UpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldAccessField +export function serializeUpdateFileAddSharedLinkRequestBodySharedLinkAccessField( + val: UpdateFileAddSharedLinkRequestBodySharedLinkAccessField ): SerializedData { return val; } -export function deserializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldAccessField( +export function deserializeUpdateFileAddSharedLinkRequestBodySharedLinkAccessField( val: any -): UpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldAccessField { +): UpdateFileAddSharedLinkRequestBodySharedLinkAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldAccessField"'; + throw 'Expecting a string for "UpdateFileAddSharedLinkRequestBodySharedLinkAccessField"'; } if (val == 'open') { return 'open'; @@ -348,8 +358,8 @@ export function deserializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldA } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( - val: UpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField +export function serializeUpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField( + val: UpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField ): SerializedData { return { ['can_download']: val.canDownload == void 0 ? void 0 : val.canDownload, @@ -357,9 +367,9 @@ export function serializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldPer ['can_edit']: val.canEdit == void 0 ? void 0 : val.canEdit, }; } -export function deserializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( +export function deserializeUpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField( val: any -): UpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField { +): UpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField { const canDownload: undefined | boolean = val.can_download == void 0 ? void 0 : val.can_download; const canPreview: undefined | boolean = @@ -370,16 +380,16 @@ export function deserializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldP canDownload: canDownload, canPreview: canPreview, canEdit: canEdit, - } satisfies UpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField; + } satisfies UpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField; } -export function serializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkField( - val: UpdateFileAddSharedLinkRequestBodyArgSharedLinkField +export function serializeUpdateFileAddSharedLinkRequestBodySharedLinkField( + val: UpdateFileAddSharedLinkRequestBodySharedLinkField ): SerializedData { return { ['access']: val.access == void 0 ? void 0 - : serializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldAccessField( + : serializeUpdateFileAddSharedLinkRequestBodySharedLinkAccessField( val.access ), ['password']: val.password == void 0 ? void 0 : val.password, @@ -388,20 +398,20 @@ export function serializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkField( ['permissions']: val.permissions == void 0 ? void 0 - : serializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( + : serializeUpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField( val.permissions ), }; } -export function deserializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkField( +export function deserializeUpdateFileAddSharedLinkRequestBodySharedLinkField( val: any -): UpdateFileAddSharedLinkRequestBodyArgSharedLinkField { +): UpdateFileAddSharedLinkRequestBodySharedLinkField { const access: | undefined - | UpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldAccessField = + | UpdateFileAddSharedLinkRequestBodySharedLinkAccessField = val.access == void 0 ? void 0 - : deserializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldAccessField( + : deserializeUpdateFileAddSharedLinkRequestBodySharedLinkAccessField( val.access ); const password: undefined | string = @@ -412,10 +422,10 @@ export function deserializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkField( val.unshared_at == void 0 ? void 0 : val.unshared_at; const permissions: | undefined - | UpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField = + | UpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField = val.permissions == void 0 ? void 0 - : deserializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( + : deserializeUpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField( val.permissions ); return { @@ -424,45 +434,45 @@ export function deserializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkField( vanityName: vanityName, unsharedAt: unsharedAt, permissions: permissions, - } satisfies UpdateFileAddSharedLinkRequestBodyArgSharedLinkField; + } satisfies UpdateFileAddSharedLinkRequestBodySharedLinkField; } -export function serializeUpdateFileAddSharedLinkRequestBodyArg( - val: UpdateFileAddSharedLinkRequestBodyArg +export function serializeUpdateFileAddSharedLinkRequestBody( + val: UpdateFileAddSharedLinkRequestBody ): SerializedData { return { ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkField( + : serializeUpdateFileAddSharedLinkRequestBodySharedLinkField( val.sharedLink ), }; } -export function deserializeUpdateFileAddSharedLinkRequestBodyArg( +export function deserializeUpdateFileAddSharedLinkRequestBody( val: any -): UpdateFileAddSharedLinkRequestBodyArg { +): UpdateFileAddSharedLinkRequestBody { const sharedLink: | undefined - | UpdateFileAddSharedLinkRequestBodyArgSharedLinkField = + | UpdateFileAddSharedLinkRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkField( + : deserializeUpdateFileAddSharedLinkRequestBodySharedLinkField( val.shared_link ); return { sharedLink: sharedLink, - } satisfies UpdateFileAddSharedLinkRequestBodyArg; + } satisfies UpdateFileAddSharedLinkRequestBody; } -export function serializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField( - val: UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField +export function serializeUpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField( + val: UpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField ): SerializedData { return val; } -export function deserializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField( +export function deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField( val: any -): UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField { +): UpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField"'; + throw 'Expecting a string for "UpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField"'; } if (val == 'open') { return 'open'; @@ -475,8 +485,8 @@ export function deserializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFie } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( - val: UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField +export function serializeUpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField( + val: UpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField ): SerializedData { return { ['can_download']: val.canDownload == void 0 ? void 0 : val.canDownload, @@ -484,9 +494,9 @@ export function serializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkField ['can_edit']: val.canEdit == void 0 ? void 0 : val.canEdit, }; } -export function deserializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( +export function deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField( val: any -): UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField { +): UpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField { const canDownload: undefined | boolean = val.can_download == void 0 ? void 0 : val.can_download; const canPreview: undefined | boolean = @@ -497,16 +507,16 @@ export function deserializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFie canDownload: canDownload, canPreview: canPreview, canEdit: canEdit, - } satisfies UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField; + } satisfies UpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField; } -export function serializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkField( - val: UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkField +export function serializeUpdateFileUpdateSharedLinkRequestBodySharedLinkField( + val: UpdateFileUpdateSharedLinkRequestBodySharedLinkField ): SerializedData { return { ['access']: val.access == void 0 ? void 0 - : serializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField( + : serializeUpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField( val.access ), ['password']: val.password == void 0 ? void 0 : val.password, @@ -515,20 +525,20 @@ export function serializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkField ['permissions']: val.permissions == void 0 ? void 0 - : serializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( + : serializeUpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField( val.permissions ), }; } -export function deserializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkField( +export function deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkField( val: any -): UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkField { +): UpdateFileUpdateSharedLinkRequestBodySharedLinkField { const access: | undefined - | UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField = + | UpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField = val.access == void 0 ? void 0 - : deserializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField( + : deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField( val.access ); const password: undefined | string = @@ -539,10 +549,10 @@ export function deserializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFie val.unshared_at == void 0 ? void 0 : val.unshared_at; const permissions: | undefined - | UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField = + | UpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField = val.permissions == void 0 ? void 0 - : deserializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( + : deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField( val.permissions ); return { @@ -551,69 +561,69 @@ export function deserializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFie vanityName: vanityName, unsharedAt: unsharedAt, permissions: permissions, - } satisfies UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkField; + } satisfies UpdateFileUpdateSharedLinkRequestBodySharedLinkField; } -export function serializeUpdateFileUpdateSharedLinkRequestBodyArg( - val: UpdateFileUpdateSharedLinkRequestBodyArg +export function serializeUpdateFileUpdateSharedLinkRequestBody( + val: UpdateFileUpdateSharedLinkRequestBody ): SerializedData { return { ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkField( + : serializeUpdateFileUpdateSharedLinkRequestBodySharedLinkField( val.sharedLink ), }; } -export function deserializeUpdateFileUpdateSharedLinkRequestBodyArg( +export function deserializeUpdateFileUpdateSharedLinkRequestBody( val: any -): UpdateFileUpdateSharedLinkRequestBodyArg { +): UpdateFileUpdateSharedLinkRequestBody { const sharedLink: | undefined - | UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkField = + | UpdateFileUpdateSharedLinkRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkField( + : deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkField( val.shared_link ); return { sharedLink: sharedLink, - } satisfies UpdateFileUpdateSharedLinkRequestBodyArg; + } satisfies UpdateFileUpdateSharedLinkRequestBody; } -export function serializeUpdateFileRemoveSharedLinkRequestBodyArgSharedLinkField( - val: UpdateFileRemoveSharedLinkRequestBodyArgSharedLinkField +export function serializeUpdateFileRemoveSharedLinkRequestBodySharedLinkField( + val: UpdateFileRemoveSharedLinkRequestBodySharedLinkField ): SerializedData { return {}; } -export function deserializeUpdateFileRemoveSharedLinkRequestBodyArgSharedLinkField( +export function deserializeUpdateFileRemoveSharedLinkRequestBodySharedLinkField( val: any -): UpdateFileRemoveSharedLinkRequestBodyArgSharedLinkField { - return {} satisfies UpdateFileRemoveSharedLinkRequestBodyArgSharedLinkField; +): UpdateFileRemoveSharedLinkRequestBodySharedLinkField { + return {} satisfies UpdateFileRemoveSharedLinkRequestBodySharedLinkField; } -export function serializeUpdateFileRemoveSharedLinkRequestBodyArg( - val: UpdateFileRemoveSharedLinkRequestBodyArg +export function serializeUpdateFileRemoveSharedLinkRequestBody( + val: UpdateFileRemoveSharedLinkRequestBody ): SerializedData { return { ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateFileRemoveSharedLinkRequestBodyArgSharedLinkField( + : serializeUpdateFileRemoveSharedLinkRequestBodySharedLinkField( val.sharedLink ), }; } -export function deserializeUpdateFileRemoveSharedLinkRequestBodyArg( +export function deserializeUpdateFileRemoveSharedLinkRequestBody( val: any -): UpdateFileRemoveSharedLinkRequestBodyArg { +): UpdateFileRemoveSharedLinkRequestBody { const sharedLink: | undefined - | UpdateFileRemoveSharedLinkRequestBodyArgSharedLinkField = + | UpdateFileRemoveSharedLinkRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateFileRemoveSharedLinkRequestBodyArgSharedLinkField( + : deserializeUpdateFileRemoveSharedLinkRequestBodySharedLinkField( val.shared_link ); return { sharedLink: sharedLink, - } satisfies UpdateFileRemoveSharedLinkRequestBodyArg; + } satisfies UpdateFileRemoveSharedLinkRequestBody; } diff --git a/src/managers/sharedLinksFolders.generated.ts b/src/managers/sharedLinksFolders.generated.ts index 5734dd3b..625290ca 100644 --- a/src/managers/sharedLinksFolders.generated.ts +++ b/src/managers/sharedLinksFolders.generated.ts @@ -21,10 +21,10 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetSharedItemFoldersQueryParamsArg { +export interface GetSharedItemFoldersQueryParams { readonly fields?: readonly string[]; } -export class GetSharedItemFoldersHeadersArg { +export class GetSharedItemFoldersHeaders { readonly ifNoneMatch?: string; readonly boxapi!: string; readonly extraHeaders?: { @@ -32,130 +32,135 @@ export class GetSharedItemFoldersHeadersArg { } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetFolderGetSharedLinkQueryParamsArg { +export interface GetFolderGetSharedLinkQueryParams { readonly fields: string; } -export class GetFolderGetSharedLinkHeadersArg { +export class GetFolderGetSharedLinkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldAccessField = +export type UpdateFolderAddSharedLinkRequestBodySharedLinkAccessField = | 'open' | 'company' | 'collaborators'; -export interface UpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField { +export interface UpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField { readonly canDownload?: boolean; readonly canPreview?: boolean; readonly canEdit?: boolean; } -export interface UpdateFolderAddSharedLinkRequestBodyArgSharedLinkField { - readonly access?: UpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldAccessField; +export interface UpdateFolderAddSharedLinkRequestBodySharedLinkField { + readonly access?: UpdateFolderAddSharedLinkRequestBodySharedLinkAccessField; readonly password?: string; readonly vanityName?: string; readonly unsharedAt?: string; - readonly permissions?: UpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField; + readonly permissions?: UpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField; } -export interface UpdateFolderAddSharedLinkRequestBodyArg { - readonly sharedLink?: UpdateFolderAddSharedLinkRequestBodyArgSharedLinkField; +export interface UpdateFolderAddSharedLinkRequestBody { + readonly sharedLink?: UpdateFolderAddSharedLinkRequestBodySharedLinkField; } -export interface UpdateFolderAddSharedLinkQueryParamsArg { +export interface UpdateFolderAddSharedLinkQueryParams { readonly fields: string; } -export class UpdateFolderAddSharedLinkHeadersArg { +export class UpdateFolderAddSharedLinkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField = - 'open' | 'company' | 'collaborators'; -export interface UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField { +export type UpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField = + | 'open' + | 'company' + | 'collaborators'; +export interface UpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField { readonly canDownload?: boolean; readonly canPreview?: boolean; readonly canEdit?: boolean; } -export interface UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkField { - readonly access?: UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField; +export interface UpdateFolderUpdateSharedLinkRequestBodySharedLinkField { + readonly access?: UpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField; readonly password?: string; readonly vanityName?: string; readonly unsharedAt?: string; - readonly permissions?: UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField; + readonly permissions?: UpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField; } -export interface UpdateFolderUpdateSharedLinkRequestBodyArg { - readonly sharedLink?: UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkField; +export interface UpdateFolderUpdateSharedLinkRequestBody { + readonly sharedLink?: UpdateFolderUpdateSharedLinkRequestBodySharedLinkField; } -export interface UpdateFolderUpdateSharedLinkQueryParamsArg { +export interface UpdateFolderUpdateSharedLinkQueryParams { readonly fields: string; } -export class UpdateFolderUpdateSharedLinkHeadersArg { +export class UpdateFolderUpdateSharedLinkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface UpdateFolderRemoveSharedLinkRequestBodyArgSharedLinkField {} -export interface UpdateFolderRemoveSharedLinkRequestBodyArg { - readonly sharedLink?: UpdateFolderRemoveSharedLinkRequestBodyArgSharedLinkField; +export interface UpdateFolderRemoveSharedLinkRequestBodySharedLinkField {} +export interface UpdateFolderRemoveSharedLinkRequestBody { + readonly sharedLink?: UpdateFolderRemoveSharedLinkRequestBodySharedLinkField; } -export interface UpdateFolderRemoveSharedLinkQueryParamsArg { +export interface UpdateFolderRemoveSharedLinkQueryParams { readonly fields: string; } -export class UpdateFolderRemoveSharedLinkHeadersArg { +export class UpdateFolderRemoveSharedLinkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class SharedLinksFoldersManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - SharedLinksFoldersManager, - | 'getSharedItemFolders' - | 'getFolderGetSharedLink' - | 'updateFolderAddSharedLink' - | 'updateFolderUpdateSharedLink' - | 'updateFolderRemoveSharedLink' - > + fields: + | Omit< + SharedLinksFoldersManager, + | 'networkSession' + | 'getSharedItemFolders' + | 'getFolderGetSharedLink' + | 'updateFolderAddSharedLink' + | 'updateFolderUpdateSharedLink' + | 'updateFolderRemoveSharedLink' + > + | Partial> ) { Object.assign(this, fields); } async getSharedItemFolders( - queryParams: GetSharedItemFoldersQueryParamsArg = {} satisfies GetSharedItemFoldersQueryParamsArg, - headers: GetSharedItemFoldersHeadersArg, + queryParams: GetSharedItemFoldersQueryParams = {} satisfies GetSharedItemFoldersQueryParams, + headers: GetSharedItemFoldersHeaders, cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -175,7 +180,10 @@ export class SharedLinksFoldersManager { ...headers.extraHeaders, }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/shared_items#folders') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/shared_items#folders' + ) as string, { method: 'GET', params: queryParamsMap, @@ -190,8 +198,8 @@ export class SharedLinksFoldersManager { } async getFolderGetSharedLink( folderId: string, - queryParams: GetFolderGetSharedLinkQueryParamsArg, - headers: GetFolderGetSharedLinkHeadersArg = new GetFolderGetSharedLinkHeadersArg( + queryParams: GetFolderGetSharedLinkQueryParams, + headers: GetFolderGetSharedLinkHeaders = new GetFolderGetSharedLinkHeaders( {} ), cancellationToken?: CancellationToken @@ -204,7 +212,8 @@ export class SharedLinksFoldersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '#get_shared_link' ) as string, @@ -222,9 +231,9 @@ export class SharedLinksFoldersManager { } async updateFolderAddSharedLink( folderId: string, - requestBody: UpdateFolderAddSharedLinkRequestBodyArg = {} satisfies UpdateFolderAddSharedLinkRequestBodyArg, - queryParams: UpdateFolderAddSharedLinkQueryParamsArg, - headers: UpdateFolderAddSharedLinkHeadersArg = new UpdateFolderAddSharedLinkHeadersArg( + requestBody: UpdateFolderAddSharedLinkRequestBody = {} satisfies UpdateFolderAddSharedLinkRequestBody, + queryParams: UpdateFolderAddSharedLinkQueryParams, + headers: UpdateFolderAddSharedLinkHeaders = new UpdateFolderAddSharedLinkHeaders( {} ), cancellationToken?: CancellationToken @@ -237,7 +246,8 @@ export class SharedLinksFoldersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '#add_shared_link' ) as string, @@ -245,7 +255,7 @@ export class SharedLinksFoldersManager { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateFolderAddSharedLinkRequestBodyArg(requestBody), + data: serializeUpdateFolderAddSharedLinkRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -257,9 +267,9 @@ export class SharedLinksFoldersManager { } async updateFolderUpdateSharedLink( folderId: string, - requestBody: UpdateFolderUpdateSharedLinkRequestBodyArg = {} satisfies UpdateFolderUpdateSharedLinkRequestBodyArg, - queryParams: UpdateFolderUpdateSharedLinkQueryParamsArg, - headers: UpdateFolderUpdateSharedLinkHeadersArg = new UpdateFolderUpdateSharedLinkHeadersArg( + requestBody: UpdateFolderUpdateSharedLinkRequestBody = {} satisfies UpdateFolderUpdateSharedLinkRequestBody, + queryParams: UpdateFolderUpdateSharedLinkQueryParams, + headers: UpdateFolderUpdateSharedLinkHeaders = new UpdateFolderUpdateSharedLinkHeaders( {} ), cancellationToken?: CancellationToken @@ -272,7 +282,8 @@ export class SharedLinksFoldersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '#update_shared_link' ) as string, @@ -280,7 +291,7 @@ export class SharedLinksFoldersManager { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateFolderUpdateSharedLinkRequestBodyArg(requestBody), + data: serializeUpdateFolderUpdateSharedLinkRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -292,9 +303,9 @@ export class SharedLinksFoldersManager { } async updateFolderRemoveSharedLink( folderId: string, - requestBody: UpdateFolderRemoveSharedLinkRequestBodyArg = {} satisfies UpdateFolderRemoveSharedLinkRequestBodyArg, - queryParams: UpdateFolderRemoveSharedLinkQueryParamsArg, - headers: UpdateFolderRemoveSharedLinkHeadersArg = new UpdateFolderRemoveSharedLinkHeadersArg( + requestBody: UpdateFolderRemoveSharedLinkRequestBody = {} satisfies UpdateFolderRemoveSharedLinkRequestBody, + queryParams: UpdateFolderRemoveSharedLinkQueryParams, + headers: UpdateFolderRemoveSharedLinkHeaders = new UpdateFolderRemoveSharedLinkHeaders( {} ), cancellationToken?: CancellationToken @@ -307,7 +318,8 @@ export class SharedLinksFoldersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '#remove_shared_link' ) as string, @@ -315,7 +327,7 @@ export class SharedLinksFoldersManager { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateFolderRemoveSharedLinkRequestBodyArg(requestBody), + data: serializeUpdateFolderRemoveSharedLinkRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -326,16 +338,16 @@ export class SharedLinksFoldersManager { return deserializeFolderFull(response.data); } } -export function serializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldAccessField( - val: UpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldAccessField +export function serializeUpdateFolderAddSharedLinkRequestBodySharedLinkAccessField( + val: UpdateFolderAddSharedLinkRequestBodySharedLinkAccessField ): SerializedData { return val; } -export function deserializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldAccessField( +export function deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkAccessField( val: any -): UpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldAccessField { +): UpdateFolderAddSharedLinkRequestBodySharedLinkAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldAccessField"'; + throw 'Expecting a string for "UpdateFolderAddSharedLinkRequestBodySharedLinkAccessField"'; } if (val == 'open') { return 'open'; @@ -348,8 +360,8 @@ export function deserializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkFiel } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( - val: UpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField +export function serializeUpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField( + val: UpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField ): SerializedData { return { ['can_download']: val.canDownload == void 0 ? void 0 : val.canDownload, @@ -357,9 +369,9 @@ export function serializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldP ['can_edit']: val.canEdit == void 0 ? void 0 : val.canEdit, }; } -export function deserializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( +export function deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField( val: any -): UpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField { +): UpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField { const canDownload: undefined | boolean = val.can_download == void 0 ? void 0 : val.can_download; const canPreview: undefined | boolean = @@ -370,16 +382,16 @@ export function deserializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkFiel canDownload: canDownload, canPreview: canPreview, canEdit: canEdit, - } satisfies UpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField; + } satisfies UpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField; } -export function serializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkField( - val: UpdateFolderAddSharedLinkRequestBodyArgSharedLinkField +export function serializeUpdateFolderAddSharedLinkRequestBodySharedLinkField( + val: UpdateFolderAddSharedLinkRequestBodySharedLinkField ): SerializedData { return { ['access']: val.access == void 0 ? void 0 - : serializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldAccessField( + : serializeUpdateFolderAddSharedLinkRequestBodySharedLinkAccessField( val.access ), ['password']: val.password == void 0 ? void 0 : val.password, @@ -388,20 +400,20 @@ export function serializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkField( ['permissions']: val.permissions == void 0 ? void 0 - : serializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( + : serializeUpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField( val.permissions ), }; } -export function deserializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkField( +export function deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkField( val: any -): UpdateFolderAddSharedLinkRequestBodyArgSharedLinkField { +): UpdateFolderAddSharedLinkRequestBodySharedLinkField { const access: | undefined - | UpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldAccessField = + | UpdateFolderAddSharedLinkRequestBodySharedLinkAccessField = val.access == void 0 ? void 0 - : deserializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldAccessField( + : deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkAccessField( val.access ); const password: undefined | string = @@ -412,10 +424,10 @@ export function deserializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkFiel val.unshared_at == void 0 ? void 0 : val.unshared_at; const permissions: | undefined - | UpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField = + | UpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField = val.permissions == void 0 ? void 0 - : deserializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( + : deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField( val.permissions ); return { @@ -424,45 +436,45 @@ export function deserializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkFiel vanityName: vanityName, unsharedAt: unsharedAt, permissions: permissions, - } satisfies UpdateFolderAddSharedLinkRequestBodyArgSharedLinkField; + } satisfies UpdateFolderAddSharedLinkRequestBodySharedLinkField; } -export function serializeUpdateFolderAddSharedLinkRequestBodyArg( - val: UpdateFolderAddSharedLinkRequestBodyArg +export function serializeUpdateFolderAddSharedLinkRequestBody( + val: UpdateFolderAddSharedLinkRequestBody ): SerializedData { return { ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkField( + : serializeUpdateFolderAddSharedLinkRequestBodySharedLinkField( val.sharedLink ), }; } -export function deserializeUpdateFolderAddSharedLinkRequestBodyArg( +export function deserializeUpdateFolderAddSharedLinkRequestBody( val: any -): UpdateFolderAddSharedLinkRequestBodyArg { +): UpdateFolderAddSharedLinkRequestBody { const sharedLink: | undefined - | UpdateFolderAddSharedLinkRequestBodyArgSharedLinkField = + | UpdateFolderAddSharedLinkRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkField( + : deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkField( val.shared_link ); return { sharedLink: sharedLink, - } satisfies UpdateFolderAddSharedLinkRequestBodyArg; + } satisfies UpdateFolderAddSharedLinkRequestBody; } -export function serializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField( - val: UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField +export function serializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField( + val: UpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField ): SerializedData { return val; } -export function deserializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField( +export function deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField( val: any -): UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField { +): UpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField"'; + throw 'Expecting a string for "UpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField"'; } if (val == 'open') { return 'open'; @@ -475,8 +487,8 @@ export function deserializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkF } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( - val: UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField +export function serializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField( + val: UpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField ): SerializedData { return { ['can_download']: val.canDownload == void 0 ? void 0 : val.canDownload, @@ -484,9 +496,9 @@ export function serializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFie ['can_edit']: val.canEdit == void 0 ? void 0 : val.canEdit, }; } -export function deserializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( +export function deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField( val: any -): UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField { +): UpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField { const canDownload: undefined | boolean = val.can_download == void 0 ? void 0 : val.can_download; const canPreview: undefined | boolean = @@ -497,16 +509,16 @@ export function deserializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkF canDownload: canDownload, canPreview: canPreview, canEdit: canEdit, - } satisfies UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField; + } satisfies UpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField; } -export function serializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkField( - val: UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkField +export function serializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkField( + val: UpdateFolderUpdateSharedLinkRequestBodySharedLinkField ): SerializedData { return { ['access']: val.access == void 0 ? void 0 - : serializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField( + : serializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField( val.access ), ['password']: val.password == void 0 ? void 0 : val.password, @@ -515,20 +527,20 @@ export function serializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFie ['permissions']: val.permissions == void 0 ? void 0 - : serializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( + : serializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField( val.permissions ), }; } -export function deserializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkField( +export function deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkField( val: any -): UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkField { +): UpdateFolderUpdateSharedLinkRequestBodySharedLinkField { const access: | undefined - | UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField = + | UpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField = val.access == void 0 ? void 0 - : deserializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField( + : deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField( val.access ); const password: undefined | string = @@ -539,10 +551,10 @@ export function deserializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkF val.unshared_at == void 0 ? void 0 : val.unshared_at; const permissions: | undefined - | UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField = + | UpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField = val.permissions == void 0 ? void 0 - : deserializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( + : deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField( val.permissions ); return { @@ -551,69 +563,69 @@ export function deserializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkF vanityName: vanityName, unsharedAt: unsharedAt, permissions: permissions, - } satisfies UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkField; + } satisfies UpdateFolderUpdateSharedLinkRequestBodySharedLinkField; } -export function serializeUpdateFolderUpdateSharedLinkRequestBodyArg( - val: UpdateFolderUpdateSharedLinkRequestBodyArg +export function serializeUpdateFolderUpdateSharedLinkRequestBody( + val: UpdateFolderUpdateSharedLinkRequestBody ): SerializedData { return { ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkField( + : serializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkField( val.sharedLink ), }; } -export function deserializeUpdateFolderUpdateSharedLinkRequestBodyArg( +export function deserializeUpdateFolderUpdateSharedLinkRequestBody( val: any -): UpdateFolderUpdateSharedLinkRequestBodyArg { +): UpdateFolderUpdateSharedLinkRequestBody { const sharedLink: | undefined - | UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkField = + | UpdateFolderUpdateSharedLinkRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkField( + : deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkField( val.shared_link ); return { sharedLink: sharedLink, - } satisfies UpdateFolderUpdateSharedLinkRequestBodyArg; + } satisfies UpdateFolderUpdateSharedLinkRequestBody; } -export function serializeUpdateFolderRemoveSharedLinkRequestBodyArgSharedLinkField( - val: UpdateFolderRemoveSharedLinkRequestBodyArgSharedLinkField +export function serializeUpdateFolderRemoveSharedLinkRequestBodySharedLinkField( + val: UpdateFolderRemoveSharedLinkRequestBodySharedLinkField ): SerializedData { return {}; } -export function deserializeUpdateFolderRemoveSharedLinkRequestBodyArgSharedLinkField( +export function deserializeUpdateFolderRemoveSharedLinkRequestBodySharedLinkField( val: any -): UpdateFolderRemoveSharedLinkRequestBodyArgSharedLinkField { - return {} satisfies UpdateFolderRemoveSharedLinkRequestBodyArgSharedLinkField; +): UpdateFolderRemoveSharedLinkRequestBodySharedLinkField { + return {} satisfies UpdateFolderRemoveSharedLinkRequestBodySharedLinkField; } -export function serializeUpdateFolderRemoveSharedLinkRequestBodyArg( - val: UpdateFolderRemoveSharedLinkRequestBodyArg +export function serializeUpdateFolderRemoveSharedLinkRequestBody( + val: UpdateFolderRemoveSharedLinkRequestBody ): SerializedData { return { ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateFolderRemoveSharedLinkRequestBodyArgSharedLinkField( + : serializeUpdateFolderRemoveSharedLinkRequestBodySharedLinkField( val.sharedLink ), }; } -export function deserializeUpdateFolderRemoveSharedLinkRequestBodyArg( +export function deserializeUpdateFolderRemoveSharedLinkRequestBody( val: any -): UpdateFolderRemoveSharedLinkRequestBodyArg { +): UpdateFolderRemoveSharedLinkRequestBody { const sharedLink: | undefined - | UpdateFolderRemoveSharedLinkRequestBodyArgSharedLinkField = + | UpdateFolderRemoveSharedLinkRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateFolderRemoveSharedLinkRequestBodyArgSharedLinkField( + : deserializeUpdateFolderRemoveSharedLinkRequestBodySharedLinkField( val.shared_link ); return { sharedLink: sharedLink, - } satisfies UpdateFolderRemoveSharedLinkRequestBodyArg; + } satisfies UpdateFolderRemoveSharedLinkRequestBody; } diff --git a/src/managers/sharedLinksWebLinks.generated.ts b/src/managers/sharedLinksWebLinks.generated.ts index 3044c71a..babffef5 100644 --- a/src/managers/sharedLinksWebLinks.generated.ts +++ b/src/managers/sharedLinksWebLinks.generated.ts @@ -21,10 +21,10 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetSharedItemWebLinksQueryParamsArg { +export interface GetSharedItemWebLinksQueryParams { readonly fields?: readonly string[]; } -export class GetSharedItemWebLinksHeadersArg { +export class GetSharedItemWebLinksHeaders { readonly ifNoneMatch?: string; readonly boxapi!: string; readonly extraHeaders?: { @@ -32,128 +32,135 @@ export class GetSharedItemWebLinksHeadersArg { } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetWebLinkGetSharedLinkQueryParamsArg { +export interface GetWebLinkGetSharedLinkQueryParams { readonly fields: string; } -export class GetWebLinkGetSharedLinkHeadersArg { +export class GetWebLinkGetSharedLinkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldAccessField = - 'open' | 'company' | 'collaborators'; -export interface UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField { +export type UpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField = + | 'open' + | 'company' + | 'collaborators'; +export interface UpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField { readonly canDownload?: boolean; readonly canPreview?: boolean; readonly canEdit?: boolean; } -export interface UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkField { - readonly access?: UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldAccessField; +export interface UpdateWebLinkAddSharedLinkRequestBodySharedLinkField { + readonly access?: UpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField; readonly password?: string; readonly vanityName?: string; readonly unsharedAt?: string; - readonly permissions?: UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField; + readonly permissions?: UpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField; } -export interface UpdateWebLinkAddSharedLinkRequestBodyArg { - readonly sharedLink?: UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkField; +export interface UpdateWebLinkAddSharedLinkRequestBody { + readonly sharedLink?: UpdateWebLinkAddSharedLinkRequestBodySharedLinkField; } -export interface UpdateWebLinkAddSharedLinkQueryParamsArg { +export interface UpdateWebLinkAddSharedLinkQueryParams { readonly fields: string; } -export class UpdateWebLinkAddSharedLinkHeadersArg { +export class UpdateWebLinkAddSharedLinkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField = - 'open' | 'company' | 'collaborators'; -export interface UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField { +export type UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField = + | 'open' + | 'company' + | 'collaborators'; +export interface UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField { readonly canDownload?: boolean; readonly canPreview?: boolean; readonly canEdit?: boolean; } -export interface UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkField { - readonly access?: UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField; +export interface UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField { + readonly access?: UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField; readonly password?: string; readonly vanityName?: string; readonly unsharedAt?: string; - readonly permissions?: UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField; + readonly permissions?: UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField; } -export interface UpdateWebLinkUpdateSharedLinkRequestBodyArg { - readonly sharedLink?: UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkField; +export interface UpdateWebLinkUpdateSharedLinkRequestBody { + readonly sharedLink?: UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField; } -export interface UpdateWebLinkUpdateSharedLinkQueryParamsArg { +export interface UpdateWebLinkUpdateSharedLinkQueryParams { readonly fields: string; } -export class UpdateWebLinkUpdateSharedLinkHeadersArg { +export class UpdateWebLinkUpdateSharedLinkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface UpdateWebLinkRemoveSharedLinkRequestBodyArgSharedLinkField {} -export interface UpdateWebLinkRemoveSharedLinkRequestBodyArg { - readonly sharedLink?: UpdateWebLinkRemoveSharedLinkRequestBodyArgSharedLinkField; +export interface UpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField {} +export interface UpdateWebLinkRemoveSharedLinkRequestBody { + readonly sharedLink?: UpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField; } -export interface UpdateWebLinkRemoveSharedLinkQueryParamsArg { +export interface UpdateWebLinkRemoveSharedLinkQueryParams { readonly fields: string; } -export class UpdateWebLinkRemoveSharedLinkHeadersArg { +export class UpdateWebLinkRemoveSharedLinkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class SharedLinksWebLinksManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - SharedLinksWebLinksManager, - | 'getSharedItemWebLinks' - | 'getWebLinkGetSharedLink' - | 'updateWebLinkAddSharedLink' - | 'updateWebLinkUpdateSharedLink' - | 'updateWebLinkRemoveSharedLink' - > + fields: + | Omit< + SharedLinksWebLinksManager, + | 'networkSession' + | 'getSharedItemWebLinks' + | 'getWebLinkGetSharedLink' + | 'updateWebLinkAddSharedLink' + | 'updateWebLinkUpdateSharedLink' + | 'updateWebLinkRemoveSharedLink' + > + | Partial> ) { Object.assign(this, fields); } async getSharedItemWebLinks( - queryParams: GetSharedItemWebLinksQueryParamsArg = {} satisfies GetSharedItemWebLinksQueryParamsArg, - headers: GetSharedItemWebLinksHeadersArg, + queryParams: GetSharedItemWebLinksQueryParams = {} satisfies GetSharedItemWebLinksQueryParams, + headers: GetSharedItemWebLinksHeaders, cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -173,7 +180,10 @@ export class SharedLinksWebLinksManager { ...headers.extraHeaders, }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/shared_items#web_links') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/shared_items#web_links' + ) as string, { method: 'GET', params: queryParamsMap, @@ -188,8 +198,8 @@ export class SharedLinksWebLinksManager { } async getWebLinkGetSharedLink( webLinkId: string, - queryParams: GetWebLinkGetSharedLinkQueryParamsArg, - headers: GetWebLinkGetSharedLinkHeadersArg = new GetWebLinkGetSharedLinkHeadersArg( + queryParams: GetWebLinkGetSharedLinkQueryParams, + headers: GetWebLinkGetSharedLinkHeaders = new GetWebLinkGetSharedLinkHeaders( {} ), cancellationToken?: CancellationToken @@ -202,7 +212,8 @@ export class SharedLinksWebLinksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/web_links/', + this.networkSession.baseUrls.baseUrl, + '/web_links/', toString(webLinkId) as string, '#get_shared_link' ) as string, @@ -220,9 +231,9 @@ export class SharedLinksWebLinksManager { } async updateWebLinkAddSharedLink( webLinkId: string, - requestBody: UpdateWebLinkAddSharedLinkRequestBodyArg = {} satisfies UpdateWebLinkAddSharedLinkRequestBodyArg, - queryParams: UpdateWebLinkAddSharedLinkQueryParamsArg, - headers: UpdateWebLinkAddSharedLinkHeadersArg = new UpdateWebLinkAddSharedLinkHeadersArg( + requestBody: UpdateWebLinkAddSharedLinkRequestBody = {} satisfies UpdateWebLinkAddSharedLinkRequestBody, + queryParams: UpdateWebLinkAddSharedLinkQueryParams, + headers: UpdateWebLinkAddSharedLinkHeaders = new UpdateWebLinkAddSharedLinkHeaders( {} ), cancellationToken?: CancellationToken @@ -235,7 +246,8 @@ export class SharedLinksWebLinksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/web_links/', + this.networkSession.baseUrls.baseUrl, + '/web_links/', toString(webLinkId) as string, '#add_shared_link' ) as string, @@ -243,7 +255,7 @@ export class SharedLinksWebLinksManager { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateWebLinkAddSharedLinkRequestBodyArg(requestBody), + data: serializeUpdateWebLinkAddSharedLinkRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -255,9 +267,9 @@ export class SharedLinksWebLinksManager { } async updateWebLinkUpdateSharedLink( webLinkId: string, - requestBody: UpdateWebLinkUpdateSharedLinkRequestBodyArg = {} satisfies UpdateWebLinkUpdateSharedLinkRequestBodyArg, - queryParams: UpdateWebLinkUpdateSharedLinkQueryParamsArg, - headers: UpdateWebLinkUpdateSharedLinkHeadersArg = new UpdateWebLinkUpdateSharedLinkHeadersArg( + requestBody: UpdateWebLinkUpdateSharedLinkRequestBody = {} satisfies UpdateWebLinkUpdateSharedLinkRequestBody, + queryParams: UpdateWebLinkUpdateSharedLinkQueryParams, + headers: UpdateWebLinkUpdateSharedLinkHeaders = new UpdateWebLinkUpdateSharedLinkHeaders( {} ), cancellationToken?: CancellationToken @@ -270,7 +282,8 @@ export class SharedLinksWebLinksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/web_links/', + this.networkSession.baseUrls.baseUrl, + '/web_links/', toString(webLinkId) as string, '#update_shared_link' ) as string, @@ -278,7 +291,7 @@ export class SharedLinksWebLinksManager { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateWebLinkUpdateSharedLinkRequestBodyArg(requestBody), + data: serializeUpdateWebLinkUpdateSharedLinkRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -290,9 +303,9 @@ export class SharedLinksWebLinksManager { } async updateWebLinkRemoveSharedLink( webLinkId: string, - requestBody: UpdateWebLinkRemoveSharedLinkRequestBodyArg = {} satisfies UpdateWebLinkRemoveSharedLinkRequestBodyArg, - queryParams: UpdateWebLinkRemoveSharedLinkQueryParamsArg, - headers: UpdateWebLinkRemoveSharedLinkHeadersArg = new UpdateWebLinkRemoveSharedLinkHeadersArg( + requestBody: UpdateWebLinkRemoveSharedLinkRequestBody = {} satisfies UpdateWebLinkRemoveSharedLinkRequestBody, + queryParams: UpdateWebLinkRemoveSharedLinkQueryParams, + headers: UpdateWebLinkRemoveSharedLinkHeaders = new UpdateWebLinkRemoveSharedLinkHeaders( {} ), cancellationToken?: CancellationToken @@ -305,7 +318,8 @@ export class SharedLinksWebLinksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/web_links/', + this.networkSession.baseUrls.baseUrl, + '/web_links/', toString(webLinkId) as string, '#remove_shared_link' ) as string, @@ -313,7 +327,7 @@ export class SharedLinksWebLinksManager { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateWebLinkRemoveSharedLinkRequestBodyArg(requestBody), + data: serializeUpdateWebLinkRemoveSharedLinkRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -324,16 +338,16 @@ export class SharedLinksWebLinksManager { return deserializeWebLink(response.data); } } -export function serializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldAccessField( - val: UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldAccessField +export function serializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField( + val: UpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField ): SerializedData { return val; } -export function deserializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldAccessField( +export function deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField( val: any -): UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldAccessField { +): UpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldAccessField"'; + throw 'Expecting a string for "UpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField"'; } if (val == 'open') { return 'open'; @@ -346,8 +360,8 @@ export function deserializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFie } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( - val: UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField +export function serializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField( + val: UpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField ): SerializedData { return { ['can_download']: val.canDownload == void 0 ? void 0 : val.canDownload, @@ -355,9 +369,9 @@ export function serializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkField ['can_edit']: val.canEdit == void 0 ? void 0 : val.canEdit, }; } -export function deserializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( +export function deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField( val: any -): UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField { +): UpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField { const canDownload: undefined | boolean = val.can_download == void 0 ? void 0 : val.can_download; const canPreview: undefined | boolean = @@ -368,16 +382,16 @@ export function deserializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFie canDownload: canDownload, canPreview: canPreview, canEdit: canEdit, - } satisfies UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField; + } satisfies UpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField; } -export function serializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkField( - val: UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkField +export function serializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkField( + val: UpdateWebLinkAddSharedLinkRequestBodySharedLinkField ): SerializedData { return { ['access']: val.access == void 0 ? void 0 - : serializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldAccessField( + : serializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField( val.access ), ['password']: val.password == void 0 ? void 0 : val.password, @@ -386,20 +400,20 @@ export function serializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkField ['permissions']: val.permissions == void 0 ? void 0 - : serializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( + : serializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField( val.permissions ), }; } -export function deserializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkField( +export function deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkField( val: any -): UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkField { +): UpdateWebLinkAddSharedLinkRequestBodySharedLinkField { const access: | undefined - | UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldAccessField = + | UpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField = val.access == void 0 ? void 0 - : deserializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldAccessField( + : deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField( val.access ); const password: undefined | string = @@ -410,10 +424,10 @@ export function deserializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFie val.unshared_at == void 0 ? void 0 : val.unshared_at; const permissions: | undefined - | UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField = + | UpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField = val.permissions == void 0 ? void 0 - : deserializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( + : deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField( val.permissions ); return { @@ -422,45 +436,45 @@ export function deserializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFie vanityName: vanityName, unsharedAt: unsharedAt, permissions: permissions, - } satisfies UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkField; + } satisfies UpdateWebLinkAddSharedLinkRequestBodySharedLinkField; } -export function serializeUpdateWebLinkAddSharedLinkRequestBodyArg( - val: UpdateWebLinkAddSharedLinkRequestBodyArg +export function serializeUpdateWebLinkAddSharedLinkRequestBody( + val: UpdateWebLinkAddSharedLinkRequestBody ): SerializedData { return { ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkField( + : serializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkField( val.sharedLink ), }; } -export function deserializeUpdateWebLinkAddSharedLinkRequestBodyArg( +export function deserializeUpdateWebLinkAddSharedLinkRequestBody( val: any -): UpdateWebLinkAddSharedLinkRequestBodyArg { +): UpdateWebLinkAddSharedLinkRequestBody { const sharedLink: | undefined - | UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkField = + | UpdateWebLinkAddSharedLinkRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkField( + : deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkField( val.shared_link ); return { sharedLink: sharedLink, - } satisfies UpdateWebLinkAddSharedLinkRequestBodyArg; + } satisfies UpdateWebLinkAddSharedLinkRequestBody; } -export function serializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField( - val: UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField +export function serializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField( + val: UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField ): SerializedData { return val; } -export function deserializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField( +export function deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField( val: any -): UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField { +): UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField"'; + throw 'Expecting a string for "UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField"'; } if (val == 'open') { return 'open'; @@ -473,8 +487,8 @@ export function deserializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLink } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( - val: UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField +export function serializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField( + val: UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField ): SerializedData { return { ['can_download']: val.canDownload == void 0 ? void 0 : val.canDownload, @@ -482,9 +496,9 @@ export function serializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFi ['can_edit']: val.canEdit == void 0 ? void 0 : val.canEdit, }; } -export function deserializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( +export function deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField( val: any -): UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField { +): UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField { const canDownload: undefined | boolean = val.can_download == void 0 ? void 0 : val.can_download; const canPreview: undefined | boolean = @@ -495,16 +509,16 @@ export function deserializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLink canDownload: canDownload, canPreview: canPreview, canEdit: canEdit, - } satisfies UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField; + } satisfies UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField; } -export function serializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkField( - val: UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkField +export function serializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField( + val: UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField ): SerializedData { return { ['access']: val.access == void 0 ? void 0 - : serializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField( + : serializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField( val.access ), ['password']: val.password == void 0 ? void 0 : val.password, @@ -513,20 +527,20 @@ export function serializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFi ['permissions']: val.permissions == void 0 ? void 0 - : serializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( + : serializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField( val.permissions ), }; } -export function deserializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkField( +export function deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField( val: any -): UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkField { +): UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField { const access: | undefined - | UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField = + | UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField = val.access == void 0 ? void 0 - : deserializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField( + : deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField( val.access ); const password: undefined | string = @@ -537,10 +551,10 @@ export function deserializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLink val.unshared_at == void 0 ? void 0 : val.unshared_at; const permissions: | undefined - | UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField = + | UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField = val.permissions == void 0 ? void 0 - : deserializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldPermissionsField( + : deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField( val.permissions ); return { @@ -549,69 +563,69 @@ export function deserializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLink vanityName: vanityName, unsharedAt: unsharedAt, permissions: permissions, - } satisfies UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkField; + } satisfies UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField; } -export function serializeUpdateWebLinkUpdateSharedLinkRequestBodyArg( - val: UpdateWebLinkUpdateSharedLinkRequestBodyArg +export function serializeUpdateWebLinkUpdateSharedLinkRequestBody( + val: UpdateWebLinkUpdateSharedLinkRequestBody ): SerializedData { return { ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkField( + : serializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField( val.sharedLink ), }; } -export function deserializeUpdateWebLinkUpdateSharedLinkRequestBodyArg( +export function deserializeUpdateWebLinkUpdateSharedLinkRequestBody( val: any -): UpdateWebLinkUpdateSharedLinkRequestBodyArg { +): UpdateWebLinkUpdateSharedLinkRequestBody { const sharedLink: | undefined - | UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkField = + | UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkField( + : deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField( val.shared_link ); return { sharedLink: sharedLink, - } satisfies UpdateWebLinkUpdateSharedLinkRequestBodyArg; + } satisfies UpdateWebLinkUpdateSharedLinkRequestBody; } -export function serializeUpdateWebLinkRemoveSharedLinkRequestBodyArgSharedLinkField( - val: UpdateWebLinkRemoveSharedLinkRequestBodyArgSharedLinkField +export function serializeUpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField( + val: UpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField ): SerializedData { return {}; } -export function deserializeUpdateWebLinkRemoveSharedLinkRequestBodyArgSharedLinkField( +export function deserializeUpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField( val: any -): UpdateWebLinkRemoveSharedLinkRequestBodyArgSharedLinkField { - return {} satisfies UpdateWebLinkRemoveSharedLinkRequestBodyArgSharedLinkField; +): UpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField { + return {} satisfies UpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField; } -export function serializeUpdateWebLinkRemoveSharedLinkRequestBodyArg( - val: UpdateWebLinkRemoveSharedLinkRequestBodyArg +export function serializeUpdateWebLinkRemoveSharedLinkRequestBody( + val: UpdateWebLinkRemoveSharedLinkRequestBody ): SerializedData { return { ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateWebLinkRemoveSharedLinkRequestBodyArgSharedLinkField( + : serializeUpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField( val.sharedLink ), }; } -export function deserializeUpdateWebLinkRemoveSharedLinkRequestBodyArg( +export function deserializeUpdateWebLinkRemoveSharedLinkRequestBody( val: any -): UpdateWebLinkRemoveSharedLinkRequestBodyArg { +): UpdateWebLinkRemoveSharedLinkRequestBody { const sharedLink: | undefined - | UpdateWebLinkRemoveSharedLinkRequestBodyArgSharedLinkField = + | UpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateWebLinkRemoveSharedLinkRequestBodyArgSharedLinkField( + : deserializeUpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField( val.shared_link ); return { sharedLink: sharedLink, - } satisfies UpdateWebLinkRemoveSharedLinkRequestBodyArg; + } satisfies UpdateWebLinkRemoveSharedLinkRequestBody; } diff --git a/src/managers/shieldInformationBarrierReports.generated.ts b/src/managers/shieldInformationBarrierReports.generated.ts index 528d410e..a22680a3 100644 --- a/src/managers/shieldInformationBarrierReports.generated.ts +++ b/src/managers/shieldInformationBarrierReports.generated.ts @@ -27,48 +27,46 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetShieldInformationBarrierReportsQueryParamsArg { +export interface GetShieldInformationBarrierReportsQueryParams { readonly shieldInformationBarrierId: string; readonly marker?: string; readonly limit?: number; } -export class GetShieldInformationBarrierReportsHeadersArg { +export class GetShieldInformationBarrierReportsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial< - Pick - > + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class CreateShieldInformationBarrierReportHeadersArg { +export class CreateShieldInformationBarrierReportHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit + | Omit | Partial< - Pick + Pick > ) { Object.assign(this, fields); } } -export class GetShieldInformationBarrierReportByIdHeadersArg { +export class GetShieldInformationBarrierReportByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit + | Omit | Partial< - Pick + Pick > ) { Object.assign(this, fields); @@ -76,20 +74,23 @@ export class GetShieldInformationBarrierReportByIdHeadersArg { } export class ShieldInformationBarrierReportsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - ShieldInformationBarrierReportsManager, - | 'getShieldInformationBarrierReports' - | 'createShieldInformationBarrierReport' - | 'getShieldInformationBarrierReportById' - > + fields: + | Omit< + ShieldInformationBarrierReportsManager, + | 'networkSession' + | 'getShieldInformationBarrierReports' + | 'createShieldInformationBarrierReport' + | 'getShieldInformationBarrierReportById' + > + | Partial> ) { Object.assign(this, fields); } async getShieldInformationBarrierReports( - queryParams: GetShieldInformationBarrierReportsQueryParamsArg, - headers: GetShieldInformationBarrierReportsHeadersArg = new GetShieldInformationBarrierReportsHeadersArg( + queryParams: GetShieldInformationBarrierReportsQueryParams, + headers: GetShieldInformationBarrierReportsHeaders = new GetShieldInformationBarrierReportsHeaders( {} ), cancellationToken?: CancellationToken @@ -108,7 +109,8 @@ export class ShieldInformationBarrierReportsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barrier_reports' + this.networkSession.baseUrls.baseUrl, + '/shield_information_barrier_reports' ) as string, { method: 'GET', @@ -124,7 +126,7 @@ export class ShieldInformationBarrierReportsManager { } async createShieldInformationBarrierReport( requestBody: ShieldInformationBarrierReference, - headers: CreateShieldInformationBarrierReportHeadersArg = new CreateShieldInformationBarrierReportHeadersArg( + headers: CreateShieldInformationBarrierReportHeaders = new CreateShieldInformationBarrierReportHeaders( {} ), cancellationToken?: CancellationToken @@ -134,7 +136,8 @@ export class ShieldInformationBarrierReportsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barrier_reports' + this.networkSession.baseUrls.baseUrl, + '/shield_information_barrier_reports' ) as string, { method: 'POST', @@ -151,7 +154,7 @@ export class ShieldInformationBarrierReportsManager { } async getShieldInformationBarrierReportById( shieldInformationBarrierReportId: string, - headers: GetShieldInformationBarrierReportByIdHeadersArg = new GetShieldInformationBarrierReportByIdHeadersArg( + headers: GetShieldInformationBarrierReportByIdHeaders = new GetShieldInformationBarrierReportByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -161,7 +164,8 @@ export class ShieldInformationBarrierReportsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barrier_reports/', + this.networkSession.baseUrls.baseUrl, + '/shield_information_barrier_reports/', toString(shieldInformationBarrierReportId) as string ) as string, { diff --git a/src/managers/shieldInformationBarrierSegmentMembers.generated.ts b/src/managers/shieldInformationBarrierSegmentMembers.generated.ts index 8ba8d797..aee95bbe 100644 --- a/src/managers/shieldInformationBarrierSegmentMembers.generated.ts +++ b/src/managers/shieldInformationBarrierSegmentMembers.generated.ts @@ -30,19 +30,19 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetShieldInformationBarrierSegmentMemberByIdHeadersArg { +export class GetShieldInformationBarrierSegmentMemberByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: | Omit< - GetShieldInformationBarrierSegmentMemberByIdHeadersArg, + GetShieldInformationBarrierSegmentMemberByIdHeaders, 'extraHeaders' > | Partial< Pick< - GetShieldInformationBarrierSegmentMemberByIdHeadersArg, + GetShieldInformationBarrierSegmentMemberByIdHeaders, 'extraHeaders' > > @@ -50,19 +50,19 @@ export class GetShieldInformationBarrierSegmentMemberByIdHeadersArg { Object.assign(this, fields); } } -export class DeleteShieldInformationBarrierSegmentMemberByIdHeadersArg { +export class DeleteShieldInformationBarrierSegmentMemberByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: | Omit< - DeleteShieldInformationBarrierSegmentMemberByIdHeadersArg, + DeleteShieldInformationBarrierSegmentMemberByIdHeaders, 'extraHeaders' > | Partial< Pick< - DeleteShieldInformationBarrierSegmentMemberByIdHeadersArg, + DeleteShieldInformationBarrierSegmentMemberByIdHeaders, 'extraHeaders' > > @@ -70,58 +70,49 @@ export class DeleteShieldInformationBarrierSegmentMemberByIdHeadersArg { Object.assign(this, fields); } } -export interface GetShieldInformationBarrierSegmentMembersQueryParamsArg { +export interface GetShieldInformationBarrierSegmentMembersQueryParams { readonly shieldInformationBarrierSegmentId: string; readonly marker?: string; readonly limit?: number; } -export class GetShieldInformationBarrierSegmentMembersHeadersArg { +export class GetShieldInformationBarrierSegmentMembersHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit< - GetShieldInformationBarrierSegmentMembersHeadersArg, - 'extraHeaders' - > + | Omit | Partial< - Pick< - GetShieldInformationBarrierSegmentMembersHeadersArg, - 'extraHeaders' - > + Pick > ) { Object.assign(this, fields); } } -export type CreateShieldInformationBarrierSegmentMemberRequestBodyArgTypeField = +export type CreateShieldInformationBarrierSegmentMemberRequestBodyTypeField = 'shield_information_barrier_segment_member'; -export type CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField = +export type CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField = 'shield_information_barrier_segment'; -export interface CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField { +export interface CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField { readonly id?: string; - readonly type?: CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField; + readonly type?: CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField; } -export interface CreateShieldInformationBarrierSegmentMemberRequestBodyArg { - readonly type?: CreateShieldInformationBarrierSegmentMemberRequestBodyArgTypeField; +export interface CreateShieldInformationBarrierSegmentMemberRequestBody { + readonly type?: CreateShieldInformationBarrierSegmentMemberRequestBodyTypeField; readonly shieldInformationBarrier?: ShieldInformationBarrierBase; - readonly shieldInformationBarrierSegment: CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField; + readonly shieldInformationBarrierSegment: CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField; readonly user: UserBase; } -export class CreateShieldInformationBarrierSegmentMemberHeadersArg { +export class CreateShieldInformationBarrierSegmentMemberHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit< - CreateShieldInformationBarrierSegmentMemberHeadersArg, - 'extraHeaders' - > + | Omit | Partial< Pick< - CreateShieldInformationBarrierSegmentMemberHeadersArg, + CreateShieldInformationBarrierSegmentMemberHeaders, 'extraHeaders' > > @@ -131,21 +122,26 @@ export class CreateShieldInformationBarrierSegmentMemberHeadersArg { } export class ShieldInformationBarrierSegmentMembersManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - ShieldInformationBarrierSegmentMembersManager, - | 'getShieldInformationBarrierSegmentMemberById' - | 'deleteShieldInformationBarrierSegmentMemberById' - | 'getShieldInformationBarrierSegmentMembers' - | 'createShieldInformationBarrierSegmentMember' - > + fields: + | Omit< + ShieldInformationBarrierSegmentMembersManager, + | 'networkSession' + | 'getShieldInformationBarrierSegmentMemberById' + | 'deleteShieldInformationBarrierSegmentMemberById' + | 'getShieldInformationBarrierSegmentMembers' + | 'createShieldInformationBarrierSegmentMember' + > + | Partial< + Pick + > ) { Object.assign(this, fields); } async getShieldInformationBarrierSegmentMemberById( shieldInformationBarrierSegmentMemberId: string, - headers: GetShieldInformationBarrierSegmentMemberByIdHeadersArg = new GetShieldInformationBarrierSegmentMemberByIdHeadersArg( + headers: GetShieldInformationBarrierSegmentMemberByIdHeaders = new GetShieldInformationBarrierSegmentMemberByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -155,7 +151,8 @@ export class ShieldInformationBarrierSegmentMembersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barrier_segment_members/', + this.networkSession.baseUrls.baseUrl, + '/shield_information_barrier_segment_members/', toString(shieldInformationBarrierSegmentMemberId) as string ) as string, { @@ -171,7 +168,7 @@ export class ShieldInformationBarrierSegmentMembersManager { } async deleteShieldInformationBarrierSegmentMemberById( shieldInformationBarrierSegmentMemberId: string, - headers: DeleteShieldInformationBarrierSegmentMemberByIdHeadersArg = new DeleteShieldInformationBarrierSegmentMemberByIdHeadersArg( + headers: DeleteShieldInformationBarrierSegmentMemberByIdHeaders = new DeleteShieldInformationBarrierSegmentMemberByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -181,7 +178,8 @@ export class ShieldInformationBarrierSegmentMembersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barrier_segment_members/', + this.networkSession.baseUrls.baseUrl, + '/shield_information_barrier_segment_members/', toString(shieldInformationBarrierSegmentMemberId) as string ) as string, { @@ -196,8 +194,8 @@ export class ShieldInformationBarrierSegmentMembersManager { return void 0; } async getShieldInformationBarrierSegmentMembers( - queryParams: GetShieldInformationBarrierSegmentMembersQueryParamsArg, - headers: GetShieldInformationBarrierSegmentMembersHeadersArg = new GetShieldInformationBarrierSegmentMembersHeadersArg( + queryParams: GetShieldInformationBarrierSegmentMembersQueryParams, + headers: GetShieldInformationBarrierSegmentMembersHeaders = new GetShieldInformationBarrierSegmentMembersHeaders( {} ), cancellationToken?: CancellationToken @@ -216,7 +214,8 @@ export class ShieldInformationBarrierSegmentMembersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barrier_segment_members' + this.networkSession.baseUrls.baseUrl, + '/shield_information_barrier_segment_members' ) as string, { method: 'GET', @@ -231,8 +230,8 @@ export class ShieldInformationBarrierSegmentMembersManager { return deserializeShieldInformationBarrierSegmentMembers(response.data); } async createShieldInformationBarrierSegmentMember( - requestBody: CreateShieldInformationBarrierSegmentMemberRequestBodyArg, - headers: CreateShieldInformationBarrierSegmentMemberHeadersArg = new CreateShieldInformationBarrierSegmentMemberHeadersArg( + requestBody: CreateShieldInformationBarrierSegmentMemberRequestBody, + headers: CreateShieldInformationBarrierSegmentMemberHeaders = new CreateShieldInformationBarrierSegmentMemberHeaders( {} ), cancellationToken?: CancellationToken @@ -242,12 +241,13 @@ export class ShieldInformationBarrierSegmentMembersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barrier_segment_members' + this.networkSession.baseUrls.baseUrl, + '/shield_information_barrier_segment_members' ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateShieldInformationBarrierSegmentMemberRequestBodyArg( + data: serializeCreateShieldInformationBarrierSegmentMemberRequestBody( requestBody ), contentType: 'application/json', @@ -260,76 +260,76 @@ export class ShieldInformationBarrierSegmentMembersManager { return deserializeShieldInformationBarrierSegmentMember(response.data); } } -export function serializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgTypeField( - val: CreateShieldInformationBarrierSegmentMemberRequestBodyArgTypeField +export function serializeCreateShieldInformationBarrierSegmentMemberRequestBodyTypeField( + val: CreateShieldInformationBarrierSegmentMemberRequestBodyTypeField ): SerializedData { return val; } -export function deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgTypeField( +export function deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyTypeField( val: any -): CreateShieldInformationBarrierSegmentMemberRequestBodyArgTypeField { +): CreateShieldInformationBarrierSegmentMemberRequestBodyTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateShieldInformationBarrierSegmentMemberRequestBodyArgTypeField"'; + throw 'Expecting a string for "CreateShieldInformationBarrierSegmentMemberRequestBodyTypeField"'; } if (val == 'shield_information_barrier_segment_member') { return 'shield_information_barrier_segment_member'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField( - val: CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField +export function serializeCreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField( + val: CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField ): SerializedData { return val; } -export function deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField( +export function deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField( val: any -): CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField { +): CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField"'; + throw 'Expecting a string for "CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField"'; } if (val == 'shield_information_barrier_segment') { return 'shield_information_barrier_segment'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField( - val: CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField +export function serializeCreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField( + val: CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id, ['type']: val.type == void 0 ? void 0 - : serializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField( + : serializeCreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField( val.type ), }; } -export function deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField( +export function deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField( val: any -): CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField { +): CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; const type: | undefined - | CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField = + | CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField = val.type == void 0 ? void 0 - : deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField( + : deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField( val.type ); return { id: id, type: type, - } satisfies CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField; + } satisfies CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField; } -export function serializeCreateShieldInformationBarrierSegmentMemberRequestBodyArg( - val: CreateShieldInformationBarrierSegmentMemberRequestBodyArg +export function serializeCreateShieldInformationBarrierSegmentMemberRequestBody( + val: CreateShieldInformationBarrierSegmentMemberRequestBody ): SerializedData { return { ['type']: val.type == void 0 ? void 0 - : serializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgTypeField( + : serializeCreateShieldInformationBarrierSegmentMemberRequestBodyTypeField( val.type ), ['shield_information_barrier']: @@ -337,29 +337,29 @@ export function serializeCreateShieldInformationBarrierSegmentMemberRequestBodyA ? void 0 : serializeShieldInformationBarrierBase(val.shieldInformationBarrier), ['shield_information_barrier_segment']: - serializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField( + serializeCreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField( val.shieldInformationBarrierSegment ), ['user']: serializeUserBase(val.user), }; } -export function deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyArg( +export function deserializeCreateShieldInformationBarrierSegmentMemberRequestBody( val: any -): CreateShieldInformationBarrierSegmentMemberRequestBodyArg { +): CreateShieldInformationBarrierSegmentMemberRequestBody { const type: | undefined - | CreateShieldInformationBarrierSegmentMemberRequestBodyArgTypeField = + | CreateShieldInformationBarrierSegmentMemberRequestBodyTypeField = val.type == void 0 ? void 0 - : deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgTypeField( + : deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyTypeField( val.type ); const shieldInformationBarrier: undefined | ShieldInformationBarrierBase = val.shield_information_barrier == void 0 ? void 0 : deserializeShieldInformationBarrierBase(val.shield_information_barrier); - const shieldInformationBarrierSegment: CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField = - deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField( + const shieldInformationBarrierSegment: CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField = + deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField( val.shield_information_barrier_segment ); const user: UserBase = deserializeUserBase(val.user); @@ -368,5 +368,5 @@ export function deserializeCreateShieldInformationBarrierSegmentMemberRequestBod shieldInformationBarrier: shieldInformationBarrier, shieldInformationBarrierSegment: shieldInformationBarrierSegment, user: user, - } satisfies CreateShieldInformationBarrierSegmentMemberRequestBodyArg; + } satisfies CreateShieldInformationBarrierSegmentMemberRequestBody; } diff --git a/src/managers/shieldInformationBarrierSegmentRestrictions.generated.ts b/src/managers/shieldInformationBarrierSegmentRestrictions.generated.ts index f1559cc3..d0909fd0 100644 --- a/src/managers/shieldInformationBarrierSegmentRestrictions.generated.ts +++ b/src/managers/shieldInformationBarrierSegmentRestrictions.generated.ts @@ -27,19 +27,19 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetShieldInformationBarrierSegmentRestrictionByIdHeadersArg { +export class GetShieldInformationBarrierSegmentRestrictionByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: | Omit< - GetShieldInformationBarrierSegmentRestrictionByIdHeadersArg, + GetShieldInformationBarrierSegmentRestrictionByIdHeaders, 'extraHeaders' > | Partial< Pick< - GetShieldInformationBarrierSegmentRestrictionByIdHeadersArg, + GetShieldInformationBarrierSegmentRestrictionByIdHeaders, 'extraHeaders' > > @@ -47,19 +47,19 @@ export class GetShieldInformationBarrierSegmentRestrictionByIdHeadersArg { Object.assign(this, fields); } } -export class DeleteShieldInformationBarrierSegmentRestrictionByIdHeadersArg { +export class DeleteShieldInformationBarrierSegmentRestrictionByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: | Omit< - DeleteShieldInformationBarrierSegmentRestrictionByIdHeadersArg, + DeleteShieldInformationBarrierSegmentRestrictionByIdHeaders, 'extraHeaders' > | Partial< Pick< - DeleteShieldInformationBarrierSegmentRestrictionByIdHeadersArg, + DeleteShieldInformationBarrierSegmentRestrictionByIdHeaders, 'extraHeaders' > > @@ -67,24 +67,24 @@ export class DeleteShieldInformationBarrierSegmentRestrictionByIdHeadersArg { Object.assign(this, fields); } } -export interface GetShieldInformationBarrierSegmentRestrictionsQueryParamsArg { +export interface GetShieldInformationBarrierSegmentRestrictionsQueryParams { readonly shieldInformationBarrierSegmentId: string; readonly marker?: string; readonly limit?: number; } -export class GetShieldInformationBarrierSegmentRestrictionsHeadersArg { +export class GetShieldInformationBarrierSegmentRestrictionsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: | Omit< - GetShieldInformationBarrierSegmentRestrictionsHeadersArg, + GetShieldInformationBarrierSegmentRestrictionsHeaders, 'extraHeaders' > | Partial< Pick< - GetShieldInformationBarrierSegmentRestrictionsHeadersArg, + GetShieldInformationBarrierSegmentRestrictionsHeaders, 'extraHeaders' > > @@ -92,39 +92,39 @@ export class GetShieldInformationBarrierSegmentRestrictionsHeadersArg { Object.assign(this, fields); } } -export type CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField = +export type CreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField = 'shield_information_barrier_segment_restriction'; -export type CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField = +export type CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField = 'shield_information_barrier_segment'; -export interface CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField { +export interface CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField { readonly id?: string; - readonly type?: CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField; + readonly type?: CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField; } -export type CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField = +export type CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField = 'shield_information_barrier_segment'; -export interface CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField { +export interface CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField { readonly id?: string; - readonly type?: CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField; + readonly type?: CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField; } -export interface CreateShieldInformationBarrierSegmentRestrictionRequestBodyArg { - readonly type: CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField; +export interface CreateShieldInformationBarrierSegmentRestrictionRequestBody { + readonly type: CreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField; readonly shieldInformationBarrier?: ShieldInformationBarrierBase; - readonly shieldInformationBarrierSegment: CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField; - readonly restrictedSegment: CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField; + readonly shieldInformationBarrierSegment: CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField; + readonly restrictedSegment: CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField; } -export class CreateShieldInformationBarrierSegmentRestrictionHeadersArg { +export class CreateShieldInformationBarrierSegmentRestrictionHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: | Omit< - CreateShieldInformationBarrierSegmentRestrictionHeadersArg, + CreateShieldInformationBarrierSegmentRestrictionHeaders, 'extraHeaders' > | Partial< Pick< - CreateShieldInformationBarrierSegmentRestrictionHeadersArg, + CreateShieldInformationBarrierSegmentRestrictionHeaders, 'extraHeaders' > > @@ -134,21 +134,29 @@ export class CreateShieldInformationBarrierSegmentRestrictionHeadersArg { } export class ShieldInformationBarrierSegmentRestrictionsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - ShieldInformationBarrierSegmentRestrictionsManager, - | 'getShieldInformationBarrierSegmentRestrictionById' - | 'deleteShieldInformationBarrierSegmentRestrictionById' - | 'getShieldInformationBarrierSegmentRestrictions' - | 'createShieldInformationBarrierSegmentRestriction' - > + fields: + | Omit< + ShieldInformationBarrierSegmentRestrictionsManager, + | 'networkSession' + | 'getShieldInformationBarrierSegmentRestrictionById' + | 'deleteShieldInformationBarrierSegmentRestrictionById' + | 'getShieldInformationBarrierSegmentRestrictions' + | 'createShieldInformationBarrierSegmentRestriction' + > + | Partial< + Pick< + ShieldInformationBarrierSegmentRestrictionsManager, + 'networkSession' + > + > ) { Object.assign(this, fields); } async getShieldInformationBarrierSegmentRestrictionById( shieldInformationBarrierSegmentRestrictionId: string, - headers: GetShieldInformationBarrierSegmentRestrictionByIdHeadersArg = new GetShieldInformationBarrierSegmentRestrictionByIdHeadersArg( + headers: GetShieldInformationBarrierSegmentRestrictionByIdHeaders = new GetShieldInformationBarrierSegmentRestrictionByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -158,7 +166,8 @@ export class ShieldInformationBarrierSegmentRestrictionsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barrier_segment_restrictions/', + this.networkSession.baseUrls.baseUrl, + '/shield_information_barrier_segment_restrictions/', toString(shieldInformationBarrierSegmentRestrictionId) as string ) as string, { @@ -174,7 +183,7 @@ export class ShieldInformationBarrierSegmentRestrictionsManager { } async deleteShieldInformationBarrierSegmentRestrictionById( shieldInformationBarrierSegmentRestrictionId: string, - headers: DeleteShieldInformationBarrierSegmentRestrictionByIdHeadersArg = new DeleteShieldInformationBarrierSegmentRestrictionByIdHeadersArg( + headers: DeleteShieldInformationBarrierSegmentRestrictionByIdHeaders = new DeleteShieldInformationBarrierSegmentRestrictionByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -184,7 +193,8 @@ export class ShieldInformationBarrierSegmentRestrictionsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barrier_segment_restrictions/', + this.networkSession.baseUrls.baseUrl, + '/shield_information_barrier_segment_restrictions/', toString(shieldInformationBarrierSegmentRestrictionId) as string ) as string, { @@ -199,8 +209,8 @@ export class ShieldInformationBarrierSegmentRestrictionsManager { return void 0; } async getShieldInformationBarrierSegmentRestrictions( - queryParams: GetShieldInformationBarrierSegmentRestrictionsQueryParamsArg, - headers: GetShieldInformationBarrierSegmentRestrictionsHeadersArg = new GetShieldInformationBarrierSegmentRestrictionsHeadersArg( + queryParams: GetShieldInformationBarrierSegmentRestrictionsQueryParams, + headers: GetShieldInformationBarrierSegmentRestrictionsHeaders = new GetShieldInformationBarrierSegmentRestrictionsHeaders( {} ), cancellationToken?: CancellationToken @@ -219,7 +229,8 @@ export class ShieldInformationBarrierSegmentRestrictionsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barrier_segment_restrictions' + this.networkSession.baseUrls.baseUrl, + '/shield_information_barrier_segment_restrictions' ) as string, { method: 'GET', @@ -236,8 +247,8 @@ export class ShieldInformationBarrierSegmentRestrictionsManager { ); } async createShieldInformationBarrierSegmentRestriction( - requestBody: CreateShieldInformationBarrierSegmentRestrictionRequestBodyArg, - headers: CreateShieldInformationBarrierSegmentRestrictionHeadersArg = new CreateShieldInformationBarrierSegmentRestrictionHeadersArg( + requestBody: CreateShieldInformationBarrierSegmentRestrictionRequestBody, + headers: CreateShieldInformationBarrierSegmentRestrictionHeaders = new CreateShieldInformationBarrierSegmentRestrictionHeaders( {} ), cancellationToken?: CancellationToken @@ -247,12 +258,13 @@ export class ShieldInformationBarrierSegmentRestrictionsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barrier_segment_restrictions' + this.networkSession.baseUrls.baseUrl, + '/shield_information_barrier_segment_restrictions' ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArg( + data: serializeCreateShieldInformationBarrierSegmentRestrictionRequestBody( requestBody ), contentType: 'application/json', @@ -265,120 +277,120 @@ export class ShieldInformationBarrierSegmentRestrictionsManager { return deserializeShieldInformationBarrierSegmentRestriction(response.data); } } -export function serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField( - val: CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField +export function serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField( + val: CreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField ): SerializedData { return val; } -export function deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField( +export function deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField( val: any -): CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField { +): CreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField"'; + throw 'Expecting a string for "CreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField"'; } if (val == 'shield_information_barrier_segment_restriction') { return 'shield_information_barrier_segment_restriction'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField( - val: CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField +export function serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField( + val: CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField ): SerializedData { return val; } -export function deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField( +export function deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField( val: any -): CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField { +): CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField"'; + throw 'Expecting a string for "CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField"'; } if (val == 'shield_information_barrier_segment') { return 'shield_information_barrier_segment'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField( - val: CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField +export function serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField( + val: CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id, ['type']: val.type == void 0 ? void 0 - : serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField( + : serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField( val.type ), }; } -export function deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField( +export function deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField( val: any -): CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField { +): CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; const type: | undefined - | CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField = + | CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField = val.type == void 0 ? void 0 - : deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField( + : deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField( val.type ); return { id: id, type: type, - } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField; + } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField; } -export function serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField( - val: CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField +export function serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField( + val: CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField ): SerializedData { return val; } -export function deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField( +export function deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField( val: any -): CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField { +): CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField"'; + throw 'Expecting a string for "CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField"'; } if (val == 'shield_information_barrier_segment') { return 'shield_information_barrier_segment'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField( - val: CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField +export function serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField( + val: CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id, ['type']: val.type == void 0 ? void 0 - : serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField( + : serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField( val.type ), }; } -export function deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField( +export function deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField( val: any -): CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField { +): CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; const type: | undefined - | CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField = + | CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField = val.type == void 0 ? void 0 - : deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField( + : deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField( val.type ); return { id: id, type: type, - } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField; + } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField; } -export function serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArg( - val: CreateShieldInformationBarrierSegmentRestrictionRequestBodyArg +export function serializeCreateShieldInformationBarrierSegmentRestrictionRequestBody( + val: CreateShieldInformationBarrierSegmentRestrictionRequestBody ): SerializedData { return { ['type']: - serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField( + serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField( val.type ), ['shield_information_barrier']: @@ -386,32 +398,32 @@ export function serializeCreateShieldInformationBarrierSegmentRestrictionRequest ? void 0 : serializeShieldInformationBarrierBase(val.shieldInformationBarrier), ['shield_information_barrier_segment']: - serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField( + serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField( val.shieldInformationBarrierSegment ), ['restricted_segment']: - serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField( + serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField( val.restrictedSegment ), }; } -export function deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArg( +export function deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBody( val: any -): CreateShieldInformationBarrierSegmentRestrictionRequestBodyArg { - const type: CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField = - deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField( +): CreateShieldInformationBarrierSegmentRestrictionRequestBody { + const type: CreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField = + deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField( val.type ); const shieldInformationBarrier: undefined | ShieldInformationBarrierBase = val.shield_information_barrier == void 0 ? void 0 : deserializeShieldInformationBarrierBase(val.shield_information_barrier); - const shieldInformationBarrierSegment: CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField = - deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField( + const shieldInformationBarrierSegment: CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField = + deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField( val.shield_information_barrier_segment ); - const restrictedSegment: CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField = - deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField( + const restrictedSegment: CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField = + deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField( val.restricted_segment ); return { @@ -419,5 +431,5 @@ export function deserializeCreateShieldInformationBarrierSegmentRestrictionReque shieldInformationBarrier: shieldInformationBarrier, shieldInformationBarrierSegment: shieldInformationBarrierSegment, restrictedSegment: restrictedSegment, - } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyArg; + } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBody; } diff --git a/src/managers/shieldInformationBarrierSegments.generated.ts b/src/managers/shieldInformationBarrierSegments.generated.ts index d92e7718..ec50352a 100644 --- a/src/managers/shieldInformationBarrierSegments.generated.ts +++ b/src/managers/shieldInformationBarrierSegments.generated.ts @@ -27,97 +27,85 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetShieldInformationBarrierSegmentByIdHeadersArg { +export class GetShieldInformationBarrierSegmentByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit + | Omit | Partial< - Pick + Pick > ) { Object.assign(this, fields); } } -export interface UpdateShieldInformationBarrierSegmentByIdRequestBodyArg { +export interface UpdateShieldInformationBarrierSegmentByIdRequestBody { readonly name?: string; readonly description?: string; } -export class UpdateShieldInformationBarrierSegmentByIdHeadersArg { +export class UpdateShieldInformationBarrierSegmentByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit< - UpdateShieldInformationBarrierSegmentByIdHeadersArg, - 'extraHeaders' - > + | Omit | Partial< - Pick< - UpdateShieldInformationBarrierSegmentByIdHeadersArg, - 'extraHeaders' - > + Pick > ) { Object.assign(this, fields); } } -export class DeleteShieldInformationBarrierSegmentByIdHeadersArg { +export class DeleteShieldInformationBarrierSegmentByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit< - DeleteShieldInformationBarrierSegmentByIdHeadersArg, - 'extraHeaders' - > + | Omit | Partial< - Pick< - DeleteShieldInformationBarrierSegmentByIdHeadersArg, - 'extraHeaders' - > + Pick > ) { Object.assign(this, fields); } } -export interface GetShieldInformationBarrierSegmentsQueryParamsArg { +export interface GetShieldInformationBarrierSegmentsQueryParams { readonly shieldInformationBarrierId: string; readonly marker?: string; readonly limit?: number; } -export class GetShieldInformationBarrierSegmentsHeadersArg { +export class GetShieldInformationBarrierSegmentsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit + | Omit | Partial< - Pick + Pick > ) { Object.assign(this, fields); } } -export interface CreateShieldInformationBarrierSegmentRequestBodyArg { +export interface CreateShieldInformationBarrierSegmentRequestBody { readonly shieldInformationBarrier: ShieldInformationBarrierBase; readonly name: string; readonly description?: string; } -export class CreateShieldInformationBarrierSegmentHeadersArg { +export class CreateShieldInformationBarrierSegmentHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit + | Omit | Partial< - Pick + Pick > ) { Object.assign(this, fields); @@ -125,22 +113,25 @@ export class CreateShieldInformationBarrierSegmentHeadersArg { } export class ShieldInformationBarrierSegmentsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - ShieldInformationBarrierSegmentsManager, - | 'getShieldInformationBarrierSegmentById' - | 'updateShieldInformationBarrierSegmentById' - | 'deleteShieldInformationBarrierSegmentById' - | 'getShieldInformationBarrierSegments' - | 'createShieldInformationBarrierSegment' - > + fields: + | Omit< + ShieldInformationBarrierSegmentsManager, + | 'networkSession' + | 'getShieldInformationBarrierSegmentById' + | 'updateShieldInformationBarrierSegmentById' + | 'deleteShieldInformationBarrierSegmentById' + | 'getShieldInformationBarrierSegments' + | 'createShieldInformationBarrierSegment' + > + | Partial> ) { Object.assign(this, fields); } async getShieldInformationBarrierSegmentById( shieldInformationBarrierSegmentId: string, - headers: GetShieldInformationBarrierSegmentByIdHeadersArg = new GetShieldInformationBarrierSegmentByIdHeadersArg( + headers: GetShieldInformationBarrierSegmentByIdHeaders = new GetShieldInformationBarrierSegmentByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -150,7 +141,8 @@ export class ShieldInformationBarrierSegmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barrier_segments/', + this.networkSession.baseUrls.baseUrl, + '/shield_information_barrier_segments/', toString(shieldInformationBarrierSegmentId) as string ) as string, { @@ -166,8 +158,8 @@ export class ShieldInformationBarrierSegmentsManager { } async updateShieldInformationBarrierSegmentById( shieldInformationBarrierSegmentId: string, - requestBody: UpdateShieldInformationBarrierSegmentByIdRequestBodyArg = {} satisfies UpdateShieldInformationBarrierSegmentByIdRequestBodyArg, - headers: UpdateShieldInformationBarrierSegmentByIdHeadersArg = new UpdateShieldInformationBarrierSegmentByIdHeadersArg( + requestBody: UpdateShieldInformationBarrierSegmentByIdRequestBody = {} satisfies UpdateShieldInformationBarrierSegmentByIdRequestBody, + headers: UpdateShieldInformationBarrierSegmentByIdHeaders = new UpdateShieldInformationBarrierSegmentByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -177,13 +169,14 @@ export class ShieldInformationBarrierSegmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barrier_segments/', + this.networkSession.baseUrls.baseUrl, + '/shield_information_barrier_segments/', toString(shieldInformationBarrierSegmentId) as string ) as string, { method: 'PUT', headers: headersMap, - data: serializeUpdateShieldInformationBarrierSegmentByIdRequestBodyArg( + data: serializeUpdateShieldInformationBarrierSegmentByIdRequestBody( requestBody ), contentType: 'application/json', @@ -197,7 +190,7 @@ export class ShieldInformationBarrierSegmentsManager { } async deleteShieldInformationBarrierSegmentById( shieldInformationBarrierSegmentId: string, - headers: DeleteShieldInformationBarrierSegmentByIdHeadersArg = new DeleteShieldInformationBarrierSegmentByIdHeadersArg( + headers: DeleteShieldInformationBarrierSegmentByIdHeaders = new DeleteShieldInformationBarrierSegmentByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -207,7 +200,8 @@ export class ShieldInformationBarrierSegmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barrier_segments/', + this.networkSession.baseUrls.baseUrl, + '/shield_information_barrier_segments/', toString(shieldInformationBarrierSegmentId) as string ) as string, { @@ -222,8 +216,8 @@ export class ShieldInformationBarrierSegmentsManager { return void 0; } async getShieldInformationBarrierSegments( - queryParams: GetShieldInformationBarrierSegmentsQueryParamsArg, - headers: GetShieldInformationBarrierSegmentsHeadersArg = new GetShieldInformationBarrierSegmentsHeadersArg( + queryParams: GetShieldInformationBarrierSegmentsQueryParams, + headers: GetShieldInformationBarrierSegmentsHeaders = new GetShieldInformationBarrierSegmentsHeaders( {} ), cancellationToken?: CancellationToken @@ -242,7 +236,8 @@ export class ShieldInformationBarrierSegmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barrier_segments' + this.networkSession.baseUrls.baseUrl, + '/shield_information_barrier_segments' ) as string, { method: 'GET', @@ -257,8 +252,8 @@ export class ShieldInformationBarrierSegmentsManager { return deserializeShieldInformationBarrierSegments(response.data); } async createShieldInformationBarrierSegment( - requestBody: CreateShieldInformationBarrierSegmentRequestBodyArg, - headers: CreateShieldInformationBarrierSegmentHeadersArg = new CreateShieldInformationBarrierSegmentHeadersArg( + requestBody: CreateShieldInformationBarrierSegmentRequestBody, + headers: CreateShieldInformationBarrierSegmentHeaders = new CreateShieldInformationBarrierSegmentHeaders( {} ), cancellationToken?: CancellationToken @@ -268,12 +263,13 @@ export class ShieldInformationBarrierSegmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barrier_segments' + this.networkSession.baseUrls.baseUrl, + '/shield_information_barrier_segments' ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateShieldInformationBarrierSegmentRequestBodyArg( + data: serializeCreateShieldInformationBarrierSegmentRequestBody( requestBody ), contentType: 'application/json', @@ -286,27 +282,27 @@ export class ShieldInformationBarrierSegmentsManager { return deserializeShieldInformationBarrierSegment(response.data); } } -export function serializeUpdateShieldInformationBarrierSegmentByIdRequestBodyArg( - val: UpdateShieldInformationBarrierSegmentByIdRequestBodyArg +export function serializeUpdateShieldInformationBarrierSegmentByIdRequestBody( + val: UpdateShieldInformationBarrierSegmentByIdRequestBody ): SerializedData { return { ['name']: val.name == void 0 ? void 0 : val.name, ['description']: val.description == void 0 ? void 0 : val.description, }; } -export function deserializeUpdateShieldInformationBarrierSegmentByIdRequestBodyArg( +export function deserializeUpdateShieldInformationBarrierSegmentByIdRequestBody( val: any -): UpdateShieldInformationBarrierSegmentByIdRequestBodyArg { +): UpdateShieldInformationBarrierSegmentByIdRequestBody { const name: undefined | string = val.name == void 0 ? void 0 : val.name; const description: undefined | string = val.description == void 0 ? void 0 : val.description; return { name: name, description: description, - } satisfies UpdateShieldInformationBarrierSegmentByIdRequestBodyArg; + } satisfies UpdateShieldInformationBarrierSegmentByIdRequestBody; } -export function serializeCreateShieldInformationBarrierSegmentRequestBodyArg( - val: CreateShieldInformationBarrierSegmentRequestBodyArg +export function serializeCreateShieldInformationBarrierSegmentRequestBody( + val: CreateShieldInformationBarrierSegmentRequestBody ): SerializedData { return { ['shield_information_barrier']: serializeShieldInformationBarrierBase( @@ -316,9 +312,9 @@ export function serializeCreateShieldInformationBarrierSegmentRequestBodyArg( ['description']: val.description == void 0 ? void 0 : val.description, }; } -export function deserializeCreateShieldInformationBarrierSegmentRequestBodyArg( +export function deserializeCreateShieldInformationBarrierSegmentRequestBody( val: any -): CreateShieldInformationBarrierSegmentRequestBodyArg { +): CreateShieldInformationBarrierSegmentRequestBody { const shieldInformationBarrier: ShieldInformationBarrierBase = deserializeShieldInformationBarrierBase(val.shield_information_barrier); const name: string = val.name; @@ -328,5 +324,5 @@ export function deserializeCreateShieldInformationBarrierSegmentRequestBodyArg( shieldInformationBarrier: shieldInformationBarrier, name: name, description: description, - } satisfies CreateShieldInformationBarrierSegmentRequestBodyArg; + } satisfies CreateShieldInformationBarrierSegmentRequestBody; } diff --git a/src/managers/shieldInformationBarriers.generated.ts b/src/managers/shieldInformationBarriers.generated.ts index afd6aa36..ee1f184e 100644 --- a/src/managers/shieldInformationBarriers.generated.ts +++ b/src/managers/shieldInformationBarriers.generated.ts @@ -27,37 +27,35 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetShieldInformationBarrierByIdHeadersArg { +export class GetShieldInformationBarrierByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateShieldInformationBarrierChangeStatusRequestBodyArgStatusField = - 'pending' | 'disabled'; -export interface CreateShieldInformationBarrierChangeStatusRequestBodyArg { +export type CreateShieldInformationBarrierChangeStatusRequestBodyStatusField = + | 'pending' + | 'disabled'; +export interface CreateShieldInformationBarrierChangeStatusRequestBody { readonly id: string; - readonly status: CreateShieldInformationBarrierChangeStatusRequestBodyArgStatusField; + readonly status: CreateShieldInformationBarrierChangeStatusRequestBodyStatusField; } -export class CreateShieldInformationBarrierChangeStatusHeadersArg { +export class CreateShieldInformationBarrierChangeStatusHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit< - CreateShieldInformationBarrierChangeStatusHeadersArg, - 'extraHeaders' - > + | Omit | Partial< Pick< - CreateShieldInformationBarrierChangeStatusHeadersArg, + CreateShieldInformationBarrierChangeStatusHeaders, 'extraHeaders' > > @@ -65,54 +63,57 @@ export class CreateShieldInformationBarrierChangeStatusHeadersArg { Object.assign(this, fields); } } -export interface GetShieldInformationBarriersQueryParamsArg { +export interface GetShieldInformationBarriersQueryParams { readonly marker?: string; readonly limit?: number; } -export class GetShieldInformationBarriersHeadersArg { +export class GetShieldInformationBarriersHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface CreateShieldInformationBarrierRequestBodyArg { +export interface CreateShieldInformationBarrierRequestBody { readonly enterprise: EnterpriseBase; } -export class CreateShieldInformationBarrierHeadersArg { +export class CreateShieldInformationBarrierHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class ShieldInformationBarriersManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - ShieldInformationBarriersManager, - | 'getShieldInformationBarrierById' - | 'createShieldInformationBarrierChangeStatus' - | 'getShieldInformationBarriers' - | 'createShieldInformationBarrier' - > + fields: + | Omit< + ShieldInformationBarriersManager, + | 'networkSession' + | 'getShieldInformationBarrierById' + | 'createShieldInformationBarrierChangeStatus' + | 'getShieldInformationBarriers' + | 'createShieldInformationBarrier' + > + | Partial> ) { Object.assign(this, fields); } async getShieldInformationBarrierById( shieldInformationBarrierId: string, - headers: GetShieldInformationBarrierByIdHeadersArg = new GetShieldInformationBarrierByIdHeadersArg( + headers: GetShieldInformationBarrierByIdHeaders = new GetShieldInformationBarrierByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -122,7 +123,8 @@ export class ShieldInformationBarriersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barriers/', + this.networkSession.baseUrls.baseUrl, + '/shield_information_barriers/', toString(shieldInformationBarrierId) as string ) as string, { @@ -137,8 +139,8 @@ export class ShieldInformationBarriersManager { return deserializeShieldInformationBarrier(response.data); } async createShieldInformationBarrierChangeStatus( - requestBody: CreateShieldInformationBarrierChangeStatusRequestBodyArg, - headers: CreateShieldInformationBarrierChangeStatusHeadersArg = new CreateShieldInformationBarrierChangeStatusHeadersArg( + requestBody: CreateShieldInformationBarrierChangeStatusRequestBody, + headers: CreateShieldInformationBarrierChangeStatusHeaders = new CreateShieldInformationBarrierChangeStatusHeaders( {} ), cancellationToken?: CancellationToken @@ -148,12 +150,13 @@ export class ShieldInformationBarriersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barriers/change_status' + this.networkSession.baseUrls.baseUrl, + '/shield_information_barriers/change_status' ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateShieldInformationBarrierChangeStatusRequestBodyArg( + data: serializeCreateShieldInformationBarrierChangeStatusRequestBody( requestBody ), contentType: 'application/json', @@ -166,8 +169,8 @@ export class ShieldInformationBarriersManager { return deserializeShieldInformationBarrier(response.data); } async getShieldInformationBarriers( - queryParams: GetShieldInformationBarriersQueryParamsArg = {} satisfies GetShieldInformationBarriersQueryParamsArg, - headers: GetShieldInformationBarriersHeadersArg = new GetShieldInformationBarriersHeadersArg( + queryParams: GetShieldInformationBarriersQueryParams = {} satisfies GetShieldInformationBarriersQueryParams, + headers: GetShieldInformationBarriersHeaders = new GetShieldInformationBarriersHeaders( {} ), cancellationToken?: CancellationToken @@ -183,7 +186,8 @@ export class ShieldInformationBarriersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barriers' + this.networkSession.baseUrls.baseUrl, + '/shield_information_barriers' ) as string, { method: 'GET', @@ -198,8 +202,8 @@ export class ShieldInformationBarriersManager { return deserializeShieldInformationBarriers(response.data); } async createShieldInformationBarrier( - requestBody: CreateShieldInformationBarrierRequestBodyArg, - headers: CreateShieldInformationBarrierHeadersArg = new CreateShieldInformationBarrierHeadersArg( + requestBody: CreateShieldInformationBarrierRequestBody, + headers: CreateShieldInformationBarrierHeaders = new CreateShieldInformationBarrierHeaders( {} ), cancellationToken?: CancellationToken @@ -209,14 +213,13 @@ export class ShieldInformationBarriersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/shield_information_barriers' + this.networkSession.baseUrls.baseUrl, + '/shield_information_barriers' ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateShieldInformationBarrierRequestBodyArg( - requestBody - ), + data: serializeCreateShieldInformationBarrierRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -227,16 +230,16 @@ export class ShieldInformationBarriersManager { return deserializeShieldInformationBarrier(response.data); } } -export function serializeCreateShieldInformationBarrierChangeStatusRequestBodyArgStatusField( - val: CreateShieldInformationBarrierChangeStatusRequestBodyArgStatusField +export function serializeCreateShieldInformationBarrierChangeStatusRequestBodyStatusField( + val: CreateShieldInformationBarrierChangeStatusRequestBodyStatusField ): SerializedData { return val; } -export function deserializeCreateShieldInformationBarrierChangeStatusRequestBodyArgStatusField( +export function deserializeCreateShieldInformationBarrierChangeStatusRequestBodyStatusField( val: any -): CreateShieldInformationBarrierChangeStatusRequestBodyArgStatusField { +): CreateShieldInformationBarrierChangeStatusRequestBodyStatusField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateShieldInformationBarrierChangeStatusRequestBodyArgStatusField"'; + throw 'Expecting a string for "CreateShieldInformationBarrierChangeStatusRequestBodyStatusField"'; } if (val == 'pending') { return 'pending'; @@ -246,40 +249,40 @@ export function deserializeCreateShieldInformationBarrierChangeStatusRequestBody } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateShieldInformationBarrierChangeStatusRequestBodyArg( - val: CreateShieldInformationBarrierChangeStatusRequestBodyArg +export function serializeCreateShieldInformationBarrierChangeStatusRequestBody( + val: CreateShieldInformationBarrierChangeStatusRequestBody ): SerializedData { return { ['id']: val.id, ['status']: - serializeCreateShieldInformationBarrierChangeStatusRequestBodyArgStatusField( + serializeCreateShieldInformationBarrierChangeStatusRequestBodyStatusField( val.status ), }; } -export function deserializeCreateShieldInformationBarrierChangeStatusRequestBodyArg( +export function deserializeCreateShieldInformationBarrierChangeStatusRequestBody( val: any -): CreateShieldInformationBarrierChangeStatusRequestBodyArg { +): CreateShieldInformationBarrierChangeStatusRequestBody { const id: string = val.id; - const status: CreateShieldInformationBarrierChangeStatusRequestBodyArgStatusField = - deserializeCreateShieldInformationBarrierChangeStatusRequestBodyArgStatusField( + const status: CreateShieldInformationBarrierChangeStatusRequestBodyStatusField = + deserializeCreateShieldInformationBarrierChangeStatusRequestBodyStatusField( val.status ); return { id: id, status: status, - } satisfies CreateShieldInformationBarrierChangeStatusRequestBodyArg; + } satisfies CreateShieldInformationBarrierChangeStatusRequestBody; } -export function serializeCreateShieldInformationBarrierRequestBodyArg( - val: CreateShieldInformationBarrierRequestBodyArg +export function serializeCreateShieldInformationBarrierRequestBody( + val: CreateShieldInformationBarrierRequestBody ): SerializedData { return { ['enterprise']: serializeEnterpriseBase(val.enterprise) }; } -export function deserializeCreateShieldInformationBarrierRequestBodyArg( +export function deserializeCreateShieldInformationBarrierRequestBody( val: any -): CreateShieldInformationBarrierRequestBodyArg { +): CreateShieldInformationBarrierRequestBody { const enterprise: EnterpriseBase = deserializeEnterpriseBase(val.enterprise); return { enterprise: enterprise, - } satisfies CreateShieldInformationBarrierRequestBodyArg; + } satisfies CreateShieldInformationBarrierRequestBody; } diff --git a/src/managers/signRequests.generated.ts b/src/managers/signRequests.generated.ts index 92904af3..ae59e525 100644 --- a/src/managers/signRequests.generated.ts +++ b/src/managers/signRequests.generated.ts @@ -27,88 +27,91 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class CancelSignRequestHeadersArg { +export class CancelSignRequestHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class ResendSignRequestHeadersArg { +export class ResendSignRequestHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class GetSignRequestByIdHeadersArg { +export class GetSignRequestByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetSignRequestsQueryParamsArg { +export interface GetSignRequestsQueryParams { readonly marker?: string; readonly limit?: number; } -export class GetSignRequestsHeadersArg { +export class GetSignRequestsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class CreateSignRequestHeadersArg { +export class CreateSignRequestHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class SignRequestsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - SignRequestsManager, - | 'cancelSignRequest' - | 'resendSignRequest' - | 'getSignRequestById' - | 'getSignRequests' - | 'createSignRequest' - > + fields: + | Omit< + SignRequestsManager, + | 'networkSession' + | 'cancelSignRequest' + | 'resendSignRequest' + | 'getSignRequestById' + | 'getSignRequests' + | 'createSignRequest' + > + | Partial> ) { Object.assign(this, fields); } async cancelSignRequest( signRequestId: string, - headers: CancelSignRequestHeadersArg = new CancelSignRequestHeadersArg({}), + headers: CancelSignRequestHeaders = new CancelSignRequestHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -116,7 +119,8 @@ export class SignRequestsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/sign_requests/', + this.networkSession.baseUrls.baseUrl, + '/sign_requests/', toString(signRequestId) as string, '/cancel' ) as string, @@ -133,7 +137,7 @@ export class SignRequestsManager { } async resendSignRequest( signRequestId: string, - headers: ResendSignRequestHeadersArg = new ResendSignRequestHeadersArg({}), + headers: ResendSignRequestHeaders = new ResendSignRequestHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -141,7 +145,8 @@ export class SignRequestsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/sign_requests/', + this.networkSession.baseUrls.baseUrl, + '/sign_requests/', toString(signRequestId) as string, '/resend' ) as string, @@ -158,9 +163,7 @@ export class SignRequestsManager { } async getSignRequestById( signRequestId: string, - headers: GetSignRequestByIdHeadersArg = new GetSignRequestByIdHeadersArg( - {} - ), + headers: GetSignRequestByIdHeaders = new GetSignRequestByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -168,7 +171,8 @@ export class SignRequestsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/sign_requests/', + this.networkSession.baseUrls.baseUrl, + '/sign_requests/', toString(signRequestId) as string ) as string, { @@ -183,8 +187,8 @@ export class SignRequestsManager { return deserializeSignRequest(response.data); } async getSignRequests( - queryParams: GetSignRequestsQueryParamsArg = {} satisfies GetSignRequestsQueryParamsArg, - headers: GetSignRequestsHeadersArg = new GetSignRequestsHeadersArg({}), + queryParams: GetSignRequestsQueryParams = {} satisfies GetSignRequestsQueryParams, + headers: GetSignRequestsHeaders = new GetSignRequestsHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -197,7 +201,10 @@ export class SignRequestsManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/sign_requests') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/sign_requests' + ) as string, { method: 'GET', params: queryParamsMap, @@ -212,14 +219,17 @@ export class SignRequestsManager { } async createSignRequest( requestBody: SignRequestCreateRequest, - headers: CreateSignRequestHeadersArg = new CreateSignRequestHeadersArg({}), + headers: CreateSignRequestHeaders = new CreateSignRequestHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/sign_requests') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/sign_requests' + ) as string, { method: 'POST', headers: headersMap, diff --git a/src/managers/signTemplates.generated.ts b/src/managers/signTemplates.generated.ts index d0108073..51d712e4 100644 --- a/src/managers/signTemplates.generated.ts +++ b/src/managers/signTemplates.generated.ts @@ -24,48 +24,50 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetSignTemplatesQueryParamsArg { +export interface GetSignTemplatesQueryParams { readonly marker?: string; readonly limit?: number; } -export class GetSignTemplatesHeadersArg { +export class GetSignTemplatesHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class GetSignTemplateByIdHeadersArg { +export class GetSignTemplateByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class SignTemplatesManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - SignTemplatesManager, - 'getSignTemplates' | 'getSignTemplateById' - > + fields: + | Omit< + SignTemplatesManager, + 'networkSession' | 'getSignTemplates' | 'getSignTemplateById' + > + | Partial> ) { Object.assign(this, fields); } async getSignTemplates( - queryParams: GetSignTemplatesQueryParamsArg = {} satisfies GetSignTemplatesQueryParamsArg, - headers: GetSignTemplatesHeadersArg = new GetSignTemplatesHeadersArg({}), + queryParams: GetSignTemplatesQueryParams = {} satisfies GetSignTemplatesQueryParams, + headers: GetSignTemplatesHeaders = new GetSignTemplatesHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -78,7 +80,10 @@ export class SignTemplatesManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/sign_templates') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/sign_templates' + ) as string, { method: 'GET', params: queryParamsMap, @@ -93,9 +98,7 @@ export class SignTemplatesManager { } async getSignTemplateById( templateId: string, - headers: GetSignTemplateByIdHeadersArg = new GetSignTemplateByIdHeadersArg( - {} - ), + headers: GetSignTemplateByIdHeaders = new GetSignTemplateByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -103,7 +106,8 @@ export class SignTemplatesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/sign_templates/', + this.networkSession.baseUrls.baseUrl, + '/sign_templates/', toString(templateId) as string ) as string, { diff --git a/src/managers/skills.generated.ts b/src/managers/skills.generated.ts index 9fc47f77..e37c5f5a 100644 --- a/src/managers/skills.generated.ts +++ b/src/managers/skills.generated.ts @@ -24,133 +24,135 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetFileMetadataGlobalBoxSkillsCardsHeadersArg { +export class GetFileMetadataGlobalBoxSkillsCardsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit + | Omit | Partial< - Pick + Pick > ) { Object.assign(this, fields); } } -export interface CreateFileMetadataGlobalBoxSkillsCardRequestBodyArg { +export interface CreateFileMetadataGlobalBoxSkillsCardRequestBody { readonly cards: readonly KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard[]; } -export class CreateFileMetadataGlobalBoxSkillsCardHeadersArg { +export class CreateFileMetadataGlobalBoxSkillsCardHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit + | Omit | Partial< - Pick + Pick > ) { Object.assign(this, fields); } } -export type UpdateFileMetadataGlobalBoxSkillsCardRequestBodyArgOpField = - 'replace'; -export interface UpdateFileMetadataGlobalBoxSkillsCardRequestBodyArg { - readonly op?: UpdateFileMetadataGlobalBoxSkillsCardRequestBodyArgOpField; +export type UpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField = 'replace'; +export interface UpdateFileMetadataGlobalBoxSkillsCardRequestBody { + readonly op?: UpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField; readonly path?: string; readonly value?: KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard; } -export class UpdateFileMetadataGlobalBoxSkillsCardHeadersArg { +export class UpdateFileMetadataGlobalBoxSkillsCardHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit + | Omit | Partial< - Pick + Pick > ) { Object.assign(this, fields); } } -export class DeleteFileMetadataGlobalBoxSkillsCardHeadersArg { +export class DeleteFileMetadataGlobalBoxSkillsCardHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit + | Omit | Partial< - Pick + Pick > ) { Object.assign(this, fields); } } -export type UpdateSkillInvocationByIdRequestBodyArgStatusField = +export type UpdateSkillInvocationByIdRequestBodyStatusField = | 'invoked' | 'processing' | 'success' | 'transient_failure' | 'permanent_failure'; -export interface UpdateSkillInvocationByIdRequestBodyArgMetadataField { +export interface UpdateSkillInvocationByIdRequestBodyMetadataField { readonly cards?: readonly KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard[]; } -export type UpdateSkillInvocationByIdRequestBodyArgFileFieldTypeField = 'file'; -export interface UpdateSkillInvocationByIdRequestBodyArgFileField { - readonly type?: UpdateSkillInvocationByIdRequestBodyArgFileFieldTypeField; +export type UpdateSkillInvocationByIdRequestBodyFileTypeField = 'file'; +export interface UpdateSkillInvocationByIdRequestBodyFileField { + readonly type?: UpdateSkillInvocationByIdRequestBodyFileTypeField; readonly id?: string; } -export type UpdateSkillInvocationByIdRequestBodyArgFileVersionFieldTypeField = +export type UpdateSkillInvocationByIdRequestBodyFileVersionTypeField = 'file_version'; -export interface UpdateSkillInvocationByIdRequestBodyArgFileVersionField { - readonly type?: UpdateSkillInvocationByIdRequestBodyArgFileVersionFieldTypeField; +export interface UpdateSkillInvocationByIdRequestBodyFileVersionField { + readonly type?: UpdateSkillInvocationByIdRequestBodyFileVersionTypeField; readonly id?: string; } -export interface UpdateSkillInvocationByIdRequestBodyArgUsageField { +export interface UpdateSkillInvocationByIdRequestBodyUsageField { readonly unit?: string; readonly value?: number; } -export interface UpdateSkillInvocationByIdRequestBodyArg { - readonly status: UpdateSkillInvocationByIdRequestBodyArgStatusField; - readonly metadata: UpdateSkillInvocationByIdRequestBodyArgMetadataField; - readonly file: UpdateSkillInvocationByIdRequestBodyArgFileField; - readonly fileVersion?: UpdateSkillInvocationByIdRequestBodyArgFileVersionField; - readonly usage?: UpdateSkillInvocationByIdRequestBodyArgUsageField; +export interface UpdateSkillInvocationByIdRequestBody { + readonly status: UpdateSkillInvocationByIdRequestBodyStatusField; + readonly metadata: UpdateSkillInvocationByIdRequestBodyMetadataField; + readonly file: UpdateSkillInvocationByIdRequestBodyFileField; + readonly fileVersion?: UpdateSkillInvocationByIdRequestBodyFileVersionField; + readonly usage?: UpdateSkillInvocationByIdRequestBodyUsageField; } -export class UpdateSkillInvocationByIdHeadersArg { +export class UpdateSkillInvocationByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class SkillsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - SkillsManager, - | 'getFileMetadataGlobalBoxSkillsCards' - | 'createFileMetadataGlobalBoxSkillsCard' - | 'updateFileMetadataGlobalBoxSkillsCard' - | 'deleteFileMetadataGlobalBoxSkillsCard' - | 'updateSkillInvocationById' - > + fields: + | Omit< + SkillsManager, + | 'networkSession' + | 'getFileMetadataGlobalBoxSkillsCards' + | 'createFileMetadataGlobalBoxSkillsCard' + | 'updateFileMetadataGlobalBoxSkillsCard' + | 'deleteFileMetadataGlobalBoxSkillsCard' + | 'updateSkillInvocationById' + > + | Partial> ) { Object.assign(this, fields); } async getFileMetadataGlobalBoxSkillsCards( fileId: string, - headers: GetFileMetadataGlobalBoxSkillsCardsHeadersArg = new GetFileMetadataGlobalBoxSkillsCardsHeadersArg( + headers: GetFileMetadataGlobalBoxSkillsCardsHeaders = new GetFileMetadataGlobalBoxSkillsCardsHeaders( {} ), cancellationToken?: CancellationToken @@ -160,7 +162,8 @@ export class SkillsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/metadata/global/boxSkillsCards' ) as string, @@ -177,8 +180,8 @@ export class SkillsManager { } async createFileMetadataGlobalBoxSkillsCard( fileId: string, - requestBody: CreateFileMetadataGlobalBoxSkillsCardRequestBodyArg, - headers: CreateFileMetadataGlobalBoxSkillsCardHeadersArg = new CreateFileMetadataGlobalBoxSkillsCardHeadersArg( + requestBody: CreateFileMetadataGlobalBoxSkillsCardRequestBody, + headers: CreateFileMetadataGlobalBoxSkillsCardHeaders = new CreateFileMetadataGlobalBoxSkillsCardHeaders( {} ), cancellationToken?: CancellationToken @@ -188,14 +191,15 @@ export class SkillsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/metadata/global/boxSkillsCards' ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateFileMetadataGlobalBoxSkillsCardRequestBodyArg( + data: serializeCreateFileMetadataGlobalBoxSkillsCardRequestBody( requestBody ), contentType: 'application/json', @@ -209,8 +213,8 @@ export class SkillsManager { } async updateFileMetadataGlobalBoxSkillsCard( fileId: string, - requestBody: readonly UpdateFileMetadataGlobalBoxSkillsCardRequestBodyArg[], - headers: UpdateFileMetadataGlobalBoxSkillsCardHeadersArg = new UpdateFileMetadataGlobalBoxSkillsCardHeadersArg( + requestBody: readonly UpdateFileMetadataGlobalBoxSkillsCardRequestBody[], + headers: UpdateFileMetadataGlobalBoxSkillsCardHeaders = new UpdateFileMetadataGlobalBoxSkillsCardHeaders( {} ), cancellationToken?: CancellationToken @@ -220,7 +224,8 @@ export class SkillsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/metadata/global/boxSkillsCards' ) as string, @@ -228,7 +233,7 @@ export class SkillsManager { method: 'PUT', headers: headersMap, data: requestBody.map( - serializeUpdateFileMetadataGlobalBoxSkillsCardRequestBodyArg + serializeUpdateFileMetadataGlobalBoxSkillsCardRequestBody ) as readonly any[], contentType: 'application/json-patch+json', responseFormat: 'json', @@ -241,7 +246,7 @@ export class SkillsManager { } async deleteFileMetadataGlobalBoxSkillsCard( fileId: string, - headers: DeleteFileMetadataGlobalBoxSkillsCardHeadersArg = new DeleteFileMetadataGlobalBoxSkillsCardHeadersArg( + headers: DeleteFileMetadataGlobalBoxSkillsCardHeaders = new DeleteFileMetadataGlobalBoxSkillsCardHeaders( {} ), cancellationToken?: CancellationToken @@ -251,7 +256,8 @@ export class SkillsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/metadata/global/boxSkillsCards' ) as string, @@ -268,8 +274,8 @@ export class SkillsManager { } async updateSkillInvocationById( skillId: string, - requestBody: UpdateSkillInvocationByIdRequestBodyArg, - headers: UpdateSkillInvocationByIdHeadersArg = new UpdateSkillInvocationByIdHeadersArg( + requestBody: UpdateSkillInvocationByIdRequestBody, + headers: UpdateSkillInvocationByIdHeaders = new UpdateSkillInvocationByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -279,13 +285,14 @@ export class SkillsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/skill_invocations/', + this.networkSession.baseUrls.baseUrl, + '/skill_invocations/', toString(skillId) as string ) as string, { method: 'PUT', headers: headersMap, - data: serializeUpdateSkillInvocationByIdRequestBodyArg(requestBody), + data: serializeUpdateSkillInvocationByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: void 0, auth: this.auth, @@ -296,8 +303,8 @@ export class SkillsManager { return void 0; } } -export function serializeCreateFileMetadataGlobalBoxSkillsCardRequestBodyArg( - val: CreateFileMetadataGlobalBoxSkillsCardRequestBodyArg +export function serializeCreateFileMetadataGlobalBoxSkillsCardRequestBody( + val: CreateFileMetadataGlobalBoxSkillsCardRequestBody ): SerializedData { return { ['cards']: val.cards.map(function ( @@ -309,9 +316,9 @@ export function serializeCreateFileMetadataGlobalBoxSkillsCardRequestBodyArg( }) as readonly any[], }; } -export function deserializeCreateFileMetadataGlobalBoxSkillsCardRequestBodyArg( +export function deserializeCreateFileMetadataGlobalBoxSkillsCardRequestBody( val: any -): CreateFileMetadataGlobalBoxSkillsCardRequestBodyArg { +): CreateFileMetadataGlobalBoxSkillsCardRequestBody { const cards: readonly KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard[] = sdIsList(val.cards) ? (val.cards.map(function (itm: SerializedData): any { @@ -322,32 +329,32 @@ export function deserializeCreateFileMetadataGlobalBoxSkillsCardRequestBodyArg( : []; return { cards: cards, - } satisfies CreateFileMetadataGlobalBoxSkillsCardRequestBodyArg; + } satisfies CreateFileMetadataGlobalBoxSkillsCardRequestBody; } -export function serializeUpdateFileMetadataGlobalBoxSkillsCardRequestBodyArgOpField( - val: UpdateFileMetadataGlobalBoxSkillsCardRequestBodyArgOpField +export function serializeUpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField( + val: UpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField ): SerializedData { return val; } -export function deserializeUpdateFileMetadataGlobalBoxSkillsCardRequestBodyArgOpField( +export function deserializeUpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField( val: any -): UpdateFileMetadataGlobalBoxSkillsCardRequestBodyArgOpField { +): UpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFileMetadataGlobalBoxSkillsCardRequestBodyArgOpField"'; + throw 'Expecting a string for "UpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField"'; } if (val == 'replace') { return 'replace'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFileMetadataGlobalBoxSkillsCardRequestBodyArg( - val: UpdateFileMetadataGlobalBoxSkillsCardRequestBodyArg +export function serializeUpdateFileMetadataGlobalBoxSkillsCardRequestBody( + val: UpdateFileMetadataGlobalBoxSkillsCardRequestBody ): SerializedData { return { ['op']: val.op == void 0 ? void 0 - : serializeUpdateFileMetadataGlobalBoxSkillsCardRequestBodyArgOpField( + : serializeUpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField( val.op ), ['path']: val.path == void 0 ? void 0 : val.path, @@ -359,15 +366,15 @@ export function serializeUpdateFileMetadataGlobalBoxSkillsCardRequestBodyArg( ), }; } -export function deserializeUpdateFileMetadataGlobalBoxSkillsCardRequestBodyArg( +export function deserializeUpdateFileMetadataGlobalBoxSkillsCardRequestBody( val: any -): UpdateFileMetadataGlobalBoxSkillsCardRequestBodyArg { +): UpdateFileMetadataGlobalBoxSkillsCardRequestBody { const op: | undefined - | UpdateFileMetadataGlobalBoxSkillsCardRequestBodyArgOpField = + | UpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField = val.op == void 0 ? void 0 - : deserializeUpdateFileMetadataGlobalBoxSkillsCardRequestBodyArgOpField( + : deserializeUpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField( val.op ); const path: undefined | string = val.path == void 0 ? void 0 : val.path; @@ -383,18 +390,18 @@ export function deserializeUpdateFileMetadataGlobalBoxSkillsCardRequestBodyArg( op: op, path: path, value: value, - } satisfies UpdateFileMetadataGlobalBoxSkillsCardRequestBodyArg; + } satisfies UpdateFileMetadataGlobalBoxSkillsCardRequestBody; } -export function serializeUpdateSkillInvocationByIdRequestBodyArgStatusField( - val: UpdateSkillInvocationByIdRequestBodyArgStatusField +export function serializeUpdateSkillInvocationByIdRequestBodyStatusField( + val: UpdateSkillInvocationByIdRequestBodyStatusField ): SerializedData { return val; } -export function deserializeUpdateSkillInvocationByIdRequestBodyArgStatusField( +export function deserializeUpdateSkillInvocationByIdRequestBodyStatusField( val: any -): UpdateSkillInvocationByIdRequestBodyArgStatusField { +): UpdateSkillInvocationByIdRequestBodyStatusField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateSkillInvocationByIdRequestBodyArgStatusField"'; + throw 'Expecting a string for "UpdateSkillInvocationByIdRequestBodyStatusField"'; } if (val == 'invoked') { return 'invoked'; @@ -413,8 +420,8 @@ export function deserializeUpdateSkillInvocationByIdRequestBodyArgStatusField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateSkillInvocationByIdRequestBodyArgMetadataField( - val: UpdateSkillInvocationByIdRequestBodyArgMetadataField +export function serializeUpdateSkillInvocationByIdRequestBodyMetadataField( + val: UpdateSkillInvocationByIdRequestBodyMetadataField ): SerializedData { return { ['cards']: @@ -429,9 +436,9 @@ export function serializeUpdateSkillInvocationByIdRequestBodyArgMetadataField( }) as readonly any[]), }; } -export function deserializeUpdateSkillInvocationByIdRequestBodyArgMetadataField( +export function deserializeUpdateSkillInvocationByIdRequestBodyMetadataField( val: any -): UpdateSkillInvocationByIdRequestBodyArgMetadataField { +): UpdateSkillInvocationByIdRequestBodyMetadataField { const cards: | undefined | readonly KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard[] = @@ -446,171 +453,161 @@ export function deserializeUpdateSkillInvocationByIdRequestBodyArgMetadataField( : []; return { cards: cards, - } satisfies UpdateSkillInvocationByIdRequestBodyArgMetadataField; + } satisfies UpdateSkillInvocationByIdRequestBodyMetadataField; } -export function serializeUpdateSkillInvocationByIdRequestBodyArgFileFieldTypeField( - val: UpdateSkillInvocationByIdRequestBodyArgFileFieldTypeField +export function serializeUpdateSkillInvocationByIdRequestBodyFileTypeField( + val: UpdateSkillInvocationByIdRequestBodyFileTypeField ): SerializedData { return val; } -export function deserializeUpdateSkillInvocationByIdRequestBodyArgFileFieldTypeField( +export function deserializeUpdateSkillInvocationByIdRequestBodyFileTypeField( val: any -): UpdateSkillInvocationByIdRequestBodyArgFileFieldTypeField { +): UpdateSkillInvocationByIdRequestBodyFileTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateSkillInvocationByIdRequestBodyArgFileFieldTypeField"'; + throw 'Expecting a string for "UpdateSkillInvocationByIdRequestBodyFileTypeField"'; } if (val == 'file') { return 'file'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateSkillInvocationByIdRequestBodyArgFileField( - val: UpdateSkillInvocationByIdRequestBodyArgFileField +export function serializeUpdateSkillInvocationByIdRequestBodyFileField( + val: UpdateSkillInvocationByIdRequestBodyFileField ): SerializedData { return { ['type']: val.type == void 0 ? void 0 - : serializeUpdateSkillInvocationByIdRequestBodyArgFileFieldTypeField( - val.type - ), + : serializeUpdateSkillInvocationByIdRequestBodyFileTypeField(val.type), ['id']: val.id == void 0 ? void 0 : val.id, }; } -export function deserializeUpdateSkillInvocationByIdRequestBodyArgFileField( +export function deserializeUpdateSkillInvocationByIdRequestBodyFileField( val: any -): UpdateSkillInvocationByIdRequestBodyArgFileField { - const type: - | undefined - | UpdateSkillInvocationByIdRequestBodyArgFileFieldTypeField = +): UpdateSkillInvocationByIdRequestBodyFileField { + const type: undefined | UpdateSkillInvocationByIdRequestBodyFileTypeField = val.type == void 0 ? void 0 - : deserializeUpdateSkillInvocationByIdRequestBodyArgFileFieldTypeField( - val.type - ); + : deserializeUpdateSkillInvocationByIdRequestBodyFileTypeField(val.type); const id: undefined | string = val.id == void 0 ? void 0 : val.id; return { type: type, id: id, - } satisfies UpdateSkillInvocationByIdRequestBodyArgFileField; + } satisfies UpdateSkillInvocationByIdRequestBodyFileField; } -export function serializeUpdateSkillInvocationByIdRequestBodyArgFileVersionFieldTypeField( - val: UpdateSkillInvocationByIdRequestBodyArgFileVersionFieldTypeField +export function serializeUpdateSkillInvocationByIdRequestBodyFileVersionTypeField( + val: UpdateSkillInvocationByIdRequestBodyFileVersionTypeField ): SerializedData { return val; } -export function deserializeUpdateSkillInvocationByIdRequestBodyArgFileVersionFieldTypeField( +export function deserializeUpdateSkillInvocationByIdRequestBodyFileVersionTypeField( val: any -): UpdateSkillInvocationByIdRequestBodyArgFileVersionFieldTypeField { +): UpdateSkillInvocationByIdRequestBodyFileVersionTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateSkillInvocationByIdRequestBodyArgFileVersionFieldTypeField"'; + throw 'Expecting a string for "UpdateSkillInvocationByIdRequestBodyFileVersionTypeField"'; } if (val == 'file_version') { return 'file_version'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateSkillInvocationByIdRequestBodyArgFileVersionField( - val: UpdateSkillInvocationByIdRequestBodyArgFileVersionField +export function serializeUpdateSkillInvocationByIdRequestBodyFileVersionField( + val: UpdateSkillInvocationByIdRequestBodyFileVersionField ): SerializedData { return { ['type']: val.type == void 0 ? void 0 - : serializeUpdateSkillInvocationByIdRequestBodyArgFileVersionFieldTypeField( + : serializeUpdateSkillInvocationByIdRequestBodyFileVersionTypeField( val.type ), ['id']: val.id == void 0 ? void 0 : val.id, }; } -export function deserializeUpdateSkillInvocationByIdRequestBodyArgFileVersionField( +export function deserializeUpdateSkillInvocationByIdRequestBodyFileVersionField( val: any -): UpdateSkillInvocationByIdRequestBodyArgFileVersionField { +): UpdateSkillInvocationByIdRequestBodyFileVersionField { const type: | undefined - | UpdateSkillInvocationByIdRequestBodyArgFileVersionFieldTypeField = + | UpdateSkillInvocationByIdRequestBodyFileVersionTypeField = val.type == void 0 ? void 0 - : deserializeUpdateSkillInvocationByIdRequestBodyArgFileVersionFieldTypeField( + : deserializeUpdateSkillInvocationByIdRequestBodyFileVersionTypeField( val.type ); const id: undefined | string = val.id == void 0 ? void 0 : val.id; return { type: type, id: id, - } satisfies UpdateSkillInvocationByIdRequestBodyArgFileVersionField; + } satisfies UpdateSkillInvocationByIdRequestBodyFileVersionField; } -export function serializeUpdateSkillInvocationByIdRequestBodyArgUsageField( - val: UpdateSkillInvocationByIdRequestBodyArgUsageField +export function serializeUpdateSkillInvocationByIdRequestBodyUsageField( + val: UpdateSkillInvocationByIdRequestBodyUsageField ): SerializedData { return { ['unit']: val.unit == void 0 ? void 0 : val.unit, ['value']: val.value == void 0 ? void 0 : val.value, }; } -export function deserializeUpdateSkillInvocationByIdRequestBodyArgUsageField( +export function deserializeUpdateSkillInvocationByIdRequestBodyUsageField( val: any -): UpdateSkillInvocationByIdRequestBodyArgUsageField { +): UpdateSkillInvocationByIdRequestBodyUsageField { const unit: undefined | string = val.unit == void 0 ? void 0 : val.unit; const value: undefined | number = val.value == void 0 ? void 0 : val.value; return { unit: unit, value: value, - } satisfies UpdateSkillInvocationByIdRequestBodyArgUsageField; + } satisfies UpdateSkillInvocationByIdRequestBodyUsageField; } -export function serializeUpdateSkillInvocationByIdRequestBodyArg( - val: UpdateSkillInvocationByIdRequestBodyArg +export function serializeUpdateSkillInvocationByIdRequestBody( + val: UpdateSkillInvocationByIdRequestBody ): SerializedData { return { - ['status']: serializeUpdateSkillInvocationByIdRequestBodyArgStatusField( + ['status']: serializeUpdateSkillInvocationByIdRequestBodyStatusField( val.status ), - ['metadata']: serializeUpdateSkillInvocationByIdRequestBodyArgMetadataField( + ['metadata']: serializeUpdateSkillInvocationByIdRequestBodyMetadataField( val.metadata ), - ['file']: serializeUpdateSkillInvocationByIdRequestBodyArgFileField( - val.file - ), + ['file']: serializeUpdateSkillInvocationByIdRequestBodyFileField(val.file), ['file_version']: val.fileVersion == void 0 ? void 0 - : serializeUpdateSkillInvocationByIdRequestBodyArgFileVersionField( + : serializeUpdateSkillInvocationByIdRequestBodyFileVersionField( val.fileVersion ), ['usage']: val.usage == void 0 ? void 0 - : serializeUpdateSkillInvocationByIdRequestBodyArgUsageField(val.usage), + : serializeUpdateSkillInvocationByIdRequestBodyUsageField(val.usage), }; } -export function deserializeUpdateSkillInvocationByIdRequestBodyArg( +export function deserializeUpdateSkillInvocationByIdRequestBody( val: any -): UpdateSkillInvocationByIdRequestBodyArg { - const status: UpdateSkillInvocationByIdRequestBodyArgStatusField = - deserializeUpdateSkillInvocationByIdRequestBodyArgStatusField(val.status); - const metadata: UpdateSkillInvocationByIdRequestBodyArgMetadataField = - deserializeUpdateSkillInvocationByIdRequestBodyArgMetadataField( - val.metadata - ); - const file: UpdateSkillInvocationByIdRequestBodyArgFileField = - deserializeUpdateSkillInvocationByIdRequestBodyArgFileField(val.file); +): UpdateSkillInvocationByIdRequestBody { + const status: UpdateSkillInvocationByIdRequestBodyStatusField = + deserializeUpdateSkillInvocationByIdRequestBodyStatusField(val.status); + const metadata: UpdateSkillInvocationByIdRequestBodyMetadataField = + deserializeUpdateSkillInvocationByIdRequestBodyMetadataField(val.metadata); + const file: UpdateSkillInvocationByIdRequestBodyFileField = + deserializeUpdateSkillInvocationByIdRequestBodyFileField(val.file); const fileVersion: | undefined - | UpdateSkillInvocationByIdRequestBodyArgFileVersionField = + | UpdateSkillInvocationByIdRequestBodyFileVersionField = val.file_version == void 0 ? void 0 - : deserializeUpdateSkillInvocationByIdRequestBodyArgFileVersionField( + : deserializeUpdateSkillInvocationByIdRequestBodyFileVersionField( val.file_version ); - const usage: undefined | UpdateSkillInvocationByIdRequestBodyArgUsageField = + const usage: undefined | UpdateSkillInvocationByIdRequestBodyUsageField = val.usage == void 0 ? void 0 - : deserializeUpdateSkillInvocationByIdRequestBodyArgUsageField(val.usage); + : deserializeUpdateSkillInvocationByIdRequestBodyUsageField(val.usage); return { status: status, metadata: metadata, file: file, fileVersion: fileVersion, usage: usage, - } satisfies UpdateSkillInvocationByIdRequestBodyArg; + } satisfies UpdateSkillInvocationByIdRequestBody; } diff --git a/src/managers/storagePolicies.generated.ts b/src/managers/storagePolicies.generated.ts index 87b0a80c..b01e00af 100644 --- a/src/managers/storagePolicies.generated.ts +++ b/src/managers/storagePolicies.generated.ts @@ -24,51 +24,51 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetStoragePoliciesQueryParamsArg { +export interface GetStoragePoliciesQueryParams { readonly fields?: readonly string[]; readonly marker?: string; readonly limit?: number; } -export class GetStoragePoliciesHeadersArg { +export class GetStoragePoliciesHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class GetStoragePolicyByIdHeadersArg { +export class GetStoragePolicyByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class StoragePoliciesManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - StoragePoliciesManager, - 'getStoragePolicies' | 'getStoragePolicyById' - > + fields: + | Omit< + StoragePoliciesManager, + 'networkSession' | 'getStoragePolicies' | 'getStoragePolicyById' + > + | Partial> ) { Object.assign(this, fields); } async getStoragePolicies( - queryParams: GetStoragePoliciesQueryParamsArg = {} satisfies GetStoragePoliciesQueryParamsArg, - headers: GetStoragePoliciesHeadersArg = new GetStoragePoliciesHeadersArg( - {} - ), + queryParams: GetStoragePoliciesQueryParams = {} satisfies GetStoragePoliciesQueryParams, + headers: GetStoragePoliciesHeaders = new GetStoragePoliciesHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -84,7 +84,10 @@ export class StoragePoliciesManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/storage_policies') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/storage_policies' + ) as string, { method: 'GET', params: queryParamsMap, @@ -99,9 +102,7 @@ export class StoragePoliciesManager { } async getStoragePolicyById( storagePolicyId: string, - headers: GetStoragePolicyByIdHeadersArg = new GetStoragePolicyByIdHeadersArg( - {} - ), + headers: GetStoragePolicyByIdHeaders = new GetStoragePolicyByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -109,7 +110,8 @@ export class StoragePoliciesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/storage_policies/', + this.networkSession.baseUrls.baseUrl, + '/storage_policies/', toString(storagePolicyId) as string ) as string, { diff --git a/src/managers/storagePolicyAssignments.generated.ts b/src/managers/storagePolicyAssignments.generated.ts index ed63919b..06c29452 100644 --- a/src/managers/storagePolicyAssignments.generated.ts +++ b/src/managers/storagePolicyAssignments.generated.ts @@ -24,121 +24,121 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export type GetStoragePolicyAssignmentsQueryParamsArgResolvedForTypeField = +export type GetStoragePolicyAssignmentsQueryParamsResolvedForTypeField = | 'user' | 'enterprise'; -export interface GetStoragePolicyAssignmentsQueryParamsArg { +export interface GetStoragePolicyAssignmentsQueryParams { readonly marker?: string; - readonly resolvedForType: GetStoragePolicyAssignmentsQueryParamsArgResolvedForTypeField; + readonly resolvedForType: GetStoragePolicyAssignmentsQueryParamsResolvedForTypeField; readonly resolvedForId: string; } -export class GetStoragePolicyAssignmentsHeadersArg { +export class GetStoragePolicyAssignmentsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateStoragePolicyAssignmentRequestBodyArgStoragePolicyFieldTypeField = +export type CreateStoragePolicyAssignmentRequestBodyStoragePolicyTypeField = 'storage_policy'; -export interface CreateStoragePolicyAssignmentRequestBodyArgStoragePolicyField { - readonly type: CreateStoragePolicyAssignmentRequestBodyArgStoragePolicyFieldTypeField; +export interface CreateStoragePolicyAssignmentRequestBodyStoragePolicyField { + readonly type: CreateStoragePolicyAssignmentRequestBodyStoragePolicyTypeField; readonly id: string; } -export type CreateStoragePolicyAssignmentRequestBodyArgAssignedToFieldTypeField = - 'user' | 'enterprise'; -export interface CreateStoragePolicyAssignmentRequestBodyArgAssignedToField { - readonly type: CreateStoragePolicyAssignmentRequestBodyArgAssignedToFieldTypeField; +export type CreateStoragePolicyAssignmentRequestBodyAssignedToTypeField = + | 'user' + | 'enterprise'; +export interface CreateStoragePolicyAssignmentRequestBodyAssignedToField { + readonly type: CreateStoragePolicyAssignmentRequestBodyAssignedToTypeField; readonly id: string; } -export interface CreateStoragePolicyAssignmentRequestBodyArg { - readonly storagePolicy: CreateStoragePolicyAssignmentRequestBodyArgStoragePolicyField; - readonly assignedTo: CreateStoragePolicyAssignmentRequestBodyArgAssignedToField; +export interface CreateStoragePolicyAssignmentRequestBody { + readonly storagePolicy: CreateStoragePolicyAssignmentRequestBodyStoragePolicyField; + readonly assignedTo: CreateStoragePolicyAssignmentRequestBodyAssignedToField; } -export class CreateStoragePolicyAssignmentHeadersArg { +export class CreateStoragePolicyAssignmentHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class GetStoragePolicyAssignmentByIdHeadersArg { +export class GetStoragePolicyAssignmentByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyFieldTypeField = +export type UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyTypeField = 'storage_policy'; -export interface UpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyField { - readonly type: UpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyFieldTypeField; +export interface UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyField { + readonly type: UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyTypeField; readonly id: string; } -export interface UpdateStoragePolicyAssignmentByIdRequestBodyArg { - readonly storagePolicy: UpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyField; +export interface UpdateStoragePolicyAssignmentByIdRequestBody { + readonly storagePolicy: UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyField; } -export class UpdateStoragePolicyAssignmentByIdHeadersArg { +export class UpdateStoragePolicyAssignmentByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial< - Pick - > + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteStoragePolicyAssignmentByIdHeadersArg { +export class DeleteStoragePolicyAssignmentByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial< - Pick - > + | Omit + | Partial> ) { Object.assign(this, fields); } } export class StoragePolicyAssignmentsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - StoragePolicyAssignmentsManager, - | 'getStoragePolicyAssignments' - | 'createStoragePolicyAssignment' - | 'getStoragePolicyAssignmentById' - | 'updateStoragePolicyAssignmentById' - | 'deleteStoragePolicyAssignmentById' - > + fields: + | Omit< + StoragePolicyAssignmentsManager, + | 'networkSession' + | 'getStoragePolicyAssignments' + | 'createStoragePolicyAssignment' + | 'getStoragePolicyAssignmentById' + | 'updateStoragePolicyAssignmentById' + | 'deleteStoragePolicyAssignmentById' + > + | Partial> ) { Object.assign(this, fields); } async getStoragePolicyAssignments( - queryParams: GetStoragePolicyAssignmentsQueryParamsArg, - headers: GetStoragePolicyAssignmentsHeadersArg = new GetStoragePolicyAssignmentsHeadersArg( + queryParams: GetStoragePolicyAssignmentsQueryParams, + headers: GetStoragePolicyAssignmentsHeaders = new GetStoragePolicyAssignmentsHeaders( {} ), cancellationToken?: CancellationToken @@ -154,7 +154,10 @@ export class StoragePolicyAssignmentsManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/storage_policy_assignments') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/storage_policy_assignments' + ) as string, { method: 'GET', params: queryParamsMap, @@ -168,8 +171,8 @@ export class StoragePolicyAssignmentsManager { return deserializeStoragePolicyAssignments(response.data); } async createStoragePolicyAssignment( - requestBody: CreateStoragePolicyAssignmentRequestBodyArg, - headers: CreateStoragePolicyAssignmentHeadersArg = new CreateStoragePolicyAssignmentHeadersArg( + requestBody: CreateStoragePolicyAssignmentRequestBody, + headers: CreateStoragePolicyAssignmentHeaders = new CreateStoragePolicyAssignmentHeaders( {} ), cancellationToken?: CancellationToken @@ -178,11 +181,14 @@ export class StoragePolicyAssignmentsManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/storage_policy_assignments') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/storage_policy_assignments' + ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateStoragePolicyAssignmentRequestBodyArg(requestBody), + data: serializeCreateStoragePolicyAssignmentRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -194,7 +200,7 @@ export class StoragePolicyAssignmentsManager { } async getStoragePolicyAssignmentById( storagePolicyAssignmentId: string, - headers: GetStoragePolicyAssignmentByIdHeadersArg = new GetStoragePolicyAssignmentByIdHeadersArg( + headers: GetStoragePolicyAssignmentByIdHeaders = new GetStoragePolicyAssignmentByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -204,7 +210,8 @@ export class StoragePolicyAssignmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/storage_policy_assignments/', + this.networkSession.baseUrls.baseUrl, + '/storage_policy_assignments/', toString(storagePolicyAssignmentId) as string ) as string, { @@ -220,8 +227,8 @@ export class StoragePolicyAssignmentsManager { } async updateStoragePolicyAssignmentById( storagePolicyAssignmentId: string, - requestBody: UpdateStoragePolicyAssignmentByIdRequestBodyArg, - headers: UpdateStoragePolicyAssignmentByIdHeadersArg = new UpdateStoragePolicyAssignmentByIdHeadersArg( + requestBody: UpdateStoragePolicyAssignmentByIdRequestBody, + headers: UpdateStoragePolicyAssignmentByIdHeaders = new UpdateStoragePolicyAssignmentByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -231,13 +238,14 @@ export class StoragePolicyAssignmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/storage_policy_assignments/', + this.networkSession.baseUrls.baseUrl, + '/storage_policy_assignments/', toString(storagePolicyAssignmentId) as string ) as string, { method: 'PUT', headers: headersMap, - data: serializeUpdateStoragePolicyAssignmentByIdRequestBodyArg( + data: serializeUpdateStoragePolicyAssignmentByIdRequestBody( requestBody ), contentType: 'application/json', @@ -251,7 +259,7 @@ export class StoragePolicyAssignmentsManager { } async deleteStoragePolicyAssignmentById( storagePolicyAssignmentId: string, - headers: DeleteStoragePolicyAssignmentByIdHeadersArg = new DeleteStoragePolicyAssignmentByIdHeadersArg( + headers: DeleteStoragePolicyAssignmentByIdHeaders = new DeleteStoragePolicyAssignmentByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -261,7 +269,8 @@ export class StoragePolicyAssignmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/storage_policy_assignments/', + this.networkSession.baseUrls.baseUrl, + '/storage_policy_assignments/', toString(storagePolicyAssignmentId) as string ) as string, { @@ -276,16 +285,16 @@ export class StoragePolicyAssignmentsManager { return void 0; } } -export function serializeGetStoragePolicyAssignmentsQueryParamsArgResolvedForTypeField( - val: GetStoragePolicyAssignmentsQueryParamsArgResolvedForTypeField +export function serializeGetStoragePolicyAssignmentsQueryParamsResolvedForTypeField( + val: GetStoragePolicyAssignmentsQueryParamsResolvedForTypeField ): SerializedData { return val; } -export function deserializeGetStoragePolicyAssignmentsQueryParamsArgResolvedForTypeField( +export function deserializeGetStoragePolicyAssignmentsQueryParamsResolvedForTypeField( val: any -): GetStoragePolicyAssignmentsQueryParamsArgResolvedForTypeField { +): GetStoragePolicyAssignmentsQueryParamsResolvedForTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetStoragePolicyAssignmentsQueryParamsArgResolvedForTypeField"'; + throw 'Expecting a string for "GetStoragePolicyAssignmentsQueryParamsResolvedForTypeField"'; } if (val == 'user') { return 'user'; @@ -295,56 +304,56 @@ export function deserializeGetStoragePolicyAssignmentsQueryParamsArgResolvedForT } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateStoragePolicyAssignmentRequestBodyArgStoragePolicyFieldTypeField( - val: CreateStoragePolicyAssignmentRequestBodyArgStoragePolicyFieldTypeField +export function serializeCreateStoragePolicyAssignmentRequestBodyStoragePolicyTypeField( + val: CreateStoragePolicyAssignmentRequestBodyStoragePolicyTypeField ): SerializedData { return val; } -export function deserializeCreateStoragePolicyAssignmentRequestBodyArgStoragePolicyFieldTypeField( +export function deserializeCreateStoragePolicyAssignmentRequestBodyStoragePolicyTypeField( val: any -): CreateStoragePolicyAssignmentRequestBodyArgStoragePolicyFieldTypeField { +): CreateStoragePolicyAssignmentRequestBodyStoragePolicyTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateStoragePolicyAssignmentRequestBodyArgStoragePolicyFieldTypeField"'; + throw 'Expecting a string for "CreateStoragePolicyAssignmentRequestBodyStoragePolicyTypeField"'; } if (val == 'storage_policy') { return 'storage_policy'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateStoragePolicyAssignmentRequestBodyArgStoragePolicyField( - val: CreateStoragePolicyAssignmentRequestBodyArgStoragePolicyField +export function serializeCreateStoragePolicyAssignmentRequestBodyStoragePolicyField( + val: CreateStoragePolicyAssignmentRequestBodyStoragePolicyField ): SerializedData { return { ['type']: - serializeCreateStoragePolicyAssignmentRequestBodyArgStoragePolicyFieldTypeField( + serializeCreateStoragePolicyAssignmentRequestBodyStoragePolicyTypeField( val.type ), ['id']: val.id, }; } -export function deserializeCreateStoragePolicyAssignmentRequestBodyArgStoragePolicyField( +export function deserializeCreateStoragePolicyAssignmentRequestBodyStoragePolicyField( val: any -): CreateStoragePolicyAssignmentRequestBodyArgStoragePolicyField { - const type: CreateStoragePolicyAssignmentRequestBodyArgStoragePolicyFieldTypeField = - deserializeCreateStoragePolicyAssignmentRequestBodyArgStoragePolicyFieldTypeField( +): CreateStoragePolicyAssignmentRequestBodyStoragePolicyField { + const type: CreateStoragePolicyAssignmentRequestBodyStoragePolicyTypeField = + deserializeCreateStoragePolicyAssignmentRequestBodyStoragePolicyTypeField( val.type ); const id: string = val.id; return { type: type, id: id, - } satisfies CreateStoragePolicyAssignmentRequestBodyArgStoragePolicyField; + } satisfies CreateStoragePolicyAssignmentRequestBodyStoragePolicyField; } -export function serializeCreateStoragePolicyAssignmentRequestBodyArgAssignedToFieldTypeField( - val: CreateStoragePolicyAssignmentRequestBodyArgAssignedToFieldTypeField +export function serializeCreateStoragePolicyAssignmentRequestBodyAssignedToTypeField( + val: CreateStoragePolicyAssignmentRequestBodyAssignedToTypeField ): SerializedData { return val; } -export function deserializeCreateStoragePolicyAssignmentRequestBodyArgAssignedToFieldTypeField( +export function deserializeCreateStoragePolicyAssignmentRequestBodyAssignedToTypeField( val: any -): CreateStoragePolicyAssignmentRequestBodyArgAssignedToFieldTypeField { +): CreateStoragePolicyAssignmentRequestBodyAssignedToTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateStoragePolicyAssignmentRequestBodyArgAssignedToFieldTypeField"'; + throw 'Expecting a string for "CreateStoragePolicyAssignmentRequestBodyAssignedToTypeField"'; } if (val == 'user') { return 'user'; @@ -354,118 +363,118 @@ export function deserializeCreateStoragePolicyAssignmentRequestBodyArgAssignedTo } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateStoragePolicyAssignmentRequestBodyArgAssignedToField( - val: CreateStoragePolicyAssignmentRequestBodyArgAssignedToField +export function serializeCreateStoragePolicyAssignmentRequestBodyAssignedToField( + val: CreateStoragePolicyAssignmentRequestBodyAssignedToField ): SerializedData { return { ['type']: - serializeCreateStoragePolicyAssignmentRequestBodyArgAssignedToFieldTypeField( + serializeCreateStoragePolicyAssignmentRequestBodyAssignedToTypeField( val.type ), ['id']: val.id, }; } -export function deserializeCreateStoragePolicyAssignmentRequestBodyArgAssignedToField( +export function deserializeCreateStoragePolicyAssignmentRequestBodyAssignedToField( val: any -): CreateStoragePolicyAssignmentRequestBodyArgAssignedToField { - const type: CreateStoragePolicyAssignmentRequestBodyArgAssignedToFieldTypeField = - deserializeCreateStoragePolicyAssignmentRequestBodyArgAssignedToFieldTypeField( +): CreateStoragePolicyAssignmentRequestBodyAssignedToField { + const type: CreateStoragePolicyAssignmentRequestBodyAssignedToTypeField = + deserializeCreateStoragePolicyAssignmentRequestBodyAssignedToTypeField( val.type ); const id: string = val.id; return { type: type, id: id, - } satisfies CreateStoragePolicyAssignmentRequestBodyArgAssignedToField; + } satisfies CreateStoragePolicyAssignmentRequestBodyAssignedToField; } -export function serializeCreateStoragePolicyAssignmentRequestBodyArg( - val: CreateStoragePolicyAssignmentRequestBodyArg +export function serializeCreateStoragePolicyAssignmentRequestBody( + val: CreateStoragePolicyAssignmentRequestBody ): SerializedData { return { ['storage_policy']: - serializeCreateStoragePolicyAssignmentRequestBodyArgStoragePolicyField( + serializeCreateStoragePolicyAssignmentRequestBodyStoragePolicyField( val.storagePolicy ), ['assigned_to']: - serializeCreateStoragePolicyAssignmentRequestBodyArgAssignedToField( + serializeCreateStoragePolicyAssignmentRequestBodyAssignedToField( val.assignedTo ), }; } -export function deserializeCreateStoragePolicyAssignmentRequestBodyArg( +export function deserializeCreateStoragePolicyAssignmentRequestBody( val: any -): CreateStoragePolicyAssignmentRequestBodyArg { - const storagePolicy: CreateStoragePolicyAssignmentRequestBodyArgStoragePolicyField = - deserializeCreateStoragePolicyAssignmentRequestBodyArgStoragePolicyField( +): CreateStoragePolicyAssignmentRequestBody { + const storagePolicy: CreateStoragePolicyAssignmentRequestBodyStoragePolicyField = + deserializeCreateStoragePolicyAssignmentRequestBodyStoragePolicyField( val.storage_policy ); - const assignedTo: CreateStoragePolicyAssignmentRequestBodyArgAssignedToField = - deserializeCreateStoragePolicyAssignmentRequestBodyArgAssignedToField( + const assignedTo: CreateStoragePolicyAssignmentRequestBodyAssignedToField = + deserializeCreateStoragePolicyAssignmentRequestBodyAssignedToField( val.assigned_to ); return { storagePolicy: storagePolicy, assignedTo: assignedTo, - } satisfies CreateStoragePolicyAssignmentRequestBodyArg; + } satisfies CreateStoragePolicyAssignmentRequestBody; } -export function serializeUpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyFieldTypeField( - val: UpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyFieldTypeField +export function serializeUpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyTypeField( + val: UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyTypeField ): SerializedData { return val; } -export function deserializeUpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyFieldTypeField( +export function deserializeUpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyTypeField( val: any -): UpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyFieldTypeField { +): UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyFieldTypeField"'; + throw 'Expecting a string for "UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyTypeField"'; } if (val == 'storage_policy') { return 'storage_policy'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyField( - val: UpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyField +export function serializeUpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyField( + val: UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyField ): SerializedData { return { ['type']: - serializeUpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyFieldTypeField( + serializeUpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyTypeField( val.type ), ['id']: val.id, }; } -export function deserializeUpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyField( +export function deserializeUpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyField( val: any -): UpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyField { - const type: UpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyFieldTypeField = - deserializeUpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyFieldTypeField( +): UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyField { + const type: UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyTypeField = + deserializeUpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyTypeField( val.type ); const id: string = val.id; return { type: type, id: id, - } satisfies UpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyField; + } satisfies UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyField; } -export function serializeUpdateStoragePolicyAssignmentByIdRequestBodyArg( - val: UpdateStoragePolicyAssignmentByIdRequestBodyArg +export function serializeUpdateStoragePolicyAssignmentByIdRequestBody( + val: UpdateStoragePolicyAssignmentByIdRequestBody ): SerializedData { return { ['storage_policy']: - serializeUpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyField( + serializeUpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyField( val.storagePolicy ), }; } -export function deserializeUpdateStoragePolicyAssignmentByIdRequestBodyArg( +export function deserializeUpdateStoragePolicyAssignmentByIdRequestBody( val: any -): UpdateStoragePolicyAssignmentByIdRequestBodyArg { - const storagePolicy: UpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyField = - deserializeUpdateStoragePolicyAssignmentByIdRequestBodyArgStoragePolicyField( +): UpdateStoragePolicyAssignmentByIdRequestBody { + const storagePolicy: UpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyField = + deserializeUpdateStoragePolicyAssignmentByIdRequestBodyStoragePolicyField( val.storage_policy ); return { storagePolicy: storagePolicy, - } satisfies UpdateStoragePolicyAssignmentByIdRequestBodyArg; + } satisfies UpdateStoragePolicyAssignmentByIdRequestBody; } diff --git a/src/managers/taskAssignments.generated.ts b/src/managers/taskAssignments.generated.ts index 3b003645..025828fd 100644 --- a/src/managers/taskAssignments.generated.ts +++ b/src/managers/taskAssignments.generated.ts @@ -24,108 +24,109 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetTaskAssignmentsHeadersArg { +export class GetTaskAssignmentsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateTaskAssignmentRequestBodyArgTaskFieldTypeField = 'task'; -export interface CreateTaskAssignmentRequestBodyArgTaskField { +export type CreateTaskAssignmentRequestBodyTaskTypeField = 'task'; +export interface CreateTaskAssignmentRequestBodyTaskField { readonly id: string; - readonly type: CreateTaskAssignmentRequestBodyArgTaskFieldTypeField; + readonly type: CreateTaskAssignmentRequestBodyTaskTypeField; } -export interface CreateTaskAssignmentRequestBodyArgAssignToField { +export interface CreateTaskAssignmentRequestBodyAssignToField { readonly id?: string; readonly login?: string; } -export interface CreateTaskAssignmentRequestBodyArg { - readonly task: CreateTaskAssignmentRequestBodyArgTaskField; - readonly assignTo: CreateTaskAssignmentRequestBodyArgAssignToField; +export interface CreateTaskAssignmentRequestBody { + readonly task: CreateTaskAssignmentRequestBodyTaskField; + readonly assignTo: CreateTaskAssignmentRequestBodyAssignToField; } -export class CreateTaskAssignmentHeadersArg { +export class CreateTaskAssignmentHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class GetTaskAssignmentByIdHeadersArg { +export class GetTaskAssignmentByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateTaskAssignmentByIdRequestBodyArgResolutionStateField = +export type UpdateTaskAssignmentByIdRequestBodyResolutionStateField = | 'completed' | 'incomplete' | 'approved' | 'rejected'; -export interface UpdateTaskAssignmentByIdRequestBodyArg { +export interface UpdateTaskAssignmentByIdRequestBody { readonly message?: string; - readonly resolutionState?: UpdateTaskAssignmentByIdRequestBodyArgResolutionStateField; + readonly resolutionState?: UpdateTaskAssignmentByIdRequestBodyResolutionStateField; } -export class UpdateTaskAssignmentByIdHeadersArg { +export class UpdateTaskAssignmentByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteTaskAssignmentByIdHeadersArg { +export class DeleteTaskAssignmentByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class TaskAssignmentsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - TaskAssignmentsManager, - | 'getTaskAssignments' - | 'createTaskAssignment' - | 'getTaskAssignmentById' - | 'updateTaskAssignmentById' - | 'deleteTaskAssignmentById' - > + fields: + | Omit< + TaskAssignmentsManager, + | 'networkSession' + | 'getTaskAssignments' + | 'createTaskAssignment' + | 'getTaskAssignmentById' + | 'updateTaskAssignmentById' + | 'deleteTaskAssignmentById' + > + | Partial> ) { Object.assign(this, fields); } async getTaskAssignments( taskId: string, - headers: GetTaskAssignmentsHeadersArg = new GetTaskAssignmentsHeadersArg( - {} - ), + headers: GetTaskAssignmentsHeaders = new GetTaskAssignmentsHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -133,7 +134,8 @@ export class TaskAssignmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/tasks/', + this.networkSession.baseUrls.baseUrl, + '/tasks/', toString(taskId) as string, '/assignments' ) as string, @@ -149,21 +151,22 @@ export class TaskAssignmentsManager { return deserializeTaskAssignments(response.data); } async createTaskAssignment( - requestBody: CreateTaskAssignmentRequestBodyArg, - headers: CreateTaskAssignmentHeadersArg = new CreateTaskAssignmentHeadersArg( - {} - ), + requestBody: CreateTaskAssignmentRequestBody, + headers: CreateTaskAssignmentHeaders = new CreateTaskAssignmentHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/task_assignments') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/task_assignments' + ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateTaskAssignmentRequestBodyArg(requestBody), + data: serializeCreateTaskAssignmentRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -175,7 +178,7 @@ export class TaskAssignmentsManager { } async getTaskAssignmentById( taskAssignmentId: string, - headers: GetTaskAssignmentByIdHeadersArg = new GetTaskAssignmentByIdHeadersArg( + headers: GetTaskAssignmentByIdHeaders = new GetTaskAssignmentByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -185,7 +188,8 @@ export class TaskAssignmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/task_assignments/', + this.networkSession.baseUrls.baseUrl, + '/task_assignments/', toString(taskAssignmentId) as string ) as string, { @@ -201,8 +205,8 @@ export class TaskAssignmentsManager { } async updateTaskAssignmentById( taskAssignmentId: string, - requestBody: UpdateTaskAssignmentByIdRequestBodyArg = {} satisfies UpdateTaskAssignmentByIdRequestBodyArg, - headers: UpdateTaskAssignmentByIdHeadersArg = new UpdateTaskAssignmentByIdHeadersArg( + requestBody: UpdateTaskAssignmentByIdRequestBody = {} satisfies UpdateTaskAssignmentByIdRequestBody, + headers: UpdateTaskAssignmentByIdHeaders = new UpdateTaskAssignmentByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -212,13 +216,14 @@ export class TaskAssignmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/task_assignments/', + this.networkSession.baseUrls.baseUrl, + '/task_assignments/', toString(taskAssignmentId) as string ) as string, { method: 'PUT', headers: headersMap, - data: serializeUpdateTaskAssignmentByIdRequestBodyArg(requestBody), + data: serializeUpdateTaskAssignmentByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -230,7 +235,7 @@ export class TaskAssignmentsManager { } async deleteTaskAssignmentById( taskAssignmentId: string, - headers: DeleteTaskAssignmentByIdHeadersArg = new DeleteTaskAssignmentByIdHeadersArg( + headers: DeleteTaskAssignmentByIdHeaders = new DeleteTaskAssignmentByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -240,7 +245,8 @@ export class TaskAssignmentsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/task_assignments/', + this.networkSession.baseUrls.baseUrl, + '/task_assignments/', toString(taskAssignmentId) as string ) as string, { @@ -255,93 +261,91 @@ export class TaskAssignmentsManager { return void 0; } } -export function serializeCreateTaskAssignmentRequestBodyArgTaskFieldTypeField( - val: CreateTaskAssignmentRequestBodyArgTaskFieldTypeField +export function serializeCreateTaskAssignmentRequestBodyTaskTypeField( + val: CreateTaskAssignmentRequestBodyTaskTypeField ): SerializedData { return val; } -export function deserializeCreateTaskAssignmentRequestBodyArgTaskFieldTypeField( +export function deserializeCreateTaskAssignmentRequestBodyTaskTypeField( val: any -): CreateTaskAssignmentRequestBodyArgTaskFieldTypeField { +): CreateTaskAssignmentRequestBodyTaskTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateTaskAssignmentRequestBodyArgTaskFieldTypeField"'; + throw 'Expecting a string for "CreateTaskAssignmentRequestBodyTaskTypeField"'; } if (val == 'task') { return 'task'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateTaskAssignmentRequestBodyArgTaskField( - val: CreateTaskAssignmentRequestBodyArgTaskField +export function serializeCreateTaskAssignmentRequestBodyTaskField( + val: CreateTaskAssignmentRequestBodyTaskField ): SerializedData { return { ['id']: val.id, - ['type']: serializeCreateTaskAssignmentRequestBodyArgTaskFieldTypeField( - val.type - ), + ['type']: serializeCreateTaskAssignmentRequestBodyTaskTypeField(val.type), }; } -export function deserializeCreateTaskAssignmentRequestBodyArgTaskField( +export function deserializeCreateTaskAssignmentRequestBodyTaskField( val: any -): CreateTaskAssignmentRequestBodyArgTaskField { +): CreateTaskAssignmentRequestBodyTaskField { const id: string = val.id; - const type: CreateTaskAssignmentRequestBodyArgTaskFieldTypeField = - deserializeCreateTaskAssignmentRequestBodyArgTaskFieldTypeField(val.type); + const type: CreateTaskAssignmentRequestBodyTaskTypeField = + deserializeCreateTaskAssignmentRequestBodyTaskTypeField(val.type); return { id: id, type: type, - } satisfies CreateTaskAssignmentRequestBodyArgTaskField; + } satisfies CreateTaskAssignmentRequestBodyTaskField; } -export function serializeCreateTaskAssignmentRequestBodyArgAssignToField( - val: CreateTaskAssignmentRequestBodyArgAssignToField +export function serializeCreateTaskAssignmentRequestBodyAssignToField( + val: CreateTaskAssignmentRequestBodyAssignToField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id, ['login']: val.login == void 0 ? void 0 : val.login, }; } -export function deserializeCreateTaskAssignmentRequestBodyArgAssignToField( +export function deserializeCreateTaskAssignmentRequestBodyAssignToField( val: any -): CreateTaskAssignmentRequestBodyArgAssignToField { +): CreateTaskAssignmentRequestBodyAssignToField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; const login: undefined | string = val.login == void 0 ? void 0 : val.login; return { id: id, login: login, - } satisfies CreateTaskAssignmentRequestBodyArgAssignToField; + } satisfies CreateTaskAssignmentRequestBodyAssignToField; } -export function serializeCreateTaskAssignmentRequestBodyArg( - val: CreateTaskAssignmentRequestBodyArg +export function serializeCreateTaskAssignmentRequestBody( + val: CreateTaskAssignmentRequestBody ): SerializedData { return { - ['task']: serializeCreateTaskAssignmentRequestBodyArgTaskField(val.task), - ['assign_to']: serializeCreateTaskAssignmentRequestBodyArgAssignToField( + ['task']: serializeCreateTaskAssignmentRequestBodyTaskField(val.task), + ['assign_to']: serializeCreateTaskAssignmentRequestBodyAssignToField( val.assignTo ), }; } -export function deserializeCreateTaskAssignmentRequestBodyArg( +export function deserializeCreateTaskAssignmentRequestBody( val: any -): CreateTaskAssignmentRequestBodyArg { - const task: CreateTaskAssignmentRequestBodyArgTaskField = - deserializeCreateTaskAssignmentRequestBodyArgTaskField(val.task); - const assignTo: CreateTaskAssignmentRequestBodyArgAssignToField = - deserializeCreateTaskAssignmentRequestBodyArgAssignToField(val.assign_to); +): CreateTaskAssignmentRequestBody { + const task: CreateTaskAssignmentRequestBodyTaskField = + deserializeCreateTaskAssignmentRequestBodyTaskField(val.task); + const assignTo: CreateTaskAssignmentRequestBodyAssignToField = + deserializeCreateTaskAssignmentRequestBodyAssignToField(val.assign_to); return { task: task, assignTo: assignTo, - } satisfies CreateTaskAssignmentRequestBodyArg; + } satisfies CreateTaskAssignmentRequestBody; } -export function serializeUpdateTaskAssignmentByIdRequestBodyArgResolutionStateField( - val: UpdateTaskAssignmentByIdRequestBodyArgResolutionStateField +export function serializeUpdateTaskAssignmentByIdRequestBodyResolutionStateField( + val: UpdateTaskAssignmentByIdRequestBodyResolutionStateField ): SerializedData { return val; } -export function deserializeUpdateTaskAssignmentByIdRequestBodyArgResolutionStateField( +export function deserializeUpdateTaskAssignmentByIdRequestBodyResolutionStateField( val: any -): UpdateTaskAssignmentByIdRequestBodyArgResolutionStateField { +): UpdateTaskAssignmentByIdRequestBodyResolutionStateField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateTaskAssignmentByIdRequestBodyArgResolutionStateField"'; + throw 'Expecting a string for "UpdateTaskAssignmentByIdRequestBodyResolutionStateField"'; } if (val == 'completed') { return 'completed'; @@ -357,34 +361,34 @@ export function deserializeUpdateTaskAssignmentByIdRequestBodyArgResolutionState } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateTaskAssignmentByIdRequestBodyArg( - val: UpdateTaskAssignmentByIdRequestBodyArg +export function serializeUpdateTaskAssignmentByIdRequestBody( + val: UpdateTaskAssignmentByIdRequestBody ): SerializedData { return { ['message']: val.message == void 0 ? void 0 : val.message, ['resolution_state']: val.resolutionState == void 0 ? void 0 - : serializeUpdateTaskAssignmentByIdRequestBodyArgResolutionStateField( + : serializeUpdateTaskAssignmentByIdRequestBodyResolutionStateField( val.resolutionState ), }; } -export function deserializeUpdateTaskAssignmentByIdRequestBodyArg( +export function deserializeUpdateTaskAssignmentByIdRequestBody( val: any -): UpdateTaskAssignmentByIdRequestBodyArg { +): UpdateTaskAssignmentByIdRequestBody { const message: undefined | string = val.message == void 0 ? void 0 : val.message; const resolutionState: | undefined - | UpdateTaskAssignmentByIdRequestBodyArgResolutionStateField = + | UpdateTaskAssignmentByIdRequestBodyResolutionStateField = val.resolution_state == void 0 ? void 0 - : deserializeUpdateTaskAssignmentByIdRequestBodyArgResolutionStateField( + : deserializeUpdateTaskAssignmentByIdRequestBodyResolutionStateField( val.resolution_state ); return { message: message, resolutionState: resolutionState, - } satisfies UpdateTaskAssignmentByIdRequestBodyArg; + } satisfies UpdateTaskAssignmentByIdRequestBody; } diff --git a/src/managers/tasks.generated.ts b/src/managers/tasks.generated.ts index 1006436e..982e5387 100644 --- a/src/managers/tasks.generated.ts +++ b/src/managers/tasks.generated.ts @@ -24,110 +24,113 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetFileTasksHeadersArg { +export class GetFileTasksHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateTaskRequestBodyArgItemFieldTypeField = 'file'; -export interface CreateTaskRequestBodyArgItemField { +export type CreateTaskRequestBodyItemTypeField = 'file'; +export interface CreateTaskRequestBodyItemField { readonly id?: string; - readonly type?: CreateTaskRequestBodyArgItemFieldTypeField; + readonly type?: CreateTaskRequestBodyItemTypeField; } -export type CreateTaskRequestBodyArgActionField = 'review' | 'complete'; -export type CreateTaskRequestBodyArgCompletionRuleField = +export type CreateTaskRequestBodyActionField = 'review' | 'complete'; +export type CreateTaskRequestBodyCompletionRuleField = | 'all_assignees' | 'any_assignee'; -export interface CreateTaskRequestBodyArg { - readonly item: CreateTaskRequestBodyArgItemField; - readonly action?: CreateTaskRequestBodyArgActionField; +export interface CreateTaskRequestBody { + readonly item: CreateTaskRequestBodyItemField; + readonly action?: CreateTaskRequestBodyActionField; readonly message?: string; readonly dueAt?: string; - readonly completionRule?: CreateTaskRequestBodyArgCompletionRuleField; + readonly completionRule?: CreateTaskRequestBodyCompletionRuleField; } -export class CreateTaskHeadersArg { +export class CreateTaskHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class GetTaskByIdHeadersArg { +export class GetTaskByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateTaskByIdRequestBodyArgActionField = 'review' | 'complete'; -export type UpdateTaskByIdRequestBodyArgCompletionRuleField = +export type UpdateTaskByIdRequestBodyActionField = 'review' | 'complete'; +export type UpdateTaskByIdRequestBodyCompletionRuleField = | 'all_assignees' | 'any_assignee'; -export interface UpdateTaskByIdRequestBodyArg { - readonly action?: UpdateTaskByIdRequestBodyArgActionField; +export interface UpdateTaskByIdRequestBody { + readonly action?: UpdateTaskByIdRequestBodyActionField; readonly message?: string; readonly dueAt?: string; - readonly completionRule?: UpdateTaskByIdRequestBodyArgCompletionRuleField; + readonly completionRule?: UpdateTaskByIdRequestBodyCompletionRuleField; } -export class UpdateTaskByIdHeadersArg { +export class UpdateTaskByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteTaskByIdHeadersArg { +export class DeleteTaskByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class TasksManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - TasksManager, - | 'getFileTasks' - | 'createTask' - | 'getTaskById' - | 'updateTaskById' - | 'deleteTaskById' - > + fields: + | Omit< + TasksManager, + | 'networkSession' + | 'getFileTasks' + | 'createTask' + | 'getTaskById' + | 'updateTaskById' + | 'deleteTaskById' + > + | Partial> ) { Object.assign(this, fields); } async getFileTasks( fileId: string, - headers: GetFileTasksHeadersArg = new GetFileTasksHeadersArg({}), + headers: GetFileTasksHeaders = new GetFileTasksHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -135,7 +138,8 @@ export class TasksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/tasks' ) as string, @@ -151,19 +155,19 @@ export class TasksManager { return deserializeTasks(response.data); } async createTask( - requestBody: CreateTaskRequestBodyArg, - headers: CreateTaskHeadersArg = new CreateTaskHeadersArg({}), + requestBody: CreateTaskRequestBody, + headers: CreateTaskHeaders = new CreateTaskHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/tasks') as string, + ''.concat(this.networkSession.baseUrls.baseUrl, '/tasks') as string, { method: 'POST', headers: headersMap, - data: serializeCreateTaskRequestBodyArg(requestBody), + data: serializeCreateTaskRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -175,7 +179,7 @@ export class TasksManager { } async getTaskById( taskId: string, - headers: GetTaskByIdHeadersArg = new GetTaskByIdHeadersArg({}), + headers: GetTaskByIdHeaders = new GetTaskByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -183,7 +187,8 @@ export class TasksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/tasks/', + this.networkSession.baseUrls.baseUrl, + '/tasks/', toString(taskId) as string ) as string, { @@ -199,8 +204,8 @@ export class TasksManager { } async updateTaskById( taskId: string, - requestBody: UpdateTaskByIdRequestBodyArg = {} satisfies UpdateTaskByIdRequestBodyArg, - headers: UpdateTaskByIdHeadersArg = new UpdateTaskByIdHeadersArg({}), + requestBody: UpdateTaskByIdRequestBody = {} satisfies UpdateTaskByIdRequestBody, + headers: UpdateTaskByIdHeaders = new UpdateTaskByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -208,13 +213,14 @@ export class TasksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/tasks/', + this.networkSession.baseUrls.baseUrl, + '/tasks/', toString(taskId) as string ) as string, { method: 'PUT', headers: headersMap, - data: serializeUpdateTaskByIdRequestBodyArg(requestBody), + data: serializeUpdateTaskByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -226,7 +232,7 @@ export class TasksManager { } async deleteTaskById( taskId: string, - headers: DeleteTaskByIdHeadersArg = new DeleteTaskByIdHeadersArg({}), + headers: DeleteTaskByIdHeaders = new DeleteTaskByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -234,7 +240,8 @@ export class TasksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/tasks/', + this.networkSession.baseUrls.baseUrl, + '/tasks/', toString(taskId) as string ) as string, { @@ -249,53 +256,53 @@ export class TasksManager { return void 0; } } -export function serializeCreateTaskRequestBodyArgItemFieldTypeField( - val: CreateTaskRequestBodyArgItemFieldTypeField +export function serializeCreateTaskRequestBodyItemTypeField( + val: CreateTaskRequestBodyItemTypeField ): SerializedData { return val; } -export function deserializeCreateTaskRequestBodyArgItemFieldTypeField( +export function deserializeCreateTaskRequestBodyItemTypeField( val: any -): CreateTaskRequestBodyArgItemFieldTypeField { +): CreateTaskRequestBodyItemTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateTaskRequestBodyArgItemFieldTypeField"'; + throw 'Expecting a string for "CreateTaskRequestBodyItemTypeField"'; } if (val == 'file') { return 'file'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateTaskRequestBodyArgItemField( - val: CreateTaskRequestBodyArgItemField +export function serializeCreateTaskRequestBodyItemField( + val: CreateTaskRequestBodyItemField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id, ['type']: val.type == void 0 ? void 0 - : serializeCreateTaskRequestBodyArgItemFieldTypeField(val.type), + : serializeCreateTaskRequestBodyItemTypeField(val.type), }; } -export function deserializeCreateTaskRequestBodyArgItemField( +export function deserializeCreateTaskRequestBodyItemField( val: any -): CreateTaskRequestBodyArgItemField { +): CreateTaskRequestBodyItemField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: undefined | CreateTaskRequestBodyArgItemFieldTypeField = + const type: undefined | CreateTaskRequestBodyItemTypeField = val.type == void 0 ? void 0 - : deserializeCreateTaskRequestBodyArgItemFieldTypeField(val.type); - return { id: id, type: type } satisfies CreateTaskRequestBodyArgItemField; + : deserializeCreateTaskRequestBodyItemTypeField(val.type); + return { id: id, type: type } satisfies CreateTaskRequestBodyItemField; } -export function serializeCreateTaskRequestBodyArgActionField( - val: CreateTaskRequestBodyArgActionField +export function serializeCreateTaskRequestBodyActionField( + val: CreateTaskRequestBodyActionField ): SerializedData { return val; } -export function deserializeCreateTaskRequestBodyArgActionField( +export function deserializeCreateTaskRequestBodyActionField( val: any -): CreateTaskRequestBodyArgActionField { +): CreateTaskRequestBodyActionField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateTaskRequestBodyArgActionField"'; + throw 'Expecting a string for "CreateTaskRequestBodyActionField"'; } if (val == 'review') { return 'review'; @@ -305,16 +312,16 @@ export function deserializeCreateTaskRequestBodyArgActionField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateTaskRequestBodyArgCompletionRuleField( - val: CreateTaskRequestBodyArgCompletionRuleField +export function serializeCreateTaskRequestBodyCompletionRuleField( + val: CreateTaskRequestBodyCompletionRuleField ): SerializedData { return val; } -export function deserializeCreateTaskRequestBodyArgCompletionRuleField( +export function deserializeCreateTaskRequestBodyCompletionRuleField( val: any -): CreateTaskRequestBodyArgCompletionRuleField { +): CreateTaskRequestBodyCompletionRuleField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateTaskRequestBodyArgCompletionRuleField"'; + throw 'Expecting a string for "CreateTaskRequestBodyCompletionRuleField"'; } if (val == 'all_assignees') { return 'all_assignees'; @@ -324,43 +331,39 @@ export function deserializeCreateTaskRequestBodyArgCompletionRuleField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateTaskRequestBodyArg( - val: CreateTaskRequestBodyArg +export function serializeCreateTaskRequestBody( + val: CreateTaskRequestBody ): SerializedData { return { - ['item']: serializeCreateTaskRequestBodyArgItemField(val.item), + ['item']: serializeCreateTaskRequestBodyItemField(val.item), ['action']: val.action == void 0 ? void 0 - : serializeCreateTaskRequestBodyArgActionField(val.action), + : serializeCreateTaskRequestBodyActionField(val.action), ['message']: val.message == void 0 ? void 0 : val.message, ['due_at']: val.dueAt == void 0 ? void 0 : val.dueAt, ['completion_rule']: val.completionRule == void 0 ? void 0 - : serializeCreateTaskRequestBodyArgCompletionRuleField( - val.completionRule - ), + : serializeCreateTaskRequestBodyCompletionRuleField(val.completionRule), }; } -export function deserializeCreateTaskRequestBodyArg( +export function deserializeCreateTaskRequestBody( val: any -): CreateTaskRequestBodyArg { - const item: CreateTaskRequestBodyArgItemField = - deserializeCreateTaskRequestBodyArgItemField(val.item); - const action: undefined | CreateTaskRequestBodyArgActionField = +): CreateTaskRequestBody { + const item: CreateTaskRequestBodyItemField = + deserializeCreateTaskRequestBodyItemField(val.item); + const action: undefined | CreateTaskRequestBodyActionField = val.action == void 0 ? void 0 - : deserializeCreateTaskRequestBodyArgActionField(val.action); + : deserializeCreateTaskRequestBodyActionField(val.action); const message: undefined | string = val.message == void 0 ? void 0 : val.message; const dueAt: undefined | string = val.due_at == void 0 ? void 0 : val.due_at; - const completionRule: - | undefined - | CreateTaskRequestBodyArgCompletionRuleField = + const completionRule: undefined | CreateTaskRequestBodyCompletionRuleField = val.completion_rule == void 0 ? void 0 - : deserializeCreateTaskRequestBodyArgCompletionRuleField( + : deserializeCreateTaskRequestBodyCompletionRuleField( val.completion_rule ); return { @@ -369,18 +372,18 @@ export function deserializeCreateTaskRequestBodyArg( message: message, dueAt: dueAt, completionRule: completionRule, - } satisfies CreateTaskRequestBodyArg; + } satisfies CreateTaskRequestBody; } -export function serializeUpdateTaskByIdRequestBodyArgActionField( - val: UpdateTaskByIdRequestBodyArgActionField +export function serializeUpdateTaskByIdRequestBodyActionField( + val: UpdateTaskByIdRequestBodyActionField ): SerializedData { return val; } -export function deserializeUpdateTaskByIdRequestBodyArgActionField( +export function deserializeUpdateTaskByIdRequestBodyActionField( val: any -): UpdateTaskByIdRequestBodyArgActionField { +): UpdateTaskByIdRequestBodyActionField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateTaskByIdRequestBodyArgActionField"'; + throw 'Expecting a string for "UpdateTaskByIdRequestBodyActionField"'; } if (val == 'review') { return 'review'; @@ -390,16 +393,16 @@ export function deserializeUpdateTaskByIdRequestBodyArgActionField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateTaskByIdRequestBodyArgCompletionRuleField( - val: UpdateTaskByIdRequestBodyArgCompletionRuleField +export function serializeUpdateTaskByIdRequestBodyCompletionRuleField( + val: UpdateTaskByIdRequestBodyCompletionRuleField ): SerializedData { return val; } -export function deserializeUpdateTaskByIdRequestBodyArgCompletionRuleField( +export function deserializeUpdateTaskByIdRequestBodyCompletionRuleField( val: any -): UpdateTaskByIdRequestBodyArgCompletionRuleField { +): UpdateTaskByIdRequestBodyCompletionRuleField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateTaskByIdRequestBodyArgCompletionRuleField"'; + throw 'Expecting a string for "UpdateTaskByIdRequestBodyCompletionRuleField"'; } if (val == 'all_assignees') { return 'all_assignees'; @@ -409,40 +412,40 @@ export function deserializeUpdateTaskByIdRequestBodyArgCompletionRuleField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateTaskByIdRequestBodyArg( - val: UpdateTaskByIdRequestBodyArg +export function serializeUpdateTaskByIdRequestBody( + val: UpdateTaskByIdRequestBody ): SerializedData { return { ['action']: val.action == void 0 ? void 0 - : serializeUpdateTaskByIdRequestBodyArgActionField(val.action), + : serializeUpdateTaskByIdRequestBodyActionField(val.action), ['message']: val.message == void 0 ? void 0 : val.message, ['due_at']: val.dueAt == void 0 ? void 0 : val.dueAt, ['completion_rule']: val.completionRule == void 0 ? void 0 - : serializeUpdateTaskByIdRequestBodyArgCompletionRuleField( + : serializeUpdateTaskByIdRequestBodyCompletionRuleField( val.completionRule ), }; } -export function deserializeUpdateTaskByIdRequestBodyArg( +export function deserializeUpdateTaskByIdRequestBody( val: any -): UpdateTaskByIdRequestBodyArg { - const action: undefined | UpdateTaskByIdRequestBodyArgActionField = +): UpdateTaskByIdRequestBody { + const action: undefined | UpdateTaskByIdRequestBodyActionField = val.action == void 0 ? void 0 - : deserializeUpdateTaskByIdRequestBodyArgActionField(val.action); + : deserializeUpdateTaskByIdRequestBodyActionField(val.action); const message: undefined | string = val.message == void 0 ? void 0 : val.message; const dueAt: undefined | string = val.due_at == void 0 ? void 0 : val.due_at; const completionRule: | undefined - | UpdateTaskByIdRequestBodyArgCompletionRuleField = + | UpdateTaskByIdRequestBodyCompletionRuleField = val.completion_rule == void 0 ? void 0 - : deserializeUpdateTaskByIdRequestBodyArgCompletionRuleField( + : deserializeUpdateTaskByIdRequestBodyCompletionRuleField( val.completion_rule ); return { @@ -450,5 +453,5 @@ export function deserializeUpdateTaskByIdRequestBodyArg( message: message, dueAt: dueAt, completionRule: completionRule, - } satisfies UpdateTaskByIdRequestBodyArg; + } satisfies UpdateTaskByIdRequestBody; } diff --git a/src/managers/termsOfServiceUserStatuses.generated.ts b/src/managers/termsOfServiceUserStatuses.generated.ts index e98c43c7..aef4f720 100644 --- a/src/managers/termsOfServiceUserStatuses.generated.ts +++ b/src/managers/termsOfServiceUserStatuses.generated.ts @@ -24,84 +24,84 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetTermOfServiceUserStatusesQueryParamsArg { +export interface GetTermOfServiceUserStatusesQueryParams { readonly tosId: string; readonly userId?: string; } -export class GetTermOfServiceUserStatusesHeadersArg { +export class GetTermOfServiceUserStatusesHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateTermOfServiceUserStatusRequestBodyArgTosFieldTypeField = +export type CreateTermOfServiceUserStatusRequestBodyTosTypeField = 'terms_of_service'; -export interface CreateTermOfServiceUserStatusRequestBodyArgTosField { - readonly type: CreateTermOfServiceUserStatusRequestBodyArgTosFieldTypeField; +export interface CreateTermOfServiceUserStatusRequestBodyTosField { + readonly type: CreateTermOfServiceUserStatusRequestBodyTosTypeField; readonly id: string; } -export type CreateTermOfServiceUserStatusRequestBodyArgUserFieldTypeField = - 'user'; -export interface CreateTermOfServiceUserStatusRequestBodyArgUserField { - readonly type: CreateTermOfServiceUserStatusRequestBodyArgUserFieldTypeField; +export type CreateTermOfServiceUserStatusRequestBodyUserTypeField = 'user'; +export interface CreateTermOfServiceUserStatusRequestBodyUserField { + readonly type: CreateTermOfServiceUserStatusRequestBodyUserTypeField; readonly id: string; } -export interface CreateTermOfServiceUserStatusRequestBodyArg { - readonly tos: CreateTermOfServiceUserStatusRequestBodyArgTosField; - readonly user: CreateTermOfServiceUserStatusRequestBodyArgUserField; +export interface CreateTermOfServiceUserStatusRequestBody { + readonly tos: CreateTermOfServiceUserStatusRequestBodyTosField; + readonly user: CreateTermOfServiceUserStatusRequestBodyUserField; readonly isAccepted: boolean; } -export class CreateTermOfServiceUserStatusHeadersArg { +export class CreateTermOfServiceUserStatusHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface UpdateTermOfServiceUserStatusByIdRequestBodyArg { +export interface UpdateTermOfServiceUserStatusByIdRequestBody { readonly isAccepted: boolean; } -export class UpdateTermOfServiceUserStatusByIdHeadersArg { +export class UpdateTermOfServiceUserStatusByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial< - Pick - > + | Omit + | Partial> ) { Object.assign(this, fields); } } export class TermsOfServiceUserStatusesManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - TermsOfServiceUserStatusesManager, - | 'getTermOfServiceUserStatuses' - | 'createTermOfServiceUserStatus' - | 'updateTermOfServiceUserStatusById' - > + fields: + | Omit< + TermsOfServiceUserStatusesManager, + | 'networkSession' + | 'getTermOfServiceUserStatuses' + | 'createTermOfServiceUserStatus' + | 'updateTermOfServiceUserStatusById' + > + | Partial> ) { Object.assign(this, fields); } async getTermOfServiceUserStatuses( - queryParams: GetTermOfServiceUserStatusesQueryParamsArg, - headers: GetTermOfServiceUserStatusesHeadersArg = new GetTermOfServiceUserStatusesHeadersArg( + queryParams: GetTermOfServiceUserStatusesQueryParams, + headers: GetTermOfServiceUserStatusesHeaders = new GetTermOfServiceUserStatusesHeaders( {} ), cancellationToken?: CancellationToken @@ -117,7 +117,8 @@ export class TermsOfServiceUserStatusesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/terms_of_service_user_statuses' + this.networkSession.baseUrls.baseUrl, + '/terms_of_service_user_statuses' ) as string, { method: 'GET', @@ -132,8 +133,8 @@ export class TermsOfServiceUserStatusesManager { return deserializeTermsOfServiceUserStatuses(response.data); } async createTermOfServiceUserStatus( - requestBody: CreateTermOfServiceUserStatusRequestBodyArg, - headers: CreateTermOfServiceUserStatusHeadersArg = new CreateTermOfServiceUserStatusHeadersArg( + requestBody: CreateTermOfServiceUserStatusRequestBody, + headers: CreateTermOfServiceUserStatusHeaders = new CreateTermOfServiceUserStatusHeaders( {} ), cancellationToken?: CancellationToken @@ -143,12 +144,13 @@ export class TermsOfServiceUserStatusesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/terms_of_service_user_statuses' + this.networkSession.baseUrls.baseUrl, + '/terms_of_service_user_statuses' ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateTermOfServiceUserStatusRequestBodyArg(requestBody), + data: serializeCreateTermOfServiceUserStatusRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -160,8 +162,8 @@ export class TermsOfServiceUserStatusesManager { } async updateTermOfServiceUserStatusById( termsOfServiceUserStatusId: string, - requestBody: UpdateTermOfServiceUserStatusByIdRequestBodyArg, - headers: UpdateTermOfServiceUserStatusByIdHeadersArg = new UpdateTermOfServiceUserStatusByIdHeadersArg( + requestBody: UpdateTermOfServiceUserStatusByIdRequestBody, + headers: UpdateTermOfServiceUserStatusByIdHeaders = new UpdateTermOfServiceUserStatusByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -171,13 +173,14 @@ export class TermsOfServiceUserStatusesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/terms_of_service_user_statuses/', + this.networkSession.baseUrls.baseUrl, + '/terms_of_service_user_statuses/', toString(termsOfServiceUserStatusId) as string ) as string, { method: 'PUT', headers: headersMap, - data: serializeUpdateTermOfServiceUserStatusByIdRequestBodyArg( + data: serializeUpdateTermOfServiceUserStatusByIdRequestBody( requestBody ), contentType: 'application/json', @@ -190,123 +193,115 @@ export class TermsOfServiceUserStatusesManager { return deserializeTermsOfServiceUserStatus(response.data); } } -export function serializeCreateTermOfServiceUserStatusRequestBodyArgTosFieldTypeField( - val: CreateTermOfServiceUserStatusRequestBodyArgTosFieldTypeField +export function serializeCreateTermOfServiceUserStatusRequestBodyTosTypeField( + val: CreateTermOfServiceUserStatusRequestBodyTosTypeField ): SerializedData { return val; } -export function deserializeCreateTermOfServiceUserStatusRequestBodyArgTosFieldTypeField( +export function deserializeCreateTermOfServiceUserStatusRequestBodyTosTypeField( val: any -): CreateTermOfServiceUserStatusRequestBodyArgTosFieldTypeField { +): CreateTermOfServiceUserStatusRequestBodyTosTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateTermOfServiceUserStatusRequestBodyArgTosFieldTypeField"'; + throw 'Expecting a string for "CreateTermOfServiceUserStatusRequestBodyTosTypeField"'; } if (val == 'terms_of_service') { return 'terms_of_service'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateTermOfServiceUserStatusRequestBodyArgTosField( - val: CreateTermOfServiceUserStatusRequestBodyArgTosField +export function serializeCreateTermOfServiceUserStatusRequestBodyTosField( + val: CreateTermOfServiceUserStatusRequestBodyTosField ): SerializedData { return { - ['type']: - serializeCreateTermOfServiceUserStatusRequestBodyArgTosFieldTypeField( - val.type - ), + ['type']: serializeCreateTermOfServiceUserStatusRequestBodyTosTypeField( + val.type + ), ['id']: val.id, }; } -export function deserializeCreateTermOfServiceUserStatusRequestBodyArgTosField( +export function deserializeCreateTermOfServiceUserStatusRequestBodyTosField( val: any -): CreateTermOfServiceUserStatusRequestBodyArgTosField { - const type: CreateTermOfServiceUserStatusRequestBodyArgTosFieldTypeField = - deserializeCreateTermOfServiceUserStatusRequestBodyArgTosFieldTypeField( - val.type - ); +): CreateTermOfServiceUserStatusRequestBodyTosField { + const type: CreateTermOfServiceUserStatusRequestBodyTosTypeField = + deserializeCreateTermOfServiceUserStatusRequestBodyTosTypeField(val.type); const id: string = val.id; return { type: type, id: id, - } satisfies CreateTermOfServiceUserStatusRequestBodyArgTosField; + } satisfies CreateTermOfServiceUserStatusRequestBodyTosField; } -export function serializeCreateTermOfServiceUserStatusRequestBodyArgUserFieldTypeField( - val: CreateTermOfServiceUserStatusRequestBodyArgUserFieldTypeField +export function serializeCreateTermOfServiceUserStatusRequestBodyUserTypeField( + val: CreateTermOfServiceUserStatusRequestBodyUserTypeField ): SerializedData { return val; } -export function deserializeCreateTermOfServiceUserStatusRequestBodyArgUserFieldTypeField( +export function deserializeCreateTermOfServiceUserStatusRequestBodyUserTypeField( val: any -): CreateTermOfServiceUserStatusRequestBodyArgUserFieldTypeField { +): CreateTermOfServiceUserStatusRequestBodyUserTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateTermOfServiceUserStatusRequestBodyArgUserFieldTypeField"'; + throw 'Expecting a string for "CreateTermOfServiceUserStatusRequestBodyUserTypeField"'; } if (val == 'user') { return 'user'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateTermOfServiceUserStatusRequestBodyArgUserField( - val: CreateTermOfServiceUserStatusRequestBodyArgUserField +export function serializeCreateTermOfServiceUserStatusRequestBodyUserField( + val: CreateTermOfServiceUserStatusRequestBodyUserField ): SerializedData { return { - ['type']: - serializeCreateTermOfServiceUserStatusRequestBodyArgUserFieldTypeField( - val.type - ), + ['type']: serializeCreateTermOfServiceUserStatusRequestBodyUserTypeField( + val.type + ), ['id']: val.id, }; } -export function deserializeCreateTermOfServiceUserStatusRequestBodyArgUserField( +export function deserializeCreateTermOfServiceUserStatusRequestBodyUserField( val: any -): CreateTermOfServiceUserStatusRequestBodyArgUserField { - const type: CreateTermOfServiceUserStatusRequestBodyArgUserFieldTypeField = - deserializeCreateTermOfServiceUserStatusRequestBodyArgUserFieldTypeField( - val.type - ); +): CreateTermOfServiceUserStatusRequestBodyUserField { + const type: CreateTermOfServiceUserStatusRequestBodyUserTypeField = + deserializeCreateTermOfServiceUserStatusRequestBodyUserTypeField(val.type); const id: string = val.id; return { type: type, id: id, - } satisfies CreateTermOfServiceUserStatusRequestBodyArgUserField; + } satisfies CreateTermOfServiceUserStatusRequestBodyUserField; } -export function serializeCreateTermOfServiceUserStatusRequestBodyArg( - val: CreateTermOfServiceUserStatusRequestBodyArg +export function serializeCreateTermOfServiceUserStatusRequestBody( + val: CreateTermOfServiceUserStatusRequestBody ): SerializedData { return { - ['tos']: serializeCreateTermOfServiceUserStatusRequestBodyArgTosField( - val.tos - ), - ['user']: serializeCreateTermOfServiceUserStatusRequestBodyArgUserField( + ['tos']: serializeCreateTermOfServiceUserStatusRequestBodyTosField(val.tos), + ['user']: serializeCreateTermOfServiceUserStatusRequestBodyUserField( val.user ), ['is_accepted']: val.isAccepted, }; } -export function deserializeCreateTermOfServiceUserStatusRequestBodyArg( +export function deserializeCreateTermOfServiceUserStatusRequestBody( val: any -): CreateTermOfServiceUserStatusRequestBodyArg { - const tos: CreateTermOfServiceUserStatusRequestBodyArgTosField = - deserializeCreateTermOfServiceUserStatusRequestBodyArgTosField(val.tos); - const user: CreateTermOfServiceUserStatusRequestBodyArgUserField = - deserializeCreateTermOfServiceUserStatusRequestBodyArgUserField(val.user); +): CreateTermOfServiceUserStatusRequestBody { + const tos: CreateTermOfServiceUserStatusRequestBodyTosField = + deserializeCreateTermOfServiceUserStatusRequestBodyTosField(val.tos); + const user: CreateTermOfServiceUserStatusRequestBodyUserField = + deserializeCreateTermOfServiceUserStatusRequestBodyUserField(val.user); const isAccepted: boolean = val.is_accepted; return { tos: tos, user: user, isAccepted: isAccepted, - } satisfies CreateTermOfServiceUserStatusRequestBodyArg; + } satisfies CreateTermOfServiceUserStatusRequestBody; } -export function serializeUpdateTermOfServiceUserStatusByIdRequestBodyArg( - val: UpdateTermOfServiceUserStatusByIdRequestBodyArg +export function serializeUpdateTermOfServiceUserStatusByIdRequestBody( + val: UpdateTermOfServiceUserStatusByIdRequestBody ): SerializedData { return { ['is_accepted']: val.isAccepted }; } -export function deserializeUpdateTermOfServiceUserStatusByIdRequestBodyArg( +export function deserializeUpdateTermOfServiceUserStatusByIdRequestBody( val: any -): UpdateTermOfServiceUserStatusByIdRequestBodyArg { +): UpdateTermOfServiceUserStatusByIdRequestBody { const isAccepted: boolean = val.is_accepted; return { isAccepted: isAccepted, - } satisfies UpdateTermOfServiceUserStatusByIdRequestBodyArg; + } satisfies UpdateTermOfServiceUserStatusByIdRequestBody; } diff --git a/src/managers/termsOfServices.generated.ts b/src/managers/termsOfServices.generated.ts index 8ce96753..05d42410 100644 --- a/src/managers/termsOfServices.generated.ts +++ b/src/managers/termsOfServices.generated.ts @@ -27,95 +27,92 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export type GetTermOfServicesQueryParamsArgTosTypeField = - | 'external' - | 'managed'; -export interface GetTermOfServicesQueryParamsArg { - readonly tosType?: GetTermOfServicesQueryParamsArgTosTypeField; +export type GetTermOfServicesQueryParamsTosTypeField = 'external' | 'managed'; +export interface GetTermOfServicesQueryParams { + readonly tosType?: GetTermOfServicesQueryParamsTosTypeField; } -export class GetTermOfServicesHeadersArg { +export class GetTermOfServicesHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateTermOfServiceRequestBodyArgStatusField = - | 'enabled' - | 'disabled'; -export type CreateTermOfServiceRequestBodyArgTosTypeField = - | 'external' - | 'managed'; -export interface CreateTermOfServiceRequestBodyArg { - readonly status: CreateTermOfServiceRequestBodyArgStatusField; - readonly tosType?: CreateTermOfServiceRequestBodyArgTosTypeField; +export type CreateTermOfServiceRequestBodyStatusField = 'enabled' | 'disabled'; +export type CreateTermOfServiceRequestBodyTosTypeField = 'external' | 'managed'; +export interface CreateTermOfServiceRequestBody { + readonly status: CreateTermOfServiceRequestBodyStatusField; + readonly tosType?: CreateTermOfServiceRequestBodyTosTypeField; readonly text: string; } -export class CreateTermOfServiceHeadersArg { +export class CreateTermOfServiceHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class GetTermOfServiceByIdHeadersArg { +export class GetTermOfServiceByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateTermOfServiceByIdRequestBodyArgStatusField = +export type UpdateTermOfServiceByIdRequestBodyStatusField = | 'enabled' | 'disabled'; -export interface UpdateTermOfServiceByIdRequestBodyArg { - readonly status: UpdateTermOfServiceByIdRequestBodyArgStatusField; +export interface UpdateTermOfServiceByIdRequestBody { + readonly status: UpdateTermOfServiceByIdRequestBodyStatusField; readonly text: string; } -export class UpdateTermOfServiceByIdHeadersArg { +export class UpdateTermOfServiceByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class TermsOfServicesManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - TermsOfServicesManager, - | 'getTermOfServices' - | 'createTermOfService' - | 'getTermOfServiceById' - | 'updateTermOfServiceById' - > + fields: + | Omit< + TermsOfServicesManager, + | 'networkSession' + | 'getTermOfServices' + | 'createTermOfService' + | 'getTermOfServiceById' + | 'updateTermOfServiceById' + > + | Partial> ) { Object.assign(this, fields); } async getTermOfServices( - queryParams: GetTermOfServicesQueryParamsArg = {} satisfies GetTermOfServicesQueryParamsArg, - headers: GetTermOfServicesHeadersArg = new GetTermOfServicesHeadersArg({}), + queryParams: GetTermOfServicesQueryParams = {} satisfies GetTermOfServicesQueryParams, + headers: GetTermOfServicesHeaders = new GetTermOfServicesHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -127,7 +124,10 @@ export class TermsOfServicesManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/terms_of_services') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/terms_of_services' + ) as string, { method: 'GET', params: queryParamsMap, @@ -141,21 +141,22 @@ export class TermsOfServicesManager { return deserializeTermsOfServices(response.data); } async createTermOfService( - requestBody: CreateTermOfServiceRequestBodyArg, - headers: CreateTermOfServiceHeadersArg = new CreateTermOfServiceHeadersArg( - {} - ), + requestBody: CreateTermOfServiceRequestBody, + headers: CreateTermOfServiceHeaders = new CreateTermOfServiceHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/terms_of_services') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/terms_of_services' + ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateTermOfServiceRequestBodyArg(requestBody), + data: serializeCreateTermOfServiceRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -167,9 +168,7 @@ export class TermsOfServicesManager { } async getTermOfServiceById( termsOfServiceId: string, - headers: GetTermOfServiceByIdHeadersArg = new GetTermOfServiceByIdHeadersArg( - {} - ), + headers: GetTermOfServiceByIdHeaders = new GetTermOfServiceByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -177,7 +176,8 @@ export class TermsOfServicesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/terms_of_services/', + this.networkSession.baseUrls.baseUrl, + '/terms_of_services/', toString(termsOfServiceId) as string ) as string, { @@ -193,8 +193,8 @@ export class TermsOfServicesManager { } async updateTermOfServiceById( termsOfServiceId: string, - requestBody: UpdateTermOfServiceByIdRequestBodyArg, - headers: UpdateTermOfServiceByIdHeadersArg = new UpdateTermOfServiceByIdHeadersArg( + requestBody: UpdateTermOfServiceByIdRequestBody, + headers: UpdateTermOfServiceByIdHeaders = new UpdateTermOfServiceByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -204,13 +204,14 @@ export class TermsOfServicesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/terms_of_services/', + this.networkSession.baseUrls.baseUrl, + '/terms_of_services/', toString(termsOfServiceId) as string ) as string, { method: 'PUT', headers: headersMap, - data: serializeUpdateTermOfServiceByIdRequestBodyArg(requestBody), + data: serializeUpdateTermOfServiceByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -221,16 +222,16 @@ export class TermsOfServicesManager { return deserializeTermsOfService(response.data); } } -export function serializeGetTermOfServicesQueryParamsArgTosTypeField( - val: GetTermOfServicesQueryParamsArgTosTypeField +export function serializeGetTermOfServicesQueryParamsTosTypeField( + val: GetTermOfServicesQueryParamsTosTypeField ): SerializedData { return val; } -export function deserializeGetTermOfServicesQueryParamsArgTosTypeField( +export function deserializeGetTermOfServicesQueryParamsTosTypeField( val: any -): GetTermOfServicesQueryParamsArgTosTypeField { +): GetTermOfServicesQueryParamsTosTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetTermOfServicesQueryParamsArgTosTypeField"'; + throw 'Expecting a string for "GetTermOfServicesQueryParamsTosTypeField"'; } if (val == 'external') { return 'external'; @@ -240,16 +241,16 @@ export function deserializeGetTermOfServicesQueryParamsArgTosTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateTermOfServiceRequestBodyArgStatusField( - val: CreateTermOfServiceRequestBodyArgStatusField +export function serializeCreateTermOfServiceRequestBodyStatusField( + val: CreateTermOfServiceRequestBodyStatusField ): SerializedData { return val; } -export function deserializeCreateTermOfServiceRequestBodyArgStatusField( +export function deserializeCreateTermOfServiceRequestBodyStatusField( val: any -): CreateTermOfServiceRequestBodyArgStatusField { +): CreateTermOfServiceRequestBodyStatusField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateTermOfServiceRequestBodyArgStatusField"'; + throw 'Expecting a string for "CreateTermOfServiceRequestBodyStatusField"'; } if (val == 'enabled') { return 'enabled'; @@ -259,16 +260,16 @@ export function deserializeCreateTermOfServiceRequestBodyArgStatusField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateTermOfServiceRequestBodyArgTosTypeField( - val: CreateTermOfServiceRequestBodyArgTosTypeField +export function serializeCreateTermOfServiceRequestBodyTosTypeField( + val: CreateTermOfServiceRequestBodyTosTypeField ): SerializedData { return val; } -export function deserializeCreateTermOfServiceRequestBodyArgTosTypeField( +export function deserializeCreateTermOfServiceRequestBodyTosTypeField( val: any -): CreateTermOfServiceRequestBodyArgTosTypeField { +): CreateTermOfServiceRequestBodyTosTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateTermOfServiceRequestBodyArgTosTypeField"'; + throw 'Expecting a string for "CreateTermOfServiceRequestBodyTosTypeField"'; } if (val == 'external') { return 'external'; @@ -278,46 +279,44 @@ export function deserializeCreateTermOfServiceRequestBodyArgTosTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateTermOfServiceRequestBodyArg( - val: CreateTermOfServiceRequestBodyArg +export function serializeCreateTermOfServiceRequestBody( + val: CreateTermOfServiceRequestBody ): SerializedData { return { - ['status']: serializeCreateTermOfServiceRequestBodyArgStatusField( - val.status - ), + ['status']: serializeCreateTermOfServiceRequestBodyStatusField(val.status), ['tos_type']: val.tosType == void 0 ? void 0 - : serializeCreateTermOfServiceRequestBodyArgTosTypeField(val.tosType), + : serializeCreateTermOfServiceRequestBodyTosTypeField(val.tosType), ['text']: val.text, }; } -export function deserializeCreateTermOfServiceRequestBodyArg( +export function deserializeCreateTermOfServiceRequestBody( val: any -): CreateTermOfServiceRequestBodyArg { - const status: CreateTermOfServiceRequestBodyArgStatusField = - deserializeCreateTermOfServiceRequestBodyArgStatusField(val.status); - const tosType: undefined | CreateTermOfServiceRequestBodyArgTosTypeField = +): CreateTermOfServiceRequestBody { + const status: CreateTermOfServiceRequestBodyStatusField = + deserializeCreateTermOfServiceRequestBodyStatusField(val.status); + const tosType: undefined | CreateTermOfServiceRequestBodyTosTypeField = val.tos_type == void 0 ? void 0 - : deserializeCreateTermOfServiceRequestBodyArgTosTypeField(val.tos_type); + : deserializeCreateTermOfServiceRequestBodyTosTypeField(val.tos_type); const text: string = val.text; return { status: status, tosType: tosType, text: text, - } satisfies CreateTermOfServiceRequestBodyArg; + } satisfies CreateTermOfServiceRequestBody; } -export function serializeUpdateTermOfServiceByIdRequestBodyArgStatusField( - val: UpdateTermOfServiceByIdRequestBodyArgStatusField +export function serializeUpdateTermOfServiceByIdRequestBodyStatusField( + val: UpdateTermOfServiceByIdRequestBodyStatusField ): SerializedData { return val; } -export function deserializeUpdateTermOfServiceByIdRequestBodyArgStatusField( +export function deserializeUpdateTermOfServiceByIdRequestBodyStatusField( val: any -): UpdateTermOfServiceByIdRequestBodyArgStatusField { +): UpdateTermOfServiceByIdRequestBodyStatusField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateTermOfServiceByIdRequestBodyArgStatusField"'; + throw 'Expecting a string for "UpdateTermOfServiceByIdRequestBodyStatusField"'; } if (val == 'enabled') { return 'enabled'; @@ -327,24 +326,24 @@ export function deserializeUpdateTermOfServiceByIdRequestBodyArgStatusField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateTermOfServiceByIdRequestBodyArg( - val: UpdateTermOfServiceByIdRequestBodyArg +export function serializeUpdateTermOfServiceByIdRequestBody( + val: UpdateTermOfServiceByIdRequestBody ): SerializedData { return { - ['status']: serializeUpdateTermOfServiceByIdRequestBodyArgStatusField( + ['status']: serializeUpdateTermOfServiceByIdRequestBodyStatusField( val.status ), ['text']: val.text, }; } -export function deserializeUpdateTermOfServiceByIdRequestBodyArg( +export function deserializeUpdateTermOfServiceByIdRequestBody( val: any -): UpdateTermOfServiceByIdRequestBodyArg { - const status: UpdateTermOfServiceByIdRequestBodyArgStatusField = - deserializeUpdateTermOfServiceByIdRequestBodyArgStatusField(val.status); +): UpdateTermOfServiceByIdRequestBody { + const status: UpdateTermOfServiceByIdRequestBodyStatusField = + deserializeUpdateTermOfServiceByIdRequestBodyStatusField(val.status); const text: string = val.text; return { status: status, text: text, - } satisfies UpdateTermOfServiceByIdRequestBodyArg; + } satisfies UpdateTermOfServiceByIdRequestBody; } diff --git a/src/managers/transfer.generated.ts b/src/managers/transfer.generated.ts index e2f96ef3..692073dc 100644 --- a/src/managers/transfer.generated.ts +++ b/src/managers/transfer.generated.ts @@ -21,41 +21,43 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface TransferOwnedFolderRequestBodyArgOwnedByField { +export interface TransferOwnedFolderRequestBodyOwnedByField { readonly id: string; } -export interface TransferOwnedFolderRequestBodyArg { - readonly ownedBy: TransferOwnedFolderRequestBodyArgOwnedByField; +export interface TransferOwnedFolderRequestBody { + readonly ownedBy: TransferOwnedFolderRequestBodyOwnedByField; } -export interface TransferOwnedFolderQueryParamsArg { +export interface TransferOwnedFolderQueryParams { readonly fields?: readonly string[]; readonly notify?: boolean; } -export class TransferOwnedFolderHeadersArg { +export class TransferOwnedFolderHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class TransferManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; - constructor(fields: Omit) { + readonly networkSession: NetworkSession = new NetworkSession({}); + constructor( + fields: + | Omit + | Partial> + ) { Object.assign(this, fields); } async transferOwnedFolder( userId: string, - requestBody: TransferOwnedFolderRequestBodyArg, - queryParams: TransferOwnedFolderQueryParamsArg = {} satisfies TransferOwnedFolderQueryParamsArg, - headers: TransferOwnedFolderHeadersArg = new TransferOwnedFolderHeadersArg( - {} - ), + requestBody: TransferOwnedFolderRequestBody, + queryParams: TransferOwnedFolderQueryParams = {} satisfies TransferOwnedFolderQueryParams, + headers: TransferOwnedFolderHeaders = new TransferOwnedFolderHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -71,7 +73,8 @@ export class TransferManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/users/', + this.networkSession.baseUrls.baseUrl, + '/users/', toString(userId) as string, '/folders/0' ) as string, @@ -79,7 +82,7 @@ export class TransferManager { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeTransferOwnedFolderRequestBodyArg(requestBody), + data: serializeTransferOwnedFolderRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -90,30 +93,30 @@ export class TransferManager { return deserializeFolderFull(response.data); } } -export function serializeTransferOwnedFolderRequestBodyArgOwnedByField( - val: TransferOwnedFolderRequestBodyArgOwnedByField +export function serializeTransferOwnedFolderRequestBodyOwnedByField( + val: TransferOwnedFolderRequestBodyOwnedByField ): SerializedData { return { ['id']: val.id }; } -export function deserializeTransferOwnedFolderRequestBodyArgOwnedByField( +export function deserializeTransferOwnedFolderRequestBodyOwnedByField( val: any -): TransferOwnedFolderRequestBodyArgOwnedByField { +): TransferOwnedFolderRequestBodyOwnedByField { const id: string = val.id; - return { id: id } satisfies TransferOwnedFolderRequestBodyArgOwnedByField; + return { id: id } satisfies TransferOwnedFolderRequestBodyOwnedByField; } -export function serializeTransferOwnedFolderRequestBodyArg( - val: TransferOwnedFolderRequestBodyArg +export function serializeTransferOwnedFolderRequestBody( + val: TransferOwnedFolderRequestBody ): SerializedData { return { - ['owned_by']: serializeTransferOwnedFolderRequestBodyArgOwnedByField( + ['owned_by']: serializeTransferOwnedFolderRequestBodyOwnedByField( val.ownedBy ), }; } -export function deserializeTransferOwnedFolderRequestBodyArg( +export function deserializeTransferOwnedFolderRequestBody( val: any -): TransferOwnedFolderRequestBodyArg { - const ownedBy: TransferOwnedFolderRequestBodyArgOwnedByField = - deserializeTransferOwnedFolderRequestBodyArgOwnedByField(val.owned_by); - return { ownedBy: ownedBy } satisfies TransferOwnedFolderRequestBodyArg; +): TransferOwnedFolderRequestBody { + const ownedBy: TransferOwnedFolderRequestBodyOwnedByField = + deserializeTransferOwnedFolderRequestBodyOwnedByField(val.owned_by); + return { ownedBy: ownedBy } satisfies TransferOwnedFolderRequestBody; } diff --git a/src/managers/trashedFiles.generated.ts b/src/managers/trashedFiles.generated.ts index 9cd3d9c2..9b7095db 100644 --- a/src/managers/trashedFiles.generated.ts +++ b/src/managers/trashedFiles.generated.ts @@ -24,73 +24,76 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface RestoreFileFromTrashRequestBodyArgParentField { +export interface RestoreFileFromTrashRequestBodyParentField { readonly id?: string; } -export interface RestoreFileFromTrashRequestBodyArg { +export interface RestoreFileFromTrashRequestBody { readonly name?: string; - readonly parent?: RestoreFileFromTrashRequestBodyArgParentField; + readonly parent?: RestoreFileFromTrashRequestBodyParentField; } -export interface RestoreFileFromTrashQueryParamsArg { +export interface RestoreFileFromTrashQueryParams { readonly fields?: readonly string[]; } -export class RestoreFileFromTrashHeadersArg { +export class RestoreFileFromTrashHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetFileTrashQueryParamsArg { +export interface GetFileTrashQueryParams { readonly fields?: readonly string[]; } -export class GetFileTrashHeadersArg { +export class GetFileTrashHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteFileTrashHeadersArg { +export class DeleteFileTrashHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class TrashedFilesManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - TrashedFilesManager, - 'restoreFileFromTrash' | 'getFileTrash' | 'deleteFileTrash' - > + fields: + | Omit< + TrashedFilesManager, + | 'networkSession' + | 'restoreFileFromTrash' + | 'getFileTrash' + | 'deleteFileTrash' + > + | Partial> ) { Object.assign(this, fields); } async restoreFileFromTrash( fileId: string, - requestBody: RestoreFileFromTrashRequestBodyArg = {} satisfies RestoreFileFromTrashRequestBodyArg, - queryParams: RestoreFileFromTrashQueryParamsArg = {} satisfies RestoreFileFromTrashQueryParamsArg, - headers: RestoreFileFromTrashHeadersArg = new RestoreFileFromTrashHeadersArg( - {} - ), + requestBody: RestoreFileFromTrashRequestBody = {} satisfies RestoreFileFromTrashRequestBody, + queryParams: RestoreFileFromTrashQueryParams = {} satisfies RestoreFileFromTrashQueryParams, + headers: RestoreFileFromTrashHeaders = new RestoreFileFromTrashHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -105,14 +108,15 @@ export class TrashedFilesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string ) as string, { method: 'POST', params: queryParamsMap, headers: headersMap, - data: serializeRestoreFileFromTrashRequestBodyArg(requestBody), + data: serializeRestoreFileFromTrashRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -124,8 +128,8 @@ export class TrashedFilesManager { } async getFileTrash( fileId: string, - queryParams: GetFileTrashQueryParamsArg = {} satisfies GetFileTrashQueryParamsArg, - headers: GetFileTrashHeadersArg = new GetFileTrashHeadersArg({}), + queryParams: GetFileTrashQueryParams = {} satisfies GetFileTrashQueryParams, + headers: GetFileTrashHeaders = new GetFileTrashHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -140,7 +144,8 @@ export class TrashedFilesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/trash' ) as string, @@ -158,7 +163,7 @@ export class TrashedFilesManager { } async deleteFileTrash( fileId: string, - headers: DeleteFileTrashHeadersArg = new DeleteFileTrashHeadersArg({}), + headers: DeleteFileTrashHeaders = new DeleteFileTrashHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -166,7 +171,8 @@ export class TrashedFilesManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/files/', + this.networkSession.baseUrls.baseUrl, + '/files/', toString(fileId) as string, '/trash' ) as string, @@ -182,38 +188,38 @@ export class TrashedFilesManager { return void 0; } } -export function serializeRestoreFileFromTrashRequestBodyArgParentField( - val: RestoreFileFromTrashRequestBodyArgParentField +export function serializeRestoreFileFromTrashRequestBodyParentField( + val: RestoreFileFromTrashRequestBodyParentField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id }; } -export function deserializeRestoreFileFromTrashRequestBodyArgParentField( +export function deserializeRestoreFileFromTrashRequestBodyParentField( val: any -): RestoreFileFromTrashRequestBodyArgParentField { +): RestoreFileFromTrashRequestBodyParentField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - return { id: id } satisfies RestoreFileFromTrashRequestBodyArgParentField; + return { id: id } satisfies RestoreFileFromTrashRequestBodyParentField; } -export function serializeRestoreFileFromTrashRequestBodyArg( - val: RestoreFileFromTrashRequestBodyArg +export function serializeRestoreFileFromTrashRequestBody( + val: RestoreFileFromTrashRequestBody ): SerializedData { return { ['name']: val.name == void 0 ? void 0 : val.name, ['parent']: val.parent == void 0 ? void 0 - : serializeRestoreFileFromTrashRequestBodyArgParentField(val.parent), + : serializeRestoreFileFromTrashRequestBodyParentField(val.parent), }; } -export function deserializeRestoreFileFromTrashRequestBodyArg( +export function deserializeRestoreFileFromTrashRequestBody( val: any -): RestoreFileFromTrashRequestBodyArg { +): RestoreFileFromTrashRequestBody { const name: undefined | string = val.name == void 0 ? void 0 : val.name; - const parent: undefined | RestoreFileFromTrashRequestBodyArgParentField = + const parent: undefined | RestoreFileFromTrashRequestBodyParentField = val.parent == void 0 ? void 0 - : deserializeRestoreFileFromTrashRequestBodyArgParentField(val.parent); + : deserializeRestoreFileFromTrashRequestBodyParentField(val.parent); return { name: name, parent: parent, - } satisfies RestoreFileFromTrashRequestBodyArg; + } satisfies RestoreFileFromTrashRequestBody; } diff --git a/src/managers/trashedFolders.generated.ts b/src/managers/trashedFolders.generated.ts index cd6b5e40..3a9fb7e6 100644 --- a/src/managers/trashedFolders.generated.ts +++ b/src/managers/trashedFolders.generated.ts @@ -24,71 +24,76 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface RestoreFolderFromTrashRequestBodyArgParentField { +export interface RestoreFolderFromTrashRequestBodyParentField { readonly id?: string; } -export interface RestoreFolderFromTrashRequestBodyArg { +export interface RestoreFolderFromTrashRequestBody { readonly name?: string; - readonly parent?: RestoreFolderFromTrashRequestBodyArgParentField; + readonly parent?: RestoreFolderFromTrashRequestBodyParentField; } -export interface RestoreFolderFromTrashQueryParamsArg { +export interface RestoreFolderFromTrashQueryParams { readonly fields?: readonly string[]; } -export class RestoreFolderFromTrashHeadersArg { +export class RestoreFolderFromTrashHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetFolderTrashQueryParamsArg { +export interface GetFolderTrashQueryParams { readonly fields?: readonly string[]; } -export class GetFolderTrashHeadersArg { +export class GetFolderTrashHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteFolderTrashHeadersArg { +export class DeleteFolderTrashHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class TrashedFoldersManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - TrashedFoldersManager, - 'restoreFolderFromTrash' | 'getFolderTrash' | 'deleteFolderTrash' - > + fields: + | Omit< + TrashedFoldersManager, + | 'networkSession' + | 'restoreFolderFromTrash' + | 'getFolderTrash' + | 'deleteFolderTrash' + > + | Partial> ) { Object.assign(this, fields); } async restoreFolderFromTrash( folderId: string, - requestBody: RestoreFolderFromTrashRequestBodyArg = {} satisfies RestoreFolderFromTrashRequestBodyArg, - queryParams: RestoreFolderFromTrashQueryParamsArg = {} satisfies RestoreFolderFromTrashQueryParamsArg, - headers: RestoreFolderFromTrashHeadersArg = new RestoreFolderFromTrashHeadersArg( + requestBody: RestoreFolderFromTrashRequestBody = {} satisfies RestoreFolderFromTrashRequestBody, + queryParams: RestoreFolderFromTrashQueryParams = {} satisfies RestoreFolderFromTrashQueryParams, + headers: RestoreFolderFromTrashHeaders = new RestoreFolderFromTrashHeaders( {} ), cancellationToken?: CancellationToken @@ -105,14 +110,15 @@ export class TrashedFoldersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string ) as string, { method: 'POST', params: queryParamsMap, headers: headersMap, - data: serializeRestoreFolderFromTrashRequestBodyArg(requestBody), + data: serializeRestoreFolderFromTrashRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -124,8 +130,8 @@ export class TrashedFoldersManager { } async getFolderTrash( folderId: string, - queryParams: GetFolderTrashQueryParamsArg = {} satisfies GetFolderTrashQueryParamsArg, - headers: GetFolderTrashHeadersArg = new GetFolderTrashHeadersArg({}), + queryParams: GetFolderTrashQueryParams = {} satisfies GetFolderTrashQueryParams, + headers: GetFolderTrashHeaders = new GetFolderTrashHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -140,7 +146,8 @@ export class TrashedFoldersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '/trash' ) as string, @@ -158,7 +165,7 @@ export class TrashedFoldersManager { } async deleteFolderTrash( folderId: string, - headers: DeleteFolderTrashHeadersArg = new DeleteFolderTrashHeadersArg({}), + headers: DeleteFolderTrashHeaders = new DeleteFolderTrashHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -166,7 +173,8 @@ export class TrashedFoldersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/folders/', + this.networkSession.baseUrls.baseUrl, + '/folders/', toString(folderId) as string, '/trash' ) as string, @@ -182,38 +190,38 @@ export class TrashedFoldersManager { return void 0; } } -export function serializeRestoreFolderFromTrashRequestBodyArgParentField( - val: RestoreFolderFromTrashRequestBodyArgParentField +export function serializeRestoreFolderFromTrashRequestBodyParentField( + val: RestoreFolderFromTrashRequestBodyParentField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id }; } -export function deserializeRestoreFolderFromTrashRequestBodyArgParentField( +export function deserializeRestoreFolderFromTrashRequestBodyParentField( val: any -): RestoreFolderFromTrashRequestBodyArgParentField { +): RestoreFolderFromTrashRequestBodyParentField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - return { id: id } satisfies RestoreFolderFromTrashRequestBodyArgParentField; + return { id: id } satisfies RestoreFolderFromTrashRequestBodyParentField; } -export function serializeRestoreFolderFromTrashRequestBodyArg( - val: RestoreFolderFromTrashRequestBodyArg +export function serializeRestoreFolderFromTrashRequestBody( + val: RestoreFolderFromTrashRequestBody ): SerializedData { return { ['name']: val.name == void 0 ? void 0 : val.name, ['parent']: val.parent == void 0 ? void 0 - : serializeRestoreFolderFromTrashRequestBodyArgParentField(val.parent), + : serializeRestoreFolderFromTrashRequestBodyParentField(val.parent), }; } -export function deserializeRestoreFolderFromTrashRequestBodyArg( +export function deserializeRestoreFolderFromTrashRequestBody( val: any -): RestoreFolderFromTrashRequestBodyArg { +): RestoreFolderFromTrashRequestBody { const name: undefined | string = val.name == void 0 ? void 0 : val.name; - const parent: undefined | RestoreFolderFromTrashRequestBodyArgParentField = + const parent: undefined | RestoreFolderFromTrashRequestBodyParentField = val.parent == void 0 ? void 0 - : deserializeRestoreFolderFromTrashRequestBodyArgParentField(val.parent); + : deserializeRestoreFolderFromTrashRequestBodyParentField(val.parent); return { name: name, parent: parent, - } satisfies RestoreFolderFromTrashRequestBodyArg; + } satisfies RestoreFolderFromTrashRequestBody; } diff --git a/src/managers/trashedItems.generated.ts b/src/managers/trashedItems.generated.ts index 9f70be15..fd72f9c7 100644 --- a/src/managers/trashedItems.generated.ts +++ b/src/managers/trashedItems.generated.ts @@ -21,43 +21,42 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export type GetFolderTrashItemsQueryParamsArgDirectionField = 'ASC' | 'DESC'; -export type GetFolderTrashItemsQueryParamsArgSortField = - | 'name' - | 'date' - | 'size'; -export interface GetFolderTrashItemsQueryParamsArg { +export type GetFolderTrashItemsQueryParamsDirectionField = 'ASC' | 'DESC'; +export type GetFolderTrashItemsQueryParamsSortField = 'name' | 'date' | 'size'; +export interface GetFolderTrashItemsQueryParams { readonly fields?: readonly string[]; readonly limit?: number; readonly offset?: number; readonly usemarker?: boolean; readonly marker?: string; - readonly direction?: GetFolderTrashItemsQueryParamsArgDirectionField; - readonly sort?: GetFolderTrashItemsQueryParamsArgSortField; + readonly direction?: GetFolderTrashItemsQueryParamsDirectionField; + readonly sort?: GetFolderTrashItemsQueryParamsSortField; } -export class GetFolderTrashItemsHeadersArg { +export class GetFolderTrashItemsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class TrashedItemsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; - constructor(fields: Omit) { + readonly networkSession: NetworkSession = new NetworkSession({}); + constructor( + fields: + | Omit + | Partial> + ) { Object.assign(this, fields); } async getFolderTrashItems( - queryParams: GetFolderTrashItemsQueryParamsArg = {} satisfies GetFolderTrashItemsQueryParamsArg, - headers: GetFolderTrashItemsHeadersArg = new GetFolderTrashItemsHeadersArg( - {} - ), + queryParams: GetFolderTrashItemsQueryParams = {} satisfies GetFolderTrashItemsQueryParams, + headers: GetFolderTrashItemsHeaders = new GetFolderTrashItemsHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -77,7 +76,10 @@ export class TrashedItemsManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/folders/trash/items') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/folders/trash/items' + ) as string, { method: 'GET', params: queryParamsMap, @@ -91,16 +93,16 @@ export class TrashedItemsManager { return deserializeItems(response.data); } } -export function serializeGetFolderTrashItemsQueryParamsArgDirectionField( - val: GetFolderTrashItemsQueryParamsArgDirectionField +export function serializeGetFolderTrashItemsQueryParamsDirectionField( + val: GetFolderTrashItemsQueryParamsDirectionField ): SerializedData { return val; } -export function deserializeGetFolderTrashItemsQueryParamsArgDirectionField( +export function deserializeGetFolderTrashItemsQueryParamsDirectionField( val: any -): GetFolderTrashItemsQueryParamsArgDirectionField { +): GetFolderTrashItemsQueryParamsDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetFolderTrashItemsQueryParamsArgDirectionField"'; + throw 'Expecting a string for "GetFolderTrashItemsQueryParamsDirectionField"'; } if (val == 'ASC') { return 'ASC'; @@ -110,16 +112,16 @@ export function deserializeGetFolderTrashItemsQueryParamsArgDirectionField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeGetFolderTrashItemsQueryParamsArgSortField( - val: GetFolderTrashItemsQueryParamsArgSortField +export function serializeGetFolderTrashItemsQueryParamsSortField( + val: GetFolderTrashItemsQueryParamsSortField ): SerializedData { return val; } -export function deserializeGetFolderTrashItemsQueryParamsArgSortField( +export function deserializeGetFolderTrashItemsQueryParamsSortField( val: any -): GetFolderTrashItemsQueryParamsArgSortField { +): GetFolderTrashItemsQueryParamsSortField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetFolderTrashItemsQueryParamsArgSortField"'; + throw 'Expecting a string for "GetFolderTrashItemsQueryParamsSortField"'; } if (val == 'name') { return 'name'; diff --git a/src/managers/trashedWebLinks.generated.ts b/src/managers/trashedWebLinks.generated.ts index 44343f49..14ca0cda 100644 --- a/src/managers/trashedWebLinks.generated.ts +++ b/src/managers/trashedWebLinks.generated.ts @@ -24,71 +24,76 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface RestoreWeblinkFromTrashRequestBodyArgParentField { +export interface RestoreWeblinkFromTrashRequestBodyParentField { readonly id?: string; } -export interface RestoreWeblinkFromTrashRequestBodyArg { +export interface RestoreWeblinkFromTrashRequestBody { readonly name?: string; - readonly parent?: RestoreWeblinkFromTrashRequestBodyArgParentField; + readonly parent?: RestoreWeblinkFromTrashRequestBodyParentField; } -export interface RestoreWeblinkFromTrashQueryParamsArg { +export interface RestoreWeblinkFromTrashQueryParams { readonly fields?: readonly string[]; } -export class RestoreWeblinkFromTrashHeadersArg { +export class RestoreWeblinkFromTrashHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetWebLinkTrashQueryParamsArg { +export interface GetWebLinkTrashQueryParams { readonly fields?: readonly string[]; } -export class GetWebLinkTrashHeadersArg { +export class GetWebLinkTrashHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteWebLinkTrashHeadersArg { +export class DeleteWebLinkTrashHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class TrashedWebLinksManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - TrashedWebLinksManager, - 'restoreWeblinkFromTrash' | 'getWebLinkTrash' | 'deleteWebLinkTrash' - > + fields: + | Omit< + TrashedWebLinksManager, + | 'networkSession' + | 'restoreWeblinkFromTrash' + | 'getWebLinkTrash' + | 'deleteWebLinkTrash' + > + | Partial> ) { Object.assign(this, fields); } async restoreWeblinkFromTrash( webLinkId: string, - requestBody: RestoreWeblinkFromTrashRequestBodyArg = {} satisfies RestoreWeblinkFromTrashRequestBodyArg, - queryParams: RestoreWeblinkFromTrashQueryParamsArg = {} satisfies RestoreWeblinkFromTrashQueryParamsArg, - headers: RestoreWeblinkFromTrashHeadersArg = new RestoreWeblinkFromTrashHeadersArg( + requestBody: RestoreWeblinkFromTrashRequestBody = {} satisfies RestoreWeblinkFromTrashRequestBody, + queryParams: RestoreWeblinkFromTrashQueryParams = {} satisfies RestoreWeblinkFromTrashQueryParams, + headers: RestoreWeblinkFromTrashHeaders = new RestoreWeblinkFromTrashHeaders( {} ), cancellationToken?: CancellationToken @@ -105,14 +110,15 @@ export class TrashedWebLinksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/web_links/', + this.networkSession.baseUrls.baseUrl, + '/web_links/', toString(webLinkId) as string ) as string, { method: 'POST', params: queryParamsMap, headers: headersMap, - data: serializeRestoreWeblinkFromTrashRequestBodyArg(requestBody), + data: serializeRestoreWeblinkFromTrashRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -124,8 +130,8 @@ export class TrashedWebLinksManager { } async getWebLinkTrash( webLinkId: string, - queryParams: GetWebLinkTrashQueryParamsArg = {} satisfies GetWebLinkTrashQueryParamsArg, - headers: GetWebLinkTrashHeadersArg = new GetWebLinkTrashHeadersArg({}), + queryParams: GetWebLinkTrashQueryParams = {} satisfies GetWebLinkTrashQueryParams, + headers: GetWebLinkTrashHeaders = new GetWebLinkTrashHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -140,7 +146,8 @@ export class TrashedWebLinksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/web_links/', + this.networkSession.baseUrls.baseUrl, + '/web_links/', toString(webLinkId) as string, '/trash' ) as string, @@ -158,9 +165,7 @@ export class TrashedWebLinksManager { } async deleteWebLinkTrash( webLinkId: string, - headers: DeleteWebLinkTrashHeadersArg = new DeleteWebLinkTrashHeadersArg( - {} - ), + headers: DeleteWebLinkTrashHeaders = new DeleteWebLinkTrashHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -168,7 +173,8 @@ export class TrashedWebLinksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/web_links/', + this.networkSession.baseUrls.baseUrl, + '/web_links/', toString(webLinkId) as string, '/trash' ) as string, @@ -184,38 +190,38 @@ export class TrashedWebLinksManager { return void 0; } } -export function serializeRestoreWeblinkFromTrashRequestBodyArgParentField( - val: RestoreWeblinkFromTrashRequestBodyArgParentField +export function serializeRestoreWeblinkFromTrashRequestBodyParentField( + val: RestoreWeblinkFromTrashRequestBodyParentField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id }; } -export function deserializeRestoreWeblinkFromTrashRequestBodyArgParentField( +export function deserializeRestoreWeblinkFromTrashRequestBodyParentField( val: any -): RestoreWeblinkFromTrashRequestBodyArgParentField { +): RestoreWeblinkFromTrashRequestBodyParentField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - return { id: id } satisfies RestoreWeblinkFromTrashRequestBodyArgParentField; + return { id: id } satisfies RestoreWeblinkFromTrashRequestBodyParentField; } -export function serializeRestoreWeblinkFromTrashRequestBodyArg( - val: RestoreWeblinkFromTrashRequestBodyArg +export function serializeRestoreWeblinkFromTrashRequestBody( + val: RestoreWeblinkFromTrashRequestBody ): SerializedData { return { ['name']: val.name == void 0 ? void 0 : val.name, ['parent']: val.parent == void 0 ? void 0 - : serializeRestoreWeblinkFromTrashRequestBodyArgParentField(val.parent), + : serializeRestoreWeblinkFromTrashRequestBodyParentField(val.parent), }; } -export function deserializeRestoreWeblinkFromTrashRequestBodyArg( +export function deserializeRestoreWeblinkFromTrashRequestBody( val: any -): RestoreWeblinkFromTrashRequestBodyArg { +): RestoreWeblinkFromTrashRequestBody { const name: undefined | string = val.name == void 0 ? void 0 : val.name; - const parent: undefined | RestoreWeblinkFromTrashRequestBodyArgParentField = + const parent: undefined | RestoreWeblinkFromTrashRequestBodyParentField = val.parent == void 0 ? void 0 - : deserializeRestoreWeblinkFromTrashRequestBodyArgParentField(val.parent); + : deserializeRestoreWeblinkFromTrashRequestBodyParentField(val.parent); return { name: name, parent: parent, - } satisfies RestoreWeblinkFromTrashRequestBodyArg; + } satisfies RestoreWeblinkFromTrashRequestBody; } diff --git a/src/managers/uploads.generated.ts b/src/managers/uploads.generated.ts index b637b702..1ddc8e59 100644 --- a/src/managers/uploads.generated.ts +++ b/src/managers/uploads.generated.ts @@ -28,20 +28,20 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface UploadFileVersionRequestBodyArgAttributesField { +export interface UploadFileVersionRequestBodyAttributesField { readonly name: string; readonly contentModifiedAt?: string; } -export interface UploadFileVersionRequestBodyArg { - readonly attributes: UploadFileVersionRequestBodyArgAttributesField; +export interface UploadFileVersionRequestBody { + readonly attributes: UploadFileVersionRequestBodyAttributesField; readonly file: ByteStream; readonly fileFileName?: string; readonly fileContentType?: string; } -export interface UploadFileVersionQueryParamsArg { +export interface UploadFileVersionQueryParams { readonly fields?: readonly string[]; } -export class UploadFileVersionHeadersArg { +export class UploadFileVersionHeaders { readonly ifMatch?: string; readonly contentMd5?: string; readonly extraHeaders?: { @@ -49,79 +49,84 @@ export class UploadFileVersionHeadersArg { } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface UploadFileRequestBodyArgAttributesFieldParentField { +export interface UploadFileRequestBodyAttributesParentField { readonly id: string; } -export interface UploadFileRequestBodyArgAttributesField { +export interface UploadFileRequestBodyAttributesField { readonly name: string; - readonly parent: UploadFileRequestBodyArgAttributesFieldParentField; + readonly parent: UploadFileRequestBodyAttributesParentField; readonly contentCreatedAt?: string; readonly contentModifiedAt?: string; } -export interface UploadFileRequestBodyArg { - readonly attributes: UploadFileRequestBodyArgAttributesField; +export interface UploadFileRequestBody { + readonly attributes: UploadFileRequestBodyAttributesField; readonly file: ByteStream; readonly fileFileName?: string; readonly fileContentType?: string; } -export interface UploadFileQueryParamsArg { +export interface UploadFileQueryParams { readonly fields?: readonly string[]; } -export class UploadFileHeadersArg { +export class UploadFileHeaders { readonly contentMd5?: string; readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface PreflightFileUploadRequestBodyArgParentField { +export interface PreflightFileUploadRequestBodyParentField { readonly id?: string; } -export interface PreflightFileUploadRequestBodyArg { +export interface PreflightFileUploadRequestBody { readonly name?: string; readonly size?: number; - readonly parent?: PreflightFileUploadRequestBodyArgParentField; + readonly parent?: PreflightFileUploadRequestBodyParentField; } -export class PreflightFileUploadHeadersArg { +export class PreflightFileUploadHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class UploadsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - UploadsManager, - 'uploadFileVersion' | 'uploadFile' | 'preflightFileUpload' - > + fields: + | Omit< + UploadsManager, + | 'networkSession' + | 'uploadFileVersion' + | 'uploadFile' + | 'preflightFileUpload' + > + | Partial> ) { Object.assign(this, fields); } async uploadFileVersion( fileId: string, - requestBody: UploadFileVersionRequestBodyArg, - queryParams: UploadFileVersionQueryParamsArg = {} satisfies UploadFileVersionQueryParamsArg, - headers: UploadFileVersionHeadersArg = new UploadFileVersionHeadersArg({}), + requestBody: UploadFileVersionRequestBody, + queryParams: UploadFileVersionQueryParams = {} satisfies UploadFileVersionQueryParams, + headers: UploadFileVersionHeaders = new UploadFileVersionHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -142,7 +147,8 @@ export class UploadsManager { }); const response: FetchResponse = (await fetch( ''.concat( - 'https://upload.box.com/api/2.0/files/', + this.networkSession.baseUrls.uploadUrl, + '/files/', toString(fileId) as string, '/content' ) as string, @@ -153,7 +159,7 @@ export class UploadsManager { multipartData: [ { partName: 'attributes', - data: serializeUploadFileVersionRequestBodyArgAttributesField( + data: serializeUploadFileVersionRequestBodyAttributesField( requestBody.attributes ), } satisfies MultipartItem, @@ -174,9 +180,9 @@ export class UploadsManager { return deserializeFiles(response.data); } async uploadFile( - requestBody: UploadFileRequestBodyArg, - queryParams: UploadFileQueryParamsArg = {} satisfies UploadFileQueryParamsArg, - headers: UploadFileHeadersArg = new UploadFileHeadersArg({}), + requestBody: UploadFileRequestBody, + queryParams: UploadFileQueryParams = {} satisfies UploadFileQueryParams, + headers: UploadFileHeaders = new UploadFileHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -193,7 +199,10 @@ export class UploadsManager { ...headers.extraHeaders, }); const response: FetchResponse = (await fetch( - ''.concat('https://upload.box.com/api/2.0/files/content') as string, + ''.concat( + this.networkSession.baseUrls.uploadUrl, + '/files/content' + ) as string, { method: 'POST', params: queryParamsMap, @@ -201,7 +210,7 @@ export class UploadsManager { multipartData: [ { partName: 'attributes', - data: serializeUploadFileRequestBodyArgAttributesField( + data: serializeUploadFileRequestBodyAttributesField( requestBody.attributes ), } satisfies MultipartItem, @@ -222,21 +231,22 @@ export class UploadsManager { return deserializeFiles(response.data); } async preflightFileUpload( - requestBody: PreflightFileUploadRequestBodyArg = {} satisfies PreflightFileUploadRequestBodyArg, - headers: PreflightFileUploadHeadersArg = new PreflightFileUploadHeadersArg( - {} - ), + requestBody: PreflightFileUploadRequestBody = {} satisfies PreflightFileUploadRequestBody, + headers: PreflightFileUploadHeaders = new PreflightFileUploadHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/files/content') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/files/content' + ) as string, { method: 'OPTIONS', headers: headersMap, - data: serializePreflightFileUploadRequestBodyArg(requestBody), + data: serializePreflightFileUploadRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -247,8 +257,8 @@ export class UploadsManager { return deserializeUploadUrl(response.data); } } -export function serializeUploadFileVersionRequestBodyArgAttributesField( - val: UploadFileVersionRequestBodyArgAttributesField +export function serializeUploadFileVersionRequestBodyAttributesField( + val: UploadFileVersionRequestBodyAttributesField ): SerializedData { return { ['name']: val.name, @@ -256,50 +266,46 @@ export function serializeUploadFileVersionRequestBodyArgAttributesField( val.contentModifiedAt == void 0 ? void 0 : val.contentModifiedAt, }; } -export function deserializeUploadFileVersionRequestBodyArgAttributesField( +export function deserializeUploadFileVersionRequestBodyAttributesField( val: any -): UploadFileVersionRequestBodyArgAttributesField { +): UploadFileVersionRequestBodyAttributesField { const name: string = val.name; const contentModifiedAt: undefined | string = val.content_modified_at == void 0 ? void 0 : val.content_modified_at; return { name: name, contentModifiedAt: contentModifiedAt, - } satisfies UploadFileVersionRequestBodyArgAttributesField; + } satisfies UploadFileVersionRequestBodyAttributesField; } -export function serializeUploadFileRequestBodyArgAttributesFieldParentField( - val: UploadFileRequestBodyArgAttributesFieldParentField +export function serializeUploadFileRequestBodyAttributesParentField( + val: UploadFileRequestBodyAttributesParentField ): SerializedData { return { ['id']: val.id }; } -export function deserializeUploadFileRequestBodyArgAttributesFieldParentField( +export function deserializeUploadFileRequestBodyAttributesParentField( val: any -): UploadFileRequestBodyArgAttributesFieldParentField { +): UploadFileRequestBodyAttributesParentField { const id: string = val.id; - return { - id: id, - } satisfies UploadFileRequestBodyArgAttributesFieldParentField; + return { id: id } satisfies UploadFileRequestBodyAttributesParentField; } -export function serializeUploadFileRequestBodyArgAttributesField( - val: UploadFileRequestBodyArgAttributesField +export function serializeUploadFileRequestBodyAttributesField( + val: UploadFileRequestBodyAttributesField ): SerializedData { return { ['name']: val.name, - ['parent']: serializeUploadFileRequestBodyArgAttributesFieldParentField( - val.parent - ), + ['parent']: serializeUploadFileRequestBodyAttributesParentField(val.parent), ['content_created_at']: val.contentCreatedAt == void 0 ? void 0 : val.contentCreatedAt, ['content_modified_at']: val.contentModifiedAt == void 0 ? void 0 : val.contentModifiedAt, }; } -export function deserializeUploadFileRequestBodyArgAttributesField( +export function deserializeUploadFileRequestBodyAttributesField( val: any -): UploadFileRequestBodyArgAttributesField { +): UploadFileRequestBodyAttributesField { const name: string = val.name; - const parent: UploadFileRequestBodyArgAttributesFieldParentField = - deserializeUploadFileRequestBodyArgAttributesFieldParentField(val.parent); + const parent: UploadFileRequestBodyAttributesParentField = + deserializeUploadFileRequestBodyAttributesParentField(val.parent); const contentCreatedAt: undefined | string = val.content_created_at == void 0 ? void 0 : val.content_created_at; const contentModifiedAt: undefined | string = @@ -309,21 +315,21 @@ export function deserializeUploadFileRequestBodyArgAttributesField( parent: parent, contentCreatedAt: contentCreatedAt, contentModifiedAt: contentModifiedAt, - } satisfies UploadFileRequestBodyArgAttributesField; + } satisfies UploadFileRequestBodyAttributesField; } -export function serializePreflightFileUploadRequestBodyArgParentField( - val: PreflightFileUploadRequestBodyArgParentField +export function serializePreflightFileUploadRequestBodyParentField( + val: PreflightFileUploadRequestBodyParentField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id }; } -export function deserializePreflightFileUploadRequestBodyArgParentField( +export function deserializePreflightFileUploadRequestBodyParentField( val: any -): PreflightFileUploadRequestBodyArgParentField { +): PreflightFileUploadRequestBodyParentField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - return { id: id } satisfies PreflightFileUploadRequestBodyArgParentField; + return { id: id } satisfies PreflightFileUploadRequestBodyParentField; } -export function serializePreflightFileUploadRequestBodyArg( - val: PreflightFileUploadRequestBodyArg +export function serializePreflightFileUploadRequestBody( + val: PreflightFileUploadRequestBody ): SerializedData { return { ['name']: val.name == void 0 ? void 0 : val.name, @@ -331,21 +337,21 @@ export function serializePreflightFileUploadRequestBodyArg( ['parent']: val.parent == void 0 ? void 0 - : serializePreflightFileUploadRequestBodyArgParentField(val.parent), + : serializePreflightFileUploadRequestBodyParentField(val.parent), }; } -export function deserializePreflightFileUploadRequestBodyArg( +export function deserializePreflightFileUploadRequestBody( val: any -): PreflightFileUploadRequestBodyArg { +): PreflightFileUploadRequestBody { const name: undefined | string = val.name == void 0 ? void 0 : val.name; const size: undefined | number = val.size == void 0 ? void 0 : val.size; - const parent: undefined | PreflightFileUploadRequestBodyArgParentField = + const parent: undefined | PreflightFileUploadRequestBodyParentField = val.parent == void 0 ? void 0 - : deserializePreflightFileUploadRequestBodyArgParentField(val.parent); + : deserializePreflightFileUploadRequestBodyParentField(val.parent); return { name: name, size: size, parent: parent, - } satisfies PreflightFileUploadRequestBodyArg; + } satisfies PreflightFileUploadRequestBody; } diff --git a/src/managers/userCollaborations.generated.ts b/src/managers/userCollaborations.generated.ts index 2774e12c..1f46335f 100644 --- a/src/managers/userCollaborations.generated.ts +++ b/src/managers/userCollaborations.generated.ts @@ -21,22 +21,22 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetCollaborationByIdQueryParamsArg { +export interface GetCollaborationByIdQueryParams { readonly fields?: readonly string[]; } -export class GetCollaborationByIdHeadersArg { +export class GetCollaborationByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateCollaborationByIdRequestBodyArgRoleField = +export type UpdateCollaborationByIdRequestBodyRoleField = | 'editor' | 'viewer' | 'previewer' @@ -45,56 +45,54 @@ export type UpdateCollaborationByIdRequestBodyArgRoleField = | 'viewer uploader' | 'co-owner' | 'owner'; -export type UpdateCollaborationByIdRequestBodyArgStatusField = +export type UpdateCollaborationByIdRequestBodyStatusField = | 'pending' | 'accepted' | 'rejected'; -export interface UpdateCollaborationByIdRequestBodyArg { - readonly role: UpdateCollaborationByIdRequestBodyArgRoleField; - readonly status?: UpdateCollaborationByIdRequestBodyArgStatusField; +export interface UpdateCollaborationByIdRequestBody { + readonly role: UpdateCollaborationByIdRequestBodyRoleField; + readonly status?: UpdateCollaborationByIdRequestBodyStatusField; readonly expiresAt?: string; readonly canViewPath?: boolean; } -export class UpdateCollaborationByIdHeadersArg { +export class UpdateCollaborationByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteCollaborationByIdHeadersArg { +export class DeleteCollaborationByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateCollaborationRequestBodyArgItemFieldTypeField = - | 'file' - | 'folder'; -export interface CreateCollaborationRequestBodyArgItemField { - readonly type?: CreateCollaborationRequestBodyArgItemFieldTypeField; +export type CreateCollaborationRequestBodyItemTypeField = 'file' | 'folder'; +export interface CreateCollaborationRequestBodyItemField { + readonly type?: CreateCollaborationRequestBodyItemTypeField; readonly id?: string; } -export type CreateCollaborationRequestBodyArgAccessibleByFieldTypeField = +export type CreateCollaborationRequestBodyAccessibleByTypeField = | 'user' | 'group'; -export interface CreateCollaborationRequestBodyArgAccessibleByField { - readonly type: CreateCollaborationRequestBodyArgAccessibleByFieldTypeField; +export interface CreateCollaborationRequestBodyAccessibleByField { + readonly type: CreateCollaborationRequestBodyAccessibleByTypeField; readonly id?: string; readonly login?: string; } -export type CreateCollaborationRequestBodyArgRoleField = +export type CreateCollaborationRequestBodyRoleField = | 'editor' | 'viewer' | 'previewer' @@ -102,50 +100,51 @@ export type CreateCollaborationRequestBodyArgRoleField = | 'previewer uploader' | 'viewer uploader' | 'co-owner'; -export interface CreateCollaborationRequestBodyArg { - readonly item: CreateCollaborationRequestBodyArgItemField; - readonly accessibleBy: CreateCollaborationRequestBodyArgAccessibleByField; - readonly role: CreateCollaborationRequestBodyArgRoleField; +export interface CreateCollaborationRequestBody { + readonly item: CreateCollaborationRequestBodyItemField; + readonly accessibleBy: CreateCollaborationRequestBodyAccessibleByField; + readonly role: CreateCollaborationRequestBodyRoleField; readonly isAccessOnly?: boolean; readonly canViewPath?: boolean; readonly expiresAt?: string; } -export interface CreateCollaborationQueryParamsArg { +export interface CreateCollaborationQueryParams { readonly fields?: readonly string[]; readonly notify?: boolean; } -export class CreateCollaborationHeadersArg { +export class CreateCollaborationHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class UserCollaborationsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - UserCollaborationsManager, - | 'getCollaborationById' - | 'updateCollaborationById' - | 'deleteCollaborationById' - | 'createCollaboration' - > + fields: + | Omit< + UserCollaborationsManager, + | 'networkSession' + | 'getCollaborationById' + | 'updateCollaborationById' + | 'deleteCollaborationById' + | 'createCollaboration' + > + | Partial> ) { Object.assign(this, fields); } async getCollaborationById( collaborationId: string, - queryParams: GetCollaborationByIdQueryParamsArg = {} satisfies GetCollaborationByIdQueryParamsArg, - headers: GetCollaborationByIdHeadersArg = new GetCollaborationByIdHeadersArg( - {} - ), + queryParams: GetCollaborationByIdQueryParams = {} satisfies GetCollaborationByIdQueryParams, + headers: GetCollaborationByIdHeaders = new GetCollaborationByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -160,7 +159,8 @@ export class UserCollaborationsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/collaborations/', + this.networkSession.baseUrls.baseUrl, + '/collaborations/', toString(collaborationId) as string ) as string, { @@ -177,8 +177,8 @@ export class UserCollaborationsManager { } async updateCollaborationById( collaborationId: string, - requestBody: UpdateCollaborationByIdRequestBodyArg, - headers: UpdateCollaborationByIdHeadersArg = new UpdateCollaborationByIdHeadersArg( + requestBody: UpdateCollaborationByIdRequestBody, + headers: UpdateCollaborationByIdHeaders = new UpdateCollaborationByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -188,13 +188,14 @@ export class UserCollaborationsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/collaborations/', + this.networkSession.baseUrls.baseUrl, + '/collaborations/', toString(collaborationId) as string ) as string, { method: 'PUT', headers: headersMap, - data: serializeUpdateCollaborationByIdRequestBodyArg(requestBody), + data: serializeUpdateCollaborationByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -206,7 +207,7 @@ export class UserCollaborationsManager { } async deleteCollaborationById( collaborationId: string, - headers: DeleteCollaborationByIdHeadersArg = new DeleteCollaborationByIdHeadersArg( + headers: DeleteCollaborationByIdHeaders = new DeleteCollaborationByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -216,7 +217,8 @@ export class UserCollaborationsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/collaborations/', + this.networkSession.baseUrls.baseUrl, + '/collaborations/', toString(collaborationId) as string ) as string, { @@ -231,11 +233,9 @@ export class UserCollaborationsManager { return void 0; } async createCollaboration( - requestBody: CreateCollaborationRequestBodyArg, - queryParams: CreateCollaborationQueryParamsArg = {} satisfies CreateCollaborationQueryParamsArg, - headers: CreateCollaborationHeadersArg = new CreateCollaborationHeadersArg( - {} - ), + requestBody: CreateCollaborationRequestBody, + queryParams: CreateCollaborationQueryParams = {} satisfies CreateCollaborationQueryParams, + headers: CreateCollaborationHeaders = new CreateCollaborationHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -250,12 +250,15 @@ export class UserCollaborationsManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/collaborations') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/collaborations' + ) as string, { method: 'POST', params: queryParamsMap, headers: headersMap, - data: serializeCreateCollaborationRequestBodyArg(requestBody), + data: serializeCreateCollaborationRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -266,16 +269,16 @@ export class UserCollaborationsManager { return deserializeCollaboration(response.data); } } -export function serializeUpdateCollaborationByIdRequestBodyArgRoleField( - val: UpdateCollaborationByIdRequestBodyArgRoleField +export function serializeUpdateCollaborationByIdRequestBodyRoleField( + val: UpdateCollaborationByIdRequestBodyRoleField ): SerializedData { return val; } -export function deserializeUpdateCollaborationByIdRequestBodyArgRoleField( +export function deserializeUpdateCollaborationByIdRequestBodyRoleField( val: any -): UpdateCollaborationByIdRequestBodyArgRoleField { +): UpdateCollaborationByIdRequestBodyRoleField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateCollaborationByIdRequestBodyArgRoleField"'; + throw 'Expecting a string for "UpdateCollaborationByIdRequestBodyRoleField"'; } if (val == 'editor') { return 'editor'; @@ -303,16 +306,16 @@ export function deserializeUpdateCollaborationByIdRequestBodyArgRoleField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateCollaborationByIdRequestBodyArgStatusField( - val: UpdateCollaborationByIdRequestBodyArgStatusField +export function serializeUpdateCollaborationByIdRequestBodyStatusField( + val: UpdateCollaborationByIdRequestBodyStatusField ): SerializedData { return val; } -export function deserializeUpdateCollaborationByIdRequestBodyArgStatusField( +export function deserializeUpdateCollaborationByIdRequestBodyStatusField( val: any -): UpdateCollaborationByIdRequestBodyArgStatusField { +): UpdateCollaborationByIdRequestBodyStatusField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateCollaborationByIdRequestBodyArgStatusField"'; + throw 'Expecting a string for "UpdateCollaborationByIdRequestBodyStatusField"'; } if (val == 'pending') { return 'pending'; @@ -325,28 +328,28 @@ export function deserializeUpdateCollaborationByIdRequestBodyArgStatusField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateCollaborationByIdRequestBodyArg( - val: UpdateCollaborationByIdRequestBodyArg +export function serializeUpdateCollaborationByIdRequestBody( + val: UpdateCollaborationByIdRequestBody ): SerializedData { return { - ['role']: serializeUpdateCollaborationByIdRequestBodyArgRoleField(val.role), + ['role']: serializeUpdateCollaborationByIdRequestBodyRoleField(val.role), ['status']: val.status == void 0 ? void 0 - : serializeUpdateCollaborationByIdRequestBodyArgStatusField(val.status), + : serializeUpdateCollaborationByIdRequestBodyStatusField(val.status), ['expires_at']: val.expiresAt == void 0 ? void 0 : val.expiresAt, ['can_view_path']: val.canViewPath == void 0 ? void 0 : val.canViewPath, }; } -export function deserializeUpdateCollaborationByIdRequestBodyArg( +export function deserializeUpdateCollaborationByIdRequestBody( val: any -): UpdateCollaborationByIdRequestBodyArg { - const role: UpdateCollaborationByIdRequestBodyArgRoleField = - deserializeUpdateCollaborationByIdRequestBodyArgRoleField(val.role); - const status: undefined | UpdateCollaborationByIdRequestBodyArgStatusField = +): UpdateCollaborationByIdRequestBody { + const role: UpdateCollaborationByIdRequestBodyRoleField = + deserializeUpdateCollaborationByIdRequestBodyRoleField(val.role); + const status: undefined | UpdateCollaborationByIdRequestBodyStatusField = val.status == void 0 ? void 0 - : deserializeUpdateCollaborationByIdRequestBodyArgStatusField(val.status); + : deserializeUpdateCollaborationByIdRequestBodyStatusField(val.status); const expiresAt: undefined | string = val.expires_at == void 0 ? void 0 : val.expires_at; const canViewPath: undefined | boolean = @@ -356,18 +359,18 @@ export function deserializeUpdateCollaborationByIdRequestBodyArg( status: status, expiresAt: expiresAt, canViewPath: canViewPath, - } satisfies UpdateCollaborationByIdRequestBodyArg; + } satisfies UpdateCollaborationByIdRequestBody; } -export function serializeCreateCollaborationRequestBodyArgItemFieldTypeField( - val: CreateCollaborationRequestBodyArgItemFieldTypeField +export function serializeCreateCollaborationRequestBodyItemTypeField( + val: CreateCollaborationRequestBodyItemTypeField ): SerializedData { return val; } -export function deserializeCreateCollaborationRequestBodyArgItemFieldTypeField( +export function deserializeCreateCollaborationRequestBodyItemTypeField( val: any -): CreateCollaborationRequestBodyArgItemFieldTypeField { +): CreateCollaborationRequestBodyItemTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateCollaborationRequestBodyArgItemFieldTypeField"'; + throw 'Expecting a string for "CreateCollaborationRequestBodyItemTypeField"'; } if (val == 'file') { return 'file'; @@ -377,44 +380,40 @@ export function deserializeCreateCollaborationRequestBodyArgItemFieldTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateCollaborationRequestBodyArgItemField( - val: CreateCollaborationRequestBodyArgItemField +export function serializeCreateCollaborationRequestBodyItemField( + val: CreateCollaborationRequestBodyItemField ): SerializedData { return { ['type']: val.type == void 0 ? void 0 - : serializeCreateCollaborationRequestBodyArgItemFieldTypeField( - val.type - ), + : serializeCreateCollaborationRequestBodyItemTypeField(val.type), ['id']: val.id == void 0 ? void 0 : val.id, }; } -export function deserializeCreateCollaborationRequestBodyArgItemField( +export function deserializeCreateCollaborationRequestBodyItemField( val: any -): CreateCollaborationRequestBodyArgItemField { - const type: undefined | CreateCollaborationRequestBodyArgItemFieldTypeField = +): CreateCollaborationRequestBodyItemField { + const type: undefined | CreateCollaborationRequestBodyItemTypeField = val.type == void 0 ? void 0 - : deserializeCreateCollaborationRequestBodyArgItemFieldTypeField( - val.type - ); + : deserializeCreateCollaborationRequestBodyItemTypeField(val.type); const id: undefined | string = val.id == void 0 ? void 0 : val.id; return { type: type, id: id, - } satisfies CreateCollaborationRequestBodyArgItemField; + } satisfies CreateCollaborationRequestBodyItemField; } -export function serializeCreateCollaborationRequestBodyArgAccessibleByFieldTypeField( - val: CreateCollaborationRequestBodyArgAccessibleByFieldTypeField +export function serializeCreateCollaborationRequestBodyAccessibleByTypeField( + val: CreateCollaborationRequestBodyAccessibleByTypeField ): SerializedData { return val; } -export function deserializeCreateCollaborationRequestBodyArgAccessibleByFieldTypeField( +export function deserializeCreateCollaborationRequestBodyAccessibleByTypeField( val: any -): CreateCollaborationRequestBodyArgAccessibleByFieldTypeField { +): CreateCollaborationRequestBodyAccessibleByTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateCollaborationRequestBodyArgAccessibleByFieldTypeField"'; + throw 'Expecting a string for "CreateCollaborationRequestBodyAccessibleByTypeField"'; } if (val == 'user') { return 'user'; @@ -424,43 +423,40 @@ export function deserializeCreateCollaborationRequestBodyArgAccessibleByFieldTyp } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateCollaborationRequestBodyArgAccessibleByField( - val: CreateCollaborationRequestBodyArgAccessibleByField +export function serializeCreateCollaborationRequestBodyAccessibleByField( + val: CreateCollaborationRequestBodyAccessibleByField ): SerializedData { return { - ['type']: - serializeCreateCollaborationRequestBodyArgAccessibleByFieldTypeField( - val.type - ), + ['type']: serializeCreateCollaborationRequestBodyAccessibleByTypeField( + val.type + ), ['id']: val.id == void 0 ? void 0 : val.id, ['login']: val.login == void 0 ? void 0 : val.login, }; } -export function deserializeCreateCollaborationRequestBodyArgAccessibleByField( +export function deserializeCreateCollaborationRequestBodyAccessibleByField( val: any -): CreateCollaborationRequestBodyArgAccessibleByField { - const type: CreateCollaborationRequestBodyArgAccessibleByFieldTypeField = - deserializeCreateCollaborationRequestBodyArgAccessibleByFieldTypeField( - val.type - ); +): CreateCollaborationRequestBodyAccessibleByField { + const type: CreateCollaborationRequestBodyAccessibleByTypeField = + deserializeCreateCollaborationRequestBodyAccessibleByTypeField(val.type); const id: undefined | string = val.id == void 0 ? void 0 : val.id; const login: undefined | string = val.login == void 0 ? void 0 : val.login; return { type: type, id: id, login: login, - } satisfies CreateCollaborationRequestBodyArgAccessibleByField; + } satisfies CreateCollaborationRequestBodyAccessibleByField; } -export function serializeCreateCollaborationRequestBodyArgRoleField( - val: CreateCollaborationRequestBodyArgRoleField +export function serializeCreateCollaborationRequestBodyRoleField( + val: CreateCollaborationRequestBodyRoleField ): SerializedData { return val; } -export function deserializeCreateCollaborationRequestBodyArgRoleField( +export function deserializeCreateCollaborationRequestBodyRoleField( val: any -): CreateCollaborationRequestBodyArgRoleField { +): CreateCollaborationRequestBodyRoleField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateCollaborationRequestBodyArgRoleField"'; + throw 'Expecting a string for "CreateCollaborationRequestBodyRoleField"'; } if (val == 'editor') { return 'editor'; @@ -485,32 +481,31 @@ export function deserializeCreateCollaborationRequestBodyArgRoleField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateCollaborationRequestBodyArg( - val: CreateCollaborationRequestBodyArg +export function serializeCreateCollaborationRequestBody( + val: CreateCollaborationRequestBody ): SerializedData { return { - ['item']: serializeCreateCollaborationRequestBodyArgItemField(val.item), - ['accessible_by']: - serializeCreateCollaborationRequestBodyArgAccessibleByField( - val.accessibleBy - ), - ['role']: serializeCreateCollaborationRequestBodyArgRoleField(val.role), + ['item']: serializeCreateCollaborationRequestBodyItemField(val.item), + ['accessible_by']: serializeCreateCollaborationRequestBodyAccessibleByField( + val.accessibleBy + ), + ['role']: serializeCreateCollaborationRequestBodyRoleField(val.role), ['is_access_only']: val.isAccessOnly == void 0 ? void 0 : val.isAccessOnly, ['can_view_path']: val.canViewPath == void 0 ? void 0 : val.canViewPath, ['expires_at']: val.expiresAt == void 0 ? void 0 : val.expiresAt, }; } -export function deserializeCreateCollaborationRequestBodyArg( +export function deserializeCreateCollaborationRequestBody( val: any -): CreateCollaborationRequestBodyArg { - const item: CreateCollaborationRequestBodyArgItemField = - deserializeCreateCollaborationRequestBodyArgItemField(val.item); - const accessibleBy: CreateCollaborationRequestBodyArgAccessibleByField = - deserializeCreateCollaborationRequestBodyArgAccessibleByField( +): CreateCollaborationRequestBody { + const item: CreateCollaborationRequestBodyItemField = + deserializeCreateCollaborationRequestBodyItemField(val.item); + const accessibleBy: CreateCollaborationRequestBodyAccessibleByField = + deserializeCreateCollaborationRequestBodyAccessibleByField( val.accessible_by ); - const role: CreateCollaborationRequestBodyArgRoleField = - deserializeCreateCollaborationRequestBodyArgRoleField(val.role); + const role: CreateCollaborationRequestBodyRoleField = + deserializeCreateCollaborationRequestBodyRoleField(val.role); const isAccessOnly: undefined | boolean = val.is_access_only == void 0 ? void 0 : val.is_access_only; const canViewPath: undefined | boolean = @@ -524,5 +519,5 @@ export function deserializeCreateCollaborationRequestBodyArg( isAccessOnly: isAccessOnly, canViewPath: canViewPath, expiresAt: expiresAt, - } satisfies CreateCollaborationRequestBodyArg; + } satisfies CreateCollaborationRequestBody; } diff --git a/src/managers/users.generated.ts b/src/managers/users.generated.ts index 8fed9e76..1e880be8 100644 --- a/src/managers/users.generated.ts +++ b/src/managers/users.generated.ts @@ -27,13 +27,10 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export type GetUsersQueryParamsArgUserTypeField = - | 'all' - | 'managed' - | 'external'; -export interface GetUsersQueryParamsArg { +export type GetUsersQueryParamsUserTypeField = 'all' | 'managed' | 'external'; +export interface GetUsersQueryParams { readonly filterTerm?: string; - readonly userType?: GetUsersQueryParamsArgUserTypeField; + readonly userType?: GetUsersQueryParamsUserTypeField; readonly externalAppUserId?: string; readonly fields?: readonly string[]; readonly offset?: number; @@ -41,29 +38,29 @@ export interface GetUsersQueryParamsArg { readonly usemarker?: boolean; readonly marker?: string; } -export class GetUsersHeadersArg { +export class GetUsersHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateUserRequestBodyArgRoleField = 'coadmin' | 'user'; -export type CreateUserRequestBodyArgStatusField = +export type CreateUserRequestBodyRoleField = 'coadmin' | 'user'; +export type CreateUserRequestBodyStatusField = | 'active' | 'inactive' | 'cannot_delete_edit' | 'cannot_delete_edit_upload'; -export interface CreateUserRequestBodyArg { +export interface CreateUserRequestBody { readonly name: string; readonly login?: string; readonly isPlatformAccessOnly?: boolean; - readonly role?: CreateUserRequestBodyArgRoleField; + readonly role?: CreateUserRequestBodyRoleField; readonly language?: string; readonly isSyncEnabled?: boolean; readonly jobTitle?: string; @@ -76,69 +73,69 @@ export interface CreateUserRequestBodyArg { readonly isExternalCollabRestricted?: boolean; readonly isExemptFromDeviceLimits?: boolean; readonly isExemptFromLoginVerification?: boolean; - readonly status?: CreateUserRequestBodyArgStatusField; + readonly status?: CreateUserRequestBodyStatusField; readonly externalAppUserId?: string; } -export interface CreateUserQueryParamsArg { +export interface CreateUserQueryParams { readonly fields?: readonly string[]; } -export class CreateUserHeadersArg { +export class CreateUserHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetUserMeQueryParamsArg { +export interface GetUserMeQueryParams { readonly fields?: readonly string[]; } -export class GetUserMeHeadersArg { +export class GetUserMeHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetUserByIdQueryParamsArg { +export interface GetUserByIdQueryParams { readonly fields?: readonly string[]; } -export class GetUserByIdHeadersArg { +export class GetUserByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateUserByIdRequestBodyArgRoleField = 'coadmin' | 'user'; -export type UpdateUserByIdRequestBodyArgStatusField = +export type UpdateUserByIdRequestBodyRoleField = 'coadmin' | 'user'; +export type UpdateUserByIdRequestBodyStatusField = | 'active' | 'inactive' | 'cannot_delete_edit' | 'cannot_delete_edit_upload'; -export interface UpdateUserByIdRequestBodyArgNotificationEmailField { +export interface UpdateUserByIdRequestBodyNotificationEmailField { readonly email?: string; } -export interface UpdateUserByIdRequestBodyArg { +export interface UpdateUserByIdRequestBody { readonly enterprise?: string; readonly notify?: boolean; readonly name?: string; readonly login?: string; - readonly role?: UpdateUserByIdRequestBodyArgRoleField; + readonly role?: UpdateUserByIdRequestBodyRoleField; readonly language?: string; readonly isSyncEnabled?: boolean; readonly jobTitle?: string; @@ -151,61 +148,64 @@ export interface UpdateUserByIdRequestBodyArg { readonly isExemptFromDeviceLimits?: boolean; readonly isExemptFromLoginVerification?: boolean; readonly isPasswordResetRequired?: boolean; - readonly status?: UpdateUserByIdRequestBodyArgStatusField; + readonly status?: UpdateUserByIdRequestBodyStatusField; readonly spaceAmount?: number; - readonly notificationEmail?: UpdateUserByIdRequestBodyArgNotificationEmailField; + readonly notificationEmail?: UpdateUserByIdRequestBodyNotificationEmailField; readonly externalAppUserId?: string; } -export interface UpdateUserByIdQueryParamsArg { +export interface UpdateUserByIdQueryParams { readonly fields?: readonly string[]; } -export class UpdateUserByIdHeadersArg { +export class UpdateUserByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface DeleteUserByIdQueryParamsArg { +export interface DeleteUserByIdQueryParams { readonly notify?: boolean; readonly force?: boolean; } -export class DeleteUserByIdHeadersArg { +export class DeleteUserByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class UsersManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - UsersManager, - | 'getUsers' - | 'createUser' - | 'getUserMe' - | 'getUserById' - | 'updateUserById' - | 'deleteUserById' - > + fields: + | Omit< + UsersManager, + | 'networkSession' + | 'getUsers' + | 'createUser' + | 'getUserMe' + | 'getUserById' + | 'updateUserById' + | 'deleteUserById' + > + | Partial> ) { Object.assign(this, fields); } async getUsers( - queryParams: GetUsersQueryParamsArg = {} satisfies GetUsersQueryParamsArg, - headers: GetUsersHeadersArg = new GetUsersHeadersArg({}), + queryParams: GetUsersQueryParams = {} satisfies GetUsersQueryParams, + headers: GetUsersHeaders = new GetUsersHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -228,7 +228,7 @@ export class UsersManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/users') as string, + ''.concat(this.networkSession.baseUrls.baseUrl, '/users') as string, { method: 'GET', params: queryParamsMap, @@ -242,9 +242,9 @@ export class UsersManager { return deserializeUsers(response.data); } async createUser( - requestBody: CreateUserRequestBodyArg, - queryParams: CreateUserQueryParamsArg = {} satisfies CreateUserQueryParamsArg, - headers: CreateUserHeadersArg = new CreateUserHeadersArg({}), + requestBody: CreateUserRequestBody, + queryParams: CreateUserQueryParams = {} satisfies CreateUserQueryParams, + headers: CreateUserHeaders = new CreateUserHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -258,12 +258,12 @@ export class UsersManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/users') as string, + ''.concat(this.networkSession.baseUrls.baseUrl, '/users') as string, { method: 'POST', params: queryParamsMap, headers: headersMap, - data: serializeCreateUserRequestBodyArg(requestBody), + data: serializeCreateUserRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -274,8 +274,8 @@ export class UsersManager { return deserializeUserFull(response.data); } async getUserMe( - queryParams: GetUserMeQueryParamsArg = {} satisfies GetUserMeQueryParamsArg, - headers: GetUserMeHeadersArg = new GetUserMeHeadersArg({}), + queryParams: GetUserMeQueryParams = {} satisfies GetUserMeQueryParams, + headers: GetUserMeHeaders = new GetUserMeHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -289,7 +289,7 @@ export class UsersManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/users/me') as string, + ''.concat(this.networkSession.baseUrls.baseUrl, '/users/me') as string, { method: 'GET', params: queryParamsMap, @@ -304,8 +304,8 @@ export class UsersManager { } async getUserById( userId: string, - queryParams: GetUserByIdQueryParamsArg = {} satisfies GetUserByIdQueryParamsArg, - headers: GetUserByIdHeadersArg = new GetUserByIdHeadersArg({}), + queryParams: GetUserByIdQueryParams = {} satisfies GetUserByIdQueryParams, + headers: GetUserByIdHeaders = new GetUserByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -320,7 +320,8 @@ export class UsersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/users/', + this.networkSession.baseUrls.baseUrl, + '/users/', toString(userId) as string ) as string, { @@ -337,9 +338,9 @@ export class UsersManager { } async updateUserById( userId: string, - requestBody: UpdateUserByIdRequestBodyArg = {} satisfies UpdateUserByIdRequestBodyArg, - queryParams: UpdateUserByIdQueryParamsArg = {} satisfies UpdateUserByIdQueryParamsArg, - headers: UpdateUserByIdHeadersArg = new UpdateUserByIdHeadersArg({}), + requestBody: UpdateUserByIdRequestBody = {} satisfies UpdateUserByIdRequestBody, + queryParams: UpdateUserByIdQueryParams = {} satisfies UpdateUserByIdQueryParams, + headers: UpdateUserByIdHeaders = new UpdateUserByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -354,14 +355,15 @@ export class UsersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/users/', + this.networkSession.baseUrls.baseUrl, + '/users/', toString(userId) as string ) as string, { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateUserByIdRequestBodyArg(requestBody), + data: serializeUpdateUserByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -373,8 +375,8 @@ export class UsersManager { } async deleteUserById( userId: string, - queryParams: DeleteUserByIdQueryParamsArg = {} satisfies DeleteUserByIdQueryParamsArg, - headers: DeleteUserByIdHeadersArg = new DeleteUserByIdHeadersArg({}), + queryParams: DeleteUserByIdQueryParams = {} satisfies DeleteUserByIdQueryParams, + headers: DeleteUserByIdHeaders = new DeleteUserByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -388,7 +390,8 @@ export class UsersManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/users/', + this.networkSession.baseUrls.baseUrl, + '/users/', toString(userId) as string ) as string, { @@ -404,16 +407,16 @@ export class UsersManager { return void 0; } } -export function serializeGetUsersQueryParamsArgUserTypeField( - val: GetUsersQueryParamsArgUserTypeField +export function serializeGetUsersQueryParamsUserTypeField( + val: GetUsersQueryParamsUserTypeField ): SerializedData { return val; } -export function deserializeGetUsersQueryParamsArgUserTypeField( +export function deserializeGetUsersQueryParamsUserTypeField( val: any -): GetUsersQueryParamsArgUserTypeField { +): GetUsersQueryParamsUserTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetUsersQueryParamsArgUserTypeField"'; + throw 'Expecting a string for "GetUsersQueryParamsUserTypeField"'; } if (val == 'all') { return 'all'; @@ -426,16 +429,16 @@ export function deserializeGetUsersQueryParamsArgUserTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateUserRequestBodyArgRoleField( - val: CreateUserRequestBodyArgRoleField +export function serializeCreateUserRequestBodyRoleField( + val: CreateUserRequestBodyRoleField ): SerializedData { return val; } -export function deserializeCreateUserRequestBodyArgRoleField( +export function deserializeCreateUserRequestBodyRoleField( val: any -): CreateUserRequestBodyArgRoleField { +): CreateUserRequestBodyRoleField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateUserRequestBodyArgRoleField"'; + throw 'Expecting a string for "CreateUserRequestBodyRoleField"'; } if (val == 'coadmin') { return 'coadmin'; @@ -445,16 +448,16 @@ export function deserializeCreateUserRequestBodyArgRoleField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateUserRequestBodyArgStatusField( - val: CreateUserRequestBodyArgStatusField +export function serializeCreateUserRequestBodyStatusField( + val: CreateUserRequestBodyStatusField ): SerializedData { return val; } -export function deserializeCreateUserRequestBodyArgStatusField( +export function deserializeCreateUserRequestBodyStatusField( val: any -): CreateUserRequestBodyArgStatusField { +): CreateUserRequestBodyStatusField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateUserRequestBodyArgStatusField"'; + throw 'Expecting a string for "CreateUserRequestBodyStatusField"'; } if (val == 'active') { return 'active'; @@ -470,8 +473,8 @@ export function deserializeCreateUserRequestBodyArgStatusField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateUserRequestBodyArg( - val: CreateUserRequestBodyArg +export function serializeCreateUserRequestBody( + val: CreateUserRequestBody ): SerializedData { return { ['name']: val.name, @@ -481,7 +484,7 @@ export function serializeCreateUserRequestBodyArg( ['role']: val.role == void 0 ? void 0 - : serializeCreateUserRequestBodyArgRoleField(val.role), + : serializeCreateUserRequestBodyRoleField(val.role), ['language']: val.language == void 0 ? void 0 : val.language, ['is_sync_enabled']: val.isSyncEnabled == void 0 ? void 0 : val.isSyncEnabled, @@ -513,24 +516,24 @@ export function serializeCreateUserRequestBodyArg( ['status']: val.status == void 0 ? void 0 - : serializeCreateUserRequestBodyArgStatusField(val.status), + : serializeCreateUserRequestBodyStatusField(val.status), ['external_app_user_id']: val.externalAppUserId == void 0 ? void 0 : val.externalAppUserId, }; } -export function deserializeCreateUserRequestBodyArg( +export function deserializeCreateUserRequestBody( val: any -): CreateUserRequestBodyArg { +): CreateUserRequestBody { const name: string = val.name; const login: undefined | string = val.login == void 0 ? void 0 : val.login; const isPlatformAccessOnly: undefined | boolean = val.is_platform_access_only == void 0 ? void 0 : val.is_platform_access_only; - const role: undefined | CreateUserRequestBodyArgRoleField = + const role: undefined | CreateUserRequestBodyRoleField = val.role == void 0 ? void 0 - : deserializeCreateUserRequestBodyArgRoleField(val.role); + : deserializeCreateUserRequestBodyRoleField(val.role); const language: undefined | string = val.language == void 0 ? void 0 : val.language; const isSyncEnabled: undefined | boolean = @@ -566,10 +569,10 @@ export function deserializeCreateUserRequestBodyArg( val.is_exempt_from_login_verification == void 0 ? void 0 : val.is_exempt_from_login_verification; - const status: undefined | CreateUserRequestBodyArgStatusField = + const status: undefined | CreateUserRequestBodyStatusField = val.status == void 0 ? void 0 - : deserializeCreateUserRequestBodyArgStatusField(val.status); + : deserializeCreateUserRequestBodyStatusField(val.status); const externalAppUserId: undefined | string = val.external_app_user_id == void 0 ? void 0 : val.external_app_user_id; return { @@ -591,18 +594,18 @@ export function deserializeCreateUserRequestBodyArg( isExemptFromLoginVerification: isExemptFromLoginVerification, status: status, externalAppUserId: externalAppUserId, - } satisfies CreateUserRequestBodyArg; + } satisfies CreateUserRequestBody; } -export function serializeUpdateUserByIdRequestBodyArgRoleField( - val: UpdateUserByIdRequestBodyArgRoleField +export function serializeUpdateUserByIdRequestBodyRoleField( + val: UpdateUserByIdRequestBodyRoleField ): SerializedData { return val; } -export function deserializeUpdateUserByIdRequestBodyArgRoleField( +export function deserializeUpdateUserByIdRequestBodyRoleField( val: any -): UpdateUserByIdRequestBodyArgRoleField { +): UpdateUserByIdRequestBodyRoleField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateUserByIdRequestBodyArgRoleField"'; + throw 'Expecting a string for "UpdateUserByIdRequestBodyRoleField"'; } if (val == 'coadmin') { return 'coadmin'; @@ -612,16 +615,16 @@ export function deserializeUpdateUserByIdRequestBodyArgRoleField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateUserByIdRequestBodyArgStatusField( - val: UpdateUserByIdRequestBodyArgStatusField +export function serializeUpdateUserByIdRequestBodyStatusField( + val: UpdateUserByIdRequestBodyStatusField ): SerializedData { return val; } -export function deserializeUpdateUserByIdRequestBodyArgStatusField( +export function deserializeUpdateUserByIdRequestBodyStatusField( val: any -): UpdateUserByIdRequestBodyArgStatusField { +): UpdateUserByIdRequestBodyStatusField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateUserByIdRequestBodyArgStatusField"'; + throw 'Expecting a string for "UpdateUserByIdRequestBodyStatusField"'; } if (val == 'active') { return 'active'; @@ -637,21 +640,21 @@ export function deserializeUpdateUserByIdRequestBodyArgStatusField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateUserByIdRequestBodyArgNotificationEmailField( - val: UpdateUserByIdRequestBodyArgNotificationEmailField +export function serializeUpdateUserByIdRequestBodyNotificationEmailField( + val: UpdateUserByIdRequestBodyNotificationEmailField ): SerializedData { return { ['email']: val.email == void 0 ? void 0 : val.email }; } -export function deserializeUpdateUserByIdRequestBodyArgNotificationEmailField( +export function deserializeUpdateUserByIdRequestBodyNotificationEmailField( val: any -): UpdateUserByIdRequestBodyArgNotificationEmailField { +): UpdateUserByIdRequestBodyNotificationEmailField { const email: undefined | string = val.email == void 0 ? void 0 : val.email; return { email: email, - } satisfies UpdateUserByIdRequestBodyArgNotificationEmailField; + } satisfies UpdateUserByIdRequestBodyNotificationEmailField; } -export function serializeUpdateUserByIdRequestBodyArg( - val: UpdateUserByIdRequestBodyArg +export function serializeUpdateUserByIdRequestBody( + val: UpdateUserByIdRequestBody ): SerializedData { return { ['enterprise']: val.enterprise == void 0 ? void 0 : val.enterprise, @@ -661,7 +664,7 @@ export function serializeUpdateUserByIdRequestBodyArg( ['role']: val.role == void 0 ? void 0 - : serializeUpdateUserByIdRequestBodyArgRoleField(val.role), + : serializeUpdateUserByIdRequestBodyRoleField(val.role), ['language']: val.language == void 0 ? void 0 : val.language, ['is_sync_enabled']: val.isSyncEnabled == void 0 ? void 0 : val.isSyncEnabled, @@ -696,31 +699,31 @@ export function serializeUpdateUserByIdRequestBodyArg( ['status']: val.status == void 0 ? void 0 - : serializeUpdateUserByIdRequestBodyArgStatusField(val.status), + : serializeUpdateUserByIdRequestBodyStatusField(val.status), ['space_amount']: val.spaceAmount == void 0 ? void 0 : val.spaceAmount, ['notification_email']: val.notificationEmail == void 0 ? void 0 - : serializeUpdateUserByIdRequestBodyArgNotificationEmailField( + : serializeUpdateUserByIdRequestBodyNotificationEmailField( val.notificationEmail ), ['external_app_user_id']: val.externalAppUserId == void 0 ? void 0 : val.externalAppUserId, }; } -export function deserializeUpdateUserByIdRequestBodyArg( +export function deserializeUpdateUserByIdRequestBody( val: any -): UpdateUserByIdRequestBodyArg { +): UpdateUserByIdRequestBody { const enterprise: undefined | string = val.enterprise == void 0 ? void 0 : val.enterprise; const notify: undefined | boolean = val.notify == void 0 ? void 0 : val.notify; const name: undefined | string = val.name == void 0 ? void 0 : val.name; const login: undefined | string = val.login == void 0 ? void 0 : val.login; - const role: undefined | UpdateUserByIdRequestBodyArgRoleField = + const role: undefined | UpdateUserByIdRequestBodyRoleField = val.role == void 0 ? void 0 - : deserializeUpdateUserByIdRequestBodyArgRoleField(val.role); + : deserializeUpdateUserByIdRequestBodyRoleField(val.role); const language: undefined | string = val.language == void 0 ? void 0 : val.language; const isSyncEnabled: undefined | boolean = @@ -758,18 +761,18 @@ export function deserializeUpdateUserByIdRequestBodyArg( val.is_password_reset_required == void 0 ? void 0 : val.is_password_reset_required; - const status: undefined | UpdateUserByIdRequestBodyArgStatusField = + const status: undefined | UpdateUserByIdRequestBodyStatusField = val.status == void 0 ? void 0 - : deserializeUpdateUserByIdRequestBodyArgStatusField(val.status); + : deserializeUpdateUserByIdRequestBodyStatusField(val.status); const spaceAmount: undefined | number = val.space_amount == void 0 ? void 0 : val.space_amount; const notificationEmail: | undefined - | UpdateUserByIdRequestBodyArgNotificationEmailField = + | UpdateUserByIdRequestBodyNotificationEmailField = val.notification_email == void 0 ? void 0 - : deserializeUpdateUserByIdRequestBodyArgNotificationEmailField( + : deserializeUpdateUserByIdRequestBodyNotificationEmailField( val.notification_email ); const externalAppUserId: undefined | string = @@ -796,5 +799,5 @@ export function deserializeUpdateUserByIdRequestBodyArg( spaceAmount: spaceAmount, notificationEmail: notificationEmail, externalAppUserId: externalAppUserId, - } satisfies UpdateUserByIdRequestBodyArg; + } satisfies UpdateUserByIdRequestBody; } diff --git a/src/managers/webLinks.generated.ts b/src/managers/webLinks.generated.ts index 91f273cf..e92165c2 100644 --- a/src/managers/webLinks.generated.ts +++ b/src/managers/webLinks.generated.ts @@ -21,112 +21,115 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface CreateWebLinkRequestBodyArgParentField { +export interface CreateWebLinkRequestBodyParentField { readonly id: string; } -export interface CreateWebLinkRequestBodyArg { +export interface CreateWebLinkRequestBody { readonly url: string; - readonly parent: CreateWebLinkRequestBodyArgParentField; + readonly parent: CreateWebLinkRequestBodyParentField; readonly name?: string; readonly description?: string; } -export class CreateWebLinkHeadersArg { +export class CreateWebLinkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class GetWebLinkByIdHeadersArg { +export class GetWebLinkByIdHeaders { readonly boxapi?: string; readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface UpdateWebLinkByIdRequestBodyArgParentField { +export interface UpdateWebLinkByIdRequestBodyParentField { readonly id?: string; } -export type UpdateWebLinkByIdRequestBodyArgSharedLinkFieldAccessField = +export type UpdateWebLinkByIdRequestBodySharedLinkAccessField = | 'open' | 'company' | 'collaborators'; -export interface UpdateWebLinkByIdRequestBodyArgSharedLinkField { - readonly access?: UpdateWebLinkByIdRequestBodyArgSharedLinkFieldAccessField; +export interface UpdateWebLinkByIdRequestBodySharedLinkField { + readonly access?: UpdateWebLinkByIdRequestBodySharedLinkAccessField; readonly password?: string; readonly vanityName?: string; readonly unsharedAt?: string; } -export interface UpdateWebLinkByIdRequestBodyArg { +export interface UpdateWebLinkByIdRequestBody { readonly url?: string; - readonly parent?: UpdateWebLinkByIdRequestBodyArgParentField; + readonly parent?: UpdateWebLinkByIdRequestBodyParentField; readonly name?: string; readonly description?: string; - readonly sharedLink?: UpdateWebLinkByIdRequestBodyArgSharedLinkField; + readonly sharedLink?: UpdateWebLinkByIdRequestBodySharedLinkField; } -export class UpdateWebLinkByIdHeadersArg { +export class UpdateWebLinkByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteWebLinkByIdHeadersArg { +export class DeleteWebLinkByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class WebLinksManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - WebLinksManager, - | 'createWebLink' - | 'getWebLinkById' - | 'updateWebLinkById' - | 'deleteWebLinkById' - > + fields: + | Omit< + WebLinksManager, + | 'networkSession' + | 'createWebLink' + | 'getWebLinkById' + | 'updateWebLinkById' + | 'deleteWebLinkById' + > + | Partial> ) { Object.assign(this, fields); } async createWebLink( - requestBody: CreateWebLinkRequestBodyArg, - headers: CreateWebLinkHeadersArg = new CreateWebLinkHeadersArg({}), + requestBody: CreateWebLinkRequestBody, + headers: CreateWebLinkHeaders = new CreateWebLinkHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/web_links') as string, + ''.concat(this.networkSession.baseUrls.baseUrl, '/web_links') as string, { method: 'POST', headers: headersMap, - data: serializeCreateWebLinkRequestBodyArg(requestBody), + data: serializeCreateWebLinkRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -138,7 +141,7 @@ export class WebLinksManager { } async getWebLinkById( webLinkId: string, - headers: GetWebLinkByIdHeadersArg = new GetWebLinkByIdHeadersArg({}), + headers: GetWebLinkByIdHeaders = new GetWebLinkByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -149,7 +152,8 @@ export class WebLinksManager { }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/web_links/', + this.networkSession.baseUrls.baseUrl, + '/web_links/', toString(webLinkId) as string ) as string, { @@ -165,8 +169,8 @@ export class WebLinksManager { } async updateWebLinkById( webLinkId: string, - requestBody: UpdateWebLinkByIdRequestBodyArg = {} satisfies UpdateWebLinkByIdRequestBodyArg, - headers: UpdateWebLinkByIdHeadersArg = new UpdateWebLinkByIdHeadersArg({}), + requestBody: UpdateWebLinkByIdRequestBody = {} satisfies UpdateWebLinkByIdRequestBody, + headers: UpdateWebLinkByIdHeaders = new UpdateWebLinkByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -174,13 +178,14 @@ export class WebLinksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/web_links/', + this.networkSession.baseUrls.baseUrl, + '/web_links/', toString(webLinkId) as string ) as string, { method: 'PUT', headers: headersMap, - data: serializeUpdateWebLinkByIdRequestBodyArg(requestBody), + data: serializeUpdateWebLinkByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -192,7 +197,7 @@ export class WebLinksManager { } async deleteWebLinkById( webLinkId: string, - headers: DeleteWebLinkByIdHeadersArg = new DeleteWebLinkByIdHeadersArg({}), + headers: DeleteWebLinkByIdHeaders = new DeleteWebLinkByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -200,7 +205,8 @@ export class WebLinksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/web_links/', + this.networkSession.baseUrls.baseUrl, + '/web_links/', toString(webLinkId) as string ) as string, { @@ -215,33 +221,33 @@ export class WebLinksManager { return void 0; } } -export function serializeCreateWebLinkRequestBodyArgParentField( - val: CreateWebLinkRequestBodyArgParentField +export function serializeCreateWebLinkRequestBodyParentField( + val: CreateWebLinkRequestBodyParentField ): SerializedData { return { ['id']: val.id }; } -export function deserializeCreateWebLinkRequestBodyArgParentField( +export function deserializeCreateWebLinkRequestBodyParentField( val: any -): CreateWebLinkRequestBodyArgParentField { +): CreateWebLinkRequestBodyParentField { const id: string = val.id; - return { id: id } satisfies CreateWebLinkRequestBodyArgParentField; + return { id: id } satisfies CreateWebLinkRequestBodyParentField; } -export function serializeCreateWebLinkRequestBodyArg( - val: CreateWebLinkRequestBodyArg +export function serializeCreateWebLinkRequestBody( + val: CreateWebLinkRequestBody ): SerializedData { return { ['url']: val.url, - ['parent']: serializeCreateWebLinkRequestBodyArgParentField(val.parent), + ['parent']: serializeCreateWebLinkRequestBodyParentField(val.parent), ['name']: val.name == void 0 ? void 0 : val.name, ['description']: val.description == void 0 ? void 0 : val.description, }; } -export function deserializeCreateWebLinkRequestBodyArg( +export function deserializeCreateWebLinkRequestBody( val: any -): CreateWebLinkRequestBodyArg { +): CreateWebLinkRequestBody { const url: string = val.url; - const parent: CreateWebLinkRequestBodyArgParentField = - deserializeCreateWebLinkRequestBodyArgParentField(val.parent); + const parent: CreateWebLinkRequestBodyParentField = + deserializeCreateWebLinkRequestBodyParentField(val.parent); const name: undefined | string = val.name == void 0 ? void 0 : val.name; const description: undefined | string = val.description == void 0 ? void 0 : val.description; @@ -250,29 +256,29 @@ export function deserializeCreateWebLinkRequestBodyArg( parent: parent, name: name, description: description, - } satisfies CreateWebLinkRequestBodyArg; + } satisfies CreateWebLinkRequestBody; } -export function serializeUpdateWebLinkByIdRequestBodyArgParentField( - val: UpdateWebLinkByIdRequestBodyArgParentField +export function serializeUpdateWebLinkByIdRequestBodyParentField( + val: UpdateWebLinkByIdRequestBodyParentField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id }; } -export function deserializeUpdateWebLinkByIdRequestBodyArgParentField( +export function deserializeUpdateWebLinkByIdRequestBodyParentField( val: any -): UpdateWebLinkByIdRequestBodyArgParentField { +): UpdateWebLinkByIdRequestBodyParentField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - return { id: id } satisfies UpdateWebLinkByIdRequestBodyArgParentField; + return { id: id } satisfies UpdateWebLinkByIdRequestBodyParentField; } -export function serializeUpdateWebLinkByIdRequestBodyArgSharedLinkFieldAccessField( - val: UpdateWebLinkByIdRequestBodyArgSharedLinkFieldAccessField +export function serializeUpdateWebLinkByIdRequestBodySharedLinkAccessField( + val: UpdateWebLinkByIdRequestBodySharedLinkAccessField ): SerializedData { return val; } -export function deserializeUpdateWebLinkByIdRequestBodyArgSharedLinkFieldAccessField( +export function deserializeUpdateWebLinkByIdRequestBodySharedLinkAccessField( val: any -): UpdateWebLinkByIdRequestBodyArgSharedLinkFieldAccessField { +): UpdateWebLinkByIdRequestBodySharedLinkAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateWebLinkByIdRequestBodyArgSharedLinkFieldAccessField"'; + throw 'Expecting a string for "UpdateWebLinkByIdRequestBodySharedLinkAccessField"'; } if (val == 'open') { return 'open'; @@ -285,14 +291,14 @@ export function deserializeUpdateWebLinkByIdRequestBodyArgSharedLinkFieldAccessF } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateWebLinkByIdRequestBodyArgSharedLinkField( - val: UpdateWebLinkByIdRequestBodyArgSharedLinkField +export function serializeUpdateWebLinkByIdRequestBodySharedLinkField( + val: UpdateWebLinkByIdRequestBodySharedLinkField ): SerializedData { return { ['access']: val.access == void 0 ? void 0 - : serializeUpdateWebLinkByIdRequestBodyArgSharedLinkFieldAccessField( + : serializeUpdateWebLinkByIdRequestBodySharedLinkAccessField( val.access ), ['password']: val.password == void 0 ? void 0 : val.password, @@ -300,15 +306,13 @@ export function serializeUpdateWebLinkByIdRequestBodyArgSharedLinkField( ['unshared_at']: val.unsharedAt == void 0 ? void 0 : val.unsharedAt, }; } -export function deserializeUpdateWebLinkByIdRequestBodyArgSharedLinkField( +export function deserializeUpdateWebLinkByIdRequestBodySharedLinkField( val: any -): UpdateWebLinkByIdRequestBodyArgSharedLinkField { - const access: - | undefined - | UpdateWebLinkByIdRequestBodyArgSharedLinkFieldAccessField = +): UpdateWebLinkByIdRequestBodySharedLinkField { + const access: undefined | UpdateWebLinkByIdRequestBodySharedLinkAccessField = val.access == void 0 ? void 0 - : deserializeUpdateWebLinkByIdRequestBodyArgSharedLinkFieldAccessField( + : deserializeUpdateWebLinkByIdRequestBodySharedLinkAccessField( val.access ); const password: undefined | string = @@ -322,49 +326,45 @@ export function deserializeUpdateWebLinkByIdRequestBodyArgSharedLinkField( password: password, vanityName: vanityName, unsharedAt: unsharedAt, - } satisfies UpdateWebLinkByIdRequestBodyArgSharedLinkField; + } satisfies UpdateWebLinkByIdRequestBodySharedLinkField; } -export function serializeUpdateWebLinkByIdRequestBodyArg( - val: UpdateWebLinkByIdRequestBodyArg +export function serializeUpdateWebLinkByIdRequestBody( + val: UpdateWebLinkByIdRequestBody ): SerializedData { return { ['url']: val.url == void 0 ? void 0 : val.url, ['parent']: val.parent == void 0 ? void 0 - : serializeUpdateWebLinkByIdRequestBodyArgParentField(val.parent), + : serializeUpdateWebLinkByIdRequestBodyParentField(val.parent), ['name']: val.name == void 0 ? void 0 : val.name, ['description']: val.description == void 0 ? void 0 : val.description, ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateWebLinkByIdRequestBodyArgSharedLinkField( - val.sharedLink - ), + : serializeUpdateWebLinkByIdRequestBodySharedLinkField(val.sharedLink), }; } -export function deserializeUpdateWebLinkByIdRequestBodyArg( +export function deserializeUpdateWebLinkByIdRequestBody( val: any -): UpdateWebLinkByIdRequestBodyArg { +): UpdateWebLinkByIdRequestBody { const url: undefined | string = val.url == void 0 ? void 0 : val.url; - const parent: undefined | UpdateWebLinkByIdRequestBodyArgParentField = + const parent: undefined | UpdateWebLinkByIdRequestBodyParentField = val.parent == void 0 ? void 0 - : deserializeUpdateWebLinkByIdRequestBodyArgParentField(val.parent); + : deserializeUpdateWebLinkByIdRequestBodyParentField(val.parent); const name: undefined | string = val.name == void 0 ? void 0 : val.name; const description: undefined | string = val.description == void 0 ? void 0 : val.description; - const sharedLink: undefined | UpdateWebLinkByIdRequestBodyArgSharedLinkField = + const sharedLink: undefined | UpdateWebLinkByIdRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateWebLinkByIdRequestBodyArgSharedLinkField( - val.shared_link - ); + : deserializeUpdateWebLinkByIdRequestBodySharedLinkField(val.shared_link); return { url: url, parent: parent, name: name, description: description, sharedLink: sharedLink, - } satisfies UpdateWebLinkByIdRequestBodyArg; + } satisfies UpdateWebLinkByIdRequestBody; } diff --git a/src/managers/webhooks.generated.ts b/src/managers/webhooks.generated.ts index df3440f9..3a8475ac 100644 --- a/src/managers/webhooks.generated.ts +++ b/src/managers/webhooks.generated.ts @@ -24,28 +24,28 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetWebhooksQueryParamsArg { +export interface GetWebhooksQueryParams { readonly marker?: string; readonly limit?: number; } -export class GetWebhooksHeadersArg { +export class GetWebhooksHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateWebhookRequestBodyArgTargetFieldTypeField = 'file' | 'folder'; -export interface CreateWebhookRequestBodyArgTargetField { +export type CreateWebhookRequestBodyTargetTypeField = 'file' | 'folder'; +export interface CreateWebhookRequestBodyTargetField { readonly id?: string; - readonly type?: CreateWebhookRequestBodyArgTargetFieldTypeField; + readonly type?: CreateWebhookRequestBodyTargetTypeField; } -export type CreateWebhookRequestBodyArgTriggersField = +export type CreateWebhookRequestBodyTriggersField = | 'FILE.UPLOADED' | 'FILE.PREVIEWED' | 'FILE.DOWNLOADED' @@ -86,43 +86,41 @@ export type CreateWebhookRequestBodyArgTriggersField = | 'SIGN_REQUEST.DECLINED' | 'SIGN_REQUEST.EXPIRED' | 'SIGN_REQUEST.SIGNER_EMAIL_BOUNCED'; -export interface CreateWebhookRequestBodyArg { - readonly target: CreateWebhookRequestBodyArgTargetField; +export interface CreateWebhookRequestBody { + readonly target: CreateWebhookRequestBodyTargetField; readonly address: string; - readonly triggers: readonly CreateWebhookRequestBodyArgTriggersField[]; + readonly triggers: readonly CreateWebhookRequestBodyTriggersField[]; } -export class CreateWebhookHeadersArg { +export class CreateWebhookHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class GetWebhookByIdHeadersArg { +export class GetWebhookByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateWebhookByIdRequestBodyArgTargetFieldTypeField = - | 'file' - | 'folder'; -export interface UpdateWebhookByIdRequestBodyArgTargetField { +export type UpdateWebhookByIdRequestBodyTargetTypeField = 'file' | 'folder'; +export interface UpdateWebhookByIdRequestBodyTargetField { readonly id?: string; - readonly type?: UpdateWebhookByIdRequestBodyArgTargetFieldTypeField; + readonly type?: UpdateWebhookByIdRequestBodyTargetTypeField; } -export type UpdateWebhookByIdRequestBodyArgTriggersField = +export type UpdateWebhookByIdRequestBodyTriggersField = | 'FILE.UPLOADED' | 'FILE.PREVIEWED' | 'FILE.DOWNLOADED' @@ -163,53 +161,56 @@ export type UpdateWebhookByIdRequestBodyArgTriggersField = | 'SIGN_REQUEST.DECLINED' | 'SIGN_REQUEST.EXPIRED' | 'SIGN_REQUEST.SIGNER_EMAIL_BOUNCED'; -export interface UpdateWebhookByIdRequestBodyArg { - readonly target?: UpdateWebhookByIdRequestBodyArgTargetField; +export interface UpdateWebhookByIdRequestBody { + readonly target?: UpdateWebhookByIdRequestBodyTargetField; readonly address?: string; - readonly triggers?: readonly UpdateWebhookByIdRequestBodyArgTriggersField[]; + readonly triggers?: readonly UpdateWebhookByIdRequestBodyTriggersField[]; } -export class UpdateWebhookByIdHeadersArg { +export class UpdateWebhookByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteWebhookByIdHeadersArg { +export class DeleteWebhookByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class WebhooksManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - WebhooksManager, - | 'getWebhooks' - | 'createWebhook' - | 'getWebhookById' - | 'updateWebhookById' - | 'deleteWebhookById' - > + fields: + | Omit< + WebhooksManager, + | 'networkSession' + | 'getWebhooks' + | 'createWebhook' + | 'getWebhookById' + | 'updateWebhookById' + | 'deleteWebhookById' + > + | Partial> ) { Object.assign(this, fields); } async getWebhooks( - queryParams: GetWebhooksQueryParamsArg = {} satisfies GetWebhooksQueryParamsArg, - headers: GetWebhooksHeadersArg = new GetWebhooksHeadersArg({}), + queryParams: GetWebhooksQueryParams = {} satisfies GetWebhooksQueryParams, + headers: GetWebhooksHeaders = new GetWebhooksHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -222,7 +223,7 @@ export class WebhooksManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/webhooks') as string, + ''.concat(this.networkSession.baseUrls.baseUrl, '/webhooks') as string, { method: 'GET', params: queryParamsMap, @@ -236,19 +237,19 @@ export class WebhooksManager { return deserializeWebhooks(response.data); } async createWebhook( - requestBody: CreateWebhookRequestBodyArg, - headers: CreateWebhookHeadersArg = new CreateWebhookHeadersArg({}), + requestBody: CreateWebhookRequestBody, + headers: CreateWebhookHeaders = new CreateWebhookHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/webhooks') as string, + ''.concat(this.networkSession.baseUrls.baseUrl, '/webhooks') as string, { method: 'POST', headers: headersMap, - data: serializeCreateWebhookRequestBodyArg(requestBody), + data: serializeCreateWebhookRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -260,7 +261,7 @@ export class WebhooksManager { } async getWebhookById( webhookId: string, - headers: GetWebhookByIdHeadersArg = new GetWebhookByIdHeadersArg({}), + headers: GetWebhookByIdHeaders = new GetWebhookByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -268,7 +269,8 @@ export class WebhooksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/webhooks/', + this.networkSession.baseUrls.baseUrl, + '/webhooks/', toString(webhookId) as string ) as string, { @@ -284,8 +286,8 @@ export class WebhooksManager { } async updateWebhookById( webhookId: string, - requestBody: UpdateWebhookByIdRequestBodyArg = {} satisfies UpdateWebhookByIdRequestBodyArg, - headers: UpdateWebhookByIdHeadersArg = new UpdateWebhookByIdHeadersArg({}), + requestBody: UpdateWebhookByIdRequestBody = {} satisfies UpdateWebhookByIdRequestBody, + headers: UpdateWebhookByIdHeaders = new UpdateWebhookByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -293,13 +295,14 @@ export class WebhooksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/webhooks/', + this.networkSession.baseUrls.baseUrl, + '/webhooks/', toString(webhookId) as string ) as string, { method: 'PUT', headers: headersMap, - data: serializeUpdateWebhookByIdRequestBodyArg(requestBody), + data: serializeUpdateWebhookByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -311,7 +314,7 @@ export class WebhooksManager { } async deleteWebhookById( webhookId: string, - headers: DeleteWebhookByIdHeadersArg = new DeleteWebhookByIdHeadersArg({}), + headers: DeleteWebhookByIdHeaders = new DeleteWebhookByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -319,7 +322,8 @@ export class WebhooksManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/webhooks/', + this.networkSession.baseUrls.baseUrl, + '/webhooks/', toString(webhookId) as string ) as string, { @@ -334,16 +338,16 @@ export class WebhooksManager { return void 0; } } -export function serializeCreateWebhookRequestBodyArgTargetFieldTypeField( - val: CreateWebhookRequestBodyArgTargetFieldTypeField +export function serializeCreateWebhookRequestBodyTargetTypeField( + val: CreateWebhookRequestBodyTargetTypeField ): SerializedData { return val; } -export function deserializeCreateWebhookRequestBodyArgTargetFieldTypeField( +export function deserializeCreateWebhookRequestBodyTargetTypeField( val: any -): CreateWebhookRequestBodyArgTargetFieldTypeField { +): CreateWebhookRequestBodyTargetTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateWebhookRequestBodyArgTargetFieldTypeField"'; + throw 'Expecting a string for "CreateWebhookRequestBodyTargetTypeField"'; } if (val == 'file') { return 'file'; @@ -353,40 +357,37 @@ export function deserializeCreateWebhookRequestBodyArgTargetFieldTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateWebhookRequestBodyArgTargetField( - val: CreateWebhookRequestBodyArgTargetField +export function serializeCreateWebhookRequestBodyTargetField( + val: CreateWebhookRequestBodyTargetField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id, ['type']: val.type == void 0 ? void 0 - : serializeCreateWebhookRequestBodyArgTargetFieldTypeField(val.type), + : serializeCreateWebhookRequestBodyTargetTypeField(val.type), }; } -export function deserializeCreateWebhookRequestBodyArgTargetField( +export function deserializeCreateWebhookRequestBodyTargetField( val: any -): CreateWebhookRequestBodyArgTargetField { +): CreateWebhookRequestBodyTargetField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: undefined | CreateWebhookRequestBodyArgTargetFieldTypeField = + const type: undefined | CreateWebhookRequestBodyTargetTypeField = val.type == void 0 ? void 0 - : deserializeCreateWebhookRequestBodyArgTargetFieldTypeField(val.type); - return { - id: id, - type: type, - } satisfies CreateWebhookRequestBodyArgTargetField; + : deserializeCreateWebhookRequestBodyTargetTypeField(val.type); + return { id: id, type: type } satisfies CreateWebhookRequestBodyTargetField; } -export function serializeCreateWebhookRequestBodyArgTriggersField( - val: CreateWebhookRequestBodyArgTriggersField +export function serializeCreateWebhookRequestBodyTriggersField( + val: CreateWebhookRequestBodyTriggersField ): SerializedData { return val; } -export function deserializeCreateWebhookRequestBodyArgTriggersField( +export function deserializeCreateWebhookRequestBodyTriggersField( val: any -): CreateWebhookRequestBodyArgTriggersField { +): CreateWebhookRequestBodyTriggersField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateWebhookRequestBodyArgTriggersField"'; + throw 'Expecting a string for "CreateWebhookRequestBodyTriggersField"'; } if (val == 'FILE.UPLOADED') { return 'FILE.UPLOADED'; @@ -510,47 +511,48 @@ export function deserializeCreateWebhookRequestBodyArgTriggersField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateWebhookRequestBodyArg( - val: CreateWebhookRequestBodyArg +export function serializeCreateWebhookRequestBody( + val: CreateWebhookRequestBody ): SerializedData { return { - ['target']: serializeCreateWebhookRequestBodyArgTargetField(val.target), + ['target']: serializeCreateWebhookRequestBodyTargetField(val.target), ['address']: val.address, ['triggers']: val.triggers.map(function ( - item: CreateWebhookRequestBodyArgTriggersField + item: CreateWebhookRequestBodyTriggersField ): any { - return serializeCreateWebhookRequestBodyArgTriggersField(item); + return serializeCreateWebhookRequestBodyTriggersField(item); }) as readonly any[], }; } -export function deserializeCreateWebhookRequestBodyArg( +export function deserializeCreateWebhookRequestBody( val: any -): CreateWebhookRequestBodyArg { - const target: CreateWebhookRequestBodyArgTargetField = - deserializeCreateWebhookRequestBodyArgTargetField(val.target); +): CreateWebhookRequestBody { + const target: CreateWebhookRequestBodyTargetField = + deserializeCreateWebhookRequestBodyTargetField(val.target); const address: string = val.address; - const triggers: readonly CreateWebhookRequestBodyArgTriggersField[] = - sdIsList(val.triggers) - ? (val.triggers.map(function (itm: SerializedData): any { - return deserializeCreateWebhookRequestBodyArgTriggersField(itm); - }) as readonly any[]) - : []; + const triggers: readonly CreateWebhookRequestBodyTriggersField[] = sdIsList( + val.triggers + ) + ? (val.triggers.map(function (itm: SerializedData): any { + return deserializeCreateWebhookRequestBodyTriggersField(itm); + }) as readonly any[]) + : []; return { target: target, address: address, triggers: triggers, - } satisfies CreateWebhookRequestBodyArg; + } satisfies CreateWebhookRequestBody; } -export function serializeUpdateWebhookByIdRequestBodyArgTargetFieldTypeField( - val: UpdateWebhookByIdRequestBodyArgTargetFieldTypeField +export function serializeUpdateWebhookByIdRequestBodyTargetTypeField( + val: UpdateWebhookByIdRequestBodyTargetTypeField ): SerializedData { return val; } -export function deserializeUpdateWebhookByIdRequestBodyArgTargetFieldTypeField( +export function deserializeUpdateWebhookByIdRequestBodyTargetTypeField( val: any -): UpdateWebhookByIdRequestBodyArgTargetFieldTypeField { +): UpdateWebhookByIdRequestBodyTargetTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateWebhookByIdRequestBodyArgTargetFieldTypeField"'; + throw 'Expecting a string for "UpdateWebhookByIdRequestBodyTargetTypeField"'; } if (val == 'file') { return 'file'; @@ -560,44 +562,40 @@ export function deserializeUpdateWebhookByIdRequestBodyArgTargetFieldTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateWebhookByIdRequestBodyArgTargetField( - val: UpdateWebhookByIdRequestBodyArgTargetField +export function serializeUpdateWebhookByIdRequestBodyTargetField( + val: UpdateWebhookByIdRequestBodyTargetField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id, ['type']: val.type == void 0 ? void 0 - : serializeUpdateWebhookByIdRequestBodyArgTargetFieldTypeField( - val.type - ), + : serializeUpdateWebhookByIdRequestBodyTargetTypeField(val.type), }; } -export function deserializeUpdateWebhookByIdRequestBodyArgTargetField( +export function deserializeUpdateWebhookByIdRequestBodyTargetField( val: any -): UpdateWebhookByIdRequestBodyArgTargetField { +): UpdateWebhookByIdRequestBodyTargetField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: undefined | UpdateWebhookByIdRequestBodyArgTargetFieldTypeField = + const type: undefined | UpdateWebhookByIdRequestBodyTargetTypeField = val.type == void 0 ? void 0 - : deserializeUpdateWebhookByIdRequestBodyArgTargetFieldTypeField( - val.type - ); + : deserializeUpdateWebhookByIdRequestBodyTargetTypeField(val.type); return { id: id, type: type, - } satisfies UpdateWebhookByIdRequestBodyArgTargetField; + } satisfies UpdateWebhookByIdRequestBodyTargetField; } -export function serializeUpdateWebhookByIdRequestBodyArgTriggersField( - val: UpdateWebhookByIdRequestBodyArgTriggersField +export function serializeUpdateWebhookByIdRequestBodyTriggersField( + val: UpdateWebhookByIdRequestBodyTriggersField ): SerializedData { return val; } -export function deserializeUpdateWebhookByIdRequestBodyArgTriggersField( +export function deserializeUpdateWebhookByIdRequestBodyTriggersField( val: any -): UpdateWebhookByIdRequestBodyArgTriggersField { +): UpdateWebhookByIdRequestBodyTriggersField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateWebhookByIdRequestBodyArgTriggersField"'; + throw 'Expecting a string for "UpdateWebhookByIdRequestBodyTriggersField"'; } if (val == 'FILE.UPLOADED') { return 'FILE.UPLOADED'; @@ -721,47 +719,47 @@ export function deserializeUpdateWebhookByIdRequestBodyArgTriggersField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateWebhookByIdRequestBodyArg( - val: UpdateWebhookByIdRequestBodyArg +export function serializeUpdateWebhookByIdRequestBody( + val: UpdateWebhookByIdRequestBody ): SerializedData { return { ['target']: val.target == void 0 ? void 0 - : serializeUpdateWebhookByIdRequestBodyArgTargetField(val.target), + : serializeUpdateWebhookByIdRequestBodyTargetField(val.target), ['address']: val.address == void 0 ? void 0 : val.address, ['triggers']: val.triggers == void 0 ? void 0 : (val.triggers.map(function ( - item: UpdateWebhookByIdRequestBodyArgTriggersField + item: UpdateWebhookByIdRequestBodyTriggersField ): any { - return serializeUpdateWebhookByIdRequestBodyArgTriggersField(item); + return serializeUpdateWebhookByIdRequestBodyTriggersField(item); }) as readonly any[]), }; } -export function deserializeUpdateWebhookByIdRequestBodyArg( +export function deserializeUpdateWebhookByIdRequestBody( val: any -): UpdateWebhookByIdRequestBodyArg { - const target: undefined | UpdateWebhookByIdRequestBodyArgTargetField = +): UpdateWebhookByIdRequestBody { + const target: undefined | UpdateWebhookByIdRequestBodyTargetField = val.target == void 0 ? void 0 - : deserializeUpdateWebhookByIdRequestBodyArgTargetField(val.target); + : deserializeUpdateWebhookByIdRequestBodyTargetField(val.target); const address: undefined | string = val.address == void 0 ? void 0 : val.address; const triggers: | undefined - | readonly UpdateWebhookByIdRequestBodyArgTriggersField[] = + | readonly UpdateWebhookByIdRequestBodyTriggersField[] = val.triggers == void 0 ? void 0 : sdIsList(val.triggers) ? (val.triggers.map(function (itm: SerializedData): any { - return deserializeUpdateWebhookByIdRequestBodyArgTriggersField(itm); + return deserializeUpdateWebhookByIdRequestBodyTriggersField(itm); }) as readonly any[]) : []; return { target: target, address: address, triggers: triggers, - } satisfies UpdateWebhookByIdRequestBodyArg; + } satisfies UpdateWebhookByIdRequestBody; } diff --git a/src/managers/workflows.generated.ts b/src/managers/workflows.generated.ts index a982f179..731addcc 100644 --- a/src/managers/workflows.generated.ts +++ b/src/managers/workflows.generated.ts @@ -21,75 +21,80 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetWorkflowsQueryParamsArg { +export interface GetWorkflowsQueryParams { readonly folderId: string; readonly triggerType?: string; readonly limit?: number; readonly marker?: string; } -export class GetWorkflowsHeadersArg { +export class GetWorkflowsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateWorkflowStartRequestBodyArgTypeField = 'workflow_parameters'; -export interface CreateWorkflowStartRequestBodyArgFlowField { +export type CreateWorkflowStartRequestBodyTypeField = 'workflow_parameters'; +export interface CreateWorkflowStartRequestBodyFlowField { readonly type?: string; readonly id?: string; } -export type CreateWorkflowStartRequestBodyArgFilesFieldTypeField = 'file'; -export interface CreateWorkflowStartRequestBodyArgFilesField { - readonly type?: CreateWorkflowStartRequestBodyArgFilesFieldTypeField; +export type CreateWorkflowStartRequestBodyFilesTypeField = 'file'; +export interface CreateWorkflowStartRequestBodyFilesField { + readonly type?: CreateWorkflowStartRequestBodyFilesTypeField; readonly id?: string; } -export type CreateWorkflowStartRequestBodyArgFolderFieldTypeField = 'folder'; -export interface CreateWorkflowStartRequestBodyArgFolderField { - readonly type?: CreateWorkflowStartRequestBodyArgFolderFieldTypeField; +export type CreateWorkflowStartRequestBodyFolderTypeField = 'folder'; +export interface CreateWorkflowStartRequestBodyFolderField { + readonly type?: CreateWorkflowStartRequestBodyFolderTypeField; readonly id?: string; } -export type CreateWorkflowStartRequestBodyArgOutcomesFieldTypeField = 'outcome'; -export interface CreateWorkflowStartRequestBodyArgOutcomesField { +export type CreateWorkflowStartRequestBodyOutcomesTypeField = 'outcome'; +export interface CreateWorkflowStartRequestBodyOutcomesField { readonly id?: string; - readonly type?: CreateWorkflowStartRequestBodyArgOutcomesFieldTypeField; + readonly type?: CreateWorkflowStartRequestBodyOutcomesTypeField; readonly parameter?: string; } -export interface CreateWorkflowStartRequestBodyArg { - readonly type?: CreateWorkflowStartRequestBodyArgTypeField; - readonly flow: CreateWorkflowStartRequestBodyArgFlowField; - readonly files: readonly CreateWorkflowStartRequestBodyArgFilesField[]; - readonly folder: CreateWorkflowStartRequestBodyArgFolderField; - readonly outcomes?: readonly CreateWorkflowStartRequestBodyArgOutcomesField[]; +export interface CreateWorkflowStartRequestBody { + readonly type?: CreateWorkflowStartRequestBodyTypeField; + readonly flow: CreateWorkflowStartRequestBodyFlowField; + readonly files: readonly CreateWorkflowStartRequestBodyFilesField[]; + readonly folder: CreateWorkflowStartRequestBodyFolderField; + readonly outcomes?: readonly CreateWorkflowStartRequestBodyOutcomesField[]; } -export class CreateWorkflowStartHeadersArg { +export class CreateWorkflowStartHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class WorkflowsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit + fields: + | Omit< + WorkflowsManager, + 'networkSession' | 'getWorkflows' | 'createWorkflowStart' + > + | Partial> ) { Object.assign(this, fields); } async getWorkflows( - queryParams: GetWorkflowsQueryParamsArg, - headers: GetWorkflowsHeadersArg = new GetWorkflowsHeadersArg({}), + queryParams: GetWorkflowsQueryParams, + headers: GetWorkflowsHeaders = new GetWorkflowsHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -104,7 +109,7 @@ export class WorkflowsManager { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/workflows') as string, + ''.concat(this.networkSession.baseUrls.baseUrl, '/workflows') as string, { method: 'GET', params: queryParamsMap, @@ -119,10 +124,8 @@ export class WorkflowsManager { } async createWorkflowStart( workflowId: string, - requestBody: CreateWorkflowStartRequestBodyArg, - headers: CreateWorkflowStartHeadersArg = new CreateWorkflowStartHeadersArg( - {} - ), + requestBody: CreateWorkflowStartRequestBody, + headers: CreateWorkflowStartHeaders = new CreateWorkflowStartHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -130,14 +133,15 @@ export class WorkflowsManager { } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( ''.concat( - 'https://api.box.com/2.0/workflows/', + this.networkSession.baseUrls.baseUrl, + '/workflows/', toString(workflowId) as string, '/start' ) as string, { method: 'POST', headers: headersMap, - data: serializeCreateWorkflowStartRequestBodyArg(requestBody), + data: serializeCreateWorkflowStartRequestBody(requestBody), contentType: 'application/json', responseFormat: void 0, auth: this.auth, @@ -148,234 +152,215 @@ export class WorkflowsManager { return void 0; } } -export function serializeCreateWorkflowStartRequestBodyArgTypeField( - val: CreateWorkflowStartRequestBodyArgTypeField +export function serializeCreateWorkflowStartRequestBodyTypeField( + val: CreateWorkflowStartRequestBodyTypeField ): SerializedData { return val; } -export function deserializeCreateWorkflowStartRequestBodyArgTypeField( +export function deserializeCreateWorkflowStartRequestBodyTypeField( val: any -): CreateWorkflowStartRequestBodyArgTypeField { +): CreateWorkflowStartRequestBodyTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateWorkflowStartRequestBodyArgTypeField"'; + throw 'Expecting a string for "CreateWorkflowStartRequestBodyTypeField"'; } if (val == 'workflow_parameters') { return 'workflow_parameters'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateWorkflowStartRequestBodyArgFlowField( - val: CreateWorkflowStartRequestBodyArgFlowField +export function serializeCreateWorkflowStartRequestBodyFlowField( + val: CreateWorkflowStartRequestBodyFlowField ): SerializedData { return { ['type']: val.type == void 0 ? void 0 : val.type, ['id']: val.id == void 0 ? void 0 : val.id, }; } -export function deserializeCreateWorkflowStartRequestBodyArgFlowField( +export function deserializeCreateWorkflowStartRequestBodyFlowField( val: any -): CreateWorkflowStartRequestBodyArgFlowField { +): CreateWorkflowStartRequestBodyFlowField { const type: undefined | string = val.type == void 0 ? void 0 : val.type; const id: undefined | string = val.id == void 0 ? void 0 : val.id; return { type: type, id: id, - } satisfies CreateWorkflowStartRequestBodyArgFlowField; + } satisfies CreateWorkflowStartRequestBodyFlowField; } -export function serializeCreateWorkflowStartRequestBodyArgFilesFieldTypeField( - val: CreateWorkflowStartRequestBodyArgFilesFieldTypeField +export function serializeCreateWorkflowStartRequestBodyFilesTypeField( + val: CreateWorkflowStartRequestBodyFilesTypeField ): SerializedData { return val; } -export function deserializeCreateWorkflowStartRequestBodyArgFilesFieldTypeField( +export function deserializeCreateWorkflowStartRequestBodyFilesTypeField( val: any -): CreateWorkflowStartRequestBodyArgFilesFieldTypeField { +): CreateWorkflowStartRequestBodyFilesTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateWorkflowStartRequestBodyArgFilesFieldTypeField"'; + throw 'Expecting a string for "CreateWorkflowStartRequestBodyFilesTypeField"'; } if (val == 'file') { return 'file'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateWorkflowStartRequestBodyArgFilesField( - val: CreateWorkflowStartRequestBodyArgFilesField +export function serializeCreateWorkflowStartRequestBodyFilesField( + val: CreateWorkflowStartRequestBodyFilesField ): SerializedData { return { ['type']: val.type == void 0 ? void 0 - : serializeCreateWorkflowStartRequestBodyArgFilesFieldTypeField( - val.type - ), + : serializeCreateWorkflowStartRequestBodyFilesTypeField(val.type), ['id']: val.id == void 0 ? void 0 : val.id, }; } -export function deserializeCreateWorkflowStartRequestBodyArgFilesField( +export function deserializeCreateWorkflowStartRequestBodyFilesField( val: any -): CreateWorkflowStartRequestBodyArgFilesField { - const type: undefined | CreateWorkflowStartRequestBodyArgFilesFieldTypeField = +): CreateWorkflowStartRequestBodyFilesField { + const type: undefined | CreateWorkflowStartRequestBodyFilesTypeField = val.type == void 0 ? void 0 - : deserializeCreateWorkflowStartRequestBodyArgFilesFieldTypeField( - val.type - ); + : deserializeCreateWorkflowStartRequestBodyFilesTypeField(val.type); const id: undefined | string = val.id == void 0 ? void 0 : val.id; return { type: type, id: id, - } satisfies CreateWorkflowStartRequestBodyArgFilesField; + } satisfies CreateWorkflowStartRequestBodyFilesField; } -export function serializeCreateWorkflowStartRequestBodyArgFolderFieldTypeField( - val: CreateWorkflowStartRequestBodyArgFolderFieldTypeField +export function serializeCreateWorkflowStartRequestBodyFolderTypeField( + val: CreateWorkflowStartRequestBodyFolderTypeField ): SerializedData { return val; } -export function deserializeCreateWorkflowStartRequestBodyArgFolderFieldTypeField( +export function deserializeCreateWorkflowStartRequestBodyFolderTypeField( val: any -): CreateWorkflowStartRequestBodyArgFolderFieldTypeField { +): CreateWorkflowStartRequestBodyFolderTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateWorkflowStartRequestBodyArgFolderFieldTypeField"'; + throw 'Expecting a string for "CreateWorkflowStartRequestBodyFolderTypeField"'; } if (val == 'folder') { return 'folder'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateWorkflowStartRequestBodyArgFolderField( - val: CreateWorkflowStartRequestBodyArgFolderField +export function serializeCreateWorkflowStartRequestBodyFolderField( + val: CreateWorkflowStartRequestBodyFolderField ): SerializedData { return { ['type']: val.type == void 0 ? void 0 - : serializeCreateWorkflowStartRequestBodyArgFolderFieldTypeField( - val.type - ), + : serializeCreateWorkflowStartRequestBodyFolderTypeField(val.type), ['id']: val.id == void 0 ? void 0 : val.id, }; } -export function deserializeCreateWorkflowStartRequestBodyArgFolderField( +export function deserializeCreateWorkflowStartRequestBodyFolderField( val: any -): CreateWorkflowStartRequestBodyArgFolderField { - const type: - | undefined - | CreateWorkflowStartRequestBodyArgFolderFieldTypeField = +): CreateWorkflowStartRequestBodyFolderField { + const type: undefined | CreateWorkflowStartRequestBodyFolderTypeField = val.type == void 0 ? void 0 - : deserializeCreateWorkflowStartRequestBodyArgFolderFieldTypeField( - val.type - ); + : deserializeCreateWorkflowStartRequestBodyFolderTypeField(val.type); const id: undefined | string = val.id == void 0 ? void 0 : val.id; return { type: type, id: id, - } satisfies CreateWorkflowStartRequestBodyArgFolderField; + } satisfies CreateWorkflowStartRequestBodyFolderField; } -export function serializeCreateWorkflowStartRequestBodyArgOutcomesFieldTypeField( - val: CreateWorkflowStartRequestBodyArgOutcomesFieldTypeField +export function serializeCreateWorkflowStartRequestBodyOutcomesTypeField( + val: CreateWorkflowStartRequestBodyOutcomesTypeField ): SerializedData { return val; } -export function deserializeCreateWorkflowStartRequestBodyArgOutcomesFieldTypeField( +export function deserializeCreateWorkflowStartRequestBodyOutcomesTypeField( val: any -): CreateWorkflowStartRequestBodyArgOutcomesFieldTypeField { +): CreateWorkflowStartRequestBodyOutcomesTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateWorkflowStartRequestBodyArgOutcomesFieldTypeField"'; + throw 'Expecting a string for "CreateWorkflowStartRequestBodyOutcomesTypeField"'; } if (val == 'outcome') { return 'outcome'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateWorkflowStartRequestBodyArgOutcomesField( - val: CreateWorkflowStartRequestBodyArgOutcomesField +export function serializeCreateWorkflowStartRequestBodyOutcomesField( + val: CreateWorkflowStartRequestBodyOutcomesField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id, ['type']: val.type == void 0 ? void 0 - : serializeCreateWorkflowStartRequestBodyArgOutcomesFieldTypeField( - val.type - ), + : serializeCreateWorkflowStartRequestBodyOutcomesTypeField(val.type), ['parameter']: val.parameter == void 0 ? void 0 : val.parameter, }; } -export function deserializeCreateWorkflowStartRequestBodyArgOutcomesField( +export function deserializeCreateWorkflowStartRequestBodyOutcomesField( val: any -): CreateWorkflowStartRequestBodyArgOutcomesField { +): CreateWorkflowStartRequestBodyOutcomesField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: - | undefined - | CreateWorkflowStartRequestBodyArgOutcomesFieldTypeField = + const type: undefined | CreateWorkflowStartRequestBodyOutcomesTypeField = val.type == void 0 ? void 0 - : deserializeCreateWorkflowStartRequestBodyArgOutcomesFieldTypeField( - val.type - ); + : deserializeCreateWorkflowStartRequestBodyOutcomesTypeField(val.type); const parameter: undefined | string = val.parameter == void 0 ? void 0 : val.parameter; return { id: id, type: type, parameter: parameter, - } satisfies CreateWorkflowStartRequestBodyArgOutcomesField; + } satisfies CreateWorkflowStartRequestBodyOutcomesField; } -export function serializeCreateWorkflowStartRequestBodyArg( - val: CreateWorkflowStartRequestBodyArg +export function serializeCreateWorkflowStartRequestBody( + val: CreateWorkflowStartRequestBody ): SerializedData { return { ['type']: val.type == void 0 ? void 0 - : serializeCreateWorkflowStartRequestBodyArgTypeField(val.type), - ['flow']: serializeCreateWorkflowStartRequestBodyArgFlowField(val.flow), + : serializeCreateWorkflowStartRequestBodyTypeField(val.type), + ['flow']: serializeCreateWorkflowStartRequestBodyFlowField(val.flow), ['files']: val.files.map(function ( - item: CreateWorkflowStartRequestBodyArgFilesField + item: CreateWorkflowStartRequestBodyFilesField ): any { - return serializeCreateWorkflowStartRequestBodyArgFilesField(item); + return serializeCreateWorkflowStartRequestBodyFilesField(item); }) as readonly any[], - ['folder']: serializeCreateWorkflowStartRequestBodyArgFolderField( - val.folder - ), + ['folder']: serializeCreateWorkflowStartRequestBodyFolderField(val.folder), ['outcomes']: val.outcomes == void 0 ? void 0 : (val.outcomes.map(function ( - item: CreateWorkflowStartRequestBodyArgOutcomesField + item: CreateWorkflowStartRequestBodyOutcomesField ): any { - return serializeCreateWorkflowStartRequestBodyArgOutcomesField( - item - ); + return serializeCreateWorkflowStartRequestBodyOutcomesField(item); }) as readonly any[]), }; } -export function deserializeCreateWorkflowStartRequestBodyArg( +export function deserializeCreateWorkflowStartRequestBody( val: any -): CreateWorkflowStartRequestBodyArg { - const type: undefined | CreateWorkflowStartRequestBodyArgTypeField = +): CreateWorkflowStartRequestBody { + const type: undefined | CreateWorkflowStartRequestBodyTypeField = val.type == void 0 ? void 0 - : deserializeCreateWorkflowStartRequestBodyArgTypeField(val.type); - const flow: CreateWorkflowStartRequestBodyArgFlowField = - deserializeCreateWorkflowStartRequestBodyArgFlowField(val.flow); - const files: readonly CreateWorkflowStartRequestBodyArgFilesField[] = - sdIsList(val.files) - ? (val.files.map(function (itm: SerializedData): any { - return deserializeCreateWorkflowStartRequestBodyArgFilesField(itm); - }) as readonly any[]) - : []; - const folder: CreateWorkflowStartRequestBodyArgFolderField = - deserializeCreateWorkflowStartRequestBodyArgFolderField(val.folder); + : deserializeCreateWorkflowStartRequestBodyTypeField(val.type); + const flow: CreateWorkflowStartRequestBodyFlowField = + deserializeCreateWorkflowStartRequestBodyFlowField(val.flow); + const files: readonly CreateWorkflowStartRequestBodyFilesField[] = sdIsList( + val.files + ) + ? (val.files.map(function (itm: SerializedData): any { + return deserializeCreateWorkflowStartRequestBodyFilesField(itm); + }) as readonly any[]) + : []; + const folder: CreateWorkflowStartRequestBodyFolderField = + deserializeCreateWorkflowStartRequestBodyFolderField(val.folder); const outcomes: | undefined - | readonly CreateWorkflowStartRequestBodyArgOutcomesField[] = + | readonly CreateWorkflowStartRequestBodyOutcomesField[] = val.outcomes == void 0 ? void 0 : sdIsList(val.outcomes) ? (val.outcomes.map(function (itm: SerializedData): any { - return deserializeCreateWorkflowStartRequestBodyArgOutcomesField(itm); + return deserializeCreateWorkflowStartRequestBodyOutcomesField(itm); }) as readonly any[]) : []; return { @@ -384,5 +369,5 @@ export function deserializeCreateWorkflowStartRequestBodyArg( files: files, folder: folder, outcomes: outcomes, - } satisfies CreateWorkflowStartRequestBodyArg; + } satisfies CreateWorkflowStartRequestBody; } diff --git a/src/managers/zipDownloads.generated.ts b/src/managers/zipDownloads.generated.ts index 64ed1abb..cea683b2 100644 --- a/src/managers/zipDownloads.generated.ts +++ b/src/managers/zipDownloads.generated.ts @@ -27,78 +27,84 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class CreateZipDownloadHeadersArg { +export class CreateZipDownloadHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class GetZipDownloadContentHeadersArg { +export class GetZipDownloadContentHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class GetZipDownloadStatusHeadersArg { +export class GetZipDownloadStatusHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DownloadZipHeadersArg { +export class DownloadZipHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } export class ZipDownloadsManager { readonly auth?: Authentication; - readonly networkSession?: NetworkSession; + readonly networkSession: NetworkSession = new NetworkSession({}); constructor( - fields: Omit< - ZipDownloadsManager, - | 'createZipDownload' - | 'getZipDownloadContent' - | 'getZipDownloadStatus' - | 'downloadZip' - > + fields: + | Omit< + ZipDownloadsManager, + | 'networkSession' + | 'createZipDownload' + | 'getZipDownloadContent' + | 'getZipDownloadStatus' + | 'downloadZip' + > + | Partial> ) { Object.assign(this, fields); } async createZipDownload( requestBody: ZipDownloadRequest, - headers: CreateZipDownloadHeadersArg = new CreateZipDownloadHeadersArg({}), + headers: CreateZipDownloadHeaders = new CreateZipDownloadHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { readonly [key: string]: string; } = prepareParams({ ...{}, ...headers.extraHeaders }); const response: FetchResponse = (await fetch( - ''.concat('https://api.box.com/2.0/zip_downloads') as string, + ''.concat( + this.networkSession.baseUrls.baseUrl, + '/zip_downloads' + ) as string, { method: 'POST', headers: headersMap, @@ -114,7 +120,7 @@ export class ZipDownloadsManager { } async getZipDownloadContent( downloadUrl: string, - headers: GetZipDownloadContentHeadersArg = new GetZipDownloadContentHeadersArg( + headers: GetZipDownloadContentHeaders = new GetZipDownloadContentHeaders( {} ), cancellationToken?: CancellationToken @@ -134,9 +140,7 @@ export class ZipDownloadsManager { } async getZipDownloadStatus( statusUrl: string, - headers: GetZipDownloadStatusHeadersArg = new GetZipDownloadStatusHeadersArg( - {} - ), + headers: GetZipDownloadStatusHeaders = new GetZipDownloadStatusHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -154,7 +158,7 @@ export class ZipDownloadsManager { } async downloadZip( requestBody: ZipDownloadRequest, - headers: DownloadZipHeadersArg = new DownloadZipHeadersArg({}), + headers: DownloadZipHeaders = new DownloadZipHeaders({}), cancellationToken?: CancellationToken ): Promise { const zipDownloadSession: ZipDownload = await this.createZipDownload( @@ -162,14 +166,12 @@ export class ZipDownloadsManager { items: requestBody.items, downloadFileName: requestBody.downloadFileName, } satisfies ZipDownloadRequest, - new CreateZipDownloadHeadersArg({ extraHeaders: headers.extraHeaders }), + new CreateZipDownloadHeaders({ extraHeaders: headers.extraHeaders }), cancellationToken ); return await this.getZipDownloadContent( zipDownloadSession.downloadUrl!, - new GetZipDownloadContentHeadersArg({ - extraHeaders: headers.extraHeaders, - }), + new GetZipDownloadContentHeaders({ extraHeaders: headers.extraHeaders }), cancellationToken ); } diff --git a/src/network.ts b/src/network.ts index 93c5595d..19aca13f 100644 --- a/src/network.ts +++ b/src/network.ts @@ -1,7 +1,14 @@ +import { BaseUrls } from './baseUrls.generated.js'; + export class NetworkSession { additionalHeaders?: { readonly [key: string]: string }; + baseUrls: BaseUrls = new BaseUrls({}); - constructor(fields: Omit) { + constructor( + fields: + | Omit + | Partial> + ) { Object.assign(this, fields); } @@ -13,8 +20,13 @@ export class NetworkSession { withAdditionalHeaders(additionalHeaders: { readonly [key: string]: string }) { return new NetworkSession({ additionalHeaders: { ...this.additionalHeaders, ...additionalHeaders }, + baseUrls: this.baseUrls, }); } + + withCustomBaseUrls(baseUrls: BaseUrls) { + return new NetworkSession({ ...this, baseUrls }); + } } // Retry intervals are between 50% and 150% of the exponentially increasing base amount diff --git a/src/oauth.generated.ts b/src/oauth.generated.ts index 0c8bea67..58a86ecc 100644 --- a/src/oauth.generated.ts +++ b/src/oauth.generated.ts @@ -27,7 +27,7 @@ export class OAuthConfig { Object.assign(this, fields); } } -export interface GetAuthorizeUrlOptionsArg { +export interface GetAuthorizeUrlOptions { readonly clientId?: string; readonly redirectUri?: string; readonly responseType?: string; @@ -53,7 +53,7 @@ export class BoxOAuth implements Authentication { this.tokenStorage = this.config.tokenStorage; } getAuthorizeUrl( - options: GetAuthorizeUrlOptionsArg = {} satisfies GetAuthorizeUrlOptionsArg + options: GetAuthorizeUrlOptions = {} satisfies GetAuthorizeUrlOptions ): string { const params: { readonly [key: string]: any; @@ -78,9 +78,9 @@ export class BoxOAuth implements Authentication { authorizationCode: string, networkSession?: NetworkSession ): Promise { - const authManager: AuthorizationManager = new AuthorizationManager({ - networkSession: networkSession, - }); + const authManager: AuthorizationManager = !(networkSession == void 0) + ? new AuthorizationManager({ networkSession: networkSession }) + : new AuthorizationManager({}); const token: AccessToken = await authManager.createOauth2Token({ grantType: 'authorization_code', code: authorizationCode, @@ -107,9 +107,9 @@ export class BoxOAuth implements Authentication { : !(oldToken == void 0) ? oldToken.refreshToken : void 0; - const authManager: AuthorizationManager = new AuthorizationManager({ - networkSession: networkSession, - }); + const authManager: AuthorizationManager = !(networkSession == void 0) + ? new AuthorizationManager({ networkSession: networkSession }) + : new AuthorizationManager({}); const token: AccessToken = await authManager.createOauth2Token({ grantType: 'refresh_token', clientId: this.config.clientId, @@ -124,9 +124,9 @@ export class BoxOAuth implements Authentication { if (token == void 0) { return void 0; } - const authManager: AuthorizationManager = new AuthorizationManager({ - networkSession: networkSession, - }); + const authManager: AuthorizationManager = !(networkSession == void 0) + ? new AuthorizationManager({ networkSession: networkSession }) + : new AuthorizationManager({}); await authManager.createOauth2Revoke({ clientId: this.config.clientId, clientSecret: this.config.clientSecret, @@ -145,9 +145,9 @@ export class BoxOAuth implements Authentication { if (token == void 0 || token.accessToken == void 0) { throw 'No access token is available.'; } - const authManager: AuthorizationManager = new AuthorizationManager({ - networkSession: networkSession, - }); + const authManager: AuthorizationManager = !(networkSession == void 0) + ? new AuthorizationManager({ networkSession: networkSession }) + : new AuthorizationManager({}); const downscopedToken: AccessToken = await authManager.createOauth2Token({ grantType: 'urn:ietf:params:oauth:grant-type:token-exchange', subjectToken: token.accessToken, @@ -159,8 +159,8 @@ export class BoxOAuth implements Authentication { return downscopedToken; } } -export function serializeGetAuthorizeUrlOptionsArg( - val: GetAuthorizeUrlOptionsArg +export function serializeGetAuthorizeUrlOptions( + val: GetAuthorizeUrlOptions ): SerializedData { return { ['clientId']: val.clientId == void 0 ? void 0 : val.clientId, @@ -170,9 +170,9 @@ export function serializeGetAuthorizeUrlOptionsArg( ['scope']: val.scope == void 0 ? void 0 : val.scope, }; } -export function deserializeGetAuthorizeUrlOptionsArg( +export function deserializeGetAuthorizeUrlOptions( val: any -): GetAuthorizeUrlOptionsArg { +): GetAuthorizeUrlOptions { const clientId: undefined | string = val.clientId == void 0 ? void 0 : val.clientId; const redirectUri: undefined | string = @@ -187,5 +187,5 @@ export function deserializeGetAuthorizeUrlOptionsArg( responseType: responseType, state: state, scope: scope, - } satisfies GetAuthorizeUrlOptionsArg; + } satisfies GetAuthorizeUrlOptions; } diff --git a/src/schemas.generated.ts b/src/schemas.generated.ts index 0d16002e..148a3dd6 100644 --- a/src/schemas.generated.ts +++ b/src/schemas.generated.ts @@ -45,19 +45,19 @@ export interface PostOAuth2Revoke { readonly clientSecret?: string; readonly token?: string; } -export type ZipDownloadRequestItemsFieldTypeField = 'file' | 'folder'; +export type ZipDownloadRequestItemsTypeField = 'file' | 'folder'; export interface ZipDownloadRequestItemsField { - readonly type: ZipDownloadRequestItemsFieldTypeField; + readonly type: ZipDownloadRequestItemsTypeField; readonly id: string; } export interface ZipDownloadRequest { readonly items: readonly ZipDownloadRequestItemsField[]; readonly downloadFileName?: string; } -export type MetadataQueryOrderByFieldDirectionField = 'ASC' | 'DESC'; +export type MetadataQueryOrderByDirectionField = 'ASC' | 'DESC'; export interface MetadataQueryOrderByField { readonly fieldKey?: string; - readonly direction?: MetadataQueryOrderByFieldDirectionField; + readonly direction?: MetadataQueryOrderByDirectionField; } export interface MetadataQuery { readonly from: string; @@ -80,9 +80,9 @@ export interface FileRequestUpdateRequest { readonly isDescriptionRequired?: boolean; readonly expiresAt?: string; } -export type FileRequestCopyRequestFolderFieldTypeField = 'folder'; +export type FileRequestCopyRequestFolderTypeField = 'folder'; export interface FileRequestCopyRequestFolderField { - readonly type?: FileRequestCopyRequestFolderFieldTypeField; + readonly type?: FileRequestCopyRequestFolderTypeField; readonly id: string; } export type FileRequestCopyRequest = FileRequestUpdateRequest & { @@ -138,30 +138,29 @@ export type ClassificationTemplateTypeField = 'metadata_template'; export type ClassificationTemplateTemplateKeyField = 'securityClassification-6VMVochwUWo'; export type ClassificationTemplateDisplayNameField = 'Classification'; -export type ClassificationTemplateFieldsFieldTypeField = 'enum'; -export type ClassificationTemplateFieldsFieldKeyField = +export type ClassificationTemplateFieldsTypeField = 'enum'; +export type ClassificationTemplateFieldsKeyField = 'Box__Security__Classification__Key'; -export type ClassificationTemplateFieldsFieldDisplayNameField = - 'Classification'; -export interface ClassificationTemplateFieldsFieldOptionsFieldStaticConfigFieldClassificationField { +export type ClassificationTemplateFieldsDisplayNameField = 'Classification'; +export interface ClassificationTemplateFieldsOptionsStaticConfigClassificationField { readonly classificationDefinition?: string; readonly colorId?: number; } -export interface ClassificationTemplateFieldsFieldOptionsFieldStaticConfigField { - readonly classification?: ClassificationTemplateFieldsFieldOptionsFieldStaticConfigFieldClassificationField; +export interface ClassificationTemplateFieldsOptionsStaticConfigField { + readonly classification?: ClassificationTemplateFieldsOptionsStaticConfigClassificationField; } -export interface ClassificationTemplateFieldsFieldOptionsField { +export interface ClassificationTemplateFieldsOptionsField { readonly id: string; readonly key: string; - readonly staticConfig?: ClassificationTemplateFieldsFieldOptionsFieldStaticConfigField; + readonly staticConfig?: ClassificationTemplateFieldsOptionsStaticConfigField; } export interface ClassificationTemplateFieldsField { readonly id: string; - readonly type: ClassificationTemplateFieldsFieldTypeField; - readonly key: ClassificationTemplateFieldsFieldKeyField; - readonly displayName: ClassificationTemplateFieldsFieldDisplayNameField; + readonly type: ClassificationTemplateFieldsTypeField; + readonly key: ClassificationTemplateFieldsKeyField; + readonly displayName: ClassificationTemplateFieldsDisplayNameField; readonly hidden?: boolean; - readonly options: readonly ClassificationTemplateFieldsFieldOptionsField[]; + readonly options: readonly ClassificationTemplateFieldsOptionsField[]; } export interface ClassificationTemplate { readonly id: string; @@ -179,10 +178,10 @@ export type CollaborationAllowlistEntryDirectionField = | 'inbound' | 'outbound' | 'both'; -export type CollaborationAllowlistEntryEnterpriseFieldTypeField = 'enterprise'; +export type CollaborationAllowlistEntryEnterpriseTypeField = 'enterprise'; export interface CollaborationAllowlistEntryEnterpriseField { readonly id?: string; - readonly type?: CollaborationAllowlistEntryEnterpriseFieldTypeField; + readonly type?: CollaborationAllowlistEntryEnterpriseTypeField; readonly name?: string; } export interface CollaborationAllowlistEntry { @@ -208,10 +207,10 @@ export interface Collection { readonly name?: CollectionNameField; readonly collectionType?: CollectionCollectionTypeField; } -export type CollectionsOrderFieldDirectionField = 'ASC' | 'DESC'; +export type CollectionsOrderDirectionField = 'ASC' | 'DESC'; export interface CollectionsOrderField { readonly by?: string; - readonly direction?: CollectionsOrderFieldDirectionField; + readonly direction?: CollectionsOrderDirectionField; } export interface Collections { readonly totalCount?: number; @@ -356,10 +355,10 @@ export type GroupFull = Group & { readonly memberViewabilityLevel?: GroupFullMemberViewabilityLevelField; readonly permissions?: GroupFullPermissionsField; }; -export type GroupsOrderFieldDirectionField = 'ASC' | 'DESC'; +export type GroupsOrderDirectionField = 'ASC' | 'DESC'; export interface GroupsOrderField { readonly by?: string; - readonly direction?: GroupsOrderFieldDirectionField; + readonly direction?: GroupsOrderDirectionField; } export interface Groups { readonly totalCount?: number; @@ -400,14 +399,14 @@ export type MetadataFull = Metadata & { }; }; export type MetadataCascadePolicyTypeField = 'metadata_cascade_policy'; -export type MetadataCascadePolicyOwnerEnterpriseFieldTypeField = 'enterprise'; +export type MetadataCascadePolicyOwnerEnterpriseTypeField = 'enterprise'; export interface MetadataCascadePolicyOwnerEnterpriseField { - readonly type?: MetadataCascadePolicyOwnerEnterpriseFieldTypeField; + readonly type?: MetadataCascadePolicyOwnerEnterpriseTypeField; readonly id?: string; } -export type MetadataCascadePolicyParentFieldTypeField = 'folder'; +export type MetadataCascadePolicyParentTypeField = 'folder'; export interface MetadataCascadePolicyParentField { - readonly type?: MetadataCascadePolicyParentFieldTypeField; + readonly type?: MetadataCascadePolicyParentTypeField; readonly id?: string; } export interface MetadataCascadePolicy { @@ -425,10 +424,10 @@ export interface MetadataCascadePolicies { readonly entries?: readonly MetadataCascadePolicy[]; } export type MetadataQueryIndexStatusField = 'building' | 'active' | 'disabled'; -export type MetadataQueryIndexFieldsFieldSortDirectionField = 'asc' | 'desc'; +export type MetadataQueryIndexFieldsSortDirectionField = 'asc' | 'desc'; export interface MetadataQueryIndexFieldsField { readonly key?: string; - readonly sortDirection?: MetadataQueryIndexFieldsFieldSortDirectionField; + readonly sortDirection?: MetadataQueryIndexFieldsSortDirectionField; } export interface MetadataQueryIndex { readonly id?: string; @@ -442,24 +441,24 @@ export interface MetadataQueryIndices { readonly nextMarker?: string; } export type MetadataTemplateTypeField = 'metadata_template'; -export type MetadataTemplateFieldsFieldTypeField = +export type MetadataTemplateFieldsTypeField = | 'string' | 'float' | 'date' | 'enum' | 'multiSelect' | 'integer'; -export interface MetadataTemplateFieldsFieldOptionsField { +export interface MetadataTemplateFieldsOptionsField { readonly key: string; readonly id?: string; } export interface MetadataTemplateFieldsField { - readonly type: MetadataTemplateFieldsFieldTypeField; + readonly type: MetadataTemplateFieldsTypeField; readonly key: string; readonly displayName: string; readonly description?: string; readonly hidden?: boolean; - readonly options?: readonly MetadataTemplateFieldsFieldOptionsField[]; + readonly options?: readonly MetadataTemplateFieldsOptionsField[]; readonly id?: string; } export interface MetadataTemplate { @@ -551,17 +550,17 @@ export interface ShieldInformationBarrierSegmentRestrictionBase { readonly type?: ShieldInformationBarrierSegmentRestrictionBaseTypeField; readonly id?: string; } -export type ShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentFieldTypeField = +export type ShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentTypeField = 'shield_information_barrier_segment'; export interface ShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentField { readonly id?: string; - readonly type?: ShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentFieldTypeField; + readonly type?: ShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentTypeField; } -export type ShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentFieldTypeField = +export type ShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentTypeField = 'shield_information_barrier_segment'; export interface ShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentField { readonly id?: string; - readonly type?: ShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentFieldTypeField; + readonly type?: ShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentTypeField; } export type ShieldInformationBarrierSegmentRestrictionMini = ShieldInformationBarrierSegmentRestrictionBase & { @@ -605,10 +604,10 @@ export interface TermsOfServiceBase { readonly type?: TermsOfServiceBaseTypeField; } export type TermsOfServiceStatusField = 'enabled' | 'disabled'; -export type TermsOfServiceEnterpriseFieldTypeField = 'enterprise'; +export type TermsOfServiceEnterpriseTypeField = 'enterprise'; export interface TermsOfServiceEnterpriseField { readonly id?: string; - readonly type?: TermsOfServiceEnterpriseFieldTypeField; + readonly type?: TermsOfServiceEnterpriseTypeField; readonly name?: string; } export type TermsOfServiceTosTypeField = 'managed' | 'external'; @@ -632,10 +631,10 @@ export interface UploadPartMini { export type UploadPart = UploadPartMini & { readonly sha1?: string; }; -export type UploadPartsOrderFieldDirectionField = 'ASC' | 'DESC'; +export type UploadPartsOrderDirectionField = 'ASC' | 'DESC'; export interface UploadPartsOrderField { readonly by?: string; - readonly direction?: UploadPartsOrderFieldDirectionField; + readonly direction?: UploadPartsOrderDirectionField; } export interface UploadParts { readonly totalCount?: number; @@ -823,9 +822,9 @@ export interface TrashFileRestored { readonly itemStatus: TrashFileRestoredItemStatusField; } export type TrashWebLinkTypeField = 'web_link'; -export type TrashWebLinkPathCollectionFieldEntriesFieldTypeField = 'folder'; -export interface TrashWebLinkPathCollectionFieldEntriesField { - readonly type?: TrashWebLinkPathCollectionFieldEntriesFieldTypeField; +export type TrashWebLinkPathCollectionEntriesTypeField = 'folder'; +export interface TrashWebLinkPathCollectionEntriesField { + readonly type?: TrashWebLinkPathCollectionEntriesTypeField; readonly id?: string; readonly sequenceId?: string; readonly etag?: string; @@ -833,7 +832,7 @@ export interface TrashWebLinkPathCollectionFieldEntriesField { } export interface TrashWebLinkPathCollectionField { readonly totalCount: number; - readonly entries: readonly TrashWebLinkPathCollectionFieldEntriesField[]; + readonly entries: readonly TrashWebLinkPathCollectionEntriesField[]; } export type TrashWebLinkItemStatusField = 'active' | 'trashed' | 'deleted'; export interface TrashWebLink { @@ -857,9 +856,9 @@ export interface TrashWebLink { readonly itemStatus?: TrashWebLinkItemStatusField; } export type TrashFolderTypeField = 'folder'; -export type TrashFolderPathCollectionFieldEntriesFieldTypeField = 'folder'; -export interface TrashFolderPathCollectionFieldEntriesField { - readonly type?: TrashFolderPathCollectionFieldEntriesFieldTypeField; +export type TrashFolderPathCollectionEntriesTypeField = 'folder'; +export interface TrashFolderPathCollectionEntriesField { + readonly type?: TrashFolderPathCollectionEntriesTypeField; readonly id?: string; readonly sequenceId?: string; readonly etag?: string; @@ -867,7 +866,7 @@ export interface TrashFolderPathCollectionFieldEntriesField { } export interface TrashFolderPathCollectionField { readonly totalCount: number; - readonly entries: readonly TrashFolderPathCollectionFieldEntriesField[]; + readonly entries: readonly TrashFolderPathCollectionEntriesField[]; } export type TrashFolderItemStatusField = 'active' | 'trashed' | 'deleted'; export interface TrashFolder { @@ -894,9 +893,9 @@ export interface TrashFolder { readonly itemStatus: TrashFolderItemStatusField; } export type TrashFileTypeField = 'file'; -export type TrashFilePathCollectionFieldEntriesFieldTypeField = 'folder'; -export interface TrashFilePathCollectionFieldEntriesField { - readonly type?: TrashFilePathCollectionFieldEntriesFieldTypeField; +export type TrashFilePathCollectionEntriesTypeField = 'folder'; +export interface TrashFilePathCollectionEntriesField { + readonly type?: TrashFilePathCollectionEntriesTypeField; readonly id?: string; readonly sequenceId?: string; readonly etag?: string; @@ -904,7 +903,7 @@ export interface TrashFilePathCollectionFieldEntriesField { } export interface TrashFilePathCollectionField { readonly totalCount: number; - readonly entries: readonly TrashFilePathCollectionFieldEntriesField[]; + readonly entries: readonly TrashFilePathCollectionEntriesField[]; } export type TrashFileItemStatusField = 'active' | 'trashed' | 'deleted'; export interface TrashFile { @@ -988,13 +987,13 @@ export interface Tasks { readonly entries?: readonly Task[]; } export type RetentionPolicyAssignmentTypeField = 'retention_policy_assignment'; -export type RetentionPolicyAssignmentAssignedToFieldTypeField = +export type RetentionPolicyAssignmentAssignedToTypeField = | 'folder' | 'enterprise' | 'metadata_template'; export interface RetentionPolicyAssignmentAssignedToField { readonly id?: string; - readonly type?: RetentionPolicyAssignmentAssignedToFieldTypeField; + readonly type?: RetentionPolicyAssignmentAssignedToTypeField; } export interface RetentionPolicyAssignmentFilterFieldsField { readonly field?: string; @@ -1072,10 +1071,10 @@ export interface LegalHoldPolicies { readonly entries?: readonly LegalHoldPolicy[]; } export type InviteTypeField = 'invite'; -export type InviteInvitedToFieldTypeField = 'enterprise'; +export type InviteInvitedToTypeField = 'enterprise'; export interface InviteInvitedToField { readonly id?: string; - readonly type?: InviteInvitedToFieldTypeField; + readonly type?: InviteInvitedToTypeField; readonly name?: string; } export interface Invite { @@ -1099,10 +1098,10 @@ export interface GroupMembership { readonly createdAt?: string; readonly modifiedAt?: string; } -export type GroupMembershipsOrderFieldDirectionField = 'ASC' | 'DESC'; +export type GroupMembershipsOrderDirectionField = 'ASC' | 'DESC'; export interface GroupMembershipsOrderField { readonly by?: string; - readonly direction?: GroupMembershipsOrderFieldDirectionField; + readonly direction?: GroupMembershipsOrderDirectionField; } export interface GroupMemberships { readonly totalCount?: number; @@ -1127,10 +1126,10 @@ export type FileVersion = FileVersionMini & { export type FileVersionFull = FileVersion & { readonly versionNumber?: string; }; -export type FileVersionsOrderFieldDirectionField = 'ASC' | 'DESC'; +export type FileVersionsOrderDirectionField = 'ASC' | 'DESC'; export interface FileVersionsOrderField { readonly by?: string; - readonly direction?: FileVersionsOrderFieldDirectionField; + readonly direction?: FileVersionsOrderDirectionField; } export interface FileVersions { readonly totalCount?: number; @@ -1162,20 +1161,17 @@ export interface FilePathCollectionField { readonly totalCount: number; readonly entries: readonly FolderMini[]; } -export type FileSharedLinkFieldAccessField = +export type FileSharedLinkAccessField = 'open' | 'company' | 'collaborators'; +export type FileSharedLinkEffectiveAccessField = | 'open' | 'company' | 'collaborators'; -export type FileSharedLinkFieldEffectiveAccessField = - | 'open' - | 'company' - | 'collaborators'; -export type FileSharedLinkFieldEffectivePermissionField = +export type FileSharedLinkEffectivePermissionField = | 'can_edit' | 'can_download' | 'can_preview' | 'no_access'; -export interface FileSharedLinkFieldPermissionsField { +export interface FileSharedLinkPermissionsField { readonly canDownload: boolean; readonly canPreview: boolean; readonly canEdit: boolean; @@ -1185,12 +1181,12 @@ export interface FileSharedLinkField { readonly downloadUrl?: string; readonly vanityUrl?: string; readonly vanityName?: string; - readonly access?: FileSharedLinkFieldAccessField; - readonly effectiveAccess: FileSharedLinkFieldEffectiveAccessField; - readonly effectivePermission: FileSharedLinkFieldEffectivePermissionField; + readonly access?: FileSharedLinkAccessField; + readonly effectiveAccess: FileSharedLinkEffectiveAccessField; + readonly effectivePermission: FileSharedLinkEffectivePermissionField; readonly unsharedAt?: string; readonly isPasswordEnabled: boolean; - readonly permissions?: FileSharedLinkFieldPermissionsField; + readonly permissions?: FileSharedLinkPermissionsField; readonly downloadCount: number; readonly previewCount: number; } @@ -1226,26 +1222,26 @@ export interface FileFullPermissionsField { readonly canViewAnnotationsAll?: boolean; readonly canViewAnnotationsSelf?: boolean; } -export type FileFullLockFieldTypeField = 'lock'; -export type FileFullLockFieldAppTypeField = +export type FileFullLockTypeField = 'lock'; +export type FileFullLockAppTypeField = | 'gsuite' | 'office_wopi' | 'office_wopiplus' | 'other'; export interface FileFullLockField { readonly id?: string; - readonly type?: FileFullLockFieldTypeField; + readonly type?: FileFullLockTypeField; readonly createdBy?: UserMini; readonly createdAt?: string; readonly expiredAt?: string; readonly isDownloadPrevented?: boolean; - readonly appType?: FileFullLockFieldAppTypeField; + readonly appType?: FileFullLockAppTypeField; } -export type FileFullExpiringEmbedLinkFieldTokenTypeField = 'bearer'; +export type FileFullExpiringEmbedLinkTokenTypeField = 'bearer'; export interface FileFullExpiringEmbedLinkField { readonly accessToken?: string; readonly expiresIn?: number; - readonly tokenType?: FileFullExpiringEmbedLinkFieldTokenTypeField; + readonly tokenType?: FileFullExpiringEmbedLinkTokenTypeField; readonly restrictedTo?: readonly FileScope[]; readonly url?: string; } @@ -1267,34 +1263,34 @@ export interface FileFullMetadataField { }; }; } -export interface FileFullRepresentationsFieldEntriesFieldContentField { +export interface FileFullRepresentationsEntriesContentField { readonly urlTemplate?: string; } -export interface FileFullRepresentationsFieldEntriesFieldInfoField { +export interface FileFullRepresentationsEntriesInfoField { readonly url?: string; } -export interface FileFullRepresentationsFieldEntriesFieldPropertiesField { +export interface FileFullRepresentationsEntriesPropertiesField { readonly dimensions?: string; readonly paged?: boolean; readonly thumb?: boolean; } -export type FileFullRepresentationsFieldEntriesFieldStatusFieldStateField = +export type FileFullRepresentationsEntriesStatusStateField = | 'success' | 'viewable' | 'pending' | 'none'; -export interface FileFullRepresentationsFieldEntriesFieldStatusField { - readonly state?: FileFullRepresentationsFieldEntriesFieldStatusFieldStateField; +export interface FileFullRepresentationsEntriesStatusField { + readonly state?: FileFullRepresentationsEntriesStatusStateField; } -export interface FileFullRepresentationsFieldEntriesField { - readonly content?: FileFullRepresentationsFieldEntriesFieldContentField; - readonly info?: FileFullRepresentationsFieldEntriesFieldInfoField; - readonly properties?: FileFullRepresentationsFieldEntriesFieldPropertiesField; +export interface FileFullRepresentationsEntriesField { + readonly content?: FileFullRepresentationsEntriesContentField; + readonly info?: FileFullRepresentationsEntriesInfoField; + readonly properties?: FileFullRepresentationsEntriesPropertiesField; readonly representation?: string; - readonly status?: FileFullRepresentationsFieldEntriesFieldStatusField; + readonly status?: FileFullRepresentationsEntriesStatusField; } export interface FileFullRepresentationsField { - readonly entries?: readonly FileFullRepresentationsFieldEntriesField[]; + readonly entries?: readonly FileFullRepresentationsEntriesField[]; } export interface FileFullClassificationField { readonly name?: string; @@ -1338,11 +1334,11 @@ export interface DevicePinner { readonly ownedBy?: UserMini; readonly productName?: string; } -export type DevicePinnersOrderFieldByField = 'id'; -export type DevicePinnersOrderFieldDirectionField = 'asc' | 'desc'; +export type DevicePinnersOrderByField = 'id'; +export type DevicePinnersOrderDirectionField = 'asc' | 'desc'; export interface DevicePinnersOrderField { - readonly by?: DevicePinnersOrderFieldByField; - readonly direction?: DevicePinnersOrderFieldDirectionField; + readonly by?: DevicePinnersOrderByField; + readonly direction?: DevicePinnersOrderDirectionField; } export interface DevicePinners { readonly entries?: readonly DevicePinner[]; @@ -1365,10 +1361,10 @@ export type Comment = CommentBase & { export type CommentFull = Comment & { readonly taggedMessage?: string; }; -export type CommentsOrderFieldDirectionField = 'ASC' | 'DESC'; +export type CommentsOrderDirectionField = 'ASC' | 'DESC'; export interface CommentsOrderField { readonly by?: string; - readonly direction?: CommentsOrderFieldDirectionField; + readonly direction?: CommentsOrderDirectionField; } export interface Comments { readonly totalCount?: number; @@ -1379,11 +1375,11 @@ export interface Comments { } export type CollaborationAllowlistExemptTargetTypeField = 'collaboration_whitelist_exempt_target'; -export type CollaborationAllowlistExemptTargetEnterpriseFieldTypeField = +export type CollaborationAllowlistExemptTargetEnterpriseTypeField = 'enterprise'; export interface CollaborationAllowlistExemptTargetEnterpriseField { readonly id?: string; - readonly type?: CollaborationAllowlistExemptTargetEnterpriseFieldTypeField; + readonly type?: CollaborationAllowlistExemptTargetEnterpriseTypeField; readonly name?: string; } export interface CollaborationAllowlistExemptTarget { @@ -1417,11 +1413,11 @@ export type ShieldInformationBarrierSegmentMemberMini = ShieldInformationBarrierSegmentMemberBase & { readonly user?: UserBase; }; -export type ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentFieldTypeField = +export type ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentTypeField = 'shield_information_barrier_segment'; export interface ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentField { readonly id?: string; - readonly type?: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentFieldTypeField; + readonly type?: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentTypeField; } export type ShieldInformationBarrierSegmentMember = ShieldInformationBarrierSegmentMemberMini & { @@ -1505,10 +1501,10 @@ export interface Watermark { readonly watermark?: WatermarkWatermarkField; } export type WebhookMiniTypeField = 'webhook'; -export type WebhookMiniTargetFieldTypeField = 'file' | 'folder'; +export type WebhookMiniTargetTypeField = 'file' | 'folder'; export interface WebhookMiniTargetField { readonly id?: string; - readonly type?: WebhookMiniTargetFieldTypeField; + readonly type?: WebhookMiniTargetTypeField; } export interface WebhookMini { readonly id?: string; @@ -1583,20 +1579,17 @@ export interface WebLinkPathCollectionField { readonly totalCount: number; readonly entries: readonly FolderMini[]; } -export type WebLinkSharedLinkFieldAccessField = +export type WebLinkSharedLinkAccessField = 'open' | 'company' | 'collaborators'; +export type WebLinkSharedLinkEffectiveAccessField = | 'open' | 'company' | 'collaborators'; -export type WebLinkSharedLinkFieldEffectiveAccessField = - | 'open' - | 'company' - | 'collaborators'; -export type WebLinkSharedLinkFieldEffectivePermissionField = +export type WebLinkSharedLinkEffectivePermissionField = | 'can_edit' | 'can_download' | 'can_preview' | 'no_access'; -export interface WebLinkSharedLinkFieldPermissionsField { +export interface WebLinkSharedLinkPermissionsField { readonly canDownload: boolean; readonly canPreview: boolean; readonly canEdit: boolean; @@ -1606,12 +1599,12 @@ export interface WebLinkSharedLinkField { readonly downloadUrl?: string; readonly vanityUrl?: string; readonly vanityName?: string; - readonly access?: WebLinkSharedLinkFieldAccessField; - readonly effectiveAccess: WebLinkSharedLinkFieldEffectiveAccessField; - readonly effectivePermission: WebLinkSharedLinkFieldEffectivePermissionField; + readonly access?: WebLinkSharedLinkAccessField; + readonly effectiveAccess: WebLinkSharedLinkEffectiveAccessField; + readonly effectivePermission: WebLinkSharedLinkEffectivePermissionField; readonly unsharedAt?: string; readonly isPasswordEnabled: boolean; - readonly permissions?: WebLinkSharedLinkFieldPermissionsField; + readonly permissions?: WebLinkSharedLinkPermissionsField; readonly downloadCount: number; readonly previewCount: number; } @@ -1631,10 +1624,10 @@ export type WebLink = WebLinkMini & { readonly itemStatus?: WebLinkItemStatusField; }; export type FileFullOrFolderMiniOrWebLink = FileFull | FolderMini | WebLink; -export type ItemsOrderFieldDirectionField = 'ASC' | 'DESC'; +export type ItemsOrderDirectionField = 'ASC' | 'DESC'; export interface ItemsOrderField { readonly by?: string; - readonly direction?: ItemsOrderFieldDirectionField; + readonly direction?: ItemsOrderDirectionField; } export interface Items { readonly totalCount?: number; @@ -1647,20 +1640,17 @@ export interface FolderPathCollectionField { readonly totalCount: number; readonly entries: readonly FolderMini[]; } -export type FolderSharedLinkFieldAccessField = - | 'open' - | 'company' - | 'collaborators'; -export type FolderSharedLinkFieldEffectiveAccessField = +export type FolderSharedLinkAccessField = 'open' | 'company' | 'collaborators'; +export type FolderSharedLinkEffectiveAccessField = | 'open' | 'company' | 'collaborators'; -export type FolderSharedLinkFieldEffectivePermissionField = +export type FolderSharedLinkEffectivePermissionField = | 'can_edit' | 'can_download' | 'can_preview' | 'no_access'; -export interface FolderSharedLinkFieldPermissionsField { +export interface FolderSharedLinkPermissionsField { readonly canDownload: boolean; readonly canPreview: boolean; readonly canEdit: boolean; @@ -1670,18 +1660,18 @@ export interface FolderSharedLinkField { readonly downloadUrl?: string; readonly vanityUrl?: string; readonly vanityName?: string; - readonly access?: FolderSharedLinkFieldAccessField; - readonly effectiveAccess: FolderSharedLinkFieldEffectiveAccessField; - readonly effectivePermission: FolderSharedLinkFieldEffectivePermissionField; + readonly access?: FolderSharedLinkAccessField; + readonly effectiveAccess: FolderSharedLinkEffectiveAccessField; + readonly effectivePermission: FolderSharedLinkEffectivePermissionField; readonly unsharedAt?: string; readonly isPasswordEnabled: boolean; - readonly permissions?: FolderSharedLinkFieldPermissionsField; + readonly permissions?: FolderSharedLinkPermissionsField; readonly downloadCount: number; readonly previewCount: number; } -export type FolderFolderUploadEmailFieldAccessField = 'open' | 'collaborators'; +export type FolderFolderUploadEmailAccessField = 'open' | 'collaborators'; export interface FolderFolderUploadEmailField { - readonly access?: FolderFolderUploadEmailFieldAccessField; + readonly access?: FolderFolderUploadEmailAccessField; readonly email?: string; } export type FolderItemStatusField = 'active' | 'trashed' | 'deleted'; @@ -1900,22 +1890,22 @@ export type CollaborationRoleField = | 'co-owner' | 'owner'; export type CollaborationStatusField = 'accepted' | 'pending' | 'rejected'; -export interface CollaborationAcceptanceRequirementsStatusFieldTermsOfServiceRequirementField { +export interface CollaborationAcceptanceRequirementsStatusTermsOfServiceRequirementField { readonly isAccepted?: boolean; readonly termsOfService?: TermsOfServiceBase; } -export interface CollaborationAcceptanceRequirementsStatusFieldStrongPasswordRequirementField { +export interface CollaborationAcceptanceRequirementsStatusStrongPasswordRequirementField { readonly enterpriseHasStrongPasswordRequiredForExternalUsers?: boolean; readonly userHasStrongPassword?: boolean; } -export interface CollaborationAcceptanceRequirementsStatusFieldTwoFactorAuthenticationRequirementField { +export interface CollaborationAcceptanceRequirementsStatusTwoFactorAuthenticationRequirementField { readonly enterpriseHasTwoFactorAuthEnabled?: boolean; readonly userHasTwoFactorAuthenticationEnabled?: boolean; } export interface CollaborationAcceptanceRequirementsStatusField { - readonly termsOfServiceRequirement?: CollaborationAcceptanceRequirementsStatusFieldTermsOfServiceRequirementField; - readonly strongPasswordRequirement?: CollaborationAcceptanceRequirementsStatusFieldStrongPasswordRequirementField; - readonly twoFactorAuthenticationRequirement?: CollaborationAcceptanceRequirementsStatusFieldTwoFactorAuthenticationRequirementField; + readonly termsOfServiceRequirement?: CollaborationAcceptanceRequirementsStatusTermsOfServiceRequirementField; + readonly strongPasswordRequirement?: CollaborationAcceptanceRequirementsStatusStrongPasswordRequirementField; + readonly twoFactorAuthenticationRequirement?: CollaborationAcceptanceRequirementsStatusTwoFactorAuthenticationRequirementField; } export interface Collaboration { readonly id: string; @@ -1933,10 +1923,10 @@ export interface Collaboration { readonly modifiedAt?: string; readonly acceptanceRequirementsStatus?: CollaborationAcceptanceRequirementsStatusField; } -export type CollaborationsOrderFieldDirectionField = 'ASC' | 'DESC'; +export type CollaborationsOrderDirectionField = 'ASC' | 'DESC'; export interface CollaborationsOrderField { readonly by?: string; - readonly direction?: CollaborationsOrderFieldDirectionField; + readonly direction?: CollaborationsOrderDirectionField; } export interface Collaborations { readonly totalCount?: number; @@ -2003,47 +1993,47 @@ export interface WebhookInvocation { readonly source?: FileOrFolder; } export type SkillInvocationTypeField = 'skill_invocation'; -export type SkillInvocationSkillFieldTypeField = 'skill'; +export type SkillInvocationSkillTypeField = 'skill'; export interface SkillInvocationSkillField { readonly id?: string; - readonly type?: SkillInvocationSkillFieldTypeField; + readonly type?: SkillInvocationSkillTypeField; readonly name?: string; readonly apiKey?: string; } -export type SkillInvocationTokenFieldReadFieldTokenTypeField = 'bearer'; -export interface SkillInvocationTokenFieldReadField { +export type SkillInvocationTokenReadTokenTypeField = 'bearer'; +export interface SkillInvocationTokenReadField { readonly accessToken?: string; readonly expiresIn?: number; - readonly tokenType?: SkillInvocationTokenFieldReadFieldTokenTypeField; + readonly tokenType?: SkillInvocationTokenReadTokenTypeField; readonly restrictedTo?: string; } -export type SkillInvocationTokenFieldWriteFieldTokenTypeField = 'bearer'; -export interface SkillInvocationTokenFieldWriteField { +export type SkillInvocationTokenWriteTokenTypeField = 'bearer'; +export interface SkillInvocationTokenWriteField { readonly accessToken?: string; readonly expiresIn?: number; - readonly tokenType?: SkillInvocationTokenFieldWriteFieldTokenTypeField; + readonly tokenType?: SkillInvocationTokenWriteTokenTypeField; readonly restrictedTo?: string; } export interface SkillInvocationTokenField { - readonly read?: SkillInvocationTokenFieldReadField; - readonly write?: SkillInvocationTokenFieldWriteField; + readonly read?: SkillInvocationTokenReadField; + readonly write?: SkillInvocationTokenWriteField; } -export type SkillInvocationStatusFieldStateField = +export type SkillInvocationStatusStateField = | 'invoked' | 'processing' | 'success' | 'transient_failure' | 'permanent_failure'; export interface SkillInvocationStatusField { - readonly state?: SkillInvocationStatusFieldStateField; + readonly state?: SkillInvocationStatusStateField; readonly message?: string; readonly errorCode?: string; readonly additionalInfo?: string; } -export type SkillInvocationEnterpriseFieldTypeField = 'enterprise'; +export type SkillInvocationEnterpriseTypeField = 'enterprise'; export interface SkillInvocationEnterpriseField { readonly id?: string; - readonly type?: SkillInvocationEnterpriseFieldTypeField; + readonly type?: SkillInvocationEnterpriseTypeField; readonly name?: string; } export interface SkillInvocation { @@ -2167,29 +2157,27 @@ export interface WorkflowMini { readonly description?: string; readonly isEnabled?: boolean; } -export type WorkflowFlowsFieldTypeField = 'flow'; -export type WorkflowFlowsFieldTriggerFieldTypeField = 'trigger'; -export type WorkflowFlowsFieldTriggerFieldTriggerTypeField = - 'WORKFLOW_MANUAL_START'; -export type WorkflowFlowsFieldTriggerFieldScopeFieldTypeField = 'trigger_scope'; -export type WorkflowFlowsFieldTriggerFieldScopeFieldObjectFieldTypeField = - 'folder'; -export interface WorkflowFlowsFieldTriggerFieldScopeFieldObjectField { - readonly type?: WorkflowFlowsFieldTriggerFieldScopeFieldObjectFieldTypeField; +export type WorkflowFlowsTypeField = 'flow'; +export type WorkflowFlowsTriggerTypeField = 'trigger'; +export type WorkflowFlowsTriggerTriggerTypeField = 'WORKFLOW_MANUAL_START'; +export type WorkflowFlowsTriggerScopeTypeField = 'trigger_scope'; +export type WorkflowFlowsTriggerScopeObjectTypeField = 'folder'; +export interface WorkflowFlowsTriggerScopeObjectField { + readonly type?: WorkflowFlowsTriggerScopeObjectTypeField; readonly id?: string; } -export interface WorkflowFlowsFieldTriggerFieldScopeField { - readonly type?: WorkflowFlowsFieldTriggerFieldScopeFieldTypeField; +export interface WorkflowFlowsTriggerScopeField { + readonly type?: WorkflowFlowsTriggerScopeTypeField; readonly ref?: string; - readonly object?: WorkflowFlowsFieldTriggerFieldScopeFieldObjectField; + readonly object?: WorkflowFlowsTriggerScopeObjectField; } -export interface WorkflowFlowsFieldTriggerField { - readonly type?: WorkflowFlowsFieldTriggerFieldTypeField; - readonly triggerType?: WorkflowFlowsFieldTriggerFieldTriggerTypeField; - readonly scope?: readonly WorkflowFlowsFieldTriggerFieldScopeField[]; +export interface WorkflowFlowsTriggerField { + readonly type?: WorkflowFlowsTriggerTypeField; + readonly triggerType?: WorkflowFlowsTriggerTriggerTypeField; + readonly scope?: readonly WorkflowFlowsTriggerScopeField[]; } -export type WorkflowFlowsFieldOutcomesFieldTypeField = 'outcome'; -export type WorkflowFlowsFieldOutcomesFieldActionTypeField = +export type WorkflowFlowsOutcomesTypeField = 'outcome'; +export type WorkflowFlowsOutcomesActionTypeField = | 'add_metadata' | 'assign_task' | 'copy_file' @@ -2213,8 +2201,8 @@ export type WorkflowFlowsFieldOutcomesFieldActionTypeField = | 'apply_file_classification' | 'apply_folder_classification' | 'send_notification'; -export type WorkflowFlowsFieldOutcomesFieldIfRejectedFieldTypeField = 'outcome'; -export type WorkflowFlowsFieldOutcomesFieldIfRejectedFieldActionTypeField = +export type WorkflowFlowsOutcomesIfRejectedTypeField = 'outcome'; +export type WorkflowFlowsOutcomesIfRejectedActionTypeField = | 'add_metadata' | 'assign_task' | 'copy_file' @@ -2238,24 +2226,24 @@ export type WorkflowFlowsFieldOutcomesFieldIfRejectedFieldActionTypeField = | 'apply_file_classification' | 'apply_folder_classification' | 'send_notification'; -export interface WorkflowFlowsFieldOutcomesFieldIfRejectedField { +export interface WorkflowFlowsOutcomesIfRejectedField { readonly id?: string; - readonly type?: WorkflowFlowsFieldOutcomesFieldIfRejectedFieldTypeField; + readonly type?: WorkflowFlowsOutcomesIfRejectedTypeField; readonly name?: string; - readonly actionType?: WorkflowFlowsFieldOutcomesFieldIfRejectedFieldActionTypeField; + readonly actionType?: WorkflowFlowsOutcomesIfRejectedActionTypeField; } -export interface WorkflowFlowsFieldOutcomesField { +export interface WorkflowFlowsOutcomesField { readonly id?: string; - readonly type?: WorkflowFlowsFieldOutcomesFieldTypeField; + readonly type?: WorkflowFlowsOutcomesTypeField; readonly name?: string; - readonly actionType?: WorkflowFlowsFieldOutcomesFieldActionTypeField; - readonly ifRejected?: readonly WorkflowFlowsFieldOutcomesFieldIfRejectedField[]; + readonly actionType?: WorkflowFlowsOutcomesActionTypeField; + readonly ifRejected?: readonly WorkflowFlowsOutcomesIfRejectedField[]; } export interface WorkflowFlowsField { readonly id?: string; - readonly type?: WorkflowFlowsFieldTypeField; - readonly trigger?: WorkflowFlowsFieldTriggerField; - readonly outcomes?: readonly WorkflowFlowsFieldOutcomesField[]; + readonly type?: WorkflowFlowsTypeField; + readonly trigger?: WorkflowFlowsTriggerField; + readonly outcomes?: readonly WorkflowFlowsOutcomesField[]; readonly createdAt?: string; readonly createdBy?: UserBase; } @@ -2274,10 +2262,10 @@ export type WorkflowFull = Workflow & { readonly createdBy?: UserBase; readonly modifiedBy?: UserBase; }; -export type ZipDownloadNameConflictsFieldTypeField = 'file' | 'folder'; +export type ZipDownloadNameConflictsTypeField = 'file' | 'folder'; export interface ZipDownloadNameConflictsField { readonly id?: string; - readonly type?: ZipDownloadNameConflictsFieldTypeField; + readonly type?: ZipDownloadNameConflictsTypeField; readonly originalName?: string; readonly downloadName?: string; } @@ -2304,14 +2292,14 @@ export interface KeywordSkillCardSkillCardTitleField { readonly code?: string; readonly message: string; } -export type KeywordSkillCardSkillFieldTypeField = 'service'; +export type KeywordSkillCardSkillTypeField = 'service'; export interface KeywordSkillCardSkillField { - readonly type: KeywordSkillCardSkillFieldTypeField; + readonly type: KeywordSkillCardSkillTypeField; readonly id: string; } -export type KeywordSkillCardInvocationFieldTypeField = 'skill_invocation'; +export type KeywordSkillCardInvocationTypeField = 'skill_invocation'; export interface KeywordSkillCardInvocationField { - readonly type: KeywordSkillCardInvocationFieldTypeField; + readonly type: KeywordSkillCardInvocationTypeField; readonly id: string; } export interface KeywordSkillCardEntriesField { @@ -2369,23 +2357,23 @@ export interface TimelineSkillCardSkillCardTitleField { readonly code?: string; readonly message: string; } -export type TimelineSkillCardSkillFieldTypeField = 'service'; +export type TimelineSkillCardSkillTypeField = 'service'; export interface TimelineSkillCardSkillField { - readonly type: TimelineSkillCardSkillFieldTypeField; + readonly type: TimelineSkillCardSkillTypeField; readonly id: string; } -export type TimelineSkillCardInvocationFieldTypeField = 'skill_invocation'; +export type TimelineSkillCardInvocationTypeField = 'skill_invocation'; export interface TimelineSkillCardInvocationField { - readonly type: TimelineSkillCardInvocationFieldTypeField; + readonly type: TimelineSkillCardInvocationTypeField; readonly id: string; } -export interface TimelineSkillCardEntriesFieldAppearsField { +export interface TimelineSkillCardEntriesAppearsField { readonly start?: number; readonly end?: number; } export interface TimelineSkillCardEntriesField { readonly text?: string; - readonly appears?: readonly TimelineSkillCardEntriesFieldAppearsField[]; + readonly appears?: readonly TimelineSkillCardEntriesAppearsField[]; readonly imageUrl?: string; } export interface TimelineSkillCard { @@ -2404,22 +2392,22 @@ export interface TranscriptSkillCardSkillCardTitleField { readonly code?: string; readonly message: string; } -export type TranscriptSkillCardSkillFieldTypeField = 'service'; +export type TranscriptSkillCardSkillTypeField = 'service'; export interface TranscriptSkillCardSkillField { - readonly type: TranscriptSkillCardSkillFieldTypeField; + readonly type: TranscriptSkillCardSkillTypeField; readonly id: string; } -export type TranscriptSkillCardInvocationFieldTypeField = 'skill_invocation'; +export type TranscriptSkillCardInvocationTypeField = 'skill_invocation'; export interface TranscriptSkillCardInvocationField { - readonly type: TranscriptSkillCardInvocationFieldTypeField; + readonly type: TranscriptSkillCardInvocationTypeField; readonly id: string; } -export interface TranscriptSkillCardEntriesFieldAppearsField { +export interface TranscriptSkillCardEntriesAppearsField { readonly start?: number; } export interface TranscriptSkillCardEntriesField { readonly text?: string; - readonly appears?: readonly TranscriptSkillCardEntriesFieldAppearsField[]; + readonly appears?: readonly TranscriptSkillCardEntriesAppearsField[]; } export interface TranscriptSkillCard { readonly createdAt?: string; @@ -2437,24 +2425,24 @@ export interface StatusSkillCardSkillCardTitleField { readonly code?: string; readonly message: string; } -export type StatusSkillCardStatusFieldCodeField = +export type StatusSkillCardStatusCodeField = | 'invoked' | 'processing' | 'success' | 'transient_failure' | 'permanent_failure'; export interface StatusSkillCardStatusField { - readonly code: StatusSkillCardStatusFieldCodeField; + readonly code: StatusSkillCardStatusCodeField; readonly message?: string; } -export type StatusSkillCardSkillFieldTypeField = 'service'; +export type StatusSkillCardSkillTypeField = 'service'; export interface StatusSkillCardSkillField { - readonly type: StatusSkillCardSkillFieldTypeField; + readonly type: StatusSkillCardSkillTypeField; readonly id: string; } -export type StatusSkillCardInvocationFieldTypeField = 'skill_invocation'; +export type StatusSkillCardInvocationTypeField = 'skill_invocation'; export interface StatusSkillCardInvocationField { - readonly type: StatusSkillCardInvocationFieldTypeField; + readonly type: StatusSkillCardInvocationTypeField; readonly id: string; } export interface StatusSkillCard { @@ -2529,11 +2517,9 @@ export type SignRequestSignerInput = SignRequestPrefillTag & { readonly contentType?: SignRequestSignerInputContentTypeField; readonly pageIndex: number; }; -export type SignRequestSignerSignerDecisionFieldTypeField = - | 'signed' - | 'declined'; +export type SignRequestSignerSignerDecisionTypeField = 'signed' | 'declined'; export interface SignRequestSignerSignerDecisionField { - readonly type?: SignRequestSignerSignerDecisionFieldTypeField; + readonly type?: SignRequestSignerSignerDecisionTypeField; readonly finalizedAt?: string; readonly additionalInfo?: string; } @@ -2660,20 +2646,20 @@ export interface TemplateSigner { readonly order?: number; } export type SignTemplateTypeField = 'sign-template'; -export type SignTemplateAdditionalInfoFieldNonEditableField = +export type SignTemplateAdditionalInfoNonEditableField = | 'email_subject' | 'email_message' | 'name' | 'days_valid' | 'signers' | 'source_files'; -export type SignTemplateAdditionalInfoFieldRequiredFieldSignersField = 'email'; -export interface SignTemplateAdditionalInfoFieldRequiredField { - readonly signers?: readonly (readonly SignTemplateAdditionalInfoFieldRequiredFieldSignersField[])[]; +export type SignTemplateAdditionalInfoRequiredSignersField = 'email'; +export interface SignTemplateAdditionalInfoRequiredField { + readonly signers?: readonly (readonly SignTemplateAdditionalInfoRequiredSignersField[])[]; } export interface SignTemplateAdditionalInfoField { - readonly nonEditable?: readonly SignTemplateAdditionalInfoFieldNonEditableField[]; - readonly required?: SignTemplateAdditionalInfoFieldRequiredField; + readonly nonEditable?: readonly SignTemplateAdditionalInfoNonEditableField[]; + readonly required?: SignTemplateAdditionalInfoRequiredField; } export interface SignTemplateReadySignLinkField { readonly url?: string; @@ -2746,10 +2732,10 @@ export interface TrackingCode { readonly value?: string; } export type UserFullRoleField = 'admin' | 'coadmin' | 'user'; -export type UserFullEnterpriseFieldTypeField = 'enterprise'; +export type UserFullEnterpriseTypeField = 'enterprise'; export interface UserFullEnterpriseField { readonly id?: string; - readonly type?: UserFullEnterpriseFieldTypeField; + readonly type?: UserFullEnterpriseTypeField; readonly name?: string; } export type UserFull = User & { @@ -2766,10 +2752,10 @@ export type UserFull = User & { readonly isPlatformAccessOnly?: boolean; readonly externalAppUserId?: string; }; -export type UsersOrderFieldDirectionField = 'ASC' | 'DESC'; +export type UsersOrderDirectionField = 'ASC' | 'DESC'; export interface UsersOrderField { readonly by?: string; - readonly direction?: UsersOrderFieldDirectionField; + readonly direction?: UsersOrderDirectionField; } export interface Users { readonly totalCount?: number; @@ -2787,19 +2773,19 @@ export type MetadataFieldFilterFloat = { export type MetadataFieldFilterMultiSelect = { readonly [key: string]: readonly string[]; }; -export interface MetadataFieldFilterFloatRangeMapValue { +export interface MetadataFieldFilterFloatRangeValue { readonly lt?: number; readonly gt?: number; } export type MetadataFieldFilterFloatRange = { - readonly [key: string]: MetadataFieldFilterFloatRangeMapValue; + readonly [key: string]: MetadataFieldFilterFloatRangeValue; }; -export interface MetadataFieldFilterDateRangeMapValue { +export interface MetadataFieldFilterDateRangeValue { readonly lt?: string; readonly gt?: string; } export type MetadataFieldFilterDateRange = { - readonly [key: string]: MetadataFieldFilterDateRangeMapValue; + readonly [key: string]: MetadataFieldFilterDateRangeValue; }; export type MetadataFilterScopeField = | 'global' @@ -3041,16 +3027,16 @@ export function deserializePostOAuth2Revoke(val: any): PostOAuth2Revoke { token: token, } satisfies PostOAuth2Revoke; } -export function serializeZipDownloadRequestItemsFieldTypeField( - val: ZipDownloadRequestItemsFieldTypeField +export function serializeZipDownloadRequestItemsTypeField( + val: ZipDownloadRequestItemsTypeField ): SerializedData { return val; } -export function deserializeZipDownloadRequestItemsFieldTypeField( +export function deserializeZipDownloadRequestItemsTypeField( val: any -): ZipDownloadRequestItemsFieldTypeField { +): ZipDownloadRequestItemsTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "ZipDownloadRequestItemsFieldTypeField"'; + throw 'Expecting a string for "ZipDownloadRequestItemsTypeField"'; } if (val == 'file') { return 'file'; @@ -3064,15 +3050,15 @@ export function serializeZipDownloadRequestItemsField( val: ZipDownloadRequestItemsField ): SerializedData { return { - ['type']: serializeZipDownloadRequestItemsFieldTypeField(val.type), + ['type']: serializeZipDownloadRequestItemsTypeField(val.type), ['id']: val.id, }; } export function deserializeZipDownloadRequestItemsField( val: any ): ZipDownloadRequestItemsField { - const type: ZipDownloadRequestItemsFieldTypeField = - deserializeZipDownloadRequestItemsFieldTypeField(val.type); + const type: ZipDownloadRequestItemsTypeField = + deserializeZipDownloadRequestItemsTypeField(val.type); const id: string = val.id; return { type: type, id: id } satisfies ZipDownloadRequestItemsField; } @@ -3102,16 +3088,16 @@ export function deserializeZipDownloadRequest(val: any): ZipDownloadRequest { downloadFileName: downloadFileName, } satisfies ZipDownloadRequest; } -export function serializeMetadataQueryOrderByFieldDirectionField( - val: MetadataQueryOrderByFieldDirectionField +export function serializeMetadataQueryOrderByDirectionField( + val: MetadataQueryOrderByDirectionField ): SerializedData { return val; } -export function deserializeMetadataQueryOrderByFieldDirectionField( +export function deserializeMetadataQueryOrderByDirectionField( val: any -): MetadataQueryOrderByFieldDirectionField { +): MetadataQueryOrderByDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "MetadataQueryOrderByFieldDirectionField"'; + throw 'Expecting a string for "MetadataQueryOrderByDirectionField"'; } if (val == 'ASC') { return 'ASC'; @@ -3129,7 +3115,7 @@ export function serializeMetadataQueryOrderByField( ['direction']: val.direction == void 0 ? void 0 - : serializeMetadataQueryOrderByFieldDirectionField(val.direction), + : serializeMetadataQueryOrderByDirectionField(val.direction), }; } export function deserializeMetadataQueryOrderByField( @@ -3137,10 +3123,10 @@ export function deserializeMetadataQueryOrderByField( ): MetadataQueryOrderByField { const fieldKey: undefined | string = val.field_key == void 0 ? void 0 : val.field_key; - const direction: undefined | MetadataQueryOrderByFieldDirectionField = + const direction: undefined | MetadataQueryOrderByDirectionField = val.direction == void 0 ? void 0 - : deserializeMetadataQueryOrderByFieldDirectionField(val.direction); + : deserializeMetadataQueryOrderByDirectionField(val.direction); return { fieldKey: fieldKey, direction: direction, @@ -3269,16 +3255,16 @@ export function deserializeFileRequestUpdateRequest( expiresAt: expiresAt, } satisfies FileRequestUpdateRequest; } -export function serializeFileRequestCopyRequestFolderFieldTypeField( - val: FileRequestCopyRequestFolderFieldTypeField +export function serializeFileRequestCopyRequestFolderTypeField( + val: FileRequestCopyRequestFolderTypeField ): SerializedData { return val; } -export function deserializeFileRequestCopyRequestFolderFieldTypeField( +export function deserializeFileRequestCopyRequestFolderTypeField( val: any -): FileRequestCopyRequestFolderFieldTypeField { +): FileRequestCopyRequestFolderTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "FileRequestCopyRequestFolderFieldTypeField"'; + throw 'Expecting a string for "FileRequestCopyRequestFolderTypeField"'; } if (val == 'folder') { return 'folder'; @@ -3292,17 +3278,17 @@ export function serializeFileRequestCopyRequestFolderField( ['type']: val.type == void 0 ? void 0 - : serializeFileRequestCopyRequestFolderFieldTypeField(val.type), + : serializeFileRequestCopyRequestFolderTypeField(val.type), ['id']: val.id, }; } export function deserializeFileRequestCopyRequestFolderField( val: any ): FileRequestCopyRequestFolderField { - const type: undefined | FileRequestCopyRequestFolderFieldTypeField = + const type: undefined | FileRequestCopyRequestFolderTypeField = val.type == void 0 ? void 0 - : deserializeFileRequestCopyRequestFolderFieldTypeField(val.type); + : deserializeFileRequestCopyRequestFolderTypeField(val.type); const id: string = val.id; return { type: type, id: id } satisfies FileRequestCopyRequestFolderField; } @@ -3610,56 +3596,56 @@ export function deserializeClassificationTemplateDisplayNameField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeClassificationTemplateFieldsFieldTypeField( - val: ClassificationTemplateFieldsFieldTypeField +export function serializeClassificationTemplateFieldsTypeField( + val: ClassificationTemplateFieldsTypeField ): SerializedData { return val; } -export function deserializeClassificationTemplateFieldsFieldTypeField( +export function deserializeClassificationTemplateFieldsTypeField( val: any -): ClassificationTemplateFieldsFieldTypeField { +): ClassificationTemplateFieldsTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "ClassificationTemplateFieldsFieldTypeField"'; + throw 'Expecting a string for "ClassificationTemplateFieldsTypeField"'; } if (val == 'enum') { return 'enum'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeClassificationTemplateFieldsFieldKeyField( - val: ClassificationTemplateFieldsFieldKeyField +export function serializeClassificationTemplateFieldsKeyField( + val: ClassificationTemplateFieldsKeyField ): SerializedData { return val; } -export function deserializeClassificationTemplateFieldsFieldKeyField( +export function deserializeClassificationTemplateFieldsKeyField( val: any -): ClassificationTemplateFieldsFieldKeyField { +): ClassificationTemplateFieldsKeyField { if (!sdIsString(val)) { - throw 'Expecting a string for "ClassificationTemplateFieldsFieldKeyField"'; + throw 'Expecting a string for "ClassificationTemplateFieldsKeyField"'; } if (val == 'Box__Security__Classification__Key') { return 'Box__Security__Classification__Key'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeClassificationTemplateFieldsFieldDisplayNameField( - val: ClassificationTemplateFieldsFieldDisplayNameField +export function serializeClassificationTemplateFieldsDisplayNameField( + val: ClassificationTemplateFieldsDisplayNameField ): SerializedData { return val; } -export function deserializeClassificationTemplateFieldsFieldDisplayNameField( +export function deserializeClassificationTemplateFieldsDisplayNameField( val: any -): ClassificationTemplateFieldsFieldDisplayNameField { +): ClassificationTemplateFieldsDisplayNameField { if (!sdIsString(val)) { - throw 'Expecting a string for "ClassificationTemplateFieldsFieldDisplayNameField"'; + throw 'Expecting a string for "ClassificationTemplateFieldsDisplayNameField"'; } if (val == 'Classification') { return 'Classification'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeClassificationTemplateFieldsFieldOptionsFieldStaticConfigFieldClassificationField( - val: ClassificationTemplateFieldsFieldOptionsFieldStaticConfigFieldClassificationField +export function serializeClassificationTemplateFieldsOptionsStaticConfigClassificationField( + val: ClassificationTemplateFieldsOptionsStaticConfigClassificationField ): SerializedData { return { ['classificationDefinition']: @@ -3669,9 +3655,9 @@ export function serializeClassificationTemplateFieldsFieldOptionsFieldStaticConf ['colorID']: val.colorId == void 0 ? void 0 : val.colorId, }; } -export function deserializeClassificationTemplateFieldsFieldOptionsFieldStaticConfigFieldClassificationField( +export function deserializeClassificationTemplateFieldsOptionsStaticConfigClassificationField( val: any -): ClassificationTemplateFieldsFieldOptionsFieldStaticConfigFieldClassificationField { +): ClassificationTemplateFieldsOptionsStaticConfigClassificationField { const classificationDefinition: undefined | string = val.classificationDefinition == void 0 ? void 0 @@ -3681,37 +3667,37 @@ export function deserializeClassificationTemplateFieldsFieldOptionsFieldStaticCo return { classificationDefinition: classificationDefinition, colorId: colorId, - } satisfies ClassificationTemplateFieldsFieldOptionsFieldStaticConfigFieldClassificationField; + } satisfies ClassificationTemplateFieldsOptionsStaticConfigClassificationField; } -export function serializeClassificationTemplateFieldsFieldOptionsFieldStaticConfigField( - val: ClassificationTemplateFieldsFieldOptionsFieldStaticConfigField +export function serializeClassificationTemplateFieldsOptionsStaticConfigField( + val: ClassificationTemplateFieldsOptionsStaticConfigField ): SerializedData { return { ['classification']: val.classification == void 0 ? void 0 - : serializeClassificationTemplateFieldsFieldOptionsFieldStaticConfigFieldClassificationField( + : serializeClassificationTemplateFieldsOptionsStaticConfigClassificationField( val.classification ), }; } -export function deserializeClassificationTemplateFieldsFieldOptionsFieldStaticConfigField( +export function deserializeClassificationTemplateFieldsOptionsStaticConfigField( val: any -): ClassificationTemplateFieldsFieldOptionsFieldStaticConfigField { +): ClassificationTemplateFieldsOptionsStaticConfigField { const classification: | undefined - | ClassificationTemplateFieldsFieldOptionsFieldStaticConfigFieldClassificationField = + | ClassificationTemplateFieldsOptionsStaticConfigClassificationField = val.classification == void 0 ? void 0 - : deserializeClassificationTemplateFieldsFieldOptionsFieldStaticConfigFieldClassificationField( + : deserializeClassificationTemplateFieldsOptionsStaticConfigClassificationField( val.classification ); return { classification: classification, - } satisfies ClassificationTemplateFieldsFieldOptionsFieldStaticConfigField; + } satisfies ClassificationTemplateFieldsOptionsStaticConfigField; } -export function serializeClassificationTemplateFieldsFieldOptionsField( - val: ClassificationTemplateFieldsFieldOptionsField +export function serializeClassificationTemplateFieldsOptionsField( + val: ClassificationTemplateFieldsOptionsField ): SerializedData { return { ['id']: val.id, @@ -3719,45 +3705,45 @@ export function serializeClassificationTemplateFieldsFieldOptionsField( ['staticConfig']: val.staticConfig == void 0 ? void 0 - : serializeClassificationTemplateFieldsFieldOptionsFieldStaticConfigField( + : serializeClassificationTemplateFieldsOptionsStaticConfigField( val.staticConfig ), }; } -export function deserializeClassificationTemplateFieldsFieldOptionsField( +export function deserializeClassificationTemplateFieldsOptionsField( val: any -): ClassificationTemplateFieldsFieldOptionsField { +): ClassificationTemplateFieldsOptionsField { const id: string = val.id; const key: string = val.key; const staticConfig: | undefined - | ClassificationTemplateFieldsFieldOptionsFieldStaticConfigField = + | ClassificationTemplateFieldsOptionsStaticConfigField = val.staticConfig == void 0 ? void 0 - : deserializeClassificationTemplateFieldsFieldOptionsFieldStaticConfigField( + : deserializeClassificationTemplateFieldsOptionsStaticConfigField( val.staticConfig ); return { id: id, key: key, staticConfig: staticConfig, - } satisfies ClassificationTemplateFieldsFieldOptionsField; + } satisfies ClassificationTemplateFieldsOptionsField; } export function serializeClassificationTemplateFieldsField( val: ClassificationTemplateFieldsField ): SerializedData { return { ['id']: val.id, - ['type']: serializeClassificationTemplateFieldsFieldTypeField(val.type), - ['key']: serializeClassificationTemplateFieldsFieldKeyField(val.key), - ['displayName']: serializeClassificationTemplateFieldsFieldDisplayNameField( + ['type']: serializeClassificationTemplateFieldsTypeField(val.type), + ['key']: serializeClassificationTemplateFieldsKeyField(val.key), + ['displayName']: serializeClassificationTemplateFieldsDisplayNameField( val.displayName ), ['hidden']: val.hidden == void 0 ? void 0 : val.hidden, ['options']: val.options.map(function ( - item: ClassificationTemplateFieldsFieldOptionsField + item: ClassificationTemplateFieldsOptionsField ): any { - return serializeClassificationTemplateFieldsFieldOptionsField(item); + return serializeClassificationTemplateFieldsOptionsField(item); }) as readonly any[], }; } @@ -3765,22 +3751,21 @@ export function deserializeClassificationTemplateFieldsField( val: any ): ClassificationTemplateFieldsField { const id: string = val.id; - const type: ClassificationTemplateFieldsFieldTypeField = - deserializeClassificationTemplateFieldsFieldTypeField(val.type); - const key: ClassificationTemplateFieldsFieldKeyField = - deserializeClassificationTemplateFieldsFieldKeyField(val.key); - const displayName: ClassificationTemplateFieldsFieldDisplayNameField = - deserializeClassificationTemplateFieldsFieldDisplayNameField( - val.displayName - ); + const type: ClassificationTemplateFieldsTypeField = + deserializeClassificationTemplateFieldsTypeField(val.type); + const key: ClassificationTemplateFieldsKeyField = + deserializeClassificationTemplateFieldsKeyField(val.key); + const displayName: ClassificationTemplateFieldsDisplayNameField = + deserializeClassificationTemplateFieldsDisplayNameField(val.displayName); const hidden: undefined | boolean = val.hidden == void 0 ? void 0 : val.hidden; - const options: readonly ClassificationTemplateFieldsFieldOptionsField[] = - sdIsList(val.options) - ? (val.options.map(function (itm: SerializedData): any { - return deserializeClassificationTemplateFieldsFieldOptionsField(itm); - }) as readonly any[]) - : []; + const options: readonly ClassificationTemplateFieldsOptionsField[] = sdIsList( + val.options + ) + ? (val.options.map(function (itm: SerializedData): any { + return deserializeClassificationTemplateFieldsOptionsField(itm); + }) as readonly any[]) + : []; return { id: id, type: type, @@ -3886,16 +3871,16 @@ export function deserializeCollaborationAllowlistEntryDirectionField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCollaborationAllowlistEntryEnterpriseFieldTypeField( - val: CollaborationAllowlistEntryEnterpriseFieldTypeField +export function serializeCollaborationAllowlistEntryEnterpriseTypeField( + val: CollaborationAllowlistEntryEnterpriseTypeField ): SerializedData { return val; } -export function deserializeCollaborationAllowlistEntryEnterpriseFieldTypeField( +export function deserializeCollaborationAllowlistEntryEnterpriseTypeField( val: any -): CollaborationAllowlistEntryEnterpriseFieldTypeField { +): CollaborationAllowlistEntryEnterpriseTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CollaborationAllowlistEntryEnterpriseFieldTypeField"'; + throw 'Expecting a string for "CollaborationAllowlistEntryEnterpriseTypeField"'; } if (val == 'enterprise') { return 'enterprise'; @@ -3910,9 +3895,7 @@ export function serializeCollaborationAllowlistEntryEnterpriseField( ['type']: val.type == void 0 ? void 0 - : serializeCollaborationAllowlistEntryEnterpriseFieldTypeField( - val.type - ), + : serializeCollaborationAllowlistEntryEnterpriseTypeField(val.type), ['name']: val.name == void 0 ? void 0 : val.name, }; } @@ -3920,12 +3903,10 @@ export function deserializeCollaborationAllowlistEntryEnterpriseField( val: any ): CollaborationAllowlistEntryEnterpriseField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: undefined | CollaborationAllowlistEntryEnterpriseFieldTypeField = + const type: undefined | CollaborationAllowlistEntryEnterpriseTypeField = val.type == void 0 ? void 0 - : deserializeCollaborationAllowlistEntryEnterpriseFieldTypeField( - val.type - ); + : deserializeCollaborationAllowlistEntryEnterpriseTypeField(val.type); const name: undefined | string = val.name == void 0 ? void 0 : val.name; return { id: id, @@ -4094,16 +4075,16 @@ export function deserializeCollection(val: any): Collection { collectionType: collectionType, } satisfies Collection; } -export function serializeCollectionsOrderFieldDirectionField( - val: CollectionsOrderFieldDirectionField +export function serializeCollectionsOrderDirectionField( + val: CollectionsOrderDirectionField ): SerializedData { return val; } -export function deserializeCollectionsOrderFieldDirectionField( +export function deserializeCollectionsOrderDirectionField( val: any -): CollectionsOrderFieldDirectionField { +): CollectionsOrderDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "CollectionsOrderFieldDirectionField"'; + throw 'Expecting a string for "CollectionsOrderDirectionField"'; } if (val == 'ASC') { return 'ASC'; @@ -4121,17 +4102,17 @@ export function serializeCollectionsOrderField( ['direction']: val.direction == void 0 ? void 0 - : serializeCollectionsOrderFieldDirectionField(val.direction), + : serializeCollectionsOrderDirectionField(val.direction), }; } export function deserializeCollectionsOrderField( val: any ): CollectionsOrderField { const by: undefined | string = val.by == void 0 ? void 0 : val.by; - const direction: undefined | CollectionsOrderFieldDirectionField = + const direction: undefined | CollectionsOrderDirectionField = val.direction == void 0 ? void 0 - : deserializeCollectionsOrderFieldDirectionField(val.direction); + : deserializeCollectionsOrderDirectionField(val.direction); return { by: by, direction: direction } satisfies CollectionsOrderField; } export function serializeCollections(val: Collections): SerializedData { @@ -5130,16 +5111,16 @@ export function deserializeGroupFull(val: any): GroupFull { type: type, } satisfies GroupFull; } -export function serializeGroupsOrderFieldDirectionField( - val: GroupsOrderFieldDirectionField +export function serializeGroupsOrderDirectionField( + val: GroupsOrderDirectionField ): SerializedData { return val; } -export function deserializeGroupsOrderFieldDirectionField( +export function deserializeGroupsOrderDirectionField( val: any -): GroupsOrderFieldDirectionField { +): GroupsOrderDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "GroupsOrderFieldDirectionField"'; + throw 'Expecting a string for "GroupsOrderDirectionField"'; } if (val == 'ASC') { return 'ASC'; @@ -5157,15 +5138,15 @@ export function serializeGroupsOrderField( ['direction']: val.direction == void 0 ? void 0 - : serializeGroupsOrderFieldDirectionField(val.direction), + : serializeGroupsOrderDirectionField(val.direction), }; } export function deserializeGroupsOrderField(val: any): GroupsOrderField { const by: undefined | string = val.by == void 0 ? void 0 : val.by; - const direction: undefined | GroupsOrderFieldDirectionField = + const direction: undefined | GroupsOrderDirectionField = val.direction == void 0 ? void 0 - : deserializeGroupsOrderFieldDirectionField(val.direction); + : deserializeGroupsOrderDirectionField(val.direction); return { by: by, direction: direction } satisfies GroupsOrderField; } export function serializeGroups(val: Groups): SerializedData { @@ -5400,16 +5381,16 @@ export function deserializeMetadataCascadePolicyTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeMetadataCascadePolicyOwnerEnterpriseFieldTypeField( - val: MetadataCascadePolicyOwnerEnterpriseFieldTypeField +export function serializeMetadataCascadePolicyOwnerEnterpriseTypeField( + val: MetadataCascadePolicyOwnerEnterpriseTypeField ): SerializedData { return val; } -export function deserializeMetadataCascadePolicyOwnerEnterpriseFieldTypeField( +export function deserializeMetadataCascadePolicyOwnerEnterpriseTypeField( val: any -): MetadataCascadePolicyOwnerEnterpriseFieldTypeField { +): MetadataCascadePolicyOwnerEnterpriseTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "MetadataCascadePolicyOwnerEnterpriseFieldTypeField"'; + throw 'Expecting a string for "MetadataCascadePolicyOwnerEnterpriseTypeField"'; } if (val == 'enterprise') { return 'enterprise'; @@ -5423,33 +5404,33 @@ export function serializeMetadataCascadePolicyOwnerEnterpriseField( ['type']: val.type == void 0 ? void 0 - : serializeMetadataCascadePolicyOwnerEnterpriseFieldTypeField(val.type), + : serializeMetadataCascadePolicyOwnerEnterpriseTypeField(val.type), ['id']: val.id == void 0 ? void 0 : val.id, }; } export function deserializeMetadataCascadePolicyOwnerEnterpriseField( val: any ): MetadataCascadePolicyOwnerEnterpriseField { - const type: undefined | MetadataCascadePolicyOwnerEnterpriseFieldTypeField = + const type: undefined | MetadataCascadePolicyOwnerEnterpriseTypeField = val.type == void 0 ? void 0 - : deserializeMetadataCascadePolicyOwnerEnterpriseFieldTypeField(val.type); + : deserializeMetadataCascadePolicyOwnerEnterpriseTypeField(val.type); const id: undefined | string = val.id == void 0 ? void 0 : val.id; return { type: type, id: id, } satisfies MetadataCascadePolicyOwnerEnterpriseField; } -export function serializeMetadataCascadePolicyParentFieldTypeField( - val: MetadataCascadePolicyParentFieldTypeField +export function serializeMetadataCascadePolicyParentTypeField( + val: MetadataCascadePolicyParentTypeField ): SerializedData { return val; } -export function deserializeMetadataCascadePolicyParentFieldTypeField( +export function deserializeMetadataCascadePolicyParentTypeField( val: any -): MetadataCascadePolicyParentFieldTypeField { +): MetadataCascadePolicyParentTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "MetadataCascadePolicyParentFieldTypeField"'; + throw 'Expecting a string for "MetadataCascadePolicyParentTypeField"'; } if (val == 'folder') { return 'folder'; @@ -5463,17 +5444,17 @@ export function serializeMetadataCascadePolicyParentField( ['type']: val.type == void 0 ? void 0 - : serializeMetadataCascadePolicyParentFieldTypeField(val.type), + : serializeMetadataCascadePolicyParentTypeField(val.type), ['id']: val.id == void 0 ? void 0 : val.id, }; } export function deserializeMetadataCascadePolicyParentField( val: any ): MetadataCascadePolicyParentField { - const type: undefined | MetadataCascadePolicyParentFieldTypeField = + const type: undefined | MetadataCascadePolicyParentTypeField = val.type == void 0 ? void 0 - : deserializeMetadataCascadePolicyParentFieldTypeField(val.type); + : deserializeMetadataCascadePolicyParentTypeField(val.type); const id: undefined | string = val.id == void 0 ? void 0 : val.id; return { type: type, id: id } satisfies MetadataCascadePolicyParentField; } @@ -5585,16 +5566,16 @@ export function deserializeMetadataQueryIndexStatusField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeMetadataQueryIndexFieldsFieldSortDirectionField( - val: MetadataQueryIndexFieldsFieldSortDirectionField +export function serializeMetadataQueryIndexFieldsSortDirectionField( + val: MetadataQueryIndexFieldsSortDirectionField ): SerializedData { return val; } -export function deserializeMetadataQueryIndexFieldsFieldSortDirectionField( +export function deserializeMetadataQueryIndexFieldsSortDirectionField( val: any -): MetadataQueryIndexFieldsFieldSortDirectionField { +): MetadataQueryIndexFieldsSortDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "MetadataQueryIndexFieldsFieldSortDirectionField"'; + throw 'Expecting a string for "MetadataQueryIndexFieldsSortDirectionField"'; } if (val == 'asc') { return 'asc'; @@ -5612,7 +5593,7 @@ export function serializeMetadataQueryIndexFieldsField( ['sort_direction']: val.sortDirection == void 0 ? void 0 - : serializeMetadataQueryIndexFieldsFieldSortDirectionField( + : serializeMetadataQueryIndexFieldsSortDirectionField( val.sortDirection ), }; @@ -5621,12 +5602,10 @@ export function deserializeMetadataQueryIndexFieldsField( val: any ): MetadataQueryIndexFieldsField { const key: undefined | string = val.key == void 0 ? void 0 : val.key; - const sortDirection: - | undefined - | MetadataQueryIndexFieldsFieldSortDirectionField = + const sortDirection: undefined | MetadataQueryIndexFieldsSortDirectionField = val.sort_direction == void 0 ? void 0 - : deserializeMetadataQueryIndexFieldsFieldSortDirectionField( + : deserializeMetadataQueryIndexFieldsSortDirectionField( val.sort_direction ); return { @@ -5719,16 +5698,16 @@ export function deserializeMetadataTemplateTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeMetadataTemplateFieldsFieldTypeField( - val: MetadataTemplateFieldsFieldTypeField +export function serializeMetadataTemplateFieldsTypeField( + val: MetadataTemplateFieldsTypeField ): SerializedData { return val; } -export function deserializeMetadataTemplateFieldsFieldTypeField( +export function deserializeMetadataTemplateFieldsTypeField( val: any -): MetadataTemplateFieldsFieldTypeField { +): MetadataTemplateFieldsTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "MetadataTemplateFieldsFieldTypeField"'; + throw 'Expecting a string for "MetadataTemplateFieldsTypeField"'; } if (val == 'string') { return 'string'; @@ -5750,23 +5729,23 @@ export function deserializeMetadataTemplateFieldsFieldTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeMetadataTemplateFieldsFieldOptionsField( - val: MetadataTemplateFieldsFieldOptionsField +export function serializeMetadataTemplateFieldsOptionsField( + val: MetadataTemplateFieldsOptionsField ): SerializedData { return { ['key']: val.key, ['id']: val.id == void 0 ? void 0 : val.id }; } -export function deserializeMetadataTemplateFieldsFieldOptionsField( +export function deserializeMetadataTemplateFieldsOptionsField( val: any -): MetadataTemplateFieldsFieldOptionsField { +): MetadataTemplateFieldsOptionsField { const key: string = val.key; const id: undefined | string = val.id == void 0 ? void 0 : val.id; - return { key: key, id: id } satisfies MetadataTemplateFieldsFieldOptionsField; + return { key: key, id: id } satisfies MetadataTemplateFieldsOptionsField; } export function serializeMetadataTemplateFieldsField( val: MetadataTemplateFieldsField ): SerializedData { return { - ['type']: serializeMetadataTemplateFieldsFieldTypeField(val.type), + ['type']: serializeMetadataTemplateFieldsTypeField(val.type), ['key']: val.key, ['displayName']: val.displayName, ['description']: val.description == void 0 ? void 0 : val.description, @@ -5775,9 +5754,9 @@ export function serializeMetadataTemplateFieldsField( val.options == void 0 ? void 0 : (val.options.map(function ( - item: MetadataTemplateFieldsFieldOptionsField + item: MetadataTemplateFieldsOptionsField ): any { - return serializeMetadataTemplateFieldsFieldOptionsField(item); + return serializeMetadataTemplateFieldsOptionsField(item); }) as readonly any[]), ['id']: val.id == void 0 ? void 0 : val.id, }; @@ -5785,22 +5764,20 @@ export function serializeMetadataTemplateFieldsField( export function deserializeMetadataTemplateFieldsField( val: any ): MetadataTemplateFieldsField { - const type: MetadataTemplateFieldsFieldTypeField = - deserializeMetadataTemplateFieldsFieldTypeField(val.type); + const type: MetadataTemplateFieldsTypeField = + deserializeMetadataTemplateFieldsTypeField(val.type); const key: string = val.key; const displayName: string = val.displayName; const description: undefined | string = val.description == void 0 ? void 0 : val.description; const hidden: undefined | boolean = val.hidden == void 0 ? void 0 : val.hidden; - const options: - | undefined - | readonly MetadataTemplateFieldsFieldOptionsField[] = + const options: undefined | readonly MetadataTemplateFieldsOptionsField[] = val.options == void 0 ? void 0 : sdIsList(val.options) ? (val.options.map(function (itm: SerializedData): any { - return deserializeMetadataTemplateFieldsFieldOptionsField(itm); + return deserializeMetadataTemplateFieldsOptionsField(itm); }) as readonly any[]) : []; const id: undefined | string = val.id == void 0 ? void 0 : val.id; @@ -6371,16 +6348,16 @@ export function deserializeShieldInformationBarrierSegmentRestrictionBase( id: id, } satisfies ShieldInformationBarrierSegmentRestrictionBase; } -export function serializeShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentFieldTypeField( - val: ShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentFieldTypeField +export function serializeShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentTypeField( + val: ShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentTypeField ): SerializedData { return val; } -export function deserializeShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentFieldTypeField( +export function deserializeShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentTypeField( val: any -): ShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentFieldTypeField { +): ShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "ShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentFieldTypeField"'; + throw 'Expecting a string for "ShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentTypeField"'; } if (val == 'shield_information_barrier_segment') { return 'shield_information_barrier_segment'; @@ -6395,7 +6372,7 @@ export function serializeShieldInformationBarrierSegmentRestrictionMiniShieldInf ['type']: val.type == void 0 ? void 0 - : serializeShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentFieldTypeField( + : serializeShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentTypeField( val.type ), }; @@ -6406,10 +6383,10 @@ export function deserializeShieldInformationBarrierSegmentRestrictionMiniShieldI const id: undefined | string = val.id == void 0 ? void 0 : val.id; const type: | undefined - | ShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentFieldTypeField = + | ShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentTypeField = val.type == void 0 ? void 0 - : deserializeShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentFieldTypeField( + : deserializeShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentTypeField( val.type ); return { @@ -6417,16 +6394,16 @@ export function deserializeShieldInformationBarrierSegmentRestrictionMiniShieldI type: type, } satisfies ShieldInformationBarrierSegmentRestrictionMiniShieldInformationBarrierSegmentField; } -export function serializeShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentFieldTypeField( - val: ShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentFieldTypeField +export function serializeShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentTypeField( + val: ShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentTypeField ): SerializedData { return val; } -export function deserializeShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentFieldTypeField( +export function deserializeShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentTypeField( val: any -): ShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentFieldTypeField { +): ShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "ShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentFieldTypeField"'; + throw 'Expecting a string for "ShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentTypeField"'; } if (val == 'shield_information_barrier_segment') { return 'shield_information_barrier_segment'; @@ -6441,7 +6418,7 @@ export function serializeShieldInformationBarrierSegmentRestrictionMiniRestricte ['type']: val.type == void 0 ? void 0 - : serializeShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentFieldTypeField( + : serializeShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentTypeField( val.type ), }; @@ -6452,10 +6429,10 @@ export function deserializeShieldInformationBarrierSegmentRestrictionMiniRestric const id: undefined | string = val.id == void 0 ? void 0 : val.id; const type: | undefined - | ShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentFieldTypeField = + | ShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentTypeField = val.type == void 0 ? void 0 - : deserializeShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentFieldTypeField( + : deserializeShieldInformationBarrierSegmentRestrictionMiniRestrictedSegmentTypeField( val.type ); return { @@ -6749,16 +6726,16 @@ export function deserializeTermsOfServiceStatusField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeTermsOfServiceEnterpriseFieldTypeField( - val: TermsOfServiceEnterpriseFieldTypeField +export function serializeTermsOfServiceEnterpriseTypeField( + val: TermsOfServiceEnterpriseTypeField ): SerializedData { return val; } -export function deserializeTermsOfServiceEnterpriseFieldTypeField( +export function deserializeTermsOfServiceEnterpriseTypeField( val: any -): TermsOfServiceEnterpriseFieldTypeField { +): TermsOfServiceEnterpriseTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "TermsOfServiceEnterpriseFieldTypeField"'; + throw 'Expecting a string for "TermsOfServiceEnterpriseTypeField"'; } if (val == 'enterprise') { return 'enterprise'; @@ -6773,7 +6750,7 @@ export function serializeTermsOfServiceEnterpriseField( ['type']: val.type == void 0 ? void 0 - : serializeTermsOfServiceEnterpriseFieldTypeField(val.type), + : serializeTermsOfServiceEnterpriseTypeField(val.type), ['name']: val.name == void 0 ? void 0 : val.name, }; } @@ -6781,10 +6758,10 @@ export function deserializeTermsOfServiceEnterpriseField( val: any ): TermsOfServiceEnterpriseField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: undefined | TermsOfServiceEnterpriseFieldTypeField = + const type: undefined | TermsOfServiceEnterpriseTypeField = val.type == void 0 ? void 0 - : deserializeTermsOfServiceEnterpriseFieldTypeField(val.type); + : deserializeTermsOfServiceEnterpriseTypeField(val.type); const name: undefined | string = val.name == void 0 ? void 0 : val.name; return { id: id, @@ -6933,16 +6910,16 @@ export function deserializeUploadPart(val: any): UploadPart { size: size, } satisfies UploadPart; } -export function serializeUploadPartsOrderFieldDirectionField( - val: UploadPartsOrderFieldDirectionField +export function serializeUploadPartsOrderDirectionField( + val: UploadPartsOrderDirectionField ): SerializedData { return val; } -export function deserializeUploadPartsOrderFieldDirectionField( +export function deserializeUploadPartsOrderDirectionField( val: any -): UploadPartsOrderFieldDirectionField { +): UploadPartsOrderDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "UploadPartsOrderFieldDirectionField"'; + throw 'Expecting a string for "UploadPartsOrderDirectionField"'; } if (val == 'ASC') { return 'ASC'; @@ -6960,17 +6937,17 @@ export function serializeUploadPartsOrderField( ['direction']: val.direction == void 0 ? void 0 - : serializeUploadPartsOrderFieldDirectionField(val.direction), + : serializeUploadPartsOrderDirectionField(val.direction), }; } export function deserializeUploadPartsOrderField( val: any ): UploadPartsOrderField { const by: undefined | string = val.by == void 0 ? void 0 : val.by; - const direction: undefined | UploadPartsOrderFieldDirectionField = + const direction: undefined | UploadPartsOrderDirectionField = val.direction == void 0 ? void 0 - : deserializeUploadPartsOrderFieldDirectionField(val.direction); + : deserializeUploadPartsOrderDirectionField(val.direction); return { by: by, direction: direction } satisfies UploadPartsOrderField; } export function serializeUploadParts(val: UploadParts): SerializedData { @@ -7987,47 +7964,43 @@ export function deserializeTrashWebLinkTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeTrashWebLinkPathCollectionFieldEntriesFieldTypeField( - val: TrashWebLinkPathCollectionFieldEntriesFieldTypeField +export function serializeTrashWebLinkPathCollectionEntriesTypeField( + val: TrashWebLinkPathCollectionEntriesTypeField ): SerializedData { return val; } -export function deserializeTrashWebLinkPathCollectionFieldEntriesFieldTypeField( +export function deserializeTrashWebLinkPathCollectionEntriesTypeField( val: any -): TrashWebLinkPathCollectionFieldEntriesFieldTypeField { +): TrashWebLinkPathCollectionEntriesTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "TrashWebLinkPathCollectionFieldEntriesFieldTypeField"'; + throw 'Expecting a string for "TrashWebLinkPathCollectionEntriesTypeField"'; } if (val == 'folder') { return 'folder'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeTrashWebLinkPathCollectionFieldEntriesField( - val: TrashWebLinkPathCollectionFieldEntriesField +export function serializeTrashWebLinkPathCollectionEntriesField( + val: TrashWebLinkPathCollectionEntriesField ): SerializedData { return { ['type']: val.type == void 0 ? void 0 - : serializeTrashWebLinkPathCollectionFieldEntriesFieldTypeField( - val.type - ), + : serializeTrashWebLinkPathCollectionEntriesTypeField(val.type), ['id']: val.id == void 0 ? void 0 : val.id, ['sequence_id']: val.sequenceId == void 0 ? void 0 : val.sequenceId, ['etag']: val.etag == void 0 ? void 0 : val.etag, ['name']: val.name == void 0 ? void 0 : val.name, }; } -export function deserializeTrashWebLinkPathCollectionFieldEntriesField( +export function deserializeTrashWebLinkPathCollectionEntriesField( val: any -): TrashWebLinkPathCollectionFieldEntriesField { - const type: undefined | TrashWebLinkPathCollectionFieldEntriesFieldTypeField = +): TrashWebLinkPathCollectionEntriesField { + const type: undefined | TrashWebLinkPathCollectionEntriesTypeField = val.type == void 0 ? void 0 - : deserializeTrashWebLinkPathCollectionFieldEntriesFieldTypeField( - val.type - ); + : deserializeTrashWebLinkPathCollectionEntriesTypeField(val.type); const id: undefined | string = val.id == void 0 ? void 0 : val.id; const sequenceId: undefined | string = val.sequence_id == void 0 ? void 0 : val.sequence_id; @@ -8039,7 +8012,7 @@ export function deserializeTrashWebLinkPathCollectionFieldEntriesField( sequenceId: sequenceId, etag: etag, name: name, - } satisfies TrashWebLinkPathCollectionFieldEntriesField; + } satisfies TrashWebLinkPathCollectionEntriesField; } export function serializeTrashWebLinkPathCollectionField( val: TrashWebLinkPathCollectionField @@ -8047,9 +8020,9 @@ export function serializeTrashWebLinkPathCollectionField( return { ['total_count']: val.totalCount, ['entries']: val.entries.map(function ( - item: TrashWebLinkPathCollectionFieldEntriesField + item: TrashWebLinkPathCollectionEntriesField ): any { - return serializeTrashWebLinkPathCollectionFieldEntriesField(item); + return serializeTrashWebLinkPathCollectionEntriesField(item); }) as readonly any[], }; } @@ -8057,12 +8030,13 @@ export function deserializeTrashWebLinkPathCollectionField( val: any ): TrashWebLinkPathCollectionField { const totalCount: number = val.total_count; - const entries: readonly TrashWebLinkPathCollectionFieldEntriesField[] = - sdIsList(val.entries) - ? (val.entries.map(function (itm: SerializedData): any { - return deserializeTrashWebLinkPathCollectionFieldEntriesField(itm); - }) as readonly any[]) - : []; + const entries: readonly TrashWebLinkPathCollectionEntriesField[] = sdIsList( + val.entries + ) + ? (val.entries.map(function (itm: SerializedData): any { + return deserializeTrashWebLinkPathCollectionEntriesField(itm); + }) as readonly any[]) + : []; return { totalCount: totalCount, entries: entries, @@ -8196,47 +8170,43 @@ export function deserializeTrashFolderTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeTrashFolderPathCollectionFieldEntriesFieldTypeField( - val: TrashFolderPathCollectionFieldEntriesFieldTypeField +export function serializeTrashFolderPathCollectionEntriesTypeField( + val: TrashFolderPathCollectionEntriesTypeField ): SerializedData { return val; } -export function deserializeTrashFolderPathCollectionFieldEntriesFieldTypeField( +export function deserializeTrashFolderPathCollectionEntriesTypeField( val: any -): TrashFolderPathCollectionFieldEntriesFieldTypeField { +): TrashFolderPathCollectionEntriesTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "TrashFolderPathCollectionFieldEntriesFieldTypeField"'; + throw 'Expecting a string for "TrashFolderPathCollectionEntriesTypeField"'; } if (val == 'folder') { return 'folder'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeTrashFolderPathCollectionFieldEntriesField( - val: TrashFolderPathCollectionFieldEntriesField +export function serializeTrashFolderPathCollectionEntriesField( + val: TrashFolderPathCollectionEntriesField ): SerializedData { return { ['type']: val.type == void 0 ? void 0 - : serializeTrashFolderPathCollectionFieldEntriesFieldTypeField( - val.type - ), + : serializeTrashFolderPathCollectionEntriesTypeField(val.type), ['id']: val.id == void 0 ? void 0 : val.id, ['sequence_id']: val.sequenceId == void 0 ? void 0 : val.sequenceId, ['etag']: val.etag == void 0 ? void 0 : val.etag, ['name']: val.name == void 0 ? void 0 : val.name, }; } -export function deserializeTrashFolderPathCollectionFieldEntriesField( +export function deserializeTrashFolderPathCollectionEntriesField( val: any -): TrashFolderPathCollectionFieldEntriesField { - const type: undefined | TrashFolderPathCollectionFieldEntriesFieldTypeField = +): TrashFolderPathCollectionEntriesField { + const type: undefined | TrashFolderPathCollectionEntriesTypeField = val.type == void 0 ? void 0 - : deserializeTrashFolderPathCollectionFieldEntriesFieldTypeField( - val.type - ); + : deserializeTrashFolderPathCollectionEntriesTypeField(val.type); const id: undefined | string = val.id == void 0 ? void 0 : val.id; const sequenceId: undefined | string = val.sequence_id == void 0 ? void 0 : val.sequence_id; @@ -8248,7 +8218,7 @@ export function deserializeTrashFolderPathCollectionFieldEntriesField( sequenceId: sequenceId, etag: etag, name: name, - } satisfies TrashFolderPathCollectionFieldEntriesField; + } satisfies TrashFolderPathCollectionEntriesField; } export function serializeTrashFolderPathCollectionField( val: TrashFolderPathCollectionField @@ -8256,9 +8226,9 @@ export function serializeTrashFolderPathCollectionField( return { ['total_count']: val.totalCount, ['entries']: val.entries.map(function ( - item: TrashFolderPathCollectionFieldEntriesField + item: TrashFolderPathCollectionEntriesField ): any { - return serializeTrashFolderPathCollectionFieldEntriesField(item); + return serializeTrashFolderPathCollectionEntriesField(item); }) as readonly any[], }; } @@ -8266,12 +8236,13 @@ export function deserializeTrashFolderPathCollectionField( val: any ): TrashFolderPathCollectionField { const totalCount: number = val.total_count; - const entries: readonly TrashFolderPathCollectionFieldEntriesField[] = - sdIsList(val.entries) - ? (val.entries.map(function (itm: SerializedData): any { - return deserializeTrashFolderPathCollectionFieldEntriesField(itm); - }) as readonly any[]) - : []; + const entries: readonly TrashFolderPathCollectionEntriesField[] = sdIsList( + val.entries + ) + ? (val.entries.map(function (itm: SerializedData): any { + return deserializeTrashFolderPathCollectionEntriesField(itm); + }) as readonly any[]) + : []; return { totalCount: totalCount, entries: entries, @@ -8401,43 +8372,43 @@ export function deserializeTrashFileTypeField(val: any): TrashFileTypeField { } throw ''.concat('Invalid value: ', val) as string; } -export function serializeTrashFilePathCollectionFieldEntriesFieldTypeField( - val: TrashFilePathCollectionFieldEntriesFieldTypeField +export function serializeTrashFilePathCollectionEntriesTypeField( + val: TrashFilePathCollectionEntriesTypeField ): SerializedData { return val; } -export function deserializeTrashFilePathCollectionFieldEntriesFieldTypeField( +export function deserializeTrashFilePathCollectionEntriesTypeField( val: any -): TrashFilePathCollectionFieldEntriesFieldTypeField { +): TrashFilePathCollectionEntriesTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "TrashFilePathCollectionFieldEntriesFieldTypeField"'; + throw 'Expecting a string for "TrashFilePathCollectionEntriesTypeField"'; } if (val == 'folder') { return 'folder'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeTrashFilePathCollectionFieldEntriesField( - val: TrashFilePathCollectionFieldEntriesField +export function serializeTrashFilePathCollectionEntriesField( + val: TrashFilePathCollectionEntriesField ): SerializedData { return { ['type']: val.type == void 0 ? void 0 - : serializeTrashFilePathCollectionFieldEntriesFieldTypeField(val.type), + : serializeTrashFilePathCollectionEntriesTypeField(val.type), ['id']: val.id == void 0 ? void 0 : val.id, ['sequence_id']: val.sequenceId == void 0 ? void 0 : val.sequenceId, ['etag']: val.etag == void 0 ? void 0 : val.etag, ['name']: val.name == void 0 ? void 0 : val.name, }; } -export function deserializeTrashFilePathCollectionFieldEntriesField( +export function deserializeTrashFilePathCollectionEntriesField( val: any -): TrashFilePathCollectionFieldEntriesField { - const type: undefined | TrashFilePathCollectionFieldEntriesFieldTypeField = +): TrashFilePathCollectionEntriesField { + const type: undefined | TrashFilePathCollectionEntriesTypeField = val.type == void 0 ? void 0 - : deserializeTrashFilePathCollectionFieldEntriesFieldTypeField(val.type); + : deserializeTrashFilePathCollectionEntriesTypeField(val.type); const id: undefined | string = val.id == void 0 ? void 0 : val.id; const sequenceId: undefined | string = val.sequence_id == void 0 ? void 0 : val.sequence_id; @@ -8449,7 +8420,7 @@ export function deserializeTrashFilePathCollectionFieldEntriesField( sequenceId: sequenceId, etag: etag, name: name, - } satisfies TrashFilePathCollectionFieldEntriesField; + } satisfies TrashFilePathCollectionEntriesField; } export function serializeTrashFilePathCollectionField( val: TrashFilePathCollectionField @@ -8457,9 +8428,9 @@ export function serializeTrashFilePathCollectionField( return { ['total_count']: val.totalCount, ['entries']: val.entries.map(function ( - item: TrashFilePathCollectionFieldEntriesField + item: TrashFilePathCollectionEntriesField ): any { - return serializeTrashFilePathCollectionFieldEntriesField(item); + return serializeTrashFilePathCollectionEntriesField(item); }) as readonly any[], }; } @@ -8467,11 +8438,11 @@ export function deserializeTrashFilePathCollectionField( val: any ): TrashFilePathCollectionField { const totalCount: number = val.total_count; - const entries: readonly TrashFilePathCollectionFieldEntriesField[] = sdIsList( + const entries: readonly TrashFilePathCollectionEntriesField[] = sdIsList( val.entries ) ? (val.entries.map(function (itm: SerializedData): any { - return deserializeTrashFilePathCollectionFieldEntriesField(itm); + return deserializeTrashFilePathCollectionEntriesField(itm); }) as readonly any[]) : []; return { @@ -8954,16 +8925,16 @@ export function deserializeRetentionPolicyAssignmentTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeRetentionPolicyAssignmentAssignedToFieldTypeField( - val: RetentionPolicyAssignmentAssignedToFieldTypeField +export function serializeRetentionPolicyAssignmentAssignedToTypeField( + val: RetentionPolicyAssignmentAssignedToTypeField ): SerializedData { return val; } -export function deserializeRetentionPolicyAssignmentAssignedToFieldTypeField( +export function deserializeRetentionPolicyAssignmentAssignedToTypeField( val: any -): RetentionPolicyAssignmentAssignedToFieldTypeField { +): RetentionPolicyAssignmentAssignedToTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "RetentionPolicyAssignmentAssignedToFieldTypeField"'; + throw 'Expecting a string for "RetentionPolicyAssignmentAssignedToTypeField"'; } if (val == 'folder') { return 'folder'; @@ -8984,17 +8955,17 @@ export function serializeRetentionPolicyAssignmentAssignedToField( ['type']: val.type == void 0 ? void 0 - : serializeRetentionPolicyAssignmentAssignedToFieldTypeField(val.type), + : serializeRetentionPolicyAssignmentAssignedToTypeField(val.type), }; } export function deserializeRetentionPolicyAssignmentAssignedToField( val: any ): RetentionPolicyAssignmentAssignedToField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: undefined | RetentionPolicyAssignmentAssignedToFieldTypeField = + const type: undefined | RetentionPolicyAssignmentAssignedToTypeField = val.type == void 0 ? void 0 - : deserializeRetentionPolicyAssignmentAssignedToFieldTypeField(val.type); + : deserializeRetentionPolicyAssignmentAssignedToTypeField(val.type); return { id: id, type: type, @@ -9531,16 +9502,16 @@ export function deserializeInviteTypeField(val: any): InviteTypeField { } throw ''.concat('Invalid value: ', val) as string; } -export function serializeInviteInvitedToFieldTypeField( - val: InviteInvitedToFieldTypeField +export function serializeInviteInvitedToTypeField( + val: InviteInvitedToTypeField ): SerializedData { return val; } -export function deserializeInviteInvitedToFieldTypeField( +export function deserializeInviteInvitedToTypeField( val: any -): InviteInvitedToFieldTypeField { +): InviteInvitedToTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "InviteInvitedToFieldTypeField"'; + throw 'Expecting a string for "InviteInvitedToTypeField"'; } if (val == 'enterprise') { return 'enterprise'; @@ -9553,9 +9524,7 @@ export function serializeInviteInvitedToField( return { ['id']: val.id == void 0 ? void 0 : val.id, ['type']: - val.type == void 0 - ? void 0 - : serializeInviteInvitedToFieldTypeField(val.type), + val.type == void 0 ? void 0 : serializeInviteInvitedToTypeField(val.type), ['name']: val.name == void 0 ? void 0 : val.name, }; } @@ -9563,10 +9532,8 @@ export function deserializeInviteInvitedToField( val: any ): InviteInvitedToField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: undefined | InviteInvitedToFieldTypeField = - val.type == void 0 - ? void 0 - : deserializeInviteInvitedToFieldTypeField(val.type); + const type: undefined | InviteInvitedToTypeField = + val.type == void 0 ? void 0 : deserializeInviteInvitedToTypeField(val.type); const name: undefined | string = val.name == void 0 ? void 0 : val.name; return { id: id, type: type, name: name } satisfies InviteInvitedToField; } @@ -9688,16 +9655,16 @@ export function deserializeGroupMembership(val: any): GroupMembership { modifiedAt: modifiedAt, } satisfies GroupMembership; } -export function serializeGroupMembershipsOrderFieldDirectionField( - val: GroupMembershipsOrderFieldDirectionField +export function serializeGroupMembershipsOrderDirectionField( + val: GroupMembershipsOrderDirectionField ): SerializedData { return val; } -export function deserializeGroupMembershipsOrderFieldDirectionField( +export function deserializeGroupMembershipsOrderDirectionField( val: any -): GroupMembershipsOrderFieldDirectionField { +): GroupMembershipsOrderDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "GroupMembershipsOrderFieldDirectionField"'; + throw 'Expecting a string for "GroupMembershipsOrderDirectionField"'; } if (val == 'ASC') { return 'ASC'; @@ -9715,17 +9682,17 @@ export function serializeGroupMembershipsOrderField( ['direction']: val.direction == void 0 ? void 0 - : serializeGroupMembershipsOrderFieldDirectionField(val.direction), + : serializeGroupMembershipsOrderDirectionField(val.direction), }; } export function deserializeGroupMembershipsOrderField( val: any ): GroupMembershipsOrderField { const by: undefined | string = val.by == void 0 ? void 0 : val.by; - const direction: undefined | GroupMembershipsOrderFieldDirectionField = + const direction: undefined | GroupMembershipsOrderDirectionField = val.direction == void 0 ? void 0 - : deserializeGroupMembershipsOrderFieldDirectionField(val.direction); + : deserializeGroupMembershipsOrderDirectionField(val.direction); return { by: by, direction: direction } satisfies GroupMembershipsOrderField; } export function serializeGroupMemberships( @@ -9906,16 +9873,16 @@ export function deserializeFileVersionFull(val: any): FileVersionFull { type: type, } satisfies FileVersionFull; } -export function serializeFileVersionsOrderFieldDirectionField( - val: FileVersionsOrderFieldDirectionField +export function serializeFileVersionsOrderDirectionField( + val: FileVersionsOrderDirectionField ): SerializedData { return val; } -export function deserializeFileVersionsOrderFieldDirectionField( +export function deserializeFileVersionsOrderDirectionField( val: any -): FileVersionsOrderFieldDirectionField { +): FileVersionsOrderDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "FileVersionsOrderFieldDirectionField"'; + throw 'Expecting a string for "FileVersionsOrderDirectionField"'; } if (val == 'ASC') { return 'ASC'; @@ -9933,17 +9900,17 @@ export function serializeFileVersionsOrderField( ['direction']: val.direction == void 0 ? void 0 - : serializeFileVersionsOrderFieldDirectionField(val.direction), + : serializeFileVersionsOrderDirectionField(val.direction), }; } export function deserializeFileVersionsOrderField( val: any ): FileVersionsOrderField { const by: undefined | string = val.by == void 0 ? void 0 : val.by; - const direction: undefined | FileVersionsOrderFieldDirectionField = + const direction: undefined | FileVersionsOrderDirectionField = val.direction == void 0 ? void 0 - : deserializeFileVersionsOrderFieldDirectionField(val.direction); + : deserializeFileVersionsOrderDirectionField(val.direction); return { by: by, direction: direction } satisfies FileVersionsOrderField; } export function serializeFileVersions(val: FileVersions): SerializedData { @@ -10124,16 +10091,16 @@ export function deserializeFilePathCollectionField( entries: entries, } satisfies FilePathCollectionField; } -export function serializeFileSharedLinkFieldAccessField( - val: FileSharedLinkFieldAccessField +export function serializeFileSharedLinkAccessField( + val: FileSharedLinkAccessField ): SerializedData { return val; } -export function deserializeFileSharedLinkFieldAccessField( +export function deserializeFileSharedLinkAccessField( val: any -): FileSharedLinkFieldAccessField { +): FileSharedLinkAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "FileSharedLinkFieldAccessField"'; + throw 'Expecting a string for "FileSharedLinkAccessField"'; } if (val == 'open') { return 'open'; @@ -10146,16 +10113,16 @@ export function deserializeFileSharedLinkFieldAccessField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeFileSharedLinkFieldEffectiveAccessField( - val: FileSharedLinkFieldEffectiveAccessField +export function serializeFileSharedLinkEffectiveAccessField( + val: FileSharedLinkEffectiveAccessField ): SerializedData { return val; } -export function deserializeFileSharedLinkFieldEffectiveAccessField( +export function deserializeFileSharedLinkEffectiveAccessField( val: any -): FileSharedLinkFieldEffectiveAccessField { +): FileSharedLinkEffectiveAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "FileSharedLinkFieldEffectiveAccessField"'; + throw 'Expecting a string for "FileSharedLinkEffectiveAccessField"'; } if (val == 'open') { return 'open'; @@ -10168,16 +10135,16 @@ export function deserializeFileSharedLinkFieldEffectiveAccessField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeFileSharedLinkFieldEffectivePermissionField( - val: FileSharedLinkFieldEffectivePermissionField +export function serializeFileSharedLinkEffectivePermissionField( + val: FileSharedLinkEffectivePermissionField ): SerializedData { return val; } -export function deserializeFileSharedLinkFieldEffectivePermissionField( +export function deserializeFileSharedLinkEffectivePermissionField( val: any -): FileSharedLinkFieldEffectivePermissionField { +): FileSharedLinkEffectivePermissionField { if (!sdIsString(val)) { - throw 'Expecting a string for "FileSharedLinkFieldEffectivePermissionField"'; + throw 'Expecting a string for "FileSharedLinkEffectivePermissionField"'; } if (val == 'can_edit') { return 'can_edit'; @@ -10193,8 +10160,8 @@ export function deserializeFileSharedLinkFieldEffectivePermissionField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeFileSharedLinkFieldPermissionsField( - val: FileSharedLinkFieldPermissionsField +export function serializeFileSharedLinkPermissionsField( + val: FileSharedLinkPermissionsField ): SerializedData { return { ['can_download']: val.canDownload, @@ -10202,9 +10169,9 @@ export function serializeFileSharedLinkFieldPermissionsField( ['can_edit']: val.canEdit, }; } -export function deserializeFileSharedLinkFieldPermissionsField( +export function deserializeFileSharedLinkPermissionsField( val: any -): FileSharedLinkFieldPermissionsField { +): FileSharedLinkPermissionsField { const canDownload: boolean = val.can_download; const canPreview: boolean = val.can_preview; const canEdit: boolean = val.can_edit; @@ -10212,7 +10179,7 @@ export function deserializeFileSharedLinkFieldPermissionsField( canDownload: canDownload, canPreview: canPreview, canEdit: canEdit, - } satisfies FileSharedLinkFieldPermissionsField; + } satisfies FileSharedLinkPermissionsField; } export function serializeFileSharedLinkField( val: FileSharedLinkField @@ -10225,20 +10192,19 @@ export function serializeFileSharedLinkField( ['access']: val.access == void 0 ? void 0 - : serializeFileSharedLinkFieldAccessField(val.access), - ['effective_access']: serializeFileSharedLinkFieldEffectiveAccessField( + : serializeFileSharedLinkAccessField(val.access), + ['effective_access']: serializeFileSharedLinkEffectiveAccessField( val.effectiveAccess ), - ['effective_permission']: - serializeFileSharedLinkFieldEffectivePermissionField( - val.effectivePermission - ), + ['effective_permission']: serializeFileSharedLinkEffectivePermissionField( + val.effectivePermission + ), ['unshared_at']: val.unsharedAt == void 0 ? void 0 : val.unsharedAt, ['is_password_enabled']: val.isPasswordEnabled, ['permissions']: val.permissions == void 0 ? void 0 - : serializeFileSharedLinkFieldPermissionsField(val.permissions), + : serializeFileSharedLinkPermissionsField(val.permissions), ['download_count']: val.downloadCount, ['preview_count']: val.previewCount, }; @@ -10251,23 +10217,21 @@ export function deserializeFileSharedLinkField(val: any): FileSharedLinkField { val.vanity_url == void 0 ? void 0 : val.vanity_url; const vanityName: undefined | string = val.vanity_name == void 0 ? void 0 : val.vanity_name; - const access: undefined | FileSharedLinkFieldAccessField = + const access: undefined | FileSharedLinkAccessField = val.access == void 0 ? void 0 - : deserializeFileSharedLinkFieldAccessField(val.access); - const effectiveAccess: FileSharedLinkFieldEffectiveAccessField = - deserializeFileSharedLinkFieldEffectiveAccessField(val.effective_access); - const effectivePermission: FileSharedLinkFieldEffectivePermissionField = - deserializeFileSharedLinkFieldEffectivePermissionField( - val.effective_permission - ); + : deserializeFileSharedLinkAccessField(val.access); + const effectiveAccess: FileSharedLinkEffectiveAccessField = + deserializeFileSharedLinkEffectiveAccessField(val.effective_access); + const effectivePermission: FileSharedLinkEffectivePermissionField = + deserializeFileSharedLinkEffectivePermissionField(val.effective_permission); const unsharedAt: undefined | string = val.unshared_at == void 0 ? void 0 : val.unshared_at; const isPasswordEnabled: boolean = val.is_password_enabled; - const permissions: undefined | FileSharedLinkFieldPermissionsField = + const permissions: undefined | FileSharedLinkPermissionsField = val.permissions == void 0 ? void 0 - : deserializeFileSharedLinkFieldPermissionsField(val.permissions); + : deserializeFileSharedLinkPermissionsField(val.permissions); const downloadCount: number = val.download_count; const previewCount: number = val.preview_count; return { @@ -10480,32 +10444,32 @@ export function deserializeFileFullPermissionsField( canViewAnnotationsSelf: canViewAnnotationsSelf, } satisfies FileFullPermissionsField; } -export function serializeFileFullLockFieldTypeField( - val: FileFullLockFieldTypeField +export function serializeFileFullLockTypeField( + val: FileFullLockTypeField ): SerializedData { return val; } -export function deserializeFileFullLockFieldTypeField( +export function deserializeFileFullLockTypeField( val: any -): FileFullLockFieldTypeField { +): FileFullLockTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "FileFullLockFieldTypeField"'; + throw 'Expecting a string for "FileFullLockTypeField"'; } if (val == 'lock') { return 'lock'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeFileFullLockFieldAppTypeField( - val: FileFullLockFieldAppTypeField +export function serializeFileFullLockAppTypeField( + val: FileFullLockAppTypeField ): SerializedData { return val; } -export function deserializeFileFullLockFieldAppTypeField( +export function deserializeFileFullLockAppTypeField( val: any -): FileFullLockFieldAppTypeField { +): FileFullLockAppTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "FileFullLockFieldAppTypeField"'; + throw 'Expecting a string for "FileFullLockAppTypeField"'; } if (val == 'gsuite') { return 'gsuite'; @@ -10527,9 +10491,7 @@ export function serializeFileFullLockField( return { ['id']: val.id == void 0 ? void 0 : val.id, ['type']: - val.type == void 0 - ? void 0 - : serializeFileFullLockFieldTypeField(val.type), + val.type == void 0 ? void 0 : serializeFileFullLockTypeField(val.type), ['created_by']: val.createdBy == void 0 ? void 0 : serializeUserMini(val.createdBy), ['created_at']: val.createdAt == void 0 ? void 0 : val.createdAt, @@ -10539,15 +10501,13 @@ export function serializeFileFullLockField( ['app_type']: val.appType == void 0 ? void 0 - : serializeFileFullLockFieldAppTypeField(val.appType), + : serializeFileFullLockAppTypeField(val.appType), }; } export function deserializeFileFullLockField(val: any): FileFullLockField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: undefined | FileFullLockFieldTypeField = - val.type == void 0 - ? void 0 - : deserializeFileFullLockFieldTypeField(val.type); + const type: undefined | FileFullLockTypeField = + val.type == void 0 ? void 0 : deserializeFileFullLockTypeField(val.type); const createdBy: undefined | UserMini = val.created_by == void 0 ? void 0 : deserializeUserMini(val.created_by); const createdAt: undefined | string = @@ -10556,10 +10516,10 @@ export function deserializeFileFullLockField(val: any): FileFullLockField { val.expired_at == void 0 ? void 0 : val.expired_at; const isDownloadPrevented: undefined | boolean = val.is_download_prevented == void 0 ? void 0 : val.is_download_prevented; - const appType: undefined | FileFullLockFieldAppTypeField = + const appType: undefined | FileFullLockAppTypeField = val.app_type == void 0 ? void 0 - : deserializeFileFullLockFieldAppTypeField(val.app_type); + : deserializeFileFullLockAppTypeField(val.app_type); return { id: id, type: type, @@ -10570,16 +10530,16 @@ export function deserializeFileFullLockField(val: any): FileFullLockField { appType: appType, } satisfies FileFullLockField; } -export function serializeFileFullExpiringEmbedLinkFieldTokenTypeField( - val: FileFullExpiringEmbedLinkFieldTokenTypeField +export function serializeFileFullExpiringEmbedLinkTokenTypeField( + val: FileFullExpiringEmbedLinkTokenTypeField ): SerializedData { return val; } -export function deserializeFileFullExpiringEmbedLinkFieldTokenTypeField( +export function deserializeFileFullExpiringEmbedLinkTokenTypeField( val: any -): FileFullExpiringEmbedLinkFieldTokenTypeField { +): FileFullExpiringEmbedLinkTokenTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "FileFullExpiringEmbedLinkFieldTokenTypeField"'; + throw 'Expecting a string for "FileFullExpiringEmbedLinkTokenTypeField"'; } if (val == 'bearer') { return 'bearer'; @@ -10595,7 +10555,7 @@ export function serializeFileFullExpiringEmbedLinkField( ['token_type']: val.tokenType == void 0 ? void 0 - : serializeFileFullExpiringEmbedLinkFieldTokenTypeField(val.tokenType), + : serializeFileFullExpiringEmbedLinkTokenTypeField(val.tokenType), ['restricted_to']: val.restrictedTo == void 0 ? void 0 @@ -10612,10 +10572,10 @@ export function deserializeFileFullExpiringEmbedLinkField( val.access_token == void 0 ? void 0 : val.access_token; const expiresIn: undefined | number = val.expires_in == void 0 ? void 0 : val.expires_in; - const tokenType: undefined | FileFullExpiringEmbedLinkFieldTokenTypeField = + const tokenType: undefined | FileFullExpiringEmbedLinkTokenTypeField = val.token_type == void 0 ? void 0 - : deserializeFileFullExpiringEmbedLinkFieldTokenTypeField(val.token_type); + : deserializeFileFullExpiringEmbedLinkTokenTypeField(val.token_type); const restrictedTo: undefined | readonly FileScope[] = val.restricted_to == void 0 ? void 0 @@ -10699,37 +10659,35 @@ export function deserializeFileFullMetadataField( } = val == void 0 ? void 0 : val; return { extraData: extraData } satisfies FileFullMetadataField; } -export function serializeFileFullRepresentationsFieldEntriesFieldContentField( - val: FileFullRepresentationsFieldEntriesFieldContentField +export function serializeFileFullRepresentationsEntriesContentField( + val: FileFullRepresentationsEntriesContentField ): SerializedData { return { ['url_template']: val.urlTemplate == void 0 ? void 0 : val.urlTemplate, }; } -export function deserializeFileFullRepresentationsFieldEntriesFieldContentField( +export function deserializeFileFullRepresentationsEntriesContentField( val: any -): FileFullRepresentationsFieldEntriesFieldContentField { +): FileFullRepresentationsEntriesContentField { const urlTemplate: undefined | string = val.url_template == void 0 ? void 0 : val.url_template; return { urlTemplate: urlTemplate, - } satisfies FileFullRepresentationsFieldEntriesFieldContentField; + } satisfies FileFullRepresentationsEntriesContentField; } -export function serializeFileFullRepresentationsFieldEntriesFieldInfoField( - val: FileFullRepresentationsFieldEntriesFieldInfoField +export function serializeFileFullRepresentationsEntriesInfoField( + val: FileFullRepresentationsEntriesInfoField ): SerializedData { return { ['url']: val.url == void 0 ? void 0 : val.url }; } -export function deserializeFileFullRepresentationsFieldEntriesFieldInfoField( +export function deserializeFileFullRepresentationsEntriesInfoField( val: any -): FileFullRepresentationsFieldEntriesFieldInfoField { +): FileFullRepresentationsEntriesInfoField { const url: undefined | string = val.url == void 0 ? void 0 : val.url; - return { - url: url, - } satisfies FileFullRepresentationsFieldEntriesFieldInfoField; + return { url: url } satisfies FileFullRepresentationsEntriesInfoField; } -export function serializeFileFullRepresentationsFieldEntriesFieldPropertiesField( - val: FileFullRepresentationsFieldEntriesFieldPropertiesField +export function serializeFileFullRepresentationsEntriesPropertiesField( + val: FileFullRepresentationsEntriesPropertiesField ): SerializedData { return { ['dimensions']: val.dimensions == void 0 ? void 0 : val.dimensions, @@ -10737,9 +10695,9 @@ export function serializeFileFullRepresentationsFieldEntriesFieldPropertiesField ['thumb']: val.thumb == void 0 ? void 0 : val.thumb, }; } -export function deserializeFileFullRepresentationsFieldEntriesFieldPropertiesField( +export function deserializeFileFullRepresentationsEntriesPropertiesField( val: any -): FileFullRepresentationsFieldEntriesFieldPropertiesField { +): FileFullRepresentationsEntriesPropertiesField { const dimensions: undefined | string = val.dimensions == void 0 ? void 0 : val.dimensions; const paged: undefined | boolean = val.paged == void 0 ? void 0 : val.paged; @@ -10748,18 +10706,18 @@ export function deserializeFileFullRepresentationsFieldEntriesFieldPropertiesFie dimensions: dimensions, paged: paged, thumb: thumb, - } satisfies FileFullRepresentationsFieldEntriesFieldPropertiesField; + } satisfies FileFullRepresentationsEntriesPropertiesField; } -export function serializeFileFullRepresentationsFieldEntriesFieldStatusFieldStateField( - val: FileFullRepresentationsFieldEntriesFieldStatusFieldStateField +export function serializeFileFullRepresentationsEntriesStatusStateField( + val: FileFullRepresentationsEntriesStatusStateField ): SerializedData { return val; } -export function deserializeFileFullRepresentationsFieldEntriesFieldStatusFieldStateField( +export function deserializeFileFullRepresentationsEntriesStatusStateField( val: any -): FileFullRepresentationsFieldEntriesFieldStatusFieldStateField { +): FileFullRepresentationsEntriesStatusStateField { if (!sdIsString(val)) { - throw 'Expecting a string for "FileFullRepresentationsFieldEntriesFieldStatusFieldStateField"'; + throw 'Expecting a string for "FileFullRepresentationsEntriesStatusStateField"'; } if (val == 'success') { return 'success'; @@ -10775,51 +10733,41 @@ export function deserializeFileFullRepresentationsFieldEntriesFieldStatusFieldSt } throw ''.concat('Invalid value: ', val) as string; } -export function serializeFileFullRepresentationsFieldEntriesFieldStatusField( - val: FileFullRepresentationsFieldEntriesFieldStatusField +export function serializeFileFullRepresentationsEntriesStatusField( + val: FileFullRepresentationsEntriesStatusField ): SerializedData { return { ['state']: val.state == void 0 ? void 0 - : serializeFileFullRepresentationsFieldEntriesFieldStatusFieldStateField( - val.state - ), + : serializeFileFullRepresentationsEntriesStatusStateField(val.state), }; } -export function deserializeFileFullRepresentationsFieldEntriesFieldStatusField( +export function deserializeFileFullRepresentationsEntriesStatusField( val: any -): FileFullRepresentationsFieldEntriesFieldStatusField { - const state: - | undefined - | FileFullRepresentationsFieldEntriesFieldStatusFieldStateField = +): FileFullRepresentationsEntriesStatusField { + const state: undefined | FileFullRepresentationsEntriesStatusStateField = val.state == void 0 ? void 0 - : deserializeFileFullRepresentationsFieldEntriesFieldStatusFieldStateField( - val.state - ); - return { - state: state, - } satisfies FileFullRepresentationsFieldEntriesFieldStatusField; + : deserializeFileFullRepresentationsEntriesStatusStateField(val.state); + return { state: state } satisfies FileFullRepresentationsEntriesStatusField; } -export function serializeFileFullRepresentationsFieldEntriesField( - val: FileFullRepresentationsFieldEntriesField +export function serializeFileFullRepresentationsEntriesField( + val: FileFullRepresentationsEntriesField ): SerializedData { return { ['content']: val.content == void 0 ? void 0 - : serializeFileFullRepresentationsFieldEntriesFieldContentField( - val.content - ), + : serializeFileFullRepresentationsEntriesContentField(val.content), ['info']: val.info == void 0 ? void 0 - : serializeFileFullRepresentationsFieldEntriesFieldInfoField(val.info), + : serializeFileFullRepresentationsEntriesInfoField(val.info), ['properties']: val.properties == void 0 ? void 0 - : serializeFileFullRepresentationsFieldEntriesFieldPropertiesField( + : serializeFileFullRepresentationsEntriesPropertiesField( val.properties ), ['representation']: @@ -10827,51 +10775,39 @@ export function serializeFileFullRepresentationsFieldEntriesField( ['status']: val.status == void 0 ? void 0 - : serializeFileFullRepresentationsFieldEntriesFieldStatusField( - val.status - ), + : serializeFileFullRepresentationsEntriesStatusField(val.status), }; } -export function deserializeFileFullRepresentationsFieldEntriesField( +export function deserializeFileFullRepresentationsEntriesField( val: any -): FileFullRepresentationsFieldEntriesField { - const content: - | undefined - | FileFullRepresentationsFieldEntriesFieldContentField = +): FileFullRepresentationsEntriesField { + const content: undefined | FileFullRepresentationsEntriesContentField = val.content == void 0 ? void 0 - : deserializeFileFullRepresentationsFieldEntriesFieldContentField( - val.content - ); - const info: undefined | FileFullRepresentationsFieldEntriesFieldInfoField = + : deserializeFileFullRepresentationsEntriesContentField(val.content); + const info: undefined | FileFullRepresentationsEntriesInfoField = val.info == void 0 ? void 0 - : deserializeFileFullRepresentationsFieldEntriesFieldInfoField(val.info); - const properties: - | undefined - | FileFullRepresentationsFieldEntriesFieldPropertiesField = + : deserializeFileFullRepresentationsEntriesInfoField(val.info); + const properties: undefined | FileFullRepresentationsEntriesPropertiesField = val.properties == void 0 ? void 0 - : deserializeFileFullRepresentationsFieldEntriesFieldPropertiesField( + : deserializeFileFullRepresentationsEntriesPropertiesField( val.properties ); const representation: undefined | string = val.representation == void 0 ? void 0 : val.representation; - const status: - | undefined - | FileFullRepresentationsFieldEntriesFieldStatusField = + const status: undefined | FileFullRepresentationsEntriesStatusField = val.status == void 0 ? void 0 - : deserializeFileFullRepresentationsFieldEntriesFieldStatusField( - val.status - ); + : deserializeFileFullRepresentationsEntriesStatusField(val.status); return { content: content, info: info, properties: properties, representation: representation, status: status, - } satisfies FileFullRepresentationsFieldEntriesField; + } satisfies FileFullRepresentationsEntriesField; } export function serializeFileFullRepresentationsField( val: FileFullRepresentationsField @@ -10881,23 +10817,21 @@ export function serializeFileFullRepresentationsField( val.entries == void 0 ? void 0 : (val.entries.map(function ( - item: FileFullRepresentationsFieldEntriesField + item: FileFullRepresentationsEntriesField ): any { - return serializeFileFullRepresentationsFieldEntriesField(item); + return serializeFileFullRepresentationsEntriesField(item); }) as readonly any[]), }; } export function deserializeFileFullRepresentationsField( val: any ): FileFullRepresentationsField { - const entries: - | undefined - | readonly FileFullRepresentationsFieldEntriesField[] = + const entries: undefined | readonly FileFullRepresentationsEntriesField[] = val.entries == void 0 ? void 0 : sdIsList(val.entries) ? (val.entries.map(function (itm: SerializedData): any { - return deserializeFileFullRepresentationsFieldEntriesField(itm); + return deserializeFileFullRepresentationsEntriesField(itm); }) as readonly any[]) : []; return { entries: entries } satisfies FileFullRepresentationsField; @@ -11258,32 +11192,32 @@ export function deserializeDevicePinner(val: any): DevicePinner { productName: productName, } satisfies DevicePinner; } -export function serializeDevicePinnersOrderFieldByField( - val: DevicePinnersOrderFieldByField +export function serializeDevicePinnersOrderByField( + val: DevicePinnersOrderByField ): SerializedData { return val; } -export function deserializeDevicePinnersOrderFieldByField( +export function deserializeDevicePinnersOrderByField( val: any -): DevicePinnersOrderFieldByField { +): DevicePinnersOrderByField { if (!sdIsString(val)) { - throw 'Expecting a string for "DevicePinnersOrderFieldByField"'; + throw 'Expecting a string for "DevicePinnersOrderByField"'; } if (val == 'id') { return 'id'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeDevicePinnersOrderFieldDirectionField( - val: DevicePinnersOrderFieldDirectionField +export function serializeDevicePinnersOrderDirectionField( + val: DevicePinnersOrderDirectionField ): SerializedData { return val; } -export function deserializeDevicePinnersOrderFieldDirectionField( +export function deserializeDevicePinnersOrderDirectionField( val: any -): DevicePinnersOrderFieldDirectionField { +): DevicePinnersOrderDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "DevicePinnersOrderFieldDirectionField"'; + throw 'Expecting a string for "DevicePinnersOrderDirectionField"'; } if (val == 'asc') { return 'asc'; @@ -11298,26 +11232,22 @@ export function serializeDevicePinnersOrderField( ): SerializedData { return { ['by']: - val.by == void 0 - ? void 0 - : serializeDevicePinnersOrderFieldByField(val.by), + val.by == void 0 ? void 0 : serializeDevicePinnersOrderByField(val.by), ['direction']: val.direction == void 0 ? void 0 - : serializeDevicePinnersOrderFieldDirectionField(val.direction), + : serializeDevicePinnersOrderDirectionField(val.direction), }; } export function deserializeDevicePinnersOrderField( val: any ): DevicePinnersOrderField { - const by: undefined | DevicePinnersOrderFieldByField = - val.by == void 0 - ? void 0 - : deserializeDevicePinnersOrderFieldByField(val.by); - const direction: undefined | DevicePinnersOrderFieldDirectionField = + const by: undefined | DevicePinnersOrderByField = + val.by == void 0 ? void 0 : deserializeDevicePinnersOrderByField(val.by); + const direction: undefined | DevicePinnersOrderDirectionField = val.direction == void 0 ? void 0 - : deserializeDevicePinnersOrderFieldDirectionField(val.direction); + : deserializeDevicePinnersOrderDirectionField(val.direction); return { by: by, direction: direction } satisfies DevicePinnersOrderField; } export function serializeDevicePinners(val: DevicePinners): SerializedData { @@ -11468,16 +11398,16 @@ export function deserializeCommentFull(val: any): CommentFull { type: type, } satisfies CommentFull; } -export function serializeCommentsOrderFieldDirectionField( - val: CommentsOrderFieldDirectionField +export function serializeCommentsOrderDirectionField( + val: CommentsOrderDirectionField ): SerializedData { return val; } -export function deserializeCommentsOrderFieldDirectionField( +export function deserializeCommentsOrderDirectionField( val: any -): CommentsOrderFieldDirectionField { +): CommentsOrderDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "CommentsOrderFieldDirectionField"'; + throw 'Expecting a string for "CommentsOrderDirectionField"'; } if (val == 'ASC') { return 'ASC'; @@ -11495,15 +11425,15 @@ export function serializeCommentsOrderField( ['direction']: val.direction == void 0 ? void 0 - : serializeCommentsOrderFieldDirectionField(val.direction), + : serializeCommentsOrderDirectionField(val.direction), }; } export function deserializeCommentsOrderField(val: any): CommentsOrderField { const by: undefined | string = val.by == void 0 ? void 0 : val.by; - const direction: undefined | CommentsOrderFieldDirectionField = + const direction: undefined | CommentsOrderDirectionField = val.direction == void 0 ? void 0 - : deserializeCommentsOrderFieldDirectionField(val.direction); + : deserializeCommentsOrderDirectionField(val.direction); return { by: by, direction: direction } satisfies CommentsOrderField; } export function serializeComments(val: Comments): SerializedData { @@ -11570,16 +11500,16 @@ export function deserializeCollaborationAllowlistExemptTargetTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCollaborationAllowlistExemptTargetEnterpriseFieldTypeField( - val: CollaborationAllowlistExemptTargetEnterpriseFieldTypeField +export function serializeCollaborationAllowlistExemptTargetEnterpriseTypeField( + val: CollaborationAllowlistExemptTargetEnterpriseTypeField ): SerializedData { return val; } -export function deserializeCollaborationAllowlistExemptTargetEnterpriseFieldTypeField( +export function deserializeCollaborationAllowlistExemptTargetEnterpriseTypeField( val: any -): CollaborationAllowlistExemptTargetEnterpriseFieldTypeField { +): CollaborationAllowlistExemptTargetEnterpriseTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CollaborationAllowlistExemptTargetEnterpriseFieldTypeField"'; + throw 'Expecting a string for "CollaborationAllowlistExemptTargetEnterpriseTypeField"'; } if (val == 'enterprise') { return 'enterprise'; @@ -11594,7 +11524,7 @@ export function serializeCollaborationAllowlistExemptTargetEnterpriseField( ['type']: val.type == void 0 ? void 0 - : serializeCollaborationAllowlistExemptTargetEnterpriseFieldTypeField( + : serializeCollaborationAllowlistExemptTargetEnterpriseTypeField( val.type ), ['name']: val.name == void 0 ? void 0 : val.name, @@ -11606,10 +11536,10 @@ export function deserializeCollaborationAllowlistExemptTargetEnterpriseField( const id: undefined | string = val.id == void 0 ? void 0 : val.id; const type: | undefined - | CollaborationAllowlistExemptTargetEnterpriseFieldTypeField = + | CollaborationAllowlistExemptTargetEnterpriseTypeField = val.type == void 0 ? void 0 - : deserializeCollaborationAllowlistExemptTargetEnterpriseFieldTypeField( + : deserializeCollaborationAllowlistExemptTargetEnterpriseTypeField( val.type ); const name: undefined | string = val.name == void 0 ? void 0 : val.name; @@ -11844,16 +11774,16 @@ export function deserializeShieldInformationBarrierSegmentMemberMini( type: type, } satisfies ShieldInformationBarrierSegmentMemberMini; } -export function serializeShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentFieldTypeField( - val: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentFieldTypeField +export function serializeShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentTypeField( + val: ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentTypeField ): SerializedData { return val; } -export function deserializeShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentFieldTypeField( +export function deserializeShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentTypeField( val: any -): ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentFieldTypeField { +): ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentFieldTypeField"'; + throw 'Expecting a string for "ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentTypeField"'; } if (val == 'shield_information_barrier_segment') { return 'shield_information_barrier_segment'; @@ -11868,7 +11798,7 @@ export function serializeShieldInformationBarrierSegmentMemberShieldInformationB ['type']: val.type == void 0 ? void 0 - : serializeShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentFieldTypeField( + : serializeShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentTypeField( val.type ), }; @@ -11879,10 +11809,10 @@ export function deserializeShieldInformationBarrierSegmentMemberShieldInformatio const id: undefined | string = val.id == void 0 ? void 0 : val.id; const type: | undefined - | ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentFieldTypeField = + | ShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentTypeField = val.type == void 0 ? void 0 - : deserializeShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentFieldTypeField( + : deserializeShieldInformationBarrierSegmentMemberShieldInformationBarrierSegmentTypeField( val.type ); return { @@ -12390,16 +12320,16 @@ export function deserializeWebhookMiniTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeWebhookMiniTargetFieldTypeField( - val: WebhookMiniTargetFieldTypeField +export function serializeWebhookMiniTargetTypeField( + val: WebhookMiniTargetTypeField ): SerializedData { return val; } -export function deserializeWebhookMiniTargetFieldTypeField( +export function deserializeWebhookMiniTargetTypeField( val: any -): WebhookMiniTargetFieldTypeField { +): WebhookMiniTargetTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "WebhookMiniTargetFieldTypeField"'; + throw 'Expecting a string for "WebhookMiniTargetTypeField"'; } if (val == 'file') { return 'file'; @@ -12417,17 +12347,17 @@ export function serializeWebhookMiniTargetField( ['type']: val.type == void 0 ? void 0 - : serializeWebhookMiniTargetFieldTypeField(val.type), + : serializeWebhookMiniTargetTypeField(val.type), }; } export function deserializeWebhookMiniTargetField( val: any ): WebhookMiniTargetField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: undefined | WebhookMiniTargetFieldTypeField = + const type: undefined | WebhookMiniTargetTypeField = val.type == void 0 ? void 0 - : deserializeWebhookMiniTargetFieldTypeField(val.type); + : deserializeWebhookMiniTargetTypeField(val.type); return { id: id, type: type } satisfies WebhookMiniTargetField; } export function serializeWebhookMini(val: WebhookMini): SerializedData { @@ -12755,16 +12685,16 @@ export function deserializeWebLinkPathCollectionField( entries: entries, } satisfies WebLinkPathCollectionField; } -export function serializeWebLinkSharedLinkFieldAccessField( - val: WebLinkSharedLinkFieldAccessField +export function serializeWebLinkSharedLinkAccessField( + val: WebLinkSharedLinkAccessField ): SerializedData { return val; } -export function deserializeWebLinkSharedLinkFieldAccessField( +export function deserializeWebLinkSharedLinkAccessField( val: any -): WebLinkSharedLinkFieldAccessField { +): WebLinkSharedLinkAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "WebLinkSharedLinkFieldAccessField"'; + throw 'Expecting a string for "WebLinkSharedLinkAccessField"'; } if (val == 'open') { return 'open'; @@ -12777,16 +12707,16 @@ export function deserializeWebLinkSharedLinkFieldAccessField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeWebLinkSharedLinkFieldEffectiveAccessField( - val: WebLinkSharedLinkFieldEffectiveAccessField +export function serializeWebLinkSharedLinkEffectiveAccessField( + val: WebLinkSharedLinkEffectiveAccessField ): SerializedData { return val; } -export function deserializeWebLinkSharedLinkFieldEffectiveAccessField( +export function deserializeWebLinkSharedLinkEffectiveAccessField( val: any -): WebLinkSharedLinkFieldEffectiveAccessField { +): WebLinkSharedLinkEffectiveAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "WebLinkSharedLinkFieldEffectiveAccessField"'; + throw 'Expecting a string for "WebLinkSharedLinkEffectiveAccessField"'; } if (val == 'open') { return 'open'; @@ -12799,16 +12729,16 @@ export function deserializeWebLinkSharedLinkFieldEffectiveAccessField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeWebLinkSharedLinkFieldEffectivePermissionField( - val: WebLinkSharedLinkFieldEffectivePermissionField +export function serializeWebLinkSharedLinkEffectivePermissionField( + val: WebLinkSharedLinkEffectivePermissionField ): SerializedData { return val; } -export function deserializeWebLinkSharedLinkFieldEffectivePermissionField( +export function deserializeWebLinkSharedLinkEffectivePermissionField( val: any -): WebLinkSharedLinkFieldEffectivePermissionField { +): WebLinkSharedLinkEffectivePermissionField { if (!sdIsString(val)) { - throw 'Expecting a string for "WebLinkSharedLinkFieldEffectivePermissionField"'; + throw 'Expecting a string for "WebLinkSharedLinkEffectivePermissionField"'; } if (val == 'can_edit') { return 'can_edit'; @@ -12824,8 +12754,8 @@ export function deserializeWebLinkSharedLinkFieldEffectivePermissionField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeWebLinkSharedLinkFieldPermissionsField( - val: WebLinkSharedLinkFieldPermissionsField +export function serializeWebLinkSharedLinkPermissionsField( + val: WebLinkSharedLinkPermissionsField ): SerializedData { return { ['can_download']: val.canDownload, @@ -12833,9 +12763,9 @@ export function serializeWebLinkSharedLinkFieldPermissionsField( ['can_edit']: val.canEdit, }; } -export function deserializeWebLinkSharedLinkFieldPermissionsField( +export function deserializeWebLinkSharedLinkPermissionsField( val: any -): WebLinkSharedLinkFieldPermissionsField { +): WebLinkSharedLinkPermissionsField { const canDownload: boolean = val.can_download; const canPreview: boolean = val.can_preview; const canEdit: boolean = val.can_edit; @@ -12843,7 +12773,7 @@ export function deserializeWebLinkSharedLinkFieldPermissionsField( canDownload: canDownload, canPreview: canPreview, canEdit: canEdit, - } satisfies WebLinkSharedLinkFieldPermissionsField; + } satisfies WebLinkSharedLinkPermissionsField; } export function serializeWebLinkSharedLinkField( val: WebLinkSharedLinkField @@ -12856,12 +12786,12 @@ export function serializeWebLinkSharedLinkField( ['access']: val.access == void 0 ? void 0 - : serializeWebLinkSharedLinkFieldAccessField(val.access), - ['effective_access']: serializeWebLinkSharedLinkFieldEffectiveAccessField( + : serializeWebLinkSharedLinkAccessField(val.access), + ['effective_access']: serializeWebLinkSharedLinkEffectiveAccessField( val.effectiveAccess ), ['effective_permission']: - serializeWebLinkSharedLinkFieldEffectivePermissionField( + serializeWebLinkSharedLinkEffectivePermissionField( val.effectivePermission ), ['unshared_at']: val.unsharedAt == void 0 ? void 0 : val.unsharedAt, @@ -12869,7 +12799,7 @@ export function serializeWebLinkSharedLinkField( ['permissions']: val.permissions == void 0 ? void 0 - : serializeWebLinkSharedLinkFieldPermissionsField(val.permissions), + : serializeWebLinkSharedLinkPermissionsField(val.permissions), ['download_count']: val.downloadCount, ['preview_count']: val.previewCount, }; @@ -12884,23 +12814,23 @@ export function deserializeWebLinkSharedLinkField( val.vanity_url == void 0 ? void 0 : val.vanity_url; const vanityName: undefined | string = val.vanity_name == void 0 ? void 0 : val.vanity_name; - const access: undefined | WebLinkSharedLinkFieldAccessField = + const access: undefined | WebLinkSharedLinkAccessField = val.access == void 0 ? void 0 - : deserializeWebLinkSharedLinkFieldAccessField(val.access); - const effectiveAccess: WebLinkSharedLinkFieldEffectiveAccessField = - deserializeWebLinkSharedLinkFieldEffectiveAccessField(val.effective_access); - const effectivePermission: WebLinkSharedLinkFieldEffectivePermissionField = - deserializeWebLinkSharedLinkFieldEffectivePermissionField( + : deserializeWebLinkSharedLinkAccessField(val.access); + const effectiveAccess: WebLinkSharedLinkEffectiveAccessField = + deserializeWebLinkSharedLinkEffectiveAccessField(val.effective_access); + const effectivePermission: WebLinkSharedLinkEffectivePermissionField = + deserializeWebLinkSharedLinkEffectivePermissionField( val.effective_permission ); const unsharedAt: undefined | string = val.unshared_at == void 0 ? void 0 : val.unshared_at; const isPasswordEnabled: boolean = val.is_password_enabled; - const permissions: undefined | WebLinkSharedLinkFieldPermissionsField = + const permissions: undefined | WebLinkSharedLinkPermissionsField = val.permissions == void 0 ? void 0 - : deserializeWebLinkSharedLinkFieldPermissionsField(val.permissions); + : deserializeWebLinkSharedLinkPermissionsField(val.permissions); const downloadCount: number = val.download_count; const previewCount: number = val.preview_count; return { @@ -13066,16 +12996,16 @@ export function deserializeFileFullOrFolderMiniOrWebLink( } throw 'unknown type'; } -export function serializeItemsOrderFieldDirectionField( - val: ItemsOrderFieldDirectionField +export function serializeItemsOrderDirectionField( + val: ItemsOrderDirectionField ): SerializedData { return val; } -export function deserializeItemsOrderFieldDirectionField( +export function deserializeItemsOrderDirectionField( val: any -): ItemsOrderFieldDirectionField { +): ItemsOrderDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "ItemsOrderFieldDirectionField"'; + throw 'Expecting a string for "ItemsOrderDirectionField"'; } if (val == 'ASC') { return 'ASC'; @@ -13091,15 +13021,15 @@ export function serializeItemsOrderField(val: ItemsOrderField): SerializedData { ['direction']: val.direction == void 0 ? void 0 - : serializeItemsOrderFieldDirectionField(val.direction), + : serializeItemsOrderDirectionField(val.direction), }; } export function deserializeItemsOrderField(val: any): ItemsOrderField { const by: undefined | string = val.by == void 0 ? void 0 : val.by; - const direction: undefined | ItemsOrderFieldDirectionField = + const direction: undefined | ItemsOrderDirectionField = val.direction == void 0 ? void 0 - : deserializeItemsOrderFieldDirectionField(val.direction); + : deserializeItemsOrderDirectionField(val.direction); return { by: by, direction: direction } satisfies ItemsOrderField; } export function serializeItems(val: Items): SerializedData { @@ -13174,16 +13104,16 @@ export function deserializeFolderPathCollectionField( entries: entries, } satisfies FolderPathCollectionField; } -export function serializeFolderSharedLinkFieldAccessField( - val: FolderSharedLinkFieldAccessField +export function serializeFolderSharedLinkAccessField( + val: FolderSharedLinkAccessField ): SerializedData { return val; } -export function deserializeFolderSharedLinkFieldAccessField( +export function deserializeFolderSharedLinkAccessField( val: any -): FolderSharedLinkFieldAccessField { +): FolderSharedLinkAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "FolderSharedLinkFieldAccessField"'; + throw 'Expecting a string for "FolderSharedLinkAccessField"'; } if (val == 'open') { return 'open'; @@ -13196,16 +13126,16 @@ export function deserializeFolderSharedLinkFieldAccessField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeFolderSharedLinkFieldEffectiveAccessField( - val: FolderSharedLinkFieldEffectiveAccessField +export function serializeFolderSharedLinkEffectiveAccessField( + val: FolderSharedLinkEffectiveAccessField ): SerializedData { return val; } -export function deserializeFolderSharedLinkFieldEffectiveAccessField( +export function deserializeFolderSharedLinkEffectiveAccessField( val: any -): FolderSharedLinkFieldEffectiveAccessField { +): FolderSharedLinkEffectiveAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "FolderSharedLinkFieldEffectiveAccessField"'; + throw 'Expecting a string for "FolderSharedLinkEffectiveAccessField"'; } if (val == 'open') { return 'open'; @@ -13218,16 +13148,16 @@ export function deserializeFolderSharedLinkFieldEffectiveAccessField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeFolderSharedLinkFieldEffectivePermissionField( - val: FolderSharedLinkFieldEffectivePermissionField +export function serializeFolderSharedLinkEffectivePermissionField( + val: FolderSharedLinkEffectivePermissionField ): SerializedData { return val; } -export function deserializeFolderSharedLinkFieldEffectivePermissionField( +export function deserializeFolderSharedLinkEffectivePermissionField( val: any -): FolderSharedLinkFieldEffectivePermissionField { +): FolderSharedLinkEffectivePermissionField { if (!sdIsString(val)) { - throw 'Expecting a string for "FolderSharedLinkFieldEffectivePermissionField"'; + throw 'Expecting a string for "FolderSharedLinkEffectivePermissionField"'; } if (val == 'can_edit') { return 'can_edit'; @@ -13243,8 +13173,8 @@ export function deserializeFolderSharedLinkFieldEffectivePermissionField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeFolderSharedLinkFieldPermissionsField( - val: FolderSharedLinkFieldPermissionsField +export function serializeFolderSharedLinkPermissionsField( + val: FolderSharedLinkPermissionsField ): SerializedData { return { ['can_download']: val.canDownload, @@ -13252,9 +13182,9 @@ export function serializeFolderSharedLinkFieldPermissionsField( ['can_edit']: val.canEdit, }; } -export function deserializeFolderSharedLinkFieldPermissionsField( +export function deserializeFolderSharedLinkPermissionsField( val: any -): FolderSharedLinkFieldPermissionsField { +): FolderSharedLinkPermissionsField { const canDownload: boolean = val.can_download; const canPreview: boolean = val.can_preview; const canEdit: boolean = val.can_edit; @@ -13262,7 +13192,7 @@ export function deserializeFolderSharedLinkFieldPermissionsField( canDownload: canDownload, canPreview: canPreview, canEdit: canEdit, - } satisfies FolderSharedLinkFieldPermissionsField; + } satisfies FolderSharedLinkPermissionsField; } export function serializeFolderSharedLinkField( val: FolderSharedLinkField @@ -13275,20 +13205,19 @@ export function serializeFolderSharedLinkField( ['access']: val.access == void 0 ? void 0 - : serializeFolderSharedLinkFieldAccessField(val.access), - ['effective_access']: serializeFolderSharedLinkFieldEffectiveAccessField( + : serializeFolderSharedLinkAccessField(val.access), + ['effective_access']: serializeFolderSharedLinkEffectiveAccessField( val.effectiveAccess ), - ['effective_permission']: - serializeFolderSharedLinkFieldEffectivePermissionField( - val.effectivePermission - ), + ['effective_permission']: serializeFolderSharedLinkEffectivePermissionField( + val.effectivePermission + ), ['unshared_at']: val.unsharedAt == void 0 ? void 0 : val.unsharedAt, ['is_password_enabled']: val.isPasswordEnabled, ['permissions']: val.permissions == void 0 ? void 0 - : serializeFolderSharedLinkFieldPermissionsField(val.permissions), + : serializeFolderSharedLinkPermissionsField(val.permissions), ['download_count']: val.downloadCount, ['preview_count']: val.previewCount, }; @@ -13303,23 +13232,23 @@ export function deserializeFolderSharedLinkField( val.vanity_url == void 0 ? void 0 : val.vanity_url; const vanityName: undefined | string = val.vanity_name == void 0 ? void 0 : val.vanity_name; - const access: undefined | FolderSharedLinkFieldAccessField = + const access: undefined | FolderSharedLinkAccessField = val.access == void 0 ? void 0 - : deserializeFolderSharedLinkFieldAccessField(val.access); - const effectiveAccess: FolderSharedLinkFieldEffectiveAccessField = - deserializeFolderSharedLinkFieldEffectiveAccessField(val.effective_access); - const effectivePermission: FolderSharedLinkFieldEffectivePermissionField = - deserializeFolderSharedLinkFieldEffectivePermissionField( + : deserializeFolderSharedLinkAccessField(val.access); + const effectiveAccess: FolderSharedLinkEffectiveAccessField = + deserializeFolderSharedLinkEffectiveAccessField(val.effective_access); + const effectivePermission: FolderSharedLinkEffectivePermissionField = + deserializeFolderSharedLinkEffectivePermissionField( val.effective_permission ); const unsharedAt: undefined | string = val.unshared_at == void 0 ? void 0 : val.unshared_at; const isPasswordEnabled: boolean = val.is_password_enabled; - const permissions: undefined | FolderSharedLinkFieldPermissionsField = + const permissions: undefined | FolderSharedLinkPermissionsField = val.permissions == void 0 ? void 0 - : deserializeFolderSharedLinkFieldPermissionsField(val.permissions); + : deserializeFolderSharedLinkPermissionsField(val.permissions); const downloadCount: number = val.download_count; const previewCount: number = val.preview_count; return { @@ -13337,16 +13266,16 @@ export function deserializeFolderSharedLinkField( previewCount: previewCount, } satisfies FolderSharedLinkField; } -export function serializeFolderFolderUploadEmailFieldAccessField( - val: FolderFolderUploadEmailFieldAccessField +export function serializeFolderFolderUploadEmailAccessField( + val: FolderFolderUploadEmailAccessField ): SerializedData { return val; } -export function deserializeFolderFolderUploadEmailFieldAccessField( +export function deserializeFolderFolderUploadEmailAccessField( val: any -): FolderFolderUploadEmailFieldAccessField { +): FolderFolderUploadEmailAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "FolderFolderUploadEmailFieldAccessField"'; + throw 'Expecting a string for "FolderFolderUploadEmailAccessField"'; } if (val == 'open') { return 'open'; @@ -13363,17 +13292,17 @@ export function serializeFolderFolderUploadEmailField( ['access']: val.access == void 0 ? void 0 - : serializeFolderFolderUploadEmailFieldAccessField(val.access), + : serializeFolderFolderUploadEmailAccessField(val.access), ['email']: val.email == void 0 ? void 0 : val.email, }; } export function deserializeFolderFolderUploadEmailField( val: any ): FolderFolderUploadEmailField { - const access: undefined | FolderFolderUploadEmailFieldAccessField = + const access: undefined | FolderFolderUploadEmailAccessField = val.access == void 0 ? void 0 - : deserializeFolderFolderUploadEmailFieldAccessField(val.access); + : deserializeFolderFolderUploadEmailAccessField(val.access); const email: undefined | string = val.email == void 0 ? void 0 : val.email; return { access: access, @@ -14364,8 +14293,8 @@ export function deserializeCollaborationStatusField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCollaborationAcceptanceRequirementsStatusFieldTermsOfServiceRequirementField( - val: CollaborationAcceptanceRequirementsStatusFieldTermsOfServiceRequirementField +export function serializeCollaborationAcceptanceRequirementsStatusTermsOfServiceRequirementField( + val: CollaborationAcceptanceRequirementsStatusTermsOfServiceRequirementField ): SerializedData { return { ['is_accepted']: val.isAccepted == void 0 ? void 0 : val.isAccepted, @@ -14375,9 +14304,9 @@ export function serializeCollaborationAcceptanceRequirementsStatusFieldTermsOfSe : serializeTermsOfServiceBase(val.termsOfService), }; } -export function deserializeCollaborationAcceptanceRequirementsStatusFieldTermsOfServiceRequirementField( +export function deserializeCollaborationAcceptanceRequirementsStatusTermsOfServiceRequirementField( val: any -): CollaborationAcceptanceRequirementsStatusFieldTermsOfServiceRequirementField { +): CollaborationAcceptanceRequirementsStatusTermsOfServiceRequirementField { const isAccepted: undefined | boolean = val.is_accepted == void 0 ? void 0 : val.is_accepted; const termsOfService: undefined | TermsOfServiceBase = @@ -14387,10 +14316,10 @@ export function deserializeCollaborationAcceptanceRequirementsStatusFieldTermsOf return { isAccepted: isAccepted, termsOfService: termsOfService, - } satisfies CollaborationAcceptanceRequirementsStatusFieldTermsOfServiceRequirementField; + } satisfies CollaborationAcceptanceRequirementsStatusTermsOfServiceRequirementField; } -export function serializeCollaborationAcceptanceRequirementsStatusFieldStrongPasswordRequirementField( - val: CollaborationAcceptanceRequirementsStatusFieldStrongPasswordRequirementField +export function serializeCollaborationAcceptanceRequirementsStatusStrongPasswordRequirementField( + val: CollaborationAcceptanceRequirementsStatusStrongPasswordRequirementField ): SerializedData { return { ['enterprise_has_strong_password_required_for_external_users']: @@ -14401,9 +14330,9 @@ export function serializeCollaborationAcceptanceRequirementsStatusFieldStrongPas val.userHasStrongPassword == void 0 ? void 0 : val.userHasStrongPassword, }; } -export function deserializeCollaborationAcceptanceRequirementsStatusFieldStrongPasswordRequirementField( +export function deserializeCollaborationAcceptanceRequirementsStatusStrongPasswordRequirementField( val: any -): CollaborationAcceptanceRequirementsStatusFieldStrongPasswordRequirementField { +): CollaborationAcceptanceRequirementsStatusStrongPasswordRequirementField { const enterpriseHasStrongPasswordRequiredForExternalUsers: | undefined | boolean = @@ -14418,10 +14347,10 @@ export function deserializeCollaborationAcceptanceRequirementsStatusFieldStrongP enterpriseHasStrongPasswordRequiredForExternalUsers: enterpriseHasStrongPasswordRequiredForExternalUsers, userHasStrongPassword: userHasStrongPassword, - } satisfies CollaborationAcceptanceRequirementsStatusFieldStrongPasswordRequirementField; + } satisfies CollaborationAcceptanceRequirementsStatusStrongPasswordRequirementField; } -export function serializeCollaborationAcceptanceRequirementsStatusFieldTwoFactorAuthenticationRequirementField( - val: CollaborationAcceptanceRequirementsStatusFieldTwoFactorAuthenticationRequirementField +export function serializeCollaborationAcceptanceRequirementsStatusTwoFactorAuthenticationRequirementField( + val: CollaborationAcceptanceRequirementsStatusTwoFactorAuthenticationRequirementField ): SerializedData { return { ['enterprise_has_two_factor_auth_enabled']: @@ -14434,9 +14363,9 @@ export function serializeCollaborationAcceptanceRequirementsStatusFieldTwoFactor : val.userHasTwoFactorAuthenticationEnabled, }; } -export function deserializeCollaborationAcceptanceRequirementsStatusFieldTwoFactorAuthenticationRequirementField( +export function deserializeCollaborationAcceptanceRequirementsStatusTwoFactorAuthenticationRequirementField( val: any -): CollaborationAcceptanceRequirementsStatusFieldTwoFactorAuthenticationRequirementField { +): CollaborationAcceptanceRequirementsStatusTwoFactorAuthenticationRequirementField { const enterpriseHasTwoFactorAuthEnabled: undefined | boolean = val.enterprise_has_two_factor_auth_enabled == void 0 ? void 0 @@ -14449,7 +14378,7 @@ export function deserializeCollaborationAcceptanceRequirementsStatusFieldTwoFact enterpriseHasTwoFactorAuthEnabled: enterpriseHasTwoFactorAuthEnabled, userHasTwoFactorAuthenticationEnabled: userHasTwoFactorAuthenticationEnabled, - } satisfies CollaborationAcceptanceRequirementsStatusFieldTwoFactorAuthenticationRequirementField; + } satisfies CollaborationAcceptanceRequirementsStatusTwoFactorAuthenticationRequirementField; } export function serializeCollaborationAcceptanceRequirementsStatusField( val: CollaborationAcceptanceRequirementsStatusField @@ -14458,19 +14387,19 @@ export function serializeCollaborationAcceptanceRequirementsStatusField( ['terms_of_service_requirement']: val.termsOfServiceRequirement == void 0 ? void 0 - : serializeCollaborationAcceptanceRequirementsStatusFieldTermsOfServiceRequirementField( + : serializeCollaborationAcceptanceRequirementsStatusTermsOfServiceRequirementField( val.termsOfServiceRequirement ), ['strong_password_requirement']: val.strongPasswordRequirement == void 0 ? void 0 - : serializeCollaborationAcceptanceRequirementsStatusFieldStrongPasswordRequirementField( + : serializeCollaborationAcceptanceRequirementsStatusStrongPasswordRequirementField( val.strongPasswordRequirement ), ['two_factor_authentication_requirement']: val.twoFactorAuthenticationRequirement == void 0 ? void 0 - : serializeCollaborationAcceptanceRequirementsStatusFieldTwoFactorAuthenticationRequirementField( + : serializeCollaborationAcceptanceRequirementsStatusTwoFactorAuthenticationRequirementField( val.twoFactorAuthenticationRequirement ), }; @@ -14480,26 +14409,26 @@ export function deserializeCollaborationAcceptanceRequirementsStatusField( ): CollaborationAcceptanceRequirementsStatusField { const termsOfServiceRequirement: | undefined - | CollaborationAcceptanceRequirementsStatusFieldTermsOfServiceRequirementField = + | CollaborationAcceptanceRequirementsStatusTermsOfServiceRequirementField = val.terms_of_service_requirement == void 0 ? void 0 - : deserializeCollaborationAcceptanceRequirementsStatusFieldTermsOfServiceRequirementField( + : deserializeCollaborationAcceptanceRequirementsStatusTermsOfServiceRequirementField( val.terms_of_service_requirement ); const strongPasswordRequirement: | undefined - | CollaborationAcceptanceRequirementsStatusFieldStrongPasswordRequirementField = + | CollaborationAcceptanceRequirementsStatusStrongPasswordRequirementField = val.strong_password_requirement == void 0 ? void 0 - : deserializeCollaborationAcceptanceRequirementsStatusFieldStrongPasswordRequirementField( + : deserializeCollaborationAcceptanceRequirementsStatusStrongPasswordRequirementField( val.strong_password_requirement ); const twoFactorAuthenticationRequirement: | undefined - | CollaborationAcceptanceRequirementsStatusFieldTwoFactorAuthenticationRequirementField = + | CollaborationAcceptanceRequirementsStatusTwoFactorAuthenticationRequirementField = val.two_factor_authentication_requirement == void 0 ? void 0 - : deserializeCollaborationAcceptanceRequirementsStatusFieldTwoFactorAuthenticationRequirementField( + : deserializeCollaborationAcceptanceRequirementsStatusTwoFactorAuthenticationRequirementField( val.two_factor_authentication_requirement ); return { @@ -14601,16 +14530,16 @@ export function deserializeCollaboration(val: any): Collaboration { acceptanceRequirementsStatus: acceptanceRequirementsStatus, } satisfies Collaboration; } -export function serializeCollaborationsOrderFieldDirectionField( - val: CollaborationsOrderFieldDirectionField +export function serializeCollaborationsOrderDirectionField( + val: CollaborationsOrderDirectionField ): SerializedData { return val; } -export function deserializeCollaborationsOrderFieldDirectionField( +export function deserializeCollaborationsOrderDirectionField( val: any -): CollaborationsOrderFieldDirectionField { +): CollaborationsOrderDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "CollaborationsOrderFieldDirectionField"'; + throw 'Expecting a string for "CollaborationsOrderDirectionField"'; } if (val == 'ASC') { return 'ASC'; @@ -14628,17 +14557,17 @@ export function serializeCollaborationsOrderField( ['direction']: val.direction == void 0 ? void 0 - : serializeCollaborationsOrderFieldDirectionField(val.direction), + : serializeCollaborationsOrderDirectionField(val.direction), }; } export function deserializeCollaborationsOrderField( val: any ): CollaborationsOrderField { const by: undefined | string = val.by == void 0 ? void 0 : val.by; - const direction: undefined | CollaborationsOrderFieldDirectionField = + const direction: undefined | CollaborationsOrderDirectionField = val.direction == void 0 ? void 0 - : deserializeCollaborationsOrderFieldDirectionField(val.direction); + : deserializeCollaborationsOrderDirectionField(val.direction); return { by: by, direction: direction } satisfies CollaborationsOrderField; } export function serializeCollaborations(val: Collaborations): SerializedData { @@ -14958,16 +14887,16 @@ export function deserializeSkillInvocationTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeSkillInvocationSkillFieldTypeField( - val: SkillInvocationSkillFieldTypeField +export function serializeSkillInvocationSkillTypeField( + val: SkillInvocationSkillTypeField ): SerializedData { return val; } -export function deserializeSkillInvocationSkillFieldTypeField( +export function deserializeSkillInvocationSkillTypeField( val: any -): SkillInvocationSkillFieldTypeField { +): SkillInvocationSkillTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "SkillInvocationSkillFieldTypeField"'; + throw 'Expecting a string for "SkillInvocationSkillTypeField"'; } if (val == 'skill') { return 'skill'; @@ -14982,7 +14911,7 @@ export function serializeSkillInvocationSkillField( ['type']: val.type == void 0 ? void 0 - : serializeSkillInvocationSkillFieldTypeField(val.type), + : serializeSkillInvocationSkillTypeField(val.type), ['name']: val.name == void 0 ? void 0 : val.name, ['api_key']: val.apiKey == void 0 ? void 0 : val.apiKey, }; @@ -14991,10 +14920,10 @@ export function deserializeSkillInvocationSkillField( val: any ): SkillInvocationSkillField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: undefined | SkillInvocationSkillFieldTypeField = + const type: undefined | SkillInvocationSkillTypeField = val.type == void 0 ? void 0 - : deserializeSkillInvocationSkillFieldTypeField(val.type); + : deserializeSkillInvocationSkillTypeField(val.type); const name: undefined | string = val.name == void 0 ? void 0 : val.name; const apiKey: undefined | string = val.api_key == void 0 ? void 0 : val.api_key; @@ -15005,24 +14934,24 @@ export function deserializeSkillInvocationSkillField( apiKey: apiKey, } satisfies SkillInvocationSkillField; } -export function serializeSkillInvocationTokenFieldReadFieldTokenTypeField( - val: SkillInvocationTokenFieldReadFieldTokenTypeField +export function serializeSkillInvocationTokenReadTokenTypeField( + val: SkillInvocationTokenReadTokenTypeField ): SerializedData { return val; } -export function deserializeSkillInvocationTokenFieldReadFieldTokenTypeField( +export function deserializeSkillInvocationTokenReadTokenTypeField( val: any -): SkillInvocationTokenFieldReadFieldTokenTypeField { +): SkillInvocationTokenReadTokenTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "SkillInvocationTokenFieldReadFieldTokenTypeField"'; + throw 'Expecting a string for "SkillInvocationTokenReadTokenTypeField"'; } if (val == 'bearer') { return 'bearer'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeSkillInvocationTokenFieldReadField( - val: SkillInvocationTokenFieldReadField +export function serializeSkillInvocationTokenReadField( + val: SkillInvocationTokenReadField ): SerializedData { return { ['access_token']: val.accessToken == void 0 ? void 0 : val.accessToken, @@ -15030,27 +14959,21 @@ export function serializeSkillInvocationTokenFieldReadField( ['token_type']: val.tokenType == void 0 ? void 0 - : serializeSkillInvocationTokenFieldReadFieldTokenTypeField( - val.tokenType - ), + : serializeSkillInvocationTokenReadTokenTypeField(val.tokenType), ['restricted_to']: val.restrictedTo == void 0 ? void 0 : val.restrictedTo, }; } -export function deserializeSkillInvocationTokenFieldReadField( +export function deserializeSkillInvocationTokenReadField( val: any -): SkillInvocationTokenFieldReadField { +): SkillInvocationTokenReadField { const accessToken: undefined | string = val.access_token == void 0 ? void 0 : val.access_token; const expiresIn: undefined | number = val.expires_in == void 0 ? void 0 : val.expires_in; - const tokenType: - | undefined - | SkillInvocationTokenFieldReadFieldTokenTypeField = + const tokenType: undefined | SkillInvocationTokenReadTokenTypeField = val.token_type == void 0 ? void 0 - : deserializeSkillInvocationTokenFieldReadFieldTokenTypeField( - val.token_type - ); + : deserializeSkillInvocationTokenReadTokenTypeField(val.token_type); const restrictedTo: undefined | string = val.restricted_to == void 0 ? void 0 : val.restricted_to; return { @@ -15058,26 +14981,26 @@ export function deserializeSkillInvocationTokenFieldReadField( expiresIn: expiresIn, tokenType: tokenType, restrictedTo: restrictedTo, - } satisfies SkillInvocationTokenFieldReadField; + } satisfies SkillInvocationTokenReadField; } -export function serializeSkillInvocationTokenFieldWriteFieldTokenTypeField( - val: SkillInvocationTokenFieldWriteFieldTokenTypeField +export function serializeSkillInvocationTokenWriteTokenTypeField( + val: SkillInvocationTokenWriteTokenTypeField ): SerializedData { return val; } -export function deserializeSkillInvocationTokenFieldWriteFieldTokenTypeField( +export function deserializeSkillInvocationTokenWriteTokenTypeField( val: any -): SkillInvocationTokenFieldWriteFieldTokenTypeField { +): SkillInvocationTokenWriteTokenTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "SkillInvocationTokenFieldWriteFieldTokenTypeField"'; + throw 'Expecting a string for "SkillInvocationTokenWriteTokenTypeField"'; } if (val == 'bearer') { return 'bearer'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeSkillInvocationTokenFieldWriteField( - val: SkillInvocationTokenFieldWriteField +export function serializeSkillInvocationTokenWriteField( + val: SkillInvocationTokenWriteField ): SerializedData { return { ['access_token']: val.accessToken == void 0 ? void 0 : val.accessToken, @@ -15085,27 +15008,21 @@ export function serializeSkillInvocationTokenFieldWriteField( ['token_type']: val.tokenType == void 0 ? void 0 - : serializeSkillInvocationTokenFieldWriteFieldTokenTypeField( - val.tokenType - ), + : serializeSkillInvocationTokenWriteTokenTypeField(val.tokenType), ['restricted_to']: val.restrictedTo == void 0 ? void 0 : val.restrictedTo, }; } -export function deserializeSkillInvocationTokenFieldWriteField( +export function deserializeSkillInvocationTokenWriteField( val: any -): SkillInvocationTokenFieldWriteField { +): SkillInvocationTokenWriteField { const accessToken: undefined | string = val.access_token == void 0 ? void 0 : val.access_token; const expiresIn: undefined | number = val.expires_in == void 0 ? void 0 : val.expires_in; - const tokenType: - | undefined - | SkillInvocationTokenFieldWriteFieldTokenTypeField = + const tokenType: undefined | SkillInvocationTokenWriteTokenTypeField = val.token_type == void 0 ? void 0 - : deserializeSkillInvocationTokenFieldWriteFieldTokenTypeField( - val.token_type - ); + : deserializeSkillInvocationTokenWriteTokenTypeField(val.token_type); const restrictedTo: undefined | string = val.restricted_to == void 0 ? void 0 : val.restricted_to; return { @@ -15113,7 +15030,7 @@ export function deserializeSkillInvocationTokenFieldWriteField( expiresIn: expiresIn, tokenType: tokenType, restrictedTo: restrictedTo, - } satisfies SkillInvocationTokenFieldWriteField; + } satisfies SkillInvocationTokenWriteField; } export function serializeSkillInvocationTokenField( val: SkillInvocationTokenField @@ -15122,36 +15039,36 @@ export function serializeSkillInvocationTokenField( ['read']: val.read == void 0 ? void 0 - : serializeSkillInvocationTokenFieldReadField(val.read), + : serializeSkillInvocationTokenReadField(val.read), ['write']: val.write == void 0 ? void 0 - : serializeSkillInvocationTokenFieldWriteField(val.write), + : serializeSkillInvocationTokenWriteField(val.write), }; } export function deserializeSkillInvocationTokenField( val: any ): SkillInvocationTokenField { - const read: undefined | SkillInvocationTokenFieldReadField = + const read: undefined | SkillInvocationTokenReadField = val.read == void 0 ? void 0 - : deserializeSkillInvocationTokenFieldReadField(val.read); - const write: undefined | SkillInvocationTokenFieldWriteField = + : deserializeSkillInvocationTokenReadField(val.read); + const write: undefined | SkillInvocationTokenWriteField = val.write == void 0 ? void 0 - : deserializeSkillInvocationTokenFieldWriteField(val.write); + : deserializeSkillInvocationTokenWriteField(val.write); return { read: read, write: write } satisfies SkillInvocationTokenField; } -export function serializeSkillInvocationStatusFieldStateField( - val: SkillInvocationStatusFieldStateField +export function serializeSkillInvocationStatusStateField( + val: SkillInvocationStatusStateField ): SerializedData { return val; } -export function deserializeSkillInvocationStatusFieldStateField( +export function deserializeSkillInvocationStatusStateField( val: any -): SkillInvocationStatusFieldStateField { +): SkillInvocationStatusStateField { if (!sdIsString(val)) { - throw 'Expecting a string for "SkillInvocationStatusFieldStateField"'; + throw 'Expecting a string for "SkillInvocationStatusStateField"'; } if (val == 'invoked') { return 'invoked'; @@ -15177,7 +15094,7 @@ export function serializeSkillInvocationStatusField( ['state']: val.state == void 0 ? void 0 - : serializeSkillInvocationStatusFieldStateField(val.state), + : serializeSkillInvocationStatusStateField(val.state), ['message']: val.message == void 0 ? void 0 : val.message, ['error_code']: val.errorCode == void 0 ? void 0 : val.errorCode, ['additional_info']: @@ -15187,10 +15104,10 @@ export function serializeSkillInvocationStatusField( export function deserializeSkillInvocationStatusField( val: any ): SkillInvocationStatusField { - const state: undefined | SkillInvocationStatusFieldStateField = + const state: undefined | SkillInvocationStatusStateField = val.state == void 0 ? void 0 - : deserializeSkillInvocationStatusFieldStateField(val.state); + : deserializeSkillInvocationStatusStateField(val.state); const message: undefined | string = val.message == void 0 ? void 0 : val.message; const errorCode: undefined | string = @@ -15204,16 +15121,16 @@ export function deserializeSkillInvocationStatusField( additionalInfo: additionalInfo, } satisfies SkillInvocationStatusField; } -export function serializeSkillInvocationEnterpriseFieldTypeField( - val: SkillInvocationEnterpriseFieldTypeField +export function serializeSkillInvocationEnterpriseTypeField( + val: SkillInvocationEnterpriseTypeField ): SerializedData { return val; } -export function deserializeSkillInvocationEnterpriseFieldTypeField( +export function deserializeSkillInvocationEnterpriseTypeField( val: any -): SkillInvocationEnterpriseFieldTypeField { +): SkillInvocationEnterpriseTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "SkillInvocationEnterpriseFieldTypeField"'; + throw 'Expecting a string for "SkillInvocationEnterpriseTypeField"'; } if (val == 'enterprise') { return 'enterprise'; @@ -15228,7 +15145,7 @@ export function serializeSkillInvocationEnterpriseField( ['type']: val.type == void 0 ? void 0 - : serializeSkillInvocationEnterpriseFieldTypeField(val.type), + : serializeSkillInvocationEnterpriseTypeField(val.type), ['name']: val.name == void 0 ? void 0 : val.name, }; } @@ -15236,10 +15153,10 @@ export function deserializeSkillInvocationEnterpriseField( val: any ): SkillInvocationEnterpriseField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: undefined | SkillInvocationEnterpriseFieldTypeField = + const type: undefined | SkillInvocationEnterpriseTypeField = val.type == void 0 ? void 0 - : deserializeSkillInvocationEnterpriseFieldTypeField(val.type); + : deserializeSkillInvocationEnterpriseTypeField(val.type); const name: undefined | string = val.name == void 0 ? void 0 : val.name; return { id: id, @@ -16060,234 +15977,211 @@ export function deserializeWorkflowMini(val: any): WorkflowMini { isEnabled: isEnabled, } satisfies WorkflowMini; } -export function serializeWorkflowFlowsFieldTypeField( - val: WorkflowFlowsFieldTypeField +export function serializeWorkflowFlowsTypeField( + val: WorkflowFlowsTypeField ): SerializedData { return val; } -export function deserializeWorkflowFlowsFieldTypeField( +export function deserializeWorkflowFlowsTypeField( val: any -): WorkflowFlowsFieldTypeField { +): WorkflowFlowsTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "WorkflowFlowsFieldTypeField"'; + throw 'Expecting a string for "WorkflowFlowsTypeField"'; } if (val == 'flow') { return 'flow'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeWorkflowFlowsFieldTriggerFieldTypeField( - val: WorkflowFlowsFieldTriggerFieldTypeField +export function serializeWorkflowFlowsTriggerTypeField( + val: WorkflowFlowsTriggerTypeField ): SerializedData { return val; } -export function deserializeWorkflowFlowsFieldTriggerFieldTypeField( +export function deserializeWorkflowFlowsTriggerTypeField( val: any -): WorkflowFlowsFieldTriggerFieldTypeField { +): WorkflowFlowsTriggerTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "WorkflowFlowsFieldTriggerFieldTypeField"'; + throw 'Expecting a string for "WorkflowFlowsTriggerTypeField"'; } if (val == 'trigger') { return 'trigger'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeWorkflowFlowsFieldTriggerFieldTriggerTypeField( - val: WorkflowFlowsFieldTriggerFieldTriggerTypeField +export function serializeWorkflowFlowsTriggerTriggerTypeField( + val: WorkflowFlowsTriggerTriggerTypeField ): SerializedData { return val; } -export function deserializeWorkflowFlowsFieldTriggerFieldTriggerTypeField( +export function deserializeWorkflowFlowsTriggerTriggerTypeField( val: any -): WorkflowFlowsFieldTriggerFieldTriggerTypeField { +): WorkflowFlowsTriggerTriggerTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "WorkflowFlowsFieldTriggerFieldTriggerTypeField"'; + throw 'Expecting a string for "WorkflowFlowsTriggerTriggerTypeField"'; } if (val == 'WORKFLOW_MANUAL_START') { return 'WORKFLOW_MANUAL_START'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeWorkflowFlowsFieldTriggerFieldScopeFieldTypeField( - val: WorkflowFlowsFieldTriggerFieldScopeFieldTypeField +export function serializeWorkflowFlowsTriggerScopeTypeField( + val: WorkflowFlowsTriggerScopeTypeField ): SerializedData { return val; } -export function deserializeWorkflowFlowsFieldTriggerFieldScopeFieldTypeField( +export function deserializeWorkflowFlowsTriggerScopeTypeField( val: any -): WorkflowFlowsFieldTriggerFieldScopeFieldTypeField { +): WorkflowFlowsTriggerScopeTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "WorkflowFlowsFieldTriggerFieldScopeFieldTypeField"'; + throw 'Expecting a string for "WorkflowFlowsTriggerScopeTypeField"'; } if (val == 'trigger_scope') { return 'trigger_scope'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeWorkflowFlowsFieldTriggerFieldScopeFieldObjectFieldTypeField( - val: WorkflowFlowsFieldTriggerFieldScopeFieldObjectFieldTypeField +export function serializeWorkflowFlowsTriggerScopeObjectTypeField( + val: WorkflowFlowsTriggerScopeObjectTypeField ): SerializedData { return val; } -export function deserializeWorkflowFlowsFieldTriggerFieldScopeFieldObjectFieldTypeField( +export function deserializeWorkflowFlowsTriggerScopeObjectTypeField( val: any -): WorkflowFlowsFieldTriggerFieldScopeFieldObjectFieldTypeField { +): WorkflowFlowsTriggerScopeObjectTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "WorkflowFlowsFieldTriggerFieldScopeFieldObjectFieldTypeField"'; + throw 'Expecting a string for "WorkflowFlowsTriggerScopeObjectTypeField"'; } if (val == 'folder') { return 'folder'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeWorkflowFlowsFieldTriggerFieldScopeFieldObjectField( - val: WorkflowFlowsFieldTriggerFieldScopeFieldObjectField +export function serializeWorkflowFlowsTriggerScopeObjectField( + val: WorkflowFlowsTriggerScopeObjectField ): SerializedData { return { ['type']: val.type == void 0 ? void 0 - : serializeWorkflowFlowsFieldTriggerFieldScopeFieldObjectFieldTypeField( - val.type - ), + : serializeWorkflowFlowsTriggerScopeObjectTypeField(val.type), ['id']: val.id == void 0 ? void 0 : val.id, }; } -export function deserializeWorkflowFlowsFieldTriggerFieldScopeFieldObjectField( +export function deserializeWorkflowFlowsTriggerScopeObjectField( val: any -): WorkflowFlowsFieldTriggerFieldScopeFieldObjectField { - const type: - | undefined - | WorkflowFlowsFieldTriggerFieldScopeFieldObjectFieldTypeField = +): WorkflowFlowsTriggerScopeObjectField { + const type: undefined | WorkflowFlowsTriggerScopeObjectTypeField = val.type == void 0 ? void 0 - : deserializeWorkflowFlowsFieldTriggerFieldScopeFieldObjectFieldTypeField( - val.type - ); + : deserializeWorkflowFlowsTriggerScopeObjectTypeField(val.type); const id: undefined | string = val.id == void 0 ? void 0 : val.id; - return { - type: type, - id: id, - } satisfies WorkflowFlowsFieldTriggerFieldScopeFieldObjectField; + return { type: type, id: id } satisfies WorkflowFlowsTriggerScopeObjectField; } -export function serializeWorkflowFlowsFieldTriggerFieldScopeField( - val: WorkflowFlowsFieldTriggerFieldScopeField +export function serializeWorkflowFlowsTriggerScopeField( + val: WorkflowFlowsTriggerScopeField ): SerializedData { return { ['type']: val.type == void 0 ? void 0 - : serializeWorkflowFlowsFieldTriggerFieldScopeFieldTypeField(val.type), + : serializeWorkflowFlowsTriggerScopeTypeField(val.type), ['ref']: val.ref == void 0 ? void 0 : val.ref, ['object']: val.object == void 0 ? void 0 - : serializeWorkflowFlowsFieldTriggerFieldScopeFieldObjectField( - val.object - ), + : serializeWorkflowFlowsTriggerScopeObjectField(val.object), }; } -export function deserializeWorkflowFlowsFieldTriggerFieldScopeField( +export function deserializeWorkflowFlowsTriggerScopeField( val: any -): WorkflowFlowsFieldTriggerFieldScopeField { - const type: undefined | WorkflowFlowsFieldTriggerFieldScopeFieldTypeField = +): WorkflowFlowsTriggerScopeField { + const type: undefined | WorkflowFlowsTriggerScopeTypeField = val.type == void 0 ? void 0 - : deserializeWorkflowFlowsFieldTriggerFieldScopeFieldTypeField(val.type); + : deserializeWorkflowFlowsTriggerScopeTypeField(val.type); const ref: undefined | string = val.ref == void 0 ? void 0 : val.ref; - const object: - | undefined - | WorkflowFlowsFieldTriggerFieldScopeFieldObjectField = + const object: undefined | WorkflowFlowsTriggerScopeObjectField = val.object == void 0 ? void 0 - : deserializeWorkflowFlowsFieldTriggerFieldScopeFieldObjectField( - val.object - ); + : deserializeWorkflowFlowsTriggerScopeObjectField(val.object); return { type: type, ref: ref, object: object, - } satisfies WorkflowFlowsFieldTriggerFieldScopeField; + } satisfies WorkflowFlowsTriggerScopeField; } -export function serializeWorkflowFlowsFieldTriggerField( - val: WorkflowFlowsFieldTriggerField +export function serializeWorkflowFlowsTriggerField( + val: WorkflowFlowsTriggerField ): SerializedData { return { ['type']: val.type == void 0 ? void 0 - : serializeWorkflowFlowsFieldTriggerFieldTypeField(val.type), + : serializeWorkflowFlowsTriggerTypeField(val.type), ['trigger_type']: val.triggerType == void 0 ? void 0 - : serializeWorkflowFlowsFieldTriggerFieldTriggerTypeField( - val.triggerType - ), + : serializeWorkflowFlowsTriggerTriggerTypeField(val.triggerType), ['scope']: val.scope == void 0 ? void 0 - : (val.scope.map(function ( - item: WorkflowFlowsFieldTriggerFieldScopeField - ): any { - return serializeWorkflowFlowsFieldTriggerFieldScopeField(item); + : (val.scope.map(function (item: WorkflowFlowsTriggerScopeField): any { + return serializeWorkflowFlowsTriggerScopeField(item); }) as readonly any[]), }; } -export function deserializeWorkflowFlowsFieldTriggerField( +export function deserializeWorkflowFlowsTriggerField( val: any -): WorkflowFlowsFieldTriggerField { - const type: undefined | WorkflowFlowsFieldTriggerFieldTypeField = +): WorkflowFlowsTriggerField { + const type: undefined | WorkflowFlowsTriggerTypeField = val.type == void 0 ? void 0 - : deserializeWorkflowFlowsFieldTriggerFieldTypeField(val.type); - const triggerType: - | undefined - | WorkflowFlowsFieldTriggerFieldTriggerTypeField = + : deserializeWorkflowFlowsTriggerTypeField(val.type); + const triggerType: undefined | WorkflowFlowsTriggerTriggerTypeField = val.trigger_type == void 0 ? void 0 - : deserializeWorkflowFlowsFieldTriggerFieldTriggerTypeField( - val.trigger_type - ); - const scope: undefined | readonly WorkflowFlowsFieldTriggerFieldScopeField[] = + : deserializeWorkflowFlowsTriggerTriggerTypeField(val.trigger_type); + const scope: undefined | readonly WorkflowFlowsTriggerScopeField[] = val.scope == void 0 ? void 0 : sdIsList(val.scope) ? (val.scope.map(function (itm: SerializedData): any { - return deserializeWorkflowFlowsFieldTriggerFieldScopeField(itm); + return deserializeWorkflowFlowsTriggerScopeField(itm); }) as readonly any[]) : []; return { type: type, triggerType: triggerType, scope: scope, - } satisfies WorkflowFlowsFieldTriggerField; + } satisfies WorkflowFlowsTriggerField; } -export function serializeWorkflowFlowsFieldOutcomesFieldTypeField( - val: WorkflowFlowsFieldOutcomesFieldTypeField +export function serializeWorkflowFlowsOutcomesTypeField( + val: WorkflowFlowsOutcomesTypeField ): SerializedData { return val; } -export function deserializeWorkflowFlowsFieldOutcomesFieldTypeField( +export function deserializeWorkflowFlowsOutcomesTypeField( val: any -): WorkflowFlowsFieldOutcomesFieldTypeField { +): WorkflowFlowsOutcomesTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "WorkflowFlowsFieldOutcomesFieldTypeField"'; + throw 'Expecting a string for "WorkflowFlowsOutcomesTypeField"'; } if (val == 'outcome') { return 'outcome'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeWorkflowFlowsFieldOutcomesFieldActionTypeField( - val: WorkflowFlowsFieldOutcomesFieldActionTypeField +export function serializeWorkflowFlowsOutcomesActionTypeField( + val: WorkflowFlowsOutcomesActionTypeField ): SerializedData { return val; } -export function deserializeWorkflowFlowsFieldOutcomesFieldActionTypeField( +export function deserializeWorkflowFlowsOutcomesActionTypeField( val: any -): WorkflowFlowsFieldOutcomesFieldActionTypeField { +): WorkflowFlowsOutcomesActionTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "WorkflowFlowsFieldOutcomesFieldActionTypeField"'; + throw 'Expecting a string for "WorkflowFlowsOutcomesActionTypeField"'; } if (val == 'add_metadata') { return 'add_metadata'; @@ -16360,32 +16254,32 @@ export function deserializeWorkflowFlowsFieldOutcomesFieldActionTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeWorkflowFlowsFieldOutcomesFieldIfRejectedFieldTypeField( - val: WorkflowFlowsFieldOutcomesFieldIfRejectedFieldTypeField +export function serializeWorkflowFlowsOutcomesIfRejectedTypeField( + val: WorkflowFlowsOutcomesIfRejectedTypeField ): SerializedData { return val; } -export function deserializeWorkflowFlowsFieldOutcomesFieldIfRejectedFieldTypeField( +export function deserializeWorkflowFlowsOutcomesIfRejectedTypeField( val: any -): WorkflowFlowsFieldOutcomesFieldIfRejectedFieldTypeField { +): WorkflowFlowsOutcomesIfRejectedTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "WorkflowFlowsFieldOutcomesFieldIfRejectedFieldTypeField"'; + throw 'Expecting a string for "WorkflowFlowsOutcomesIfRejectedTypeField"'; } if (val == 'outcome') { return 'outcome'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeWorkflowFlowsFieldOutcomesFieldIfRejectedFieldActionTypeField( - val: WorkflowFlowsFieldOutcomesFieldIfRejectedFieldActionTypeField +export function serializeWorkflowFlowsOutcomesIfRejectedActionTypeField( + val: WorkflowFlowsOutcomesIfRejectedActionTypeField ): SerializedData { return val; } -export function deserializeWorkflowFlowsFieldOutcomesFieldIfRejectedFieldActionTypeField( +export function deserializeWorkflowFlowsOutcomesIfRejectedActionTypeField( val: any -): WorkflowFlowsFieldOutcomesFieldIfRejectedFieldActionTypeField { +): WorkflowFlowsOutcomesIfRejectedActionTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "WorkflowFlowsFieldOutcomesFieldIfRejectedFieldActionTypeField"'; + throw 'Expecting a string for "WorkflowFlowsOutcomesIfRejectedActionTypeField"'; } if (val == 'add_metadata') { return 'add_metadata'; @@ -16458,45 +16352,37 @@ export function deserializeWorkflowFlowsFieldOutcomesFieldIfRejectedFieldActionT } throw ''.concat('Invalid value: ', val) as string; } -export function serializeWorkflowFlowsFieldOutcomesFieldIfRejectedField( - val: WorkflowFlowsFieldOutcomesFieldIfRejectedField +export function serializeWorkflowFlowsOutcomesIfRejectedField( + val: WorkflowFlowsOutcomesIfRejectedField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id, ['type']: val.type == void 0 ? void 0 - : serializeWorkflowFlowsFieldOutcomesFieldIfRejectedFieldTypeField( - val.type - ), + : serializeWorkflowFlowsOutcomesIfRejectedTypeField(val.type), ['name']: val.name == void 0 ? void 0 : val.name, ['action_type']: val.actionType == void 0 ? void 0 - : serializeWorkflowFlowsFieldOutcomesFieldIfRejectedFieldActionTypeField( + : serializeWorkflowFlowsOutcomesIfRejectedActionTypeField( val.actionType ), }; } -export function deserializeWorkflowFlowsFieldOutcomesFieldIfRejectedField( +export function deserializeWorkflowFlowsOutcomesIfRejectedField( val: any -): WorkflowFlowsFieldOutcomesFieldIfRejectedField { +): WorkflowFlowsOutcomesIfRejectedField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: - | undefined - | WorkflowFlowsFieldOutcomesFieldIfRejectedFieldTypeField = + const type: undefined | WorkflowFlowsOutcomesIfRejectedTypeField = val.type == void 0 ? void 0 - : deserializeWorkflowFlowsFieldOutcomesFieldIfRejectedFieldTypeField( - val.type - ); + : deserializeWorkflowFlowsOutcomesIfRejectedTypeField(val.type); const name: undefined | string = val.name == void 0 ? void 0 : val.name; - const actionType: - | undefined - | WorkflowFlowsFieldOutcomesFieldIfRejectedFieldActionTypeField = + const actionType: undefined | WorkflowFlowsOutcomesIfRejectedActionTypeField = val.action_type == void 0 ? void 0 - : deserializeWorkflowFlowsFieldOutcomesFieldIfRejectedFieldActionTypeField( + : deserializeWorkflowFlowsOutcomesIfRejectedActionTypeField( val.action_type ); return { @@ -16504,59 +16390,53 @@ export function deserializeWorkflowFlowsFieldOutcomesFieldIfRejectedField( type: type, name: name, actionType: actionType, - } satisfies WorkflowFlowsFieldOutcomesFieldIfRejectedField; + } satisfies WorkflowFlowsOutcomesIfRejectedField; } -export function serializeWorkflowFlowsFieldOutcomesField( - val: WorkflowFlowsFieldOutcomesField +export function serializeWorkflowFlowsOutcomesField( + val: WorkflowFlowsOutcomesField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id, ['type']: val.type == void 0 ? void 0 - : serializeWorkflowFlowsFieldOutcomesFieldTypeField(val.type), + : serializeWorkflowFlowsOutcomesTypeField(val.type), ['name']: val.name == void 0 ? void 0 : val.name, ['action_type']: val.actionType == void 0 ? void 0 - : serializeWorkflowFlowsFieldOutcomesFieldActionTypeField( - val.actionType - ), + : serializeWorkflowFlowsOutcomesActionTypeField(val.actionType), ['if_rejected']: val.ifRejected == void 0 ? void 0 : (val.ifRejected.map(function ( - item: WorkflowFlowsFieldOutcomesFieldIfRejectedField + item: WorkflowFlowsOutcomesIfRejectedField ): any { - return serializeWorkflowFlowsFieldOutcomesFieldIfRejectedField( - item - ); + return serializeWorkflowFlowsOutcomesIfRejectedField(item); }) as readonly any[]), }; } -export function deserializeWorkflowFlowsFieldOutcomesField( +export function deserializeWorkflowFlowsOutcomesField( val: any -): WorkflowFlowsFieldOutcomesField { +): WorkflowFlowsOutcomesField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: undefined | WorkflowFlowsFieldOutcomesFieldTypeField = + const type: undefined | WorkflowFlowsOutcomesTypeField = val.type == void 0 ? void 0 - : deserializeWorkflowFlowsFieldOutcomesFieldTypeField(val.type); + : deserializeWorkflowFlowsOutcomesTypeField(val.type); const name: undefined | string = val.name == void 0 ? void 0 : val.name; - const actionType: undefined | WorkflowFlowsFieldOutcomesFieldActionTypeField = + const actionType: undefined | WorkflowFlowsOutcomesActionTypeField = val.action_type == void 0 ? void 0 - : deserializeWorkflowFlowsFieldOutcomesFieldActionTypeField( - val.action_type - ); + : deserializeWorkflowFlowsOutcomesActionTypeField(val.action_type); const ifRejected: | undefined - | readonly WorkflowFlowsFieldOutcomesFieldIfRejectedField[] = + | readonly WorkflowFlowsOutcomesIfRejectedField[] = val.if_rejected == void 0 ? void 0 : sdIsList(val.if_rejected) ? (val.if_rejected.map(function (itm: SerializedData): any { - return deserializeWorkflowFlowsFieldOutcomesFieldIfRejectedField(itm); + return deserializeWorkflowFlowsOutcomesIfRejectedField(itm); }) as readonly any[]) : []; return { @@ -16565,7 +16445,7 @@ export function deserializeWorkflowFlowsFieldOutcomesField( name: name, actionType: actionType, ifRejected: ifRejected, - } satisfies WorkflowFlowsFieldOutcomesField; + } satisfies WorkflowFlowsOutcomesField; } export function serializeWorkflowFlowsField( val: WorkflowFlowsField @@ -16573,20 +16453,16 @@ export function serializeWorkflowFlowsField( return { ['id']: val.id == void 0 ? void 0 : val.id, ['type']: - val.type == void 0 - ? void 0 - : serializeWorkflowFlowsFieldTypeField(val.type), + val.type == void 0 ? void 0 : serializeWorkflowFlowsTypeField(val.type), ['trigger']: val.trigger == void 0 ? void 0 - : serializeWorkflowFlowsFieldTriggerField(val.trigger), + : serializeWorkflowFlowsTriggerField(val.trigger), ['outcomes']: val.outcomes == void 0 ? void 0 - : (val.outcomes.map(function ( - item: WorkflowFlowsFieldOutcomesField - ): any { - return serializeWorkflowFlowsFieldOutcomesField(item); + : (val.outcomes.map(function (item: WorkflowFlowsOutcomesField): any { + return serializeWorkflowFlowsOutcomesField(item); }) as readonly any[]), ['created_at']: val.createdAt == void 0 ? void 0 : val.createdAt, ['created_by']: @@ -16595,20 +16471,18 @@ export function serializeWorkflowFlowsField( } export function deserializeWorkflowFlowsField(val: any): WorkflowFlowsField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: undefined | WorkflowFlowsFieldTypeField = - val.type == void 0 - ? void 0 - : deserializeWorkflowFlowsFieldTypeField(val.type); - const trigger: undefined | WorkflowFlowsFieldTriggerField = + const type: undefined | WorkflowFlowsTypeField = + val.type == void 0 ? void 0 : deserializeWorkflowFlowsTypeField(val.type); + const trigger: undefined | WorkflowFlowsTriggerField = val.trigger == void 0 ? void 0 - : deserializeWorkflowFlowsFieldTriggerField(val.trigger); - const outcomes: undefined | readonly WorkflowFlowsFieldOutcomesField[] = + : deserializeWorkflowFlowsTriggerField(val.trigger); + const outcomes: undefined | readonly WorkflowFlowsOutcomesField[] = val.outcomes == void 0 ? void 0 : sdIsList(val.outcomes) ? (val.outcomes.map(function (itm: SerializedData): any { - return deserializeWorkflowFlowsFieldOutcomesField(itm); + return deserializeWorkflowFlowsOutcomesField(itm); }) as readonly any[]) : []; const createdAt: undefined | string = @@ -16756,16 +16630,16 @@ export function deserializeWorkflowFull(val: any): WorkflowFull { isEnabled: isEnabled, } satisfies WorkflowFull; } -export function serializeZipDownloadNameConflictsFieldTypeField( - val: ZipDownloadNameConflictsFieldTypeField +export function serializeZipDownloadNameConflictsTypeField( + val: ZipDownloadNameConflictsTypeField ): SerializedData { return val; } -export function deserializeZipDownloadNameConflictsFieldTypeField( +export function deserializeZipDownloadNameConflictsTypeField( val: any -): ZipDownloadNameConflictsFieldTypeField { +): ZipDownloadNameConflictsTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "ZipDownloadNameConflictsFieldTypeField"'; + throw 'Expecting a string for "ZipDownloadNameConflictsTypeField"'; } if (val == 'file') { return 'file'; @@ -16783,7 +16657,7 @@ export function serializeZipDownloadNameConflictsField( ['type']: val.type == void 0 ? void 0 - : serializeZipDownloadNameConflictsFieldTypeField(val.type), + : serializeZipDownloadNameConflictsTypeField(val.type), ['original_name']: val.originalName == void 0 ? void 0 : val.originalName, ['download_name']: val.downloadName == void 0 ? void 0 : val.downloadName, }; @@ -16792,10 +16666,10 @@ export function deserializeZipDownloadNameConflictsField( val: any ): ZipDownloadNameConflictsField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: undefined | ZipDownloadNameConflictsFieldTypeField = + const type: undefined | ZipDownloadNameConflictsTypeField = val.type == void 0 ? void 0 - : deserializeZipDownloadNameConflictsFieldTypeField(val.type); + : deserializeZipDownloadNameConflictsTypeField(val.type); const originalName: undefined | string = val.original_name == void 0 ? void 0 : val.original_name; const downloadName: undefined | string = @@ -16965,16 +16839,16 @@ export function deserializeKeywordSkillCardSkillCardTitleField( message: message, } satisfies KeywordSkillCardSkillCardTitleField; } -export function serializeKeywordSkillCardSkillFieldTypeField( - val: KeywordSkillCardSkillFieldTypeField +export function serializeKeywordSkillCardSkillTypeField( + val: KeywordSkillCardSkillTypeField ): SerializedData { return val; } -export function deserializeKeywordSkillCardSkillFieldTypeField( +export function deserializeKeywordSkillCardSkillTypeField( val: any -): KeywordSkillCardSkillFieldTypeField { +): KeywordSkillCardSkillTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "KeywordSkillCardSkillFieldTypeField"'; + throw 'Expecting a string for "KeywordSkillCardSkillTypeField"'; } if (val == 'service') { return 'service'; @@ -16985,28 +16859,28 @@ export function serializeKeywordSkillCardSkillField( val: KeywordSkillCardSkillField ): SerializedData { return { - ['type']: serializeKeywordSkillCardSkillFieldTypeField(val.type), + ['type']: serializeKeywordSkillCardSkillTypeField(val.type), ['id']: val.id, }; } export function deserializeKeywordSkillCardSkillField( val: any ): KeywordSkillCardSkillField { - const type: KeywordSkillCardSkillFieldTypeField = - deserializeKeywordSkillCardSkillFieldTypeField(val.type); + const type: KeywordSkillCardSkillTypeField = + deserializeKeywordSkillCardSkillTypeField(val.type); const id: string = val.id; return { type: type, id: id } satisfies KeywordSkillCardSkillField; } -export function serializeKeywordSkillCardInvocationFieldTypeField( - val: KeywordSkillCardInvocationFieldTypeField +export function serializeKeywordSkillCardInvocationTypeField( + val: KeywordSkillCardInvocationTypeField ): SerializedData { return val; } -export function deserializeKeywordSkillCardInvocationFieldTypeField( +export function deserializeKeywordSkillCardInvocationTypeField( val: any -): KeywordSkillCardInvocationFieldTypeField { +): KeywordSkillCardInvocationTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "KeywordSkillCardInvocationFieldTypeField"'; + throw 'Expecting a string for "KeywordSkillCardInvocationTypeField"'; } if (val == 'skill_invocation') { return 'skill_invocation'; @@ -17017,15 +16891,15 @@ export function serializeKeywordSkillCardInvocationField( val: KeywordSkillCardInvocationField ): SerializedData { return { - ['type']: serializeKeywordSkillCardInvocationFieldTypeField(val.type), + ['type']: serializeKeywordSkillCardInvocationTypeField(val.type), ['id']: val.id, }; } export function deserializeKeywordSkillCardInvocationField( val: any ): KeywordSkillCardInvocationField { - const type: KeywordSkillCardInvocationFieldTypeField = - deserializeKeywordSkillCardInvocationFieldTypeField(val.type); + const type: KeywordSkillCardInvocationTypeField = + deserializeKeywordSkillCardInvocationTypeField(val.type); const id: string = val.id; return { type: type, id: id } satisfies KeywordSkillCardInvocationField; } @@ -17400,16 +17274,16 @@ export function deserializeTimelineSkillCardSkillCardTitleField( message: message, } satisfies TimelineSkillCardSkillCardTitleField; } -export function serializeTimelineSkillCardSkillFieldTypeField( - val: TimelineSkillCardSkillFieldTypeField +export function serializeTimelineSkillCardSkillTypeField( + val: TimelineSkillCardSkillTypeField ): SerializedData { return val; } -export function deserializeTimelineSkillCardSkillFieldTypeField( +export function deserializeTimelineSkillCardSkillTypeField( val: any -): TimelineSkillCardSkillFieldTypeField { +): TimelineSkillCardSkillTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "TimelineSkillCardSkillFieldTypeField"'; + throw 'Expecting a string for "TimelineSkillCardSkillTypeField"'; } if (val == 'service') { return 'service'; @@ -17420,28 +17294,28 @@ export function serializeTimelineSkillCardSkillField( val: TimelineSkillCardSkillField ): SerializedData { return { - ['type']: serializeTimelineSkillCardSkillFieldTypeField(val.type), + ['type']: serializeTimelineSkillCardSkillTypeField(val.type), ['id']: val.id, }; } export function deserializeTimelineSkillCardSkillField( val: any ): TimelineSkillCardSkillField { - const type: TimelineSkillCardSkillFieldTypeField = - deserializeTimelineSkillCardSkillFieldTypeField(val.type); + const type: TimelineSkillCardSkillTypeField = + deserializeTimelineSkillCardSkillTypeField(val.type); const id: string = val.id; return { type: type, id: id } satisfies TimelineSkillCardSkillField; } -export function serializeTimelineSkillCardInvocationFieldTypeField( - val: TimelineSkillCardInvocationFieldTypeField +export function serializeTimelineSkillCardInvocationTypeField( + val: TimelineSkillCardInvocationTypeField ): SerializedData { return val; } -export function deserializeTimelineSkillCardInvocationFieldTypeField( +export function deserializeTimelineSkillCardInvocationTypeField( val: any -): TimelineSkillCardInvocationFieldTypeField { +): TimelineSkillCardInvocationTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "TimelineSkillCardInvocationFieldTypeField"'; + throw 'Expecting a string for "TimelineSkillCardInvocationTypeField"'; } if (val == 'skill_invocation') { return 'skill_invocation'; @@ -17452,35 +17326,35 @@ export function serializeTimelineSkillCardInvocationField( val: TimelineSkillCardInvocationField ): SerializedData { return { - ['type']: serializeTimelineSkillCardInvocationFieldTypeField(val.type), + ['type']: serializeTimelineSkillCardInvocationTypeField(val.type), ['id']: val.id, }; } export function deserializeTimelineSkillCardInvocationField( val: any ): TimelineSkillCardInvocationField { - const type: TimelineSkillCardInvocationFieldTypeField = - deserializeTimelineSkillCardInvocationFieldTypeField(val.type); + const type: TimelineSkillCardInvocationTypeField = + deserializeTimelineSkillCardInvocationTypeField(val.type); const id: string = val.id; return { type: type, id: id } satisfies TimelineSkillCardInvocationField; } -export function serializeTimelineSkillCardEntriesFieldAppearsField( - val: TimelineSkillCardEntriesFieldAppearsField +export function serializeTimelineSkillCardEntriesAppearsField( + val: TimelineSkillCardEntriesAppearsField ): SerializedData { return { ['start']: val.start == void 0 ? void 0 : val.start, ['end']: val.end == void 0 ? void 0 : val.end, }; } -export function deserializeTimelineSkillCardEntriesFieldAppearsField( +export function deserializeTimelineSkillCardEntriesAppearsField( val: any -): TimelineSkillCardEntriesFieldAppearsField { +): TimelineSkillCardEntriesAppearsField { const start: undefined | number = val.start == void 0 ? void 0 : val.start; const end: undefined | number = val.end == void 0 ? void 0 : val.end; return { start: start, end: end, - } satisfies TimelineSkillCardEntriesFieldAppearsField; + } satisfies TimelineSkillCardEntriesAppearsField; } export function serializeTimelineSkillCardEntriesField( val: TimelineSkillCardEntriesField @@ -17491,9 +17365,9 @@ export function serializeTimelineSkillCardEntriesField( val.appears == void 0 ? void 0 : (val.appears.map(function ( - item: TimelineSkillCardEntriesFieldAppearsField + item: TimelineSkillCardEntriesAppearsField ): any { - return serializeTimelineSkillCardEntriesFieldAppearsField(item); + return serializeTimelineSkillCardEntriesAppearsField(item); }) as readonly any[]), ['image_url']: val.imageUrl == void 0 ? void 0 : val.imageUrl, }; @@ -17502,14 +17376,12 @@ export function deserializeTimelineSkillCardEntriesField( val: any ): TimelineSkillCardEntriesField { const text: undefined | string = val.text == void 0 ? void 0 : val.text; - const appears: - | undefined - | readonly TimelineSkillCardEntriesFieldAppearsField[] = + const appears: undefined | readonly TimelineSkillCardEntriesAppearsField[] = val.appears == void 0 ? void 0 : sdIsList(val.appears) ? (val.appears.map(function (itm: SerializedData): any { - return deserializeTimelineSkillCardEntriesFieldAppearsField(itm); + return deserializeTimelineSkillCardEntriesAppearsField(itm); }) as readonly any[]) : []; const imageUrl: undefined | string = @@ -17628,16 +17500,16 @@ export function deserializeTranscriptSkillCardSkillCardTitleField( message: message, } satisfies TranscriptSkillCardSkillCardTitleField; } -export function serializeTranscriptSkillCardSkillFieldTypeField( - val: TranscriptSkillCardSkillFieldTypeField +export function serializeTranscriptSkillCardSkillTypeField( + val: TranscriptSkillCardSkillTypeField ): SerializedData { return val; } -export function deserializeTranscriptSkillCardSkillFieldTypeField( +export function deserializeTranscriptSkillCardSkillTypeField( val: any -): TranscriptSkillCardSkillFieldTypeField { +): TranscriptSkillCardSkillTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "TranscriptSkillCardSkillFieldTypeField"'; + throw 'Expecting a string for "TranscriptSkillCardSkillTypeField"'; } if (val == 'service') { return 'service'; @@ -17648,28 +17520,28 @@ export function serializeTranscriptSkillCardSkillField( val: TranscriptSkillCardSkillField ): SerializedData { return { - ['type']: serializeTranscriptSkillCardSkillFieldTypeField(val.type), + ['type']: serializeTranscriptSkillCardSkillTypeField(val.type), ['id']: val.id, }; } export function deserializeTranscriptSkillCardSkillField( val: any ): TranscriptSkillCardSkillField { - const type: TranscriptSkillCardSkillFieldTypeField = - deserializeTranscriptSkillCardSkillFieldTypeField(val.type); + const type: TranscriptSkillCardSkillTypeField = + deserializeTranscriptSkillCardSkillTypeField(val.type); const id: string = val.id; return { type: type, id: id } satisfies TranscriptSkillCardSkillField; } -export function serializeTranscriptSkillCardInvocationFieldTypeField( - val: TranscriptSkillCardInvocationFieldTypeField +export function serializeTranscriptSkillCardInvocationTypeField( + val: TranscriptSkillCardInvocationTypeField ): SerializedData { return val; } -export function deserializeTranscriptSkillCardInvocationFieldTypeField( +export function deserializeTranscriptSkillCardInvocationTypeField( val: any -): TranscriptSkillCardInvocationFieldTypeField { +): TranscriptSkillCardInvocationTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "TranscriptSkillCardInvocationFieldTypeField"'; + throw 'Expecting a string for "TranscriptSkillCardInvocationTypeField"'; } if (val == 'skill_invocation') { return 'skill_invocation'; @@ -17680,28 +17552,28 @@ export function serializeTranscriptSkillCardInvocationField( val: TranscriptSkillCardInvocationField ): SerializedData { return { - ['type']: serializeTranscriptSkillCardInvocationFieldTypeField(val.type), + ['type']: serializeTranscriptSkillCardInvocationTypeField(val.type), ['id']: val.id, }; } export function deserializeTranscriptSkillCardInvocationField( val: any ): TranscriptSkillCardInvocationField { - const type: TranscriptSkillCardInvocationFieldTypeField = - deserializeTranscriptSkillCardInvocationFieldTypeField(val.type); + const type: TranscriptSkillCardInvocationTypeField = + deserializeTranscriptSkillCardInvocationTypeField(val.type); const id: string = val.id; return { type: type, id: id } satisfies TranscriptSkillCardInvocationField; } -export function serializeTranscriptSkillCardEntriesFieldAppearsField( - val: TranscriptSkillCardEntriesFieldAppearsField +export function serializeTranscriptSkillCardEntriesAppearsField( + val: TranscriptSkillCardEntriesAppearsField ): SerializedData { return { ['start']: val.start == void 0 ? void 0 : val.start }; } -export function deserializeTranscriptSkillCardEntriesFieldAppearsField( +export function deserializeTranscriptSkillCardEntriesAppearsField( val: any -): TranscriptSkillCardEntriesFieldAppearsField { +): TranscriptSkillCardEntriesAppearsField { const start: undefined | number = val.start == void 0 ? void 0 : val.start; - return { start: start } satisfies TranscriptSkillCardEntriesFieldAppearsField; + return { start: start } satisfies TranscriptSkillCardEntriesAppearsField; } export function serializeTranscriptSkillCardEntriesField( val: TranscriptSkillCardEntriesField @@ -17712,9 +17584,9 @@ export function serializeTranscriptSkillCardEntriesField( val.appears == void 0 ? void 0 : (val.appears.map(function ( - item: TranscriptSkillCardEntriesFieldAppearsField + item: TranscriptSkillCardEntriesAppearsField ): any { - return serializeTranscriptSkillCardEntriesFieldAppearsField(item); + return serializeTranscriptSkillCardEntriesAppearsField(item); }) as readonly any[]), }; } @@ -17722,14 +17594,12 @@ export function deserializeTranscriptSkillCardEntriesField( val: any ): TranscriptSkillCardEntriesField { const text: undefined | string = val.text == void 0 ? void 0 : val.text; - const appears: - | undefined - | readonly TranscriptSkillCardEntriesFieldAppearsField[] = + const appears: undefined | readonly TranscriptSkillCardEntriesAppearsField[] = val.appears == void 0 ? void 0 : sdIsList(val.appears) ? (val.appears.map(function (itm: SerializedData): any { - return deserializeTranscriptSkillCardEntriesFieldAppearsField(itm); + return deserializeTranscriptSkillCardEntriesAppearsField(itm); }) as readonly any[]) : []; return { @@ -17845,16 +17715,16 @@ export function deserializeStatusSkillCardSkillCardTitleField( message: message, } satisfies StatusSkillCardSkillCardTitleField; } -export function serializeStatusSkillCardStatusFieldCodeField( - val: StatusSkillCardStatusFieldCodeField +export function serializeStatusSkillCardStatusCodeField( + val: StatusSkillCardStatusCodeField ): SerializedData { return val; } -export function deserializeStatusSkillCardStatusFieldCodeField( +export function deserializeStatusSkillCardStatusCodeField( val: any -): StatusSkillCardStatusFieldCodeField { +): StatusSkillCardStatusCodeField { if (!sdIsString(val)) { - throw 'Expecting a string for "StatusSkillCardStatusFieldCodeField"'; + throw 'Expecting a string for "StatusSkillCardStatusCodeField"'; } if (val == 'invoked') { return 'invoked'; @@ -17877,29 +17747,29 @@ export function serializeStatusSkillCardStatusField( val: StatusSkillCardStatusField ): SerializedData { return { - ['code']: serializeStatusSkillCardStatusFieldCodeField(val.code), + ['code']: serializeStatusSkillCardStatusCodeField(val.code), ['message']: val.message == void 0 ? void 0 : val.message, }; } export function deserializeStatusSkillCardStatusField( val: any ): StatusSkillCardStatusField { - const code: StatusSkillCardStatusFieldCodeField = - deserializeStatusSkillCardStatusFieldCodeField(val.code); + const code: StatusSkillCardStatusCodeField = + deserializeStatusSkillCardStatusCodeField(val.code); const message: undefined | string = val.message == void 0 ? void 0 : val.message; return { code: code, message: message } satisfies StatusSkillCardStatusField; } -export function serializeStatusSkillCardSkillFieldTypeField( - val: StatusSkillCardSkillFieldTypeField +export function serializeStatusSkillCardSkillTypeField( + val: StatusSkillCardSkillTypeField ): SerializedData { return val; } -export function deserializeStatusSkillCardSkillFieldTypeField( +export function deserializeStatusSkillCardSkillTypeField( val: any -): StatusSkillCardSkillFieldTypeField { +): StatusSkillCardSkillTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "StatusSkillCardSkillFieldTypeField"'; + throw 'Expecting a string for "StatusSkillCardSkillTypeField"'; } if (val == 'service') { return 'service'; @@ -17910,28 +17780,28 @@ export function serializeStatusSkillCardSkillField( val: StatusSkillCardSkillField ): SerializedData { return { - ['type']: serializeStatusSkillCardSkillFieldTypeField(val.type), + ['type']: serializeStatusSkillCardSkillTypeField(val.type), ['id']: val.id, }; } export function deserializeStatusSkillCardSkillField( val: any ): StatusSkillCardSkillField { - const type: StatusSkillCardSkillFieldTypeField = - deserializeStatusSkillCardSkillFieldTypeField(val.type); + const type: StatusSkillCardSkillTypeField = + deserializeStatusSkillCardSkillTypeField(val.type); const id: string = val.id; return { type: type, id: id } satisfies StatusSkillCardSkillField; } -export function serializeStatusSkillCardInvocationFieldTypeField( - val: StatusSkillCardInvocationFieldTypeField +export function serializeStatusSkillCardInvocationTypeField( + val: StatusSkillCardInvocationTypeField ): SerializedData { return val; } -export function deserializeStatusSkillCardInvocationFieldTypeField( +export function deserializeStatusSkillCardInvocationTypeField( val: any -): StatusSkillCardInvocationFieldTypeField { +): StatusSkillCardInvocationTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "StatusSkillCardInvocationFieldTypeField"'; + throw 'Expecting a string for "StatusSkillCardInvocationTypeField"'; } if (val == 'skill_invocation') { return 'skill_invocation'; @@ -17942,15 +17812,15 @@ export function serializeStatusSkillCardInvocationField( val: StatusSkillCardInvocationField ): SerializedData { return { - ['type']: serializeStatusSkillCardInvocationFieldTypeField(val.type), + ['type']: serializeStatusSkillCardInvocationTypeField(val.type), ['id']: val.id, }; } export function deserializeStatusSkillCardInvocationField( val: any ): StatusSkillCardInvocationField { - const type: StatusSkillCardInvocationFieldTypeField = - deserializeStatusSkillCardInvocationFieldTypeField(val.type); + const type: StatusSkillCardInvocationTypeField = + deserializeStatusSkillCardInvocationTypeField(val.type); const id: string = val.id; return { type: type, id: id } satisfies StatusSkillCardInvocationField; } @@ -18331,16 +18201,16 @@ export function deserializeSignRequestSignerInput( dateValue: dateValue, } satisfies SignRequestSignerInput; } -export function serializeSignRequestSignerSignerDecisionFieldTypeField( - val: SignRequestSignerSignerDecisionFieldTypeField +export function serializeSignRequestSignerSignerDecisionTypeField( + val: SignRequestSignerSignerDecisionTypeField ): SerializedData { return val; } -export function deserializeSignRequestSignerSignerDecisionFieldTypeField( +export function deserializeSignRequestSignerSignerDecisionTypeField( val: any -): SignRequestSignerSignerDecisionFieldTypeField { +): SignRequestSignerSignerDecisionTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "SignRequestSignerSignerDecisionFieldTypeField"'; + throw 'Expecting a string for "SignRequestSignerSignerDecisionTypeField"'; } if (val == 'signed') { return 'signed'; @@ -18357,7 +18227,7 @@ export function serializeSignRequestSignerSignerDecisionField( ['type']: val.type == void 0 ? void 0 - : serializeSignRequestSignerSignerDecisionFieldTypeField(val.type), + : serializeSignRequestSignerSignerDecisionTypeField(val.type), ['finalized_at']: val.finalizedAt == void 0 ? void 0 : val.finalizedAt, ['additional_info']: val.additionalInfo == void 0 ? void 0 : val.additionalInfo, @@ -18366,10 +18236,10 @@ export function serializeSignRequestSignerSignerDecisionField( export function deserializeSignRequestSignerSignerDecisionField( val: any ): SignRequestSignerSignerDecisionField { - const type: undefined | SignRequestSignerSignerDecisionFieldTypeField = + const type: undefined | SignRequestSignerSignerDecisionTypeField = val.type == void 0 ? void 0 - : deserializeSignRequestSignerSignerDecisionFieldTypeField(val.type); + : deserializeSignRequestSignerSignerDecisionTypeField(val.type); const finalizedAt: undefined | string = val.finalized_at == void 0 ? void 0 : val.finalized_at; const additionalInfo: undefined | string = @@ -19261,16 +19131,16 @@ export function deserializeSignTemplateTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeSignTemplateAdditionalInfoFieldNonEditableField( - val: SignTemplateAdditionalInfoFieldNonEditableField +export function serializeSignTemplateAdditionalInfoNonEditableField( + val: SignTemplateAdditionalInfoNonEditableField ): SerializedData { return val; } -export function deserializeSignTemplateAdditionalInfoFieldNonEditableField( +export function deserializeSignTemplateAdditionalInfoNonEditableField( val: any -): SignTemplateAdditionalInfoFieldNonEditableField { +): SignTemplateAdditionalInfoNonEditableField { if (!sdIsString(val)) { - throw 'Expecting a string for "SignTemplateAdditionalInfoFieldNonEditableField"'; + throw 'Expecting a string for "SignTemplateAdditionalInfoNonEditableField"'; } if (val == 'email_subject') { return 'email_subject'; @@ -19292,64 +19162,62 @@ export function deserializeSignTemplateAdditionalInfoFieldNonEditableField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeSignTemplateAdditionalInfoFieldRequiredFieldSignersField( - val: SignTemplateAdditionalInfoFieldRequiredFieldSignersField +export function serializeSignTemplateAdditionalInfoRequiredSignersField( + val: SignTemplateAdditionalInfoRequiredSignersField ): SerializedData { return val; } -export function deserializeSignTemplateAdditionalInfoFieldRequiredFieldSignersField( +export function deserializeSignTemplateAdditionalInfoRequiredSignersField( val: any -): SignTemplateAdditionalInfoFieldRequiredFieldSignersField { +): SignTemplateAdditionalInfoRequiredSignersField { if (!sdIsString(val)) { - throw 'Expecting a string for "SignTemplateAdditionalInfoFieldRequiredFieldSignersField"'; + throw 'Expecting a string for "SignTemplateAdditionalInfoRequiredSignersField"'; } if (val == 'email') { return 'email'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeSignTemplateAdditionalInfoFieldRequiredField( - val: SignTemplateAdditionalInfoFieldRequiredField +export function serializeSignTemplateAdditionalInfoRequiredField( + val: SignTemplateAdditionalInfoRequiredField ): SerializedData { return { ['signers']: val.signers == void 0 ? void 0 : (val.signers.map(function ( - item: readonly SignTemplateAdditionalInfoFieldRequiredFieldSignersField[] + item: readonly SignTemplateAdditionalInfoRequiredSignersField[] ): any { return item.map(function ( - item: SignTemplateAdditionalInfoFieldRequiredFieldSignersField + item: SignTemplateAdditionalInfoRequiredSignersField ): any { - return serializeSignTemplateAdditionalInfoFieldRequiredFieldSignersField( + return serializeSignTemplateAdditionalInfoRequiredSignersField( item ); }) as readonly any[]; }) as readonly any[]), }; } -export function deserializeSignTemplateAdditionalInfoFieldRequiredField( +export function deserializeSignTemplateAdditionalInfoRequiredField( val: any -): SignTemplateAdditionalInfoFieldRequiredField { +): SignTemplateAdditionalInfoRequiredField { const signers: | undefined - | readonly (readonly SignTemplateAdditionalInfoFieldRequiredFieldSignersField[])[] = + | readonly (readonly SignTemplateAdditionalInfoRequiredSignersField[])[] = val.signers == void 0 ? void 0 : sdIsList(val.signers) ? (val.signers.map(function (itm: SerializedData): any { return sdIsList(itm) ? (itm.map(function (itm: SerializedData): any { - return deserializeSignTemplateAdditionalInfoFieldRequiredFieldSignersField( + return deserializeSignTemplateAdditionalInfoRequiredSignersField( itm ); }) as readonly any[]) : []; }) as readonly any[]) : []; - return { - signers: signers, - } satisfies SignTemplateAdditionalInfoFieldRequiredField; + return { signers: signers } satisfies SignTemplateAdditionalInfoRequiredField; } export function serializeSignTemplateAdditionalInfoField( val: SignTemplateAdditionalInfoField @@ -19359,16 +19227,14 @@ export function serializeSignTemplateAdditionalInfoField( val.nonEditable == void 0 ? void 0 : (val.nonEditable.map(function ( - item: SignTemplateAdditionalInfoFieldNonEditableField + item: SignTemplateAdditionalInfoNonEditableField ): any { - return serializeSignTemplateAdditionalInfoFieldNonEditableField( - item - ); + return serializeSignTemplateAdditionalInfoNonEditableField(item); }) as readonly any[]), ['required']: val.required == void 0 ? void 0 - : serializeSignTemplateAdditionalInfoFieldRequiredField(val.required), + : serializeSignTemplateAdditionalInfoRequiredField(val.required), }; } export function deserializeSignTemplateAdditionalInfoField( @@ -19376,20 +19242,18 @@ export function deserializeSignTemplateAdditionalInfoField( ): SignTemplateAdditionalInfoField { const nonEditable: | undefined - | readonly SignTemplateAdditionalInfoFieldNonEditableField[] = + | readonly SignTemplateAdditionalInfoNonEditableField[] = val.non_editable == void 0 ? void 0 : sdIsList(val.non_editable) ? (val.non_editable.map(function (itm: SerializedData): any { - return deserializeSignTemplateAdditionalInfoFieldNonEditableField( - itm - ); + return deserializeSignTemplateAdditionalInfoNonEditableField(itm); }) as readonly any[]) : []; - const required: undefined | SignTemplateAdditionalInfoFieldRequiredField = + const required: undefined | SignTemplateAdditionalInfoRequiredField = val.required == void 0 ? void 0 - : deserializeSignTemplateAdditionalInfoFieldRequiredField(val.required); + : deserializeSignTemplateAdditionalInfoRequiredField(val.required); return { nonEditable: nonEditable, required: required, @@ -19845,16 +19709,16 @@ export function deserializeUserFullRoleField(val: any): UserFullRoleField { } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUserFullEnterpriseFieldTypeField( - val: UserFullEnterpriseFieldTypeField +export function serializeUserFullEnterpriseTypeField( + val: UserFullEnterpriseTypeField ): SerializedData { return val; } -export function deserializeUserFullEnterpriseFieldTypeField( +export function deserializeUserFullEnterpriseTypeField( val: any -): UserFullEnterpriseFieldTypeField { +): UserFullEnterpriseTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "UserFullEnterpriseFieldTypeField"'; + throw 'Expecting a string for "UserFullEnterpriseTypeField"'; } if (val == 'enterprise') { return 'enterprise'; @@ -19869,7 +19733,7 @@ export function serializeUserFullEnterpriseField( ['type']: val.type == void 0 ? void 0 - : serializeUserFullEnterpriseFieldTypeField(val.type), + : serializeUserFullEnterpriseTypeField(val.type), ['name']: val.name == void 0 ? void 0 : val.name, }; } @@ -19877,10 +19741,10 @@ export function deserializeUserFullEnterpriseField( val: any ): UserFullEnterpriseField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: undefined | UserFullEnterpriseFieldTypeField = + const type: undefined | UserFullEnterpriseTypeField = val.type == void 0 ? void 0 - : deserializeUserFullEnterpriseFieldTypeField(val.type); + : deserializeUserFullEnterpriseTypeField(val.type); const name: undefined | string = val.name == void 0 ? void 0 : val.name; return { id: id, type: type, name: name } satisfies UserFullEnterpriseField; } @@ -20044,16 +19908,16 @@ export function deserializeUserFull(val: any): UserFull { type: type, } satisfies UserFull; } -export function serializeUsersOrderFieldDirectionField( - val: UsersOrderFieldDirectionField +export function serializeUsersOrderDirectionField( + val: UsersOrderDirectionField ): SerializedData { return val; } -export function deserializeUsersOrderFieldDirectionField( +export function deserializeUsersOrderDirectionField( val: any -): UsersOrderFieldDirectionField { +): UsersOrderDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "UsersOrderFieldDirectionField"'; + throw 'Expecting a string for "UsersOrderDirectionField"'; } if (val == 'ASC') { return 'ASC'; @@ -20069,15 +19933,15 @@ export function serializeUsersOrderField(val: UsersOrderField): SerializedData { ['direction']: val.direction == void 0 ? void 0 - : serializeUsersOrderFieldDirectionField(val.direction), + : serializeUsersOrderDirectionField(val.direction), }; } export function deserializeUsersOrderField(val: any): UsersOrderField { const by: undefined | string = val.by == void 0 ? void 0 : val.by; - const direction: undefined | UsersOrderFieldDirectionField = + const direction: undefined | UsersOrderDirectionField = val.direction == void 0 ? void 0 - : deserializeUsersOrderFieldDirectionField(val.direction); + : deserializeUsersOrderDirectionField(val.direction); return { by: by, direction: direction } satisfies UsersOrderField; } export function serializeUsers(val: Users): SerializedData { @@ -20169,20 +20033,20 @@ export function deserializeMetadataFieldFilterMultiSelect( ): MetadataFieldFilterMultiSelect { return val; } -export function serializeMetadataFieldFilterFloatRangeMapValue( - val: MetadataFieldFilterFloatRangeMapValue +export function serializeMetadataFieldFilterFloatRangeValue( + val: MetadataFieldFilterFloatRangeValue ): SerializedData { return { ['lt']: val.lt == void 0 ? void 0 : val.lt, ['gt']: val.gt == void 0 ? void 0 : val.gt, }; } -export function deserializeMetadataFieldFilterFloatRangeMapValue( +export function deserializeMetadataFieldFilterFloatRangeValue( val: any -): MetadataFieldFilterFloatRangeMapValue { +): MetadataFieldFilterFloatRangeValue { const lt: undefined | number = val.lt == void 0 ? void 0 : val.lt; const gt: undefined | number = val.gt == void 0 ? void 0 : val.gt; - return { lt: lt, gt: gt } satisfies MetadataFieldFilterFloatRangeMapValue; + return { lt: lt, gt: gt } satisfies MetadataFieldFilterFloatRangeValue; } export function serializeMetadataFieldFilterFloatRange( val: MetadataFieldFilterFloatRange @@ -20190,7 +20054,7 @@ export function serializeMetadataFieldFilterFloatRange( return Object.fromEntries( Object.entries(val).map(([k, v]: [string, any]) => [ k, - serializeMetadataFieldFilterFloatRangeMapValue(v), + serializeMetadataFieldFilterFloatRangeValue(v), ]) ) as { readonly [key: string]: any; @@ -20201,20 +20065,20 @@ export function deserializeMetadataFieldFilterFloatRange( ): MetadataFieldFilterFloatRange { return val; } -export function serializeMetadataFieldFilterDateRangeMapValue( - val: MetadataFieldFilterDateRangeMapValue +export function serializeMetadataFieldFilterDateRangeValue( + val: MetadataFieldFilterDateRangeValue ): SerializedData { return { ['lt']: val.lt == void 0 ? void 0 : val.lt, ['gt']: val.gt == void 0 ? void 0 : val.gt, }; } -export function deserializeMetadataFieldFilterDateRangeMapValue( +export function deserializeMetadataFieldFilterDateRangeValue( val: any -): MetadataFieldFilterDateRangeMapValue { +): MetadataFieldFilterDateRangeValue { const lt: undefined | string = val.lt == void 0 ? void 0 : val.lt; const gt: undefined | string = val.gt == void 0 ? void 0 : val.gt; - return { lt: lt, gt: gt } satisfies MetadataFieldFilterDateRangeMapValue; + return { lt: lt, gt: gt } satisfies MetadataFieldFilterDateRangeValue; } export function serializeMetadataFieldFilterDateRange( val: MetadataFieldFilterDateRange @@ -20222,7 +20086,7 @@ export function serializeMetadataFieldFilterDateRange( return Object.fromEntries( Object.entries(val).map(([k, v]: [string, any]) => [ k, - serializeMetadataFieldFilterDateRangeMapValue(v), + serializeMetadataFieldFilterDateRangeValue(v), ]) ) as { readonly [key: string]: any; diff --git a/src/test/auth.generated.test.ts b/src/test/auth.generated.test.ts index 57160862..42564f2e 100644 --- a/src/test/auth.generated.test.ts +++ b/src/test/auth.generated.test.ts @@ -1,23 +1,23 @@ import { serializeFiles } from '../schemas.generated.js'; import { deserializeFiles } from '../schemas.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; import { serializeFileFull } from '../schemas.generated.js'; import { deserializeFileFull } from '../schemas.generated.js'; -import { serializeUpdateFileByIdRequestBodyArg } from '../managers/files.generated.js'; -import { deserializeUpdateFileByIdRequestBodyArg } from '../managers/files.generated.js'; +import { serializeUpdateFileByIdRequestBody } from '../managers/files.generated.js'; +import { deserializeUpdateFileByIdRequestBody } from '../managers/files.generated.js'; import { serializeUserFull } from '../schemas.generated.js'; import { deserializeUserFull } from '../schemas.generated.js'; -import { GetUserMeQueryParamsArg } from '../managers/users.generated.js'; +import { GetUserMeQueryParams } from '../managers/users.generated.js'; import { AccessToken } from '../schemas.generated.js'; import { Files } from '../schemas.generated.js'; -import { UploadFileRequestBodyArg } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBody } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; import { FileFull } from '../schemas.generated.js'; -import { UpdateFileByIdRequestBodyArg } from '../managers/files.generated.js'; +import { UpdateFileByIdRequestBody } from '../managers/files.generated.js'; import { decodeBase64 } from '../utils.js'; import { getEnvVar } from '../utils.js'; import { getUuid } from '../utils.js'; @@ -72,7 +72,7 @@ test('test_jwt_auth', async function test_jwt_auth(): Promise { await auth.asEnterprise(enterpriseId); const newUser: UserFull = await client.users.getUserMe({ fields: ['enterprise' as ''], - } satisfies GetUserMeQueryParamsArg); + } satisfies GetUserMeQueryParams); if (!!(newUser.enterprise == void 0)) { throw 'Assertion failed'; } @@ -120,7 +120,7 @@ test('test_ccg_auth', async function test_ccg_auth(): Promise { await auth.asEnterprise(enterpriseId); const newUser: UserFull = await client.users.getUserMe({ fields: ['enterprise' as ''], - } satisfies GetUserMeQueryParamsArg); + } satisfies GetUserMeQueryParams); if (!!(newUser.enterprise == void 0)) { throw 'Assertion failed'; } @@ -175,12 +175,10 @@ test('test_oauth_auth_downscope', async function test_oauth_auth_downscope(): Pr const uploadedFiles: Files = await parentClient.uploads.uploadFile({ attributes: { name: getUuid(), - parent: { - id: '0', - } satisfies UploadFileRequestBodyArgAttributesFieldParentField, - } satisfies UploadFileRequestBodyArgAttributesField, + parent: { id: '0' } satisfies UploadFileRequestBodyAttributesParentField, + } satisfies UploadFileRequestBodyAttributesField, file: generateByteStream(1024 * 1024), - } satisfies UploadFileRequestBodyArg); + } satisfies UploadFileRequestBody); const file: FileFull = uploadedFiles.entries![0]; const resourcePath: string = ''.concat( 'https://api.box.com/2.0/files/', @@ -198,7 +196,7 @@ test('test_oauth_auth_downscope', async function test_oauth_auth_downscope(): Pr }); await downscopedClient.files.updateFileById(file.id, { name: getUuid(), - } satisfies UpdateFileByIdRequestBodyArg); + } satisfies UpdateFileByIdRequestBody); await expect(async () => { await downscopedClient.files.deleteFileById(file.id); }).rejects.toThrow(); diff --git a/src/test/avatars.generated.test.ts b/src/test/avatars.generated.test.ts index 538a1778..d8003983 100644 --- a/src/test/avatars.generated.test.ts +++ b/src/test/avatars.generated.test.ts @@ -5,7 +5,7 @@ import { deserializeUserAvatar } from '../schemas.generated.js'; import { BoxClient } from '../client.generated.js'; import { UserFull } from '../schemas.generated.js'; import { UserAvatar } from '../schemas.generated.js'; -import { CreateUserAvatarRequestBodyArg } from '../managers/avatars.generated.js'; +import { CreateUserAvatarRequestBody } from '../managers/avatars.generated.js'; import { ByteStream } from '../utils.js'; import { decodeBase64 } from '../utils.js'; import { getEnvVar } from '../utils.js'; @@ -33,7 +33,7 @@ test('testAvatars', async function testAvatars(): Promise { ), picContentType: 'image/png', picFileName: 'avatar.png', - } satisfies CreateUserAvatarRequestBodyArg + } satisfies CreateUserAvatarRequestBody ); if (!!(createdAvatar.picUrls!.small == void 0)) { throw 'Assertion failed'; diff --git a/src/test/classifications.generated.test.ts b/src/test/classifications.generated.test.ts index 270d025b..ec897c7d 100644 --- a/src/test/classifications.generated.test.ts +++ b/src/test/classifications.generated.test.ts @@ -1,27 +1,27 @@ -import { serializeUpdateClassificationRequestBodyArg } from '../managers/classifications.generated.js'; -import { deserializeUpdateClassificationRequestBodyArg } from '../managers/classifications.generated.js'; -import { serializeUpdateClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; -import { deserializeUpdateClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; -import { serializeUpdateClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; -import { deserializeUpdateClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; -import { serializeUpdateClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; -import { deserializeUpdateClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; -import { serializeUpdateClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; -import { deserializeUpdateClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; -import { serializeUpdateClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; -import { deserializeUpdateClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; -import { serializeClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; -import { deserializeClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; +import { serializeUpdateClassificationRequestBody } from '../managers/classifications.generated.js'; +import { deserializeUpdateClassificationRequestBody } from '../managers/classifications.generated.js'; +import { serializeUpdateClassificationRequestBodyOpField } from '../managers/classifications.generated.js'; +import { deserializeUpdateClassificationRequestBodyOpField } from '../managers/classifications.generated.js'; +import { serializeUpdateClassificationRequestBodyFieldKeyField } from '../managers/classifications.generated.js'; +import { deserializeUpdateClassificationRequestBodyFieldKeyField } from '../managers/classifications.generated.js'; +import { serializeUpdateClassificationRequestBodyDataField } from '../managers/classifications.generated.js'; +import { deserializeUpdateClassificationRequestBodyDataField } from '../managers/classifications.generated.js'; +import { serializeUpdateClassificationRequestBodyDataStaticConfigField } from '../managers/classifications.generated.js'; +import { deserializeUpdateClassificationRequestBodyDataStaticConfigField } from '../managers/classifications.generated.js'; +import { serializeUpdateClassificationRequestBodyDataStaticConfigClassificationField } from '../managers/classifications.generated.js'; +import { deserializeUpdateClassificationRequestBodyDataStaticConfigClassificationField } from '../managers/classifications.generated.js'; +import { serializeClassificationTemplateFieldsOptionsField } from '../schemas.generated.js'; +import { deserializeClassificationTemplateFieldsOptionsField } from '../schemas.generated.js'; import { serializeClassificationTemplate } from '../schemas.generated.js'; import { deserializeClassificationTemplate } from '../schemas.generated.js'; import { BoxClient } from '../client.generated.js'; -import { UpdateClassificationRequestBodyArg } from '../managers/classifications.generated.js'; -import { UpdateClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; -import { UpdateClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; -import { UpdateClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; -import { UpdateClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; -import { UpdateClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; -import { ClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; +import { UpdateClassificationRequestBody } from '../managers/classifications.generated.js'; +import { UpdateClassificationRequestBodyOpField } from '../managers/classifications.generated.js'; +import { UpdateClassificationRequestBodyFieldKeyField } from '../managers/classifications.generated.js'; +import { UpdateClassificationRequestBodyDataField } from '../managers/classifications.generated.js'; +import { UpdateClassificationRequestBodyDataStaticConfigField } from '../managers/classifications.generated.js'; +import { UpdateClassificationRequestBodyDataStaticConfigClassificationField } from '../managers/classifications.generated.js'; +import { ClassificationTemplateFieldsOptionsField } from '../schemas.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; import { getOrCreateClassificationTemplate } from './commons.generated.js'; @@ -60,9 +60,9 @@ test('testClassifications', async function testClassifications(): Promise { const classificationTemplateWithUpdatedClassification: ClassificationTemplate = await client.classifications.updateClassification([ { - op: 'editEnumOption' as UpdateClassificationRequestBodyArgOpField, + op: 'editEnumOption' as UpdateClassificationRequestBodyOpField, fieldKey: - 'Box__Security__Classification__Key' as UpdateClassificationRequestBodyArgFieldKeyField, + 'Box__Security__Classification__Key' as UpdateClassificationRequestBodyFieldKeyField, enumOptionKey: classification.key, data: { key: updatedClassificationName, @@ -70,12 +70,12 @@ test('testClassifications', async function testClassifications(): Promise { classification: { colorId: 2, classificationDefinition: updatedClassificationDescription, - } satisfies UpdateClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField, - } satisfies UpdateClassificationRequestBodyArgDataFieldStaticConfigField, - } satisfies UpdateClassificationRequestBodyArgDataField, - } satisfies UpdateClassificationRequestBodyArg, + } satisfies UpdateClassificationRequestBodyDataStaticConfigClassificationField, + } satisfies UpdateClassificationRequestBodyDataStaticConfigField, + } satisfies UpdateClassificationRequestBodyDataField, + } satisfies UpdateClassificationRequestBody, ]); - const updatedClassifications: readonly ClassificationTemplateFieldsFieldOptionsField[] = + const updatedClassifications: readonly ClassificationTemplateFieldsOptionsField[] = classificationTemplateWithUpdatedClassification.fields[0].options; const updatedClassification: any = updatedClassifications[0]; if (!(updatedClassification.key == updatedClassificationName)) { diff --git a/src/test/client.generated.test.ts b/src/test/client.generated.test.ts index 3391ebad..18f8e39d 100644 --- a/src/test/client.generated.test.ts +++ b/src/test/client.generated.test.ts @@ -1,10 +1,10 @@ import { serializeUserFull } from '../schemas.generated.js'; import { deserializeUserFull } from '../schemas.generated.js'; -import { serializeCreateUserRequestBodyArg } from '../managers/users.generated.js'; -import { deserializeCreateUserRequestBodyArg } from '../managers/users.generated.js'; +import { serializeCreateUserRequestBody } from '../managers/users.generated.js'; +import { deserializeCreateUserRequestBody } from '../managers/users.generated.js'; import { BoxClient } from '../client.generated.js'; import { UserFull } from '../schemas.generated.js'; -import { CreateUserRequestBodyArg } from '../managers/users.generated.js'; +import { CreateUserRequestBody } from '../managers/users.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; import { toString } from '../utils.js'; @@ -22,7 +22,7 @@ test('testWithAsUserHeader', async function testWithAsUserHeader(): Promise const createdUser: UserFull = await client.users.createUser({ name: userName, isPlatformAccessOnly: true, - } satisfies CreateUserRequestBodyArg); + } satisfies CreateUserRequestBody); const asUserClient: BoxClient = client.withAsUserHeader(createdUser.id); const adminUser: UserFull = await client.users.getUserMe(); if (!!((toString(adminUser.name) as string) == userName)) { @@ -46,7 +46,7 @@ test('testWithExtraHeaders', async function testWithExtraHeaders(): Promise const createdUser: UserFull = await client.users.createUser({ name: userName, isPlatformAccessOnly: true, - } satisfies CreateUserRequestBodyArg); + } satisfies CreateUserRequestBody); const asUserClient: BoxClient = client.withExtraHeaders({ ['As-User']: createdUser.id, }); diff --git a/src/test/collaborationAllowlistEntries.generated.test.ts b/src/test/collaborationAllowlistEntries.generated.test.ts index b1bded23..d8b62b04 100644 --- a/src/test/collaborationAllowlistEntries.generated.test.ts +++ b/src/test/collaborationAllowlistEntries.generated.test.ts @@ -2,12 +2,12 @@ import { serializeCollaborationAllowlistEntries } from '../schemas.generated.js' import { deserializeCollaborationAllowlistEntries } from '../schemas.generated.js'; import { serializeCollaborationAllowlistEntry } from '../schemas.generated.js'; import { deserializeCollaborationAllowlistEntry } from '../schemas.generated.js'; -import { serializeCreateCollaborationWhitelistEntryRequestBodyArg } from '../managers/collaborationAllowlistEntries.generated.js'; -import { deserializeCreateCollaborationWhitelistEntryRequestBodyArg } from '../managers/collaborationAllowlistEntries.generated.js'; +import { serializeCreateCollaborationWhitelistEntryRequestBody } from '../managers/collaborationAllowlistEntries.generated.js'; +import { deserializeCreateCollaborationWhitelistEntryRequestBody } from '../managers/collaborationAllowlistEntries.generated.js'; import { BoxClient } from '../client.generated.js'; import { CollaborationAllowlistEntries } from '../schemas.generated.js'; import { CollaborationAllowlistEntry } from '../schemas.generated.js'; -import { CreateCollaborationWhitelistEntryRequestBodyArg } from '../managers/collaborationAllowlistEntries.generated.js'; +import { CreateCollaborationWhitelistEntryRequestBody } from '../managers/collaborationAllowlistEntries.generated.js'; import { getDefaultClient } from './commons.generated.js'; import { SerializedData } from '../json.js'; import { sdIsEmpty } from '../json.js'; @@ -30,7 +30,7 @@ test('collaborationAllowlistEntries', async function collaborationAllowlistEntri { direction: direction, domain: domain, - } satisfies CreateCollaborationWhitelistEntryRequestBodyArg + } satisfies CreateCollaborationWhitelistEntryRequestBody ); if (!(newEntry.type == 'collaboration_whitelist_entry')) { throw 'Assertion failed'; diff --git a/src/test/collaborationAllowlistExemptTargets.generated.test.ts b/src/test/collaborationAllowlistExemptTargets.generated.test.ts index 3ec1c25d..1ac9e8d1 100644 --- a/src/test/collaborationAllowlistExemptTargets.generated.test.ts +++ b/src/test/collaborationAllowlistExemptTargets.generated.test.ts @@ -2,21 +2,21 @@ import { serializeCollaborationAllowlistExemptTargets } from '../schemas.generat import { deserializeCollaborationAllowlistExemptTargets } from '../schemas.generated.js'; import { serializeUserFull } from '../schemas.generated.js'; import { deserializeUserFull } from '../schemas.generated.js'; -import { serializeCreateUserRequestBodyArg } from '../managers/users.generated.js'; -import { deserializeCreateUserRequestBodyArg } from '../managers/users.generated.js'; +import { serializeCreateUserRequestBody } from '../managers/users.generated.js'; +import { deserializeCreateUserRequestBody } from '../managers/users.generated.js'; import { serializeCollaborationAllowlistExemptTarget } from '../schemas.generated.js'; import { deserializeCollaborationAllowlistExemptTarget } from '../schemas.generated.js'; -import { serializeCreateCollaborationWhitelistExemptTargetRequestBodyArg } from '../managers/collaborationAllowlistExemptTargets.generated.js'; -import { deserializeCreateCollaborationWhitelistExemptTargetRequestBodyArg } from '../managers/collaborationAllowlistExemptTargets.generated.js'; -import { serializeCreateCollaborationWhitelistExemptTargetRequestBodyArgUserField } from '../managers/collaborationAllowlistExemptTargets.generated.js'; -import { deserializeCreateCollaborationWhitelistExemptTargetRequestBodyArgUserField } from '../managers/collaborationAllowlistExemptTargets.generated.js'; +import { serializeCreateCollaborationWhitelistExemptTargetRequestBody } from '../managers/collaborationAllowlistExemptTargets.generated.js'; +import { deserializeCreateCollaborationWhitelistExemptTargetRequestBody } from '../managers/collaborationAllowlistExemptTargets.generated.js'; +import { serializeCreateCollaborationWhitelistExemptTargetRequestBodyUserField } from '../managers/collaborationAllowlistExemptTargets.generated.js'; +import { deserializeCreateCollaborationWhitelistExemptTargetRequestBodyUserField } from '../managers/collaborationAllowlistExemptTargets.generated.js'; import { BoxClient } from '../client.generated.js'; import { CollaborationAllowlistExemptTargets } from '../schemas.generated.js'; import { UserFull } from '../schemas.generated.js'; -import { CreateUserRequestBodyArg } from '../managers/users.generated.js'; +import { CreateUserRequestBody } from '../managers/users.generated.js'; import { CollaborationAllowlistExemptTarget } from '../schemas.generated.js'; -import { CreateCollaborationWhitelistExemptTargetRequestBodyArg } from '../managers/collaborationAllowlistExemptTargets.generated.js'; -import { CreateCollaborationWhitelistExemptTargetRequestBodyArgUserField } from '../managers/collaborationAllowlistExemptTargets.generated.js'; +import { CreateCollaborationWhitelistExemptTargetRequestBody } from '../managers/collaborationAllowlistExemptTargets.generated.js'; +import { CreateCollaborationWhitelistExemptTargetRequestBodyUserField } from '../managers/collaborationAllowlistExemptTargets.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; import { toString } from '../utils.js'; @@ -39,14 +39,14 @@ test('collaborationAllowlistExemptTargets', async function collaborationAllowlis name: getUuid(), login: ''.concat(getUuid(), '@boxdemo.com') as string, isPlatformAccessOnly: true, - } satisfies CreateUserRequestBodyArg); + } satisfies CreateUserRequestBody); const newExemptTarget: CollaborationAllowlistExemptTarget = await client.collaborationAllowlistExemptTargets.createCollaborationWhitelistExemptTarget( { user: { id: user.id, - } satisfies CreateCollaborationWhitelistExemptTargetRequestBodyArgUserField, - } satisfies CreateCollaborationWhitelistExemptTargetRequestBodyArg + } satisfies CreateCollaborationWhitelistExemptTargetRequestBodyUserField, + } satisfies CreateCollaborationWhitelistExemptTargetRequestBody ); if ( !( diff --git a/src/test/collections.generated.test.ts b/src/test/collections.generated.test.ts index c6a966e3..c32377c5 100644 --- a/src/test/collections.generated.test.ts +++ b/src/test/collections.generated.test.ts @@ -6,23 +6,23 @@ import { serializeItems } from '../schemas.generated.js'; import { deserializeItems } from '../schemas.generated.js'; import { serializeFolderFull } from '../schemas.generated.js'; import { deserializeFolderFull } from '../schemas.generated.js'; -import { serializeCreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { deserializeCreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { serializeCreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; -import { deserializeCreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; -import { serializeUpdateFolderByIdRequestBodyArg } from '../managers/folders.generated.js'; -import { deserializeUpdateFolderByIdRequestBodyArg } from '../managers/folders.generated.js'; -import { serializeUpdateFolderByIdRequestBodyArgCollectionsField } from '../managers/folders.generated.js'; -import { deserializeUpdateFolderByIdRequestBodyArgCollectionsField } from '../managers/folders.generated.js'; +import { serializeCreateFolderRequestBody } from '../managers/folders.generated.js'; +import { deserializeCreateFolderRequestBody } from '../managers/folders.generated.js'; +import { serializeCreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; +import { deserializeCreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; +import { serializeUpdateFolderByIdRequestBody } from '../managers/folders.generated.js'; +import { deserializeUpdateFolderByIdRequestBody } from '../managers/folders.generated.js'; +import { serializeUpdateFolderByIdRequestBodyCollectionsField } from '../managers/folders.generated.js'; +import { deserializeUpdateFolderByIdRequestBodyCollectionsField } from '../managers/folders.generated.js'; import { BoxClient } from '../client.generated.js'; import { Collections } from '../schemas.generated.js'; import { Collection } from '../schemas.generated.js'; import { Items } from '../schemas.generated.js'; import { FolderFull } from '../schemas.generated.js'; -import { CreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { CreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; -import { UpdateFolderByIdRequestBodyArg } from '../managers/folders.generated.js'; -import { UpdateFolderByIdRequestBodyArgCollectionsField } from '../managers/folders.generated.js'; +import { CreateFolderRequestBody } from '../managers/folders.generated.js'; +import { CreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; +import { UpdateFolderByIdRequestBody } from '../managers/folders.generated.js'; +import { UpdateFolderByIdRequestBodyCollectionsField } from '../managers/folders.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; import { SerializedData } from '../json.js'; @@ -41,15 +41,15 @@ test('testCollections', async function testCollections(): Promise { ); const folder: FolderFull = await client.folders.createFolder({ name: getUuid(), - parent: { id: '0' } satisfies CreateFolderRequestBodyArgParentField, - } satisfies CreateFolderRequestBodyArg); + parent: { id: '0' } satisfies CreateFolderRequestBodyParentField, + } satisfies CreateFolderRequestBody); await client.folders.updateFolderById(folder.id, { collections: [ { id: favouriteCollection.id, - } satisfies UpdateFolderByIdRequestBodyArgCollectionsField, + } satisfies UpdateFolderByIdRequestBodyCollectionsField, ], - } satisfies UpdateFolderByIdRequestBodyArg); + } satisfies UpdateFolderByIdRequestBody); const collectionItemsAfterUpdate: Items = await client.collections.getCollectionItems(favouriteCollection.id!); if ( @@ -62,7 +62,7 @@ test('testCollections', async function testCollections(): Promise { } await client.folders.updateFolderById(folder.id, { collections: [], - } satisfies UpdateFolderByIdRequestBodyArg); + } satisfies UpdateFolderByIdRequestBody); const collectionItemsAfterRemove: Items = await client.collections.getCollectionItems(favouriteCollection.id!); if ( diff --git a/src/test/comments.generated.test.ts b/src/test/comments.generated.test.ts index fbed8b64..fc20ac78 100644 --- a/src/test/comments.generated.test.ts +++ b/src/test/comments.generated.test.ts @@ -1,33 +1,33 @@ import { serializeFiles } from '../schemas.generated.js'; import { deserializeFiles } from '../schemas.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; import { serializeComments } from '../schemas.generated.js'; import { deserializeComments } from '../schemas.generated.js'; import { serializeCommentFull } from '../schemas.generated.js'; import { deserializeCommentFull } from '../schemas.generated.js'; -import { serializeCreateCommentRequestBodyArg } from '../managers/comments.generated.js'; -import { deserializeCreateCommentRequestBodyArg } from '../managers/comments.generated.js'; -import { serializeCreateCommentRequestBodyArgItemField } from '../managers/comments.generated.js'; -import { deserializeCreateCommentRequestBodyArgItemField } from '../managers/comments.generated.js'; -import { serializeCreateCommentRequestBodyArgItemFieldTypeField } from '../managers/comments.generated.js'; -import { deserializeCreateCommentRequestBodyArgItemFieldTypeField } from '../managers/comments.generated.js'; -import { serializeUpdateCommentByIdRequestBodyArg } from '../managers/comments.generated.js'; -import { deserializeUpdateCommentByIdRequestBodyArg } from '../managers/comments.generated.js'; +import { serializeCreateCommentRequestBody } from '../managers/comments.generated.js'; +import { deserializeCreateCommentRequestBody } from '../managers/comments.generated.js'; +import { serializeCreateCommentRequestBodyItemField } from '../managers/comments.generated.js'; +import { deserializeCreateCommentRequestBodyItemField } from '../managers/comments.generated.js'; +import { serializeCreateCommentRequestBodyItemTypeField } from '../managers/comments.generated.js'; +import { deserializeCreateCommentRequestBodyItemTypeField } from '../managers/comments.generated.js'; +import { serializeUpdateCommentByIdRequestBody } from '../managers/comments.generated.js'; +import { deserializeUpdateCommentByIdRequestBody } from '../managers/comments.generated.js'; import { BoxClient } from '../client.generated.js'; import { ByteStream } from '../utils.js'; import { Files } from '../schemas.generated.js'; -import { UploadFileRequestBodyArg } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBody } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; import { Comments } from '../schemas.generated.js'; import { CommentFull } from '../schemas.generated.js'; -import { CreateCommentRequestBodyArg } from '../managers/comments.generated.js'; -import { CreateCommentRequestBodyArgItemField } from '../managers/comments.generated.js'; -import { CreateCommentRequestBodyArgItemFieldTypeField } from '../managers/comments.generated.js'; -import { UpdateCommentByIdRequestBodyArg } from '../managers/comments.generated.js'; +import { CreateCommentRequestBody } from '../managers/comments.generated.js'; +import { CreateCommentRequestBodyItemField } from '../managers/comments.generated.js'; +import { CreateCommentRequestBodyItemTypeField } from '../managers/comments.generated.js'; +import { UpdateCommentByIdRequestBody } from '../managers/comments.generated.js'; import { generateByteStream } from '../utils.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; @@ -49,10 +49,10 @@ test('comments', async function comments(): Promise { name: fileName, parent: { id: parentId, - } satisfies UploadFileRequestBodyArgAttributesFieldParentField, - } satisfies UploadFileRequestBodyArgAttributesField, + } satisfies UploadFileRequestBodyAttributesParentField, + } satisfies UploadFileRequestBodyAttributesField, file: fileByteStream, - } satisfies UploadFileRequestBodyArg); + } satisfies UploadFileRequestBody); const fileId: string = uploadedFiles.entries![0].id; const comments: Comments = await client.comments.getFileComments(fileId); if (!(comments.totalCount == 0)) { @@ -63,9 +63,9 @@ test('comments', async function comments(): Promise { message: message, item: { id: fileId, - type: 'file' as CreateCommentRequestBodyArgItemFieldTypeField, - } satisfies CreateCommentRequestBodyArgItemField, - } satisfies CreateCommentRequestBodyArg); + type: 'file' as CreateCommentRequestBodyItemTypeField, + } satisfies CreateCommentRequestBodyItemField, + } satisfies CreateCommentRequestBody); if (!(newComment.message == message)) { throw 'Assertion failed'; } @@ -79,9 +79,9 @@ test('comments', async function comments(): Promise { message: message, item: { id: newComment.id!, - type: 'comment' as CreateCommentRequestBodyArgItemFieldTypeField, - } satisfies CreateCommentRequestBodyArgItemField, - } satisfies CreateCommentRequestBodyArg); + type: 'comment' as CreateCommentRequestBodyItemTypeField, + } satisfies CreateCommentRequestBodyItemField, + } satisfies CreateCommentRequestBody); if (!(newReplyComment.message == message)) { throw 'Assertion failed'; } @@ -91,7 +91,7 @@ test('comments', async function comments(): Promise { const newMessage: string = 'Hi!'; await client.comments.updateCommentById(newReplyComment.id!, { message: newMessage, - } satisfies UpdateCommentByIdRequestBodyArg); + } satisfies UpdateCommentByIdRequestBody); const newComments: Comments = await client.comments.getFileComments(fileId); if (!(newComments.totalCount == 2)) { throw 'Assertion failed'; diff --git a/src/test/commons.generated.ts b/src/test/commons.generated.ts index 06ee8fca..0f7e3b29 100644 --- a/src/test/commons.generated.ts +++ b/src/test/commons.generated.ts @@ -1,53 +1,53 @@ import { serializeFolderFull } from '../schemas.generated.js'; import { deserializeFolderFull } from '../schemas.generated.js'; -import { serializeCreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { deserializeCreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { serializeCreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; -import { deserializeCreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; +import { serializeCreateFolderRequestBody } from '../managers/folders.generated.js'; +import { deserializeCreateFolderRequestBody } from '../managers/folders.generated.js'; +import { serializeCreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; +import { deserializeCreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; import { serializeFileFull } from '../schemas.generated.js'; import { deserializeFileFull } from '../schemas.generated.js'; import { serializeFiles } from '../schemas.generated.js'; import { deserializeFiles } from '../schemas.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; -import { serializeClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; -import { deserializeClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; -import { serializeAddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; -import { serializeCreateClassificationTemplateRequestBodyArg } from '../managers/classifications.generated.js'; -import { deserializeCreateClassificationTemplateRequestBodyArg } from '../managers/classifications.generated.js'; -import { serializeCreateClassificationTemplateRequestBodyArgScopeField } from '../managers/classifications.generated.js'; -import { deserializeCreateClassificationTemplateRequestBodyArgScopeField } from '../managers/classifications.generated.js'; -import { serializeCreateClassificationTemplateRequestBodyArgDisplayNameField } from '../managers/classifications.generated.js'; -import { deserializeCreateClassificationTemplateRequestBodyArgDisplayNameField } from '../managers/classifications.generated.js'; -import { serializeCreateClassificationTemplateRequestBodyArgTemplateKeyField } from '../managers/classifications.generated.js'; -import { deserializeCreateClassificationTemplateRequestBodyArgTemplateKeyField } from '../managers/classifications.generated.js'; -import { serializeCreateClassificationTemplateRequestBodyArgFieldsField } from '../managers/classifications.generated.js'; -import { deserializeCreateClassificationTemplateRequestBodyArgFieldsField } from '../managers/classifications.generated.js'; -import { serializeCreateClassificationTemplateRequestBodyArgFieldsFieldTypeField } from '../managers/classifications.generated.js'; -import { deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldTypeField } from '../managers/classifications.generated.js'; -import { serializeCreateClassificationTemplateRequestBodyArgFieldsFieldKeyField } from '../managers/classifications.generated.js'; -import { deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldKeyField } from '../managers/classifications.generated.js'; -import { serializeCreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField } from '../managers/classifications.generated.js'; -import { deserializeCreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField } from '../managers/classifications.generated.js'; +import { serializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; +import { serializeClassificationTemplateFieldsOptionsField } from '../schemas.generated.js'; +import { deserializeClassificationTemplateFieldsOptionsField } from '../schemas.generated.js'; +import { serializeAddClassificationRequestBody } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBody } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyOpField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyOpField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyFieldKeyField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyFieldKeyField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyDataField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyDataField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyDataStaticConfigField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyDataStaticConfigField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyDataStaticConfigClassificationField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyDataStaticConfigClassificationField } from '../managers/classifications.generated.js'; +import { serializeCreateClassificationTemplateRequestBody } from '../managers/classifications.generated.js'; +import { deserializeCreateClassificationTemplateRequestBody } from '../managers/classifications.generated.js'; +import { serializeCreateClassificationTemplateRequestBodyScopeField } from '../managers/classifications.generated.js'; +import { deserializeCreateClassificationTemplateRequestBodyScopeField } from '../managers/classifications.generated.js'; +import { serializeCreateClassificationTemplateRequestBodyDisplayNameField } from '../managers/classifications.generated.js'; +import { deserializeCreateClassificationTemplateRequestBodyDisplayNameField } from '../managers/classifications.generated.js'; +import { serializeCreateClassificationTemplateRequestBodyTemplateKeyField } from '../managers/classifications.generated.js'; +import { deserializeCreateClassificationTemplateRequestBodyTemplateKeyField } from '../managers/classifications.generated.js'; +import { serializeCreateClassificationTemplateRequestBodyFieldsField } from '../managers/classifications.generated.js'; +import { deserializeCreateClassificationTemplateRequestBodyFieldsField } from '../managers/classifications.generated.js'; +import { serializeCreateClassificationTemplateRequestBodyFieldsTypeField } from '../managers/classifications.generated.js'; +import { deserializeCreateClassificationTemplateRequestBodyFieldsTypeField } from '../managers/classifications.generated.js'; +import { serializeCreateClassificationTemplateRequestBodyFieldsKeyField } from '../managers/classifications.generated.js'; +import { deserializeCreateClassificationTemplateRequestBodyFieldsKeyField } from '../managers/classifications.generated.js'; +import { serializeCreateClassificationTemplateRequestBodyFieldsDisplayNameField } from '../managers/classifications.generated.js'; +import { deserializeCreateClassificationTemplateRequestBodyFieldsDisplayNameField } from '../managers/classifications.generated.js'; import { serializeShieldInformationBarrier } from '../schemas.generated.js'; import { deserializeShieldInformationBarrier } from '../schemas.generated.js'; import { serializeShieldInformationBarriers } from '../schemas.generated.js'; import { deserializeShieldInformationBarriers } from '../schemas.generated.js'; -import { serializeCreateShieldInformationBarrierRequestBodyArg } from '../managers/shieldInformationBarriers.generated.js'; -import { deserializeCreateShieldInformationBarrierRequestBodyArg } from '../managers/shieldInformationBarriers.generated.js'; +import { serializeCreateShieldInformationBarrierRequestBody } from '../managers/shieldInformationBarriers.generated.js'; +import { deserializeCreateShieldInformationBarrierRequestBody } from '../managers/shieldInformationBarriers.generated.js'; import { serializeEnterpriseBase } from '../schemas.generated.js'; import { deserializeEnterpriseBase } from '../schemas.generated.js'; import { serializeEnterpriseBaseTypeField } from '../schemas.generated.js'; @@ -55,32 +55,32 @@ import { deserializeEnterpriseBaseTypeField } from '../schemas.generated.js'; import { serializeClassificationTemplate } from '../schemas.generated.js'; import { deserializeClassificationTemplate } from '../schemas.generated.js'; import { FolderFull } from '../schemas.generated.js'; -import { CreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { CreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; +import { CreateFolderRequestBody } from '../managers/folders.generated.js'; +import { CreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; import { FileFull } from '../schemas.generated.js'; import { ByteStream } from '../utils.js'; import { Files } from '../schemas.generated.js'; -import { UploadFileRequestBodyArg } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; -import { ClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; -import { AddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; -import { CreateClassificationTemplateRequestBodyArg } from '../managers/classifications.generated.js'; -import { CreateClassificationTemplateRequestBodyArgScopeField } from '../managers/classifications.generated.js'; -import { CreateClassificationTemplateRequestBodyArgDisplayNameField } from '../managers/classifications.generated.js'; -import { CreateClassificationTemplateRequestBodyArgTemplateKeyField } from '../managers/classifications.generated.js'; -import { CreateClassificationTemplateRequestBodyArgFieldsField } from '../managers/classifications.generated.js'; -import { CreateClassificationTemplateRequestBodyArgFieldsFieldTypeField } from '../managers/classifications.generated.js'; -import { CreateClassificationTemplateRequestBodyArgFieldsFieldKeyField } from '../managers/classifications.generated.js'; -import { CreateClassificationTemplateRequestBodyArgFieldsFieldDisplayNameField } from '../managers/classifications.generated.js'; +import { UploadFileRequestBody } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; +import { ClassificationTemplateFieldsOptionsField } from '../schemas.generated.js'; +import { AddClassificationRequestBody } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyOpField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyFieldKeyField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyDataField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyDataStaticConfigField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyDataStaticConfigClassificationField } from '../managers/classifications.generated.js'; +import { CreateClassificationTemplateRequestBody } from '../managers/classifications.generated.js'; +import { CreateClassificationTemplateRequestBodyScopeField } from '../managers/classifications.generated.js'; +import { CreateClassificationTemplateRequestBodyDisplayNameField } from '../managers/classifications.generated.js'; +import { CreateClassificationTemplateRequestBodyTemplateKeyField } from '../managers/classifications.generated.js'; +import { CreateClassificationTemplateRequestBodyFieldsField } from '../managers/classifications.generated.js'; +import { CreateClassificationTemplateRequestBodyFieldsTypeField } from '../managers/classifications.generated.js'; +import { CreateClassificationTemplateRequestBodyFieldsKeyField } from '../managers/classifications.generated.js'; +import { CreateClassificationTemplateRequestBodyFieldsDisplayNameField } from '../managers/classifications.generated.js'; import { ShieldInformationBarrier } from '../schemas.generated.js'; import { ShieldInformationBarriers } from '../schemas.generated.js'; -import { CreateShieldInformationBarrierRequestBodyArg } from '../managers/shieldInformationBarriers.generated.js'; +import { CreateShieldInformationBarrierRequestBody } from '../managers/shieldInformationBarriers.generated.js'; import { EnterpriseBase } from '../schemas.generated.js'; import { EnterpriseBaseTypeField } from '../schemas.generated.js'; import { decodeBase64 } from '../utils.js'; @@ -121,8 +121,8 @@ export async function createNewFolder(): Promise { const newFolderName: string = getUuid(); return await client.folders.createFolder({ name: newFolderName, - parent: { id: '0' } satisfies CreateFolderRequestBodyArgParentField, - } satisfies CreateFolderRequestBodyArg); + parent: { id: '0' } satisfies CreateFolderRequestBodyParentField, + } satisfies CreateFolderRequestBody); } export async function uploadNewFile(): Promise { const client: BoxClient = getDefaultClient(); @@ -131,38 +131,36 @@ export async function uploadNewFile(): Promise { const uploadedFiles: Files = await client.uploads.uploadFile({ attributes: { name: newFileName, - parent: { - id: '0', - } satisfies UploadFileRequestBodyArgAttributesFieldParentField, - } satisfies UploadFileRequestBodyArgAttributesField, + parent: { id: '0' } satisfies UploadFileRequestBodyAttributesParentField, + } satisfies UploadFileRequestBodyAttributesField, file: fileContentStream, - } satisfies UploadFileRequestBodyArg); + } satisfies UploadFileRequestBody); return uploadedFiles.entries![0]; } export async function getOrCreateClassification( classificationTemplate: ClassificationTemplate ): Promise { const client: BoxClient = getDefaultClient(); - const classifications: readonly ClassificationTemplateFieldsFieldOptionsField[] = + const classifications: readonly ClassificationTemplateFieldsOptionsField[] = classificationTemplate.fields[0].options; const currentNumberOfClassifications: number = classifications.length; if (currentNumberOfClassifications == 0) { const classificationTemplateWithNewClassification: ClassificationTemplate = await client.classifications.addClassification([ { - op: 'addEnumOption' as AddClassificationRequestBodyArgOpField, + op: 'addEnumOption' as AddClassificationRequestBodyOpField, fieldKey: - 'Box__Security__Classification__Key' as AddClassificationRequestBodyArgFieldKeyField, + 'Box__Security__Classification__Key' as AddClassificationRequestBodyFieldKeyField, data: { key: getUuid(), staticConfig: { classification: { colorId: 3, classificationDefinition: 'Some description', - } satisfies AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField, - } satisfies AddClassificationRequestBodyArgDataFieldStaticConfigField, - } satisfies AddClassificationRequestBodyArgDataField, - } satisfies AddClassificationRequestBodyArg, + } satisfies AddClassificationRequestBodyDataStaticConfigClassificationField, + } satisfies AddClassificationRequestBodyDataStaticConfigField, + } satisfies AddClassificationRequestBodyDataField, + } satisfies AddClassificationRequestBody, ]); return classificationTemplateWithNewClassification.fields[0].options[0]; } @@ -174,22 +172,21 @@ export async function getOrCreateClassificationTemplate(): Promise { const uploadedFiles: Files = await client.uploads.uploadFile({ attributes: { name: newFileName, - parent: { - id: '0', - } satisfies UploadFileRequestBodyArgAttributesFieldParentField, - } satisfies UploadFileRequestBodyArgAttributesField, + parent: { id: '0' } satisfies UploadFileRequestBodyAttributesParentField, + } satisfies UploadFileRequestBodyAttributesField, file: fileContentStream, - } satisfies UploadFileRequestBodyArg); + } satisfies UploadFileRequestBody); const uploadedFile: FileFull = uploadedFiles.entries![0]; const downloadedFileContent: ByteStream = await client.downloads.downloadFile( uploadedFile.id diff --git a/src/test/emailAliases.generated.test.ts b/src/test/emailAliases.generated.test.ts index 7cd15658..47809d11 100644 --- a/src/test/emailAliases.generated.test.ts +++ b/src/test/emailAliases.generated.test.ts @@ -1,19 +1,19 @@ import { serializeUserFull } from '../schemas.generated.js'; import { deserializeUserFull } from '../schemas.generated.js'; -import { serializeCreateUserRequestBodyArg } from '../managers/users.generated.js'; -import { deserializeCreateUserRequestBodyArg } from '../managers/users.generated.js'; +import { serializeCreateUserRequestBody } from '../managers/users.generated.js'; +import { deserializeCreateUserRequestBody } from '../managers/users.generated.js'; import { serializeEmailAliases } from '../schemas.generated.js'; import { deserializeEmailAliases } from '../schemas.generated.js'; import { serializeEmailAlias } from '../schemas.generated.js'; import { deserializeEmailAlias } from '../schemas.generated.js'; -import { serializeCreateUserEmailAliasRequestBodyArg } from '../managers/emailAliases.generated.js'; -import { deserializeCreateUserEmailAliasRequestBodyArg } from '../managers/emailAliases.generated.js'; +import { serializeCreateUserEmailAliasRequestBody } from '../managers/emailAliases.generated.js'; +import { deserializeCreateUserEmailAliasRequestBody } from '../managers/emailAliases.generated.js'; import { BoxClient } from '../client.generated.js'; import { UserFull } from '../schemas.generated.js'; -import { CreateUserRequestBodyArg } from '../managers/users.generated.js'; +import { CreateUserRequestBody } from '../managers/users.generated.js'; import { EmailAliases } from '../schemas.generated.js'; import { EmailAlias } from '../schemas.generated.js'; -import { CreateUserEmailAliasRequestBodyArg } from '../managers/emailAliases.generated.js'; +import { CreateUserEmailAliasRequestBody } from '../managers/emailAliases.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; import { SerializedData } from '../json.js'; @@ -30,7 +30,7 @@ test('testEmailAliases', async function testEmailAliases(): Promise { const newUser: UserFull = await client.users.createUser({ name: newUserName, login: newUserLogin, - } satisfies CreateUserRequestBodyArg); + } satisfies CreateUserRequestBody); const aliases: EmailAliases = await client.emailAliases.getUserEmailAliases( newUser.id ); @@ -40,7 +40,7 @@ test('testEmailAliases', async function testEmailAliases(): Promise { const newAliasEmail: string = ''.concat(newUser.id, '@boxdemo.com') as string; const newAlias: EmailAlias = await client.emailAliases.createUserEmailAlias( newUser.id, - { email: newAliasEmail } satisfies CreateUserEmailAliasRequestBodyArg + { email: newAliasEmail } satisfies CreateUserEmailAliasRequestBody ); const updatedAliases: EmailAliases = await client.emailAliases.getUserEmailAliases(newUser.id); diff --git a/src/test/fileClassifications.generated.test.ts b/src/test/fileClassifications.generated.test.ts index 35c0d7cc..cd9a2e38 100644 --- a/src/test/fileClassifications.generated.test.ts +++ b/src/test/fileClassifications.generated.test.ts @@ -1,45 +1,45 @@ -import { serializeClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; -import { deserializeClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; -import { serializeAddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; +import { serializeClassificationTemplateFieldsOptionsField } from '../schemas.generated.js'; +import { deserializeClassificationTemplateFieldsOptionsField } from '../schemas.generated.js'; +import { serializeAddClassificationRequestBody } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBody } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyOpField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyOpField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyFieldKeyField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyFieldKeyField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyDataField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyDataField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyDataStaticConfigField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyDataStaticConfigField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyDataStaticConfigClassificationField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyDataStaticConfigClassificationField } from '../managers/classifications.generated.js'; import { serializeFileFull } from '../schemas.generated.js'; import { deserializeFileFull } from '../schemas.generated.js'; import { serializeClassification } from '../schemas.generated.js'; import { deserializeClassification } from '../schemas.generated.js'; -import { serializeAddClassificationToFileRequestBodyArg } from '../managers/fileClassifications.generated.js'; -import { deserializeAddClassificationToFileRequestBodyArg } from '../managers/fileClassifications.generated.js'; -import { serializeUpdateClassificationOnFileRequestBodyArg } from '../managers/fileClassifications.generated.js'; -import { deserializeUpdateClassificationOnFileRequestBodyArg } from '../managers/fileClassifications.generated.js'; -import { serializeUpdateClassificationOnFileRequestBodyArgOpField } from '../managers/fileClassifications.generated.js'; -import { deserializeUpdateClassificationOnFileRequestBodyArgOpField } from '../managers/fileClassifications.generated.js'; -import { serializeUpdateClassificationOnFileRequestBodyArgPathField } from '../managers/fileClassifications.generated.js'; -import { deserializeUpdateClassificationOnFileRequestBodyArgPathField } from '../managers/fileClassifications.generated.js'; +import { serializeAddClassificationToFileRequestBody } from '../managers/fileClassifications.generated.js'; +import { deserializeAddClassificationToFileRequestBody } from '../managers/fileClassifications.generated.js'; +import { serializeUpdateClassificationOnFileRequestBody } from '../managers/fileClassifications.generated.js'; +import { deserializeUpdateClassificationOnFileRequestBody } from '../managers/fileClassifications.generated.js'; +import { serializeUpdateClassificationOnFileRequestBodyOpField } from '../managers/fileClassifications.generated.js'; +import { deserializeUpdateClassificationOnFileRequestBodyOpField } from '../managers/fileClassifications.generated.js'; +import { serializeUpdateClassificationOnFileRequestBodyPathField } from '../managers/fileClassifications.generated.js'; +import { deserializeUpdateClassificationOnFileRequestBodyPathField } from '../managers/fileClassifications.generated.js'; import { serializeClassificationTemplate } from '../schemas.generated.js'; import { deserializeClassificationTemplate } from '../schemas.generated.js'; import { BoxClient } from '../client.generated.js'; -import { ClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; -import { AddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; +import { ClassificationTemplateFieldsOptionsField } from '../schemas.generated.js'; +import { AddClassificationRequestBody } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyOpField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyFieldKeyField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyDataField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyDataStaticConfigField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyDataStaticConfigClassificationField } from '../managers/classifications.generated.js'; import { FileFull } from '../schemas.generated.js'; import { Classification } from '../schemas.generated.js'; -import { AddClassificationToFileRequestBodyArg } from '../managers/fileClassifications.generated.js'; -import { UpdateClassificationOnFileRequestBodyArg } from '../managers/fileClassifications.generated.js'; -import { UpdateClassificationOnFileRequestBodyArgOpField } from '../managers/fileClassifications.generated.js'; -import { UpdateClassificationOnFileRequestBodyArgPathField } from '../managers/fileClassifications.generated.js'; +import { AddClassificationToFileRequestBody } from '../managers/fileClassifications.generated.js'; +import { UpdateClassificationOnFileRequestBody } from '../managers/fileClassifications.generated.js'; +import { UpdateClassificationOnFileRequestBodyOpField } from '../managers/fileClassifications.generated.js'; +import { UpdateClassificationOnFileRequestBodyPathField } from '../managers/fileClassifications.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; import { uploadNewFile } from './commons.generated.js'; @@ -57,26 +57,26 @@ const client: BoxClient = getDefaultClient(); export async function getOrCreateSecondClassification( classificationTemplate: ClassificationTemplate ): Promise { - const classifications: readonly ClassificationTemplateFieldsFieldOptionsField[] = + const classifications: readonly ClassificationTemplateFieldsOptionsField[] = classificationTemplate.fields[0].options; const currentNumberOfClassifications: number = classifications.length; if (currentNumberOfClassifications == 1) { const classificationTemplateWithNewClassification: ClassificationTemplate = await client.classifications.addClassification([ { - op: 'addEnumOption' as AddClassificationRequestBodyArgOpField, + op: 'addEnumOption' as AddClassificationRequestBodyOpField, fieldKey: - 'Box__Security__Classification__Key' as AddClassificationRequestBodyArgFieldKeyField, + 'Box__Security__Classification__Key' as AddClassificationRequestBodyFieldKeyField, data: { key: getUuid(), staticConfig: { classification: { colorId: 4, classificationDefinition: 'Other description', - } satisfies AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField, - } satisfies AddClassificationRequestBodyArgDataFieldStaticConfigField, - } satisfies AddClassificationRequestBodyArgDataField, - } satisfies AddClassificationRequestBodyArg, + } satisfies AddClassificationRequestBodyDataStaticConfigClassificationField, + } satisfies AddClassificationRequestBodyDataStaticConfigField, + } satisfies AddClassificationRequestBodyDataField, + } satisfies AddClassificationRequestBody, ]); return classificationTemplateWithNewClassification.fields[0].options[1]; } @@ -95,7 +95,7 @@ test('testFileClassifications', async function testFileClassifications(): Promis const createdFileClassification: Classification = await client.fileClassifications.addClassificationToFile(file.id, { boxSecurityClassificationKey: classification.key, - } satisfies AddClassificationToFileRequestBodyArg); + } satisfies AddClassificationToFileRequestBody); if ( !( createdFileClassification.boxSecurityClassificationKey == @@ -117,10 +117,10 @@ test('testFileClassifications', async function testFileClassifications(): Promis const updatedFileClassification: Classification = await client.fileClassifications.updateClassificationOnFile(file.id, [ { - op: 'replace' as UpdateClassificationOnFileRequestBodyArgOpField, - path: '/Box__Security__Classification__Key' as UpdateClassificationOnFileRequestBodyArgPathField, + op: 'replace' as UpdateClassificationOnFileRequestBodyOpField, + path: '/Box__Security__Classification__Key' as UpdateClassificationOnFileRequestBodyPathField, value: secondClassification.key, - } satisfies UpdateClassificationOnFileRequestBodyArg, + } satisfies UpdateClassificationOnFileRequestBody, ]); if ( !( diff --git a/src/test/fileMetadata.generated.test.ts b/src/test/fileMetadata.generated.test.ts index 8a1364ba..12f4406e 100644 --- a/src/test/fileMetadata.generated.test.ts +++ b/src/test/fileMetadata.generated.test.ts @@ -4,28 +4,28 @@ import { serializeMetadatas } from '../schemas.generated.js'; import { deserializeMetadatas } from '../schemas.generated.js'; import { serializeMetadataFull } from '../schemas.generated.js'; import { deserializeMetadataFull } from '../schemas.generated.js'; -import { serializeCreateFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; -import { deserializeCreateFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; -import { serializeGetFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; -import { deserializeGetFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; -import { serializeUpdateFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; -import { deserializeUpdateFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; -import { serializeUpdateFileMetadataByIdRequestBodyArg } from '../managers/fileMetadata.generated.js'; -import { deserializeUpdateFileMetadataByIdRequestBodyArg } from '../managers/fileMetadata.generated.js'; -import { serializeUpdateFileMetadataByIdRequestBodyArgOpField } from '../managers/fileMetadata.generated.js'; -import { deserializeUpdateFileMetadataByIdRequestBodyArgOpField } from '../managers/fileMetadata.generated.js'; -import { serializeDeleteFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; -import { deserializeDeleteFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; +import { serializeCreateFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; +import { deserializeCreateFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; +import { serializeGetFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; +import { deserializeGetFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; +import { serializeUpdateFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; +import { deserializeUpdateFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; +import { serializeUpdateFileMetadataByIdRequestBody } from '../managers/fileMetadata.generated.js'; +import { deserializeUpdateFileMetadataByIdRequestBody } from '../managers/fileMetadata.generated.js'; +import { serializeUpdateFileMetadataByIdRequestBodyOpField } from '../managers/fileMetadata.generated.js'; +import { deserializeUpdateFileMetadataByIdRequestBodyOpField } from '../managers/fileMetadata.generated.js'; +import { serializeDeleteFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; +import { deserializeDeleteFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; import { BoxClient } from '../client.generated.js'; import { FileFull } from '../schemas.generated.js'; import { Metadatas } from '../schemas.generated.js'; import { MetadataFull } from '../schemas.generated.js'; -import { CreateFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; -import { GetFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; -import { UpdateFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; -import { UpdateFileMetadataByIdRequestBodyArg } from '../managers/fileMetadata.generated.js'; -import { UpdateFileMetadataByIdRequestBodyArgOpField } from '../managers/fileMetadata.generated.js'; -import { DeleteFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; +import { CreateFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; +import { GetFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; +import { UpdateFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; +import { UpdateFileMetadataByIdRequestBody } from '../managers/fileMetadata.generated.js'; +import { UpdateFileMetadataByIdRequestBodyOpField } from '../managers/fileMetadata.generated.js'; +import { DeleteFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; import { generateByteStream } from '../utils.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; @@ -48,7 +48,7 @@ test('testFileMetadata', async function testFileMetadata(): Promise { } const createdMetadata: any = await client.fileMetadata.createFileMetadataById( file.id, - 'global' as CreateFileMetadataByIdScopeArg, + 'global' as CreateFileMetadataByIdScope, 'properties', { ['abc']: 'xyz' } ); @@ -63,7 +63,7 @@ test('testFileMetadata', async function testFileMetadata(): Promise { } const receivedMetadata: any = await client.fileMetadata.getFileMetadataById( file.id, - 'global' as GetFileMetadataByIdScopeArg, + 'global' as GetFileMetadataByIdScope, 'properties' ); if (!(receivedMetadata.extraData!.abc == 'xyz')) { @@ -72,20 +72,20 @@ test('testFileMetadata', async function testFileMetadata(): Promise { const newValue: any = 'bar'; const updatedMetadata: any = await client.fileMetadata.updateFileMetadataById( file.id, - 'global' as UpdateFileMetadataByIdScopeArg, + 'global' as UpdateFileMetadataByIdScope, 'properties', [ { - op: 'replace' as UpdateFileMetadataByIdRequestBodyArgOpField, + op: 'replace' as UpdateFileMetadataByIdRequestBodyOpField, path: '/abc', value: newValue, - } satisfies UpdateFileMetadataByIdRequestBodyArg, + } satisfies UpdateFileMetadataByIdRequestBody, ] ); const receivedUpdatedMetadata: any = await client.fileMetadata.getFileMetadataById( file.id, - 'global' as GetFileMetadataByIdScopeArg, + 'global' as GetFileMetadataByIdScope, 'properties' ); if (!(receivedUpdatedMetadata.extraData!.abc == newValue)) { @@ -93,13 +93,13 @@ test('testFileMetadata', async function testFileMetadata(): Promise { } await client.fileMetadata.deleteFileMetadataById( file.id, - 'global' as DeleteFileMetadataByIdScopeArg, + 'global' as DeleteFileMetadataByIdScope, 'properties' ); await expect(async () => { await client.fileMetadata.getFileMetadataById( file.id, - 'global' as GetFileMetadataByIdScopeArg, + 'global' as GetFileMetadataByIdScope, 'properties' ); }).rejects.toThrow(); diff --git a/src/test/fileRequests.generated.test.ts b/src/test/fileRequests.generated.test.ts index b7ad9d8b..e6bd9e58 100644 --- a/src/test/fileRequests.generated.test.ts +++ b/src/test/fileRequests.generated.test.ts @@ -4,15 +4,15 @@ import { serializeFileRequestCopyRequest } from '../schemas.generated.js'; import { deserializeFileRequestCopyRequest } from '../schemas.generated.js'; import { serializeFileRequestCopyRequestFolderField } from '../schemas.generated.js'; import { deserializeFileRequestCopyRequestFolderField } from '../schemas.generated.js'; -import { serializeFileRequestCopyRequestFolderFieldTypeField } from '../schemas.generated.js'; -import { deserializeFileRequestCopyRequestFolderFieldTypeField } from '../schemas.generated.js'; +import { serializeFileRequestCopyRequestFolderTypeField } from '../schemas.generated.js'; +import { deserializeFileRequestCopyRequestFolderTypeField } from '../schemas.generated.js'; import { serializeFileRequestUpdateRequest } from '../schemas.generated.js'; import { deserializeFileRequestUpdateRequest } from '../schemas.generated.js'; import { BoxClient } from '../client.generated.js'; import { FileRequest } from '../schemas.generated.js'; import { FileRequestCopyRequest } from '../schemas.generated.js'; import { FileRequestCopyRequestFolderField } from '../schemas.generated.js'; -import { FileRequestCopyRequestFolderFieldTypeField } from '../schemas.generated.js'; +import { FileRequestCopyRequestFolderTypeField } from '../schemas.generated.js'; import { FileRequestUpdateRequest } from '../schemas.generated.js'; import { getEnvVar } from '../utils.js'; import { getDefaultClientAsUser } from './commons.generated.js'; @@ -42,7 +42,7 @@ test('testGetCopyUpdateDeleteFileRequest', async function testGetCopyUpdateDelet await client.fileRequests.createFileRequestCopy(fileRequestId, { folder: { id: fileRequest.folder.id, - type: 'folder' as FileRequestCopyRequestFolderFieldTypeField, + type: 'folder' as FileRequestCopyRequestFolderTypeField, } satisfies FileRequestCopyRequestFolderField, } satisfies FileRequestCopyRequest); if (!!(copiedFileRequest.id == fileRequestId)) { diff --git a/src/test/fileVersions.generated.test.ts b/src/test/fileVersions.generated.test.ts index 19b1f092..d1ce38d3 100644 --- a/src/test/fileVersions.generated.test.ts +++ b/src/test/fileVersions.generated.test.ts @@ -1,33 +1,33 @@ import { serializeFiles } from '../schemas.generated.js'; import { deserializeFiles } from '../schemas.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; import { serializeFileFull } from '../schemas.generated.js'; import { deserializeFileFull } from '../schemas.generated.js'; -import { serializeUploadFileVersionRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileVersionRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; +import { serializeUploadFileVersionRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileVersionRequestBodyAttributesField } from '../managers/uploads.generated.js'; import { serializeFileVersions } from '../schemas.generated.js'; import { deserializeFileVersions } from '../schemas.generated.js'; import { serializeFileVersionFull } from '../schemas.generated.js'; import { deserializeFileVersionFull } from '../schemas.generated.js'; -import { serializePromoteFileVersionRequestBodyArg } from '../managers/fileVersions.generated.js'; -import { deserializePromoteFileVersionRequestBodyArg } from '../managers/fileVersions.generated.js'; -import { serializePromoteFileVersionRequestBodyArgTypeField } from '../managers/fileVersions.generated.js'; -import { deserializePromoteFileVersionRequestBodyArgTypeField } from '../managers/fileVersions.generated.js'; +import { serializePromoteFileVersionRequestBody } from '../managers/fileVersions.generated.js'; +import { deserializePromoteFileVersionRequestBody } from '../managers/fileVersions.generated.js'; +import { serializePromoteFileVersionRequestBodyTypeField } from '../managers/fileVersions.generated.js'; +import { deserializePromoteFileVersionRequestBodyTypeField } from '../managers/fileVersions.generated.js'; import { BoxClient } from '../client.generated.js'; import { Files } from '../schemas.generated.js'; -import { UploadFileRequestBodyArg } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBody } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; import { FileFull } from '../schemas.generated.js'; -import { UploadFileVersionRequestBodyArg } from '../managers/uploads.generated.js'; -import { UploadFileVersionRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; +import { UploadFileVersionRequestBody } from '../managers/uploads.generated.js'; +import { UploadFileVersionRequestBodyAttributesField } from '../managers/uploads.generated.js'; import { FileVersions } from '../schemas.generated.js'; import { FileVersionFull } from '../schemas.generated.js'; -import { PromoteFileVersionRequestBodyArg } from '../managers/fileVersions.generated.js'; -import { PromoteFileVersionRequestBodyArgTypeField } from '../managers/fileVersions.generated.js'; +import { PromoteFileVersionRequestBody } from '../managers/fileVersions.generated.js'; +import { PromoteFileVersionRequestBodyTypeField } from '../managers/fileVersions.generated.js'; import { getUuid } from '../utils.js'; import { generateByteStream } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; @@ -45,12 +45,10 @@ test('testCreateListGetRestoreDeleteFileVersion', async function testCreateListG const files: Files = await client.uploads.uploadFile({ attributes: { name: oldName, - parent: { - id: '0', - } satisfies UploadFileRequestBodyArgAttributesFieldParentField, - } satisfies UploadFileRequestBodyArgAttributesField, + parent: { id: '0' } satisfies UploadFileRequestBodyAttributesParentField, + } satisfies UploadFileRequestBodyAttributesField, file: generateByteStream(10), - } satisfies UploadFileRequestBodyArg); + } satisfies UploadFileRequestBody); const file: FileFull = files.entries![0]; if (!(file.name == oldName)) { throw 'Assertion failed'; @@ -61,9 +59,9 @@ test('testCreateListGetRestoreDeleteFileVersion', async function testCreateListG const newFiles: Files = await client.uploads.uploadFileVersion(file.id, { attributes: { name: newName, - } satisfies UploadFileVersionRequestBodyArgAttributesField, + } satisfies UploadFileVersionRequestBodyAttributesField, file: generateByteStream(20), - } satisfies UploadFileVersionRequestBodyArg); + } satisfies UploadFileVersionRequestBody); const newFile: FileFull = newFiles.entries![0]; if (!(newFile.name == newName)) { throw 'Assertion failed'; @@ -87,8 +85,8 @@ test('testCreateListGetRestoreDeleteFileVersion', async function testCreateListG } await client.fileVersions.promoteFileVersion(file.id, { id: fileVersions.entries![0].id, - type: 'file_version' as PromoteFileVersionRequestBodyArgTypeField, - } satisfies PromoteFileVersionRequestBodyArg); + type: 'file_version' as PromoteFileVersionRequestBodyTypeField, + } satisfies PromoteFileVersionRequestBody); const fileRestored: FileFull = await client.files.getFileById(file.id); if (!(fileRestored.name == oldName)) { throw 'Assertion failed'; diff --git a/src/test/fileWatermarks.generated.test.ts b/src/test/fileWatermarks.generated.test.ts index 4eec4ebe..4ea9c977 100644 --- a/src/test/fileWatermarks.generated.test.ts +++ b/src/test/fileWatermarks.generated.test.ts @@ -1,29 +1,29 @@ import { serializeFiles } from '../schemas.generated.js'; import { deserializeFiles } from '../schemas.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; import { serializeFileFull } from '../schemas.generated.js'; import { deserializeFileFull } from '../schemas.generated.js'; import { serializeWatermark } from '../schemas.generated.js'; import { deserializeWatermark } from '../schemas.generated.js'; -import { serializeUpdateFileWatermarkRequestBodyArg } from '../managers/fileWatermarks.generated.js'; -import { deserializeUpdateFileWatermarkRequestBodyArg } from '../managers/fileWatermarks.generated.js'; -import { serializeUpdateFileWatermarkRequestBodyArgWatermarkField } from '../managers/fileWatermarks.generated.js'; -import { deserializeUpdateFileWatermarkRequestBodyArgWatermarkField } from '../managers/fileWatermarks.generated.js'; -import { serializeUpdateFileWatermarkRequestBodyArgWatermarkFieldImprintField } from '../managers/fileWatermarks.generated.js'; -import { deserializeUpdateFileWatermarkRequestBodyArgWatermarkFieldImprintField } from '../managers/fileWatermarks.generated.js'; +import { serializeUpdateFileWatermarkRequestBody } from '../managers/fileWatermarks.generated.js'; +import { deserializeUpdateFileWatermarkRequestBody } from '../managers/fileWatermarks.generated.js'; +import { serializeUpdateFileWatermarkRequestBodyWatermarkField } from '../managers/fileWatermarks.generated.js'; +import { deserializeUpdateFileWatermarkRequestBodyWatermarkField } from '../managers/fileWatermarks.generated.js'; +import { serializeUpdateFileWatermarkRequestBodyWatermarkImprintField } from '../managers/fileWatermarks.generated.js'; +import { deserializeUpdateFileWatermarkRequestBodyWatermarkImprintField } from '../managers/fileWatermarks.generated.js'; import { BoxClient } from '../client.generated.js'; import { Files } from '../schemas.generated.js'; -import { UploadFileRequestBodyArg } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBody } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; import { FileFull } from '../schemas.generated.js'; import { Watermark } from '../schemas.generated.js'; -import { UpdateFileWatermarkRequestBodyArg } from '../managers/fileWatermarks.generated.js'; -import { UpdateFileWatermarkRequestBodyArgWatermarkField } from '../managers/fileWatermarks.generated.js'; -import { UpdateFileWatermarkRequestBodyArgWatermarkFieldImprintField } from '../managers/fileWatermarks.generated.js'; +import { UpdateFileWatermarkRequestBody } from '../managers/fileWatermarks.generated.js'; +import { UpdateFileWatermarkRequestBodyWatermarkField } from '../managers/fileWatermarks.generated.js'; +import { UpdateFileWatermarkRequestBodyWatermarkImprintField } from '../managers/fileWatermarks.generated.js'; import { getUuid } from '../utils.js'; import { generateByteStream } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; @@ -40,20 +40,18 @@ test('testCreateGetDeleteFileWatermark', async function testCreateGetDeleteFileW const uploadedFiles: Files = await client.uploads.uploadFile({ attributes: { name: fileName, - parent: { - id: '0', - } satisfies UploadFileRequestBodyArgAttributesFieldParentField, - } satisfies UploadFileRequestBodyArgAttributesField, + parent: { id: '0' } satisfies UploadFileRequestBodyAttributesParentField, + } satisfies UploadFileRequestBodyAttributesField, file: generateByteStream(10), - } satisfies UploadFileRequestBodyArg); + } satisfies UploadFileRequestBody); const file: FileFull = uploadedFiles.entries![0]; const createdWatermark: Watermark = await client.fileWatermarks.updateFileWatermark(file.id, { watermark: { imprint: - 'default' as UpdateFileWatermarkRequestBodyArgWatermarkFieldImprintField, - } satisfies UpdateFileWatermarkRequestBodyArgWatermarkField, - } satisfies UpdateFileWatermarkRequestBodyArg); + 'default' as UpdateFileWatermarkRequestBodyWatermarkImprintField, + } satisfies UpdateFileWatermarkRequestBodyWatermarkField, + } satisfies UpdateFileWatermarkRequestBody); const watermark: Watermark = await client.fileWatermarks.getFileWatermark( file.id ); diff --git a/src/test/files.generated.test.ts b/src/test/files.generated.test.ts index 90e7e267..3970846c 100644 --- a/src/test/files.generated.test.ts +++ b/src/test/files.generated.test.ts @@ -2,33 +2,33 @@ import { serializeFileFull } from '../schemas.generated.js'; import { deserializeFileFull } from '../schemas.generated.js'; import { serializeFiles } from '../schemas.generated.js'; import { deserializeFiles } from '../schemas.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; -import { serializeGetFileThumbnailByIdExtensionArg } from '../managers/files.generated.js'; -import { deserializeGetFileThumbnailByIdExtensionArg } from '../managers/files.generated.js'; +import { serializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; +import { serializeGetFileThumbnailByIdExtension } from '../managers/files.generated.js'; +import { deserializeGetFileThumbnailByIdExtension } from '../managers/files.generated.js'; import { serializeTrashFile } from '../schemas.generated.js'; import { deserializeTrashFile } from '../schemas.generated.js'; -import { serializeUpdateFileByIdRequestBodyArg } from '../managers/files.generated.js'; -import { deserializeUpdateFileByIdRequestBodyArg } from '../managers/files.generated.js'; -import { serializeCopyFileRequestBodyArg } from '../managers/files.generated.js'; -import { deserializeCopyFileRequestBodyArg } from '../managers/files.generated.js'; -import { serializeCopyFileRequestBodyArgParentField } from '../managers/files.generated.js'; -import { deserializeCopyFileRequestBodyArgParentField } from '../managers/files.generated.js'; +import { serializeUpdateFileByIdRequestBody } from '../managers/files.generated.js'; +import { deserializeUpdateFileByIdRequestBody } from '../managers/files.generated.js'; +import { serializeCopyFileRequestBody } from '../managers/files.generated.js'; +import { deserializeCopyFileRequestBody } from '../managers/files.generated.js'; +import { serializeCopyFileRequestBodyParentField } from '../managers/files.generated.js'; +import { deserializeCopyFileRequestBodyParentField } from '../managers/files.generated.js'; import { BoxClient } from '../client.generated.js'; import { FileFull } from '../schemas.generated.js'; import { Files } from '../schemas.generated.js'; -import { UploadFileRequestBodyArg } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; -import { GetFileThumbnailByIdExtensionArg } from '../managers/files.generated.js'; -import { GetFileByIdQueryParamsArg } from '../managers/files.generated.js'; -import { GetFileByIdHeadersArg } from '../managers/files.generated.js'; +import { UploadFileRequestBody } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; +import { GetFileThumbnailByIdExtension } from '../managers/files.generated.js'; +import { GetFileByIdQueryParams } from '../managers/files.generated.js'; +import { GetFileByIdHeaders } from '../managers/files.generated.js'; import { TrashFile } from '../schemas.generated.js'; -import { UpdateFileByIdRequestBodyArg } from '../managers/files.generated.js'; -import { CopyFileRequestBodyArg } from '../managers/files.generated.js'; -import { CopyFileRequestBodyArgParentField } from '../managers/files.generated.js'; +import { UpdateFileByIdRequestBody } from '../managers/files.generated.js'; +import { CopyFileRequestBody } from '../managers/files.generated.js'; +import { CopyFileRequestBodyParentField } from '../managers/files.generated.js'; import { getUuid } from '../utils.js'; import { generateByteStream } from '../utils.js'; import { readByteStream } from '../utils.js'; @@ -51,12 +51,10 @@ export async function uploadFile( const uploadedFiles: Files = await client.uploads.uploadFile({ attributes: { name: fileName, - parent: { - id: '0', - } satisfies UploadFileRequestBodyArgAttributesFieldParentField, - } satisfies UploadFileRequestBodyArgAttributesField, + parent: { id: '0' } satisfies UploadFileRequestBodyAttributesParentField, + } satisfies UploadFileRequestBodyAttributesField, file: fileStream, - } satisfies UploadFileRequestBodyArg); + } satisfies UploadFileRequestBody); return uploadedFiles.entries![0]; } test('testGetFileThumbnail', async function testGetFileThumbnail(): Promise { @@ -72,7 +70,7 @@ test('testGetFileThumbnail', async function testGetFileThumbnail(): Promise await readByteStream( await client.files.getFileThumbnailById( thumbnailFile.id, - 'png' as GetFileThumbnailByIdExtensionArg + 'png' as GetFileThumbnailByIdExtension ) ), await readByteStream(thumbnailContentStream) @@ -89,7 +87,7 @@ test('testGetFileFullExtraFields', async function testGetFileFullExtraFields(): const uploadedFile: FileFull = await uploadFile(newFileName, fileStream); const file: FileFull = await client.files.getFileById(uploadedFile.id, { fields: ['is_externally_owned' as '', 'has_collaborations' as ''], - } satisfies GetFileByIdQueryParamsArg); + } satisfies GetFileByIdQueryParams); if (!(file.isExternallyOwned == false)) { throw 'Assertion failed'; } @@ -109,10 +107,8 @@ test('testCreateGetAndDeleteFile', async function testCreateGetAndDeleteFile(): await expect(async () => { await client.files.getFileById( uploadedFile.id, - { fields: ['name' as ''] } satisfies GetFileByIdQueryParamsArg, - new GetFileByIdHeadersArg({ - extraHeaders: { ['if-none-match']: file.etag }, - }) + { fields: ['name' as ''] } satisfies GetFileByIdQueryParams, + new GetFileByIdHeaders({ extraHeaders: { ['if-none-match']: file.etag } }) ); }).rejects.toThrow(); if (!(file.name == newFileName)) { @@ -134,7 +130,7 @@ test('testUpdateFile', async function testUpdateFile(): Promise { { name: updatedName, description: 'Updated description', - } satisfies UpdateFileByIdRequestBodyArg + } satisfies UpdateFileByIdRequestBody ); if (!(updatedFile.name == updatedName)) { throw 'Assertion failed'; @@ -148,9 +144,9 @@ test('testCopyFile', async function testCopyFile(): Promise { const fileOrigin: FileFull = await uploadNewFile(); const copiedFileName: string = getUuid(); const copiedFile: FileFull = await client.files.copyFile(fileOrigin.id, { - parent: { id: '0' } satisfies CopyFileRequestBodyArgParentField, + parent: { id: '0' } satisfies CopyFileRequestBodyParentField, name: copiedFileName, - } satisfies CopyFileRequestBodyArg); + } satisfies CopyFileRequestBody); if (!(copiedFile.parent!.id == '0')) { throw 'Assertion failed'; } diff --git a/src/test/folderClassifications.generated.test.ts b/src/test/folderClassifications.generated.test.ts index d450c57e..f80497f0 100644 --- a/src/test/folderClassifications.generated.test.ts +++ b/src/test/folderClassifications.generated.test.ts @@ -1,45 +1,45 @@ -import { serializeClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; -import { deserializeClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; -import { serializeAddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; -import { serializeAddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; -import { deserializeAddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; +import { serializeClassificationTemplateFieldsOptionsField } from '../schemas.generated.js'; +import { deserializeClassificationTemplateFieldsOptionsField } from '../schemas.generated.js'; +import { serializeAddClassificationRequestBody } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBody } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyOpField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyOpField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyFieldKeyField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyFieldKeyField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyDataField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyDataField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyDataStaticConfigField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyDataStaticConfigField } from '../managers/classifications.generated.js'; +import { serializeAddClassificationRequestBodyDataStaticConfigClassificationField } from '../managers/classifications.generated.js'; +import { deserializeAddClassificationRequestBodyDataStaticConfigClassificationField } from '../managers/classifications.generated.js'; import { serializeFolderFull } from '../schemas.generated.js'; import { deserializeFolderFull } from '../schemas.generated.js'; import { serializeClassification } from '../schemas.generated.js'; import { deserializeClassification } from '../schemas.generated.js'; -import { serializeAddClassificationToFolderRequestBodyArg } from '../managers/folderClassifications.generated.js'; -import { deserializeAddClassificationToFolderRequestBodyArg } from '../managers/folderClassifications.generated.js'; -import { serializeUpdateClassificationOnFolderRequestBodyArg } from '../managers/folderClassifications.generated.js'; -import { deserializeUpdateClassificationOnFolderRequestBodyArg } from '../managers/folderClassifications.generated.js'; -import { serializeUpdateClassificationOnFolderRequestBodyArgOpField } from '../managers/folderClassifications.generated.js'; -import { deserializeUpdateClassificationOnFolderRequestBodyArgOpField } from '../managers/folderClassifications.generated.js'; -import { serializeUpdateClassificationOnFolderRequestBodyArgPathField } from '../managers/folderClassifications.generated.js'; -import { deserializeUpdateClassificationOnFolderRequestBodyArgPathField } from '../managers/folderClassifications.generated.js'; +import { serializeAddClassificationToFolderRequestBody } from '../managers/folderClassifications.generated.js'; +import { deserializeAddClassificationToFolderRequestBody } from '../managers/folderClassifications.generated.js'; +import { serializeUpdateClassificationOnFolderRequestBody } from '../managers/folderClassifications.generated.js'; +import { deserializeUpdateClassificationOnFolderRequestBody } from '../managers/folderClassifications.generated.js'; +import { serializeUpdateClassificationOnFolderRequestBodyOpField } from '../managers/folderClassifications.generated.js'; +import { deserializeUpdateClassificationOnFolderRequestBodyOpField } from '../managers/folderClassifications.generated.js'; +import { serializeUpdateClassificationOnFolderRequestBodyPathField } from '../managers/folderClassifications.generated.js'; +import { deserializeUpdateClassificationOnFolderRequestBodyPathField } from '../managers/folderClassifications.generated.js'; import { serializeClassificationTemplate } from '../schemas.generated.js'; import { deserializeClassificationTemplate } from '../schemas.generated.js'; import { BoxClient } from '../client.generated.js'; -import { ClassificationTemplateFieldsFieldOptionsField } from '../schemas.generated.js'; -import { AddClassificationRequestBodyArg } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgOpField } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgFieldKeyField } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgDataField } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgDataFieldStaticConfigField } from '../managers/classifications.generated.js'; -import { AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField } from '../managers/classifications.generated.js'; +import { ClassificationTemplateFieldsOptionsField } from '../schemas.generated.js'; +import { AddClassificationRequestBody } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyOpField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyFieldKeyField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyDataField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyDataStaticConfigField } from '../managers/classifications.generated.js'; +import { AddClassificationRequestBodyDataStaticConfigClassificationField } from '../managers/classifications.generated.js'; import { FolderFull } from '../schemas.generated.js'; import { Classification } from '../schemas.generated.js'; -import { AddClassificationToFolderRequestBodyArg } from '../managers/folderClassifications.generated.js'; -import { UpdateClassificationOnFolderRequestBodyArg } from '../managers/folderClassifications.generated.js'; -import { UpdateClassificationOnFolderRequestBodyArgOpField } from '../managers/folderClassifications.generated.js'; -import { UpdateClassificationOnFolderRequestBodyArgPathField } from '../managers/folderClassifications.generated.js'; +import { AddClassificationToFolderRequestBody } from '../managers/folderClassifications.generated.js'; +import { UpdateClassificationOnFolderRequestBody } from '../managers/folderClassifications.generated.js'; +import { UpdateClassificationOnFolderRequestBodyOpField } from '../managers/folderClassifications.generated.js'; +import { UpdateClassificationOnFolderRequestBodyPathField } from '../managers/folderClassifications.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; import { createNewFolder } from './commons.generated.js'; @@ -57,26 +57,26 @@ const client: BoxClient = getDefaultClient(); export async function getOrCreateSecondClassification( classificationTemplate: ClassificationTemplate ): Promise { - const classifications: readonly ClassificationTemplateFieldsFieldOptionsField[] = + const classifications: readonly ClassificationTemplateFieldsOptionsField[] = classificationTemplate.fields[0].options; const currentNumberOfClassifications: number = classifications.length; if (currentNumberOfClassifications == 1) { const classificationTemplateWithNewClassification: ClassificationTemplate = await client.classifications.addClassification([ { - op: 'addEnumOption' as AddClassificationRequestBodyArgOpField, + op: 'addEnumOption' as AddClassificationRequestBodyOpField, fieldKey: - 'Box__Security__Classification__Key' as AddClassificationRequestBodyArgFieldKeyField, + 'Box__Security__Classification__Key' as AddClassificationRequestBodyFieldKeyField, data: { key: getUuid(), staticConfig: { classification: { colorId: 4, classificationDefinition: 'Other description', - } satisfies AddClassificationRequestBodyArgDataFieldStaticConfigFieldClassificationField, - } satisfies AddClassificationRequestBodyArgDataFieldStaticConfigField, - } satisfies AddClassificationRequestBodyArgDataField, - } satisfies AddClassificationRequestBodyArg, + } satisfies AddClassificationRequestBodyDataStaticConfigClassificationField, + } satisfies AddClassificationRequestBodyDataStaticConfigField, + } satisfies AddClassificationRequestBodyDataField, + } satisfies AddClassificationRequestBody, ]); return classificationTemplateWithNewClassification.fields[0].options[1]; } @@ -95,7 +95,7 @@ test('testFolderClassifications', async function testFolderClassifications(): Pr const createdFolderClassification: Classification = await client.folderClassifications.addClassificationToFolder(folder.id, { boxSecurityClassificationKey: classification.key, - } satisfies AddClassificationToFolderRequestBodyArg); + } satisfies AddClassificationToFolderRequestBody); if ( !( createdFolderClassification.boxSecurityClassificationKey == @@ -117,10 +117,10 @@ test('testFolderClassifications', async function testFolderClassifications(): Pr const updatedFolderClassification: Classification = await client.folderClassifications.updateClassificationOnFolder(folder.id, [ { - op: 'replace' as UpdateClassificationOnFolderRequestBodyArgOpField, - path: '/Box__Security__Classification__Key' as UpdateClassificationOnFolderRequestBodyArgPathField, + op: 'replace' as UpdateClassificationOnFolderRequestBodyOpField, + path: '/Box__Security__Classification__Key' as UpdateClassificationOnFolderRequestBodyPathField, value: secondClassification.key, - } satisfies UpdateClassificationOnFolderRequestBodyArg, + } satisfies UpdateClassificationOnFolderRequestBody, ]); if ( !( diff --git a/src/test/folderLocks.generated.test.ts b/src/test/folderLocks.generated.test.ts index d0232141..16ed0554 100644 --- a/src/test/folderLocks.generated.test.ts +++ b/src/test/folderLocks.generated.test.ts @@ -4,20 +4,20 @@ import { serializeFolderLocks } from '../schemas.generated.js'; import { deserializeFolderLocks } from '../schemas.generated.js'; import { serializeFolderLock } from '../schemas.generated.js'; import { deserializeFolderLock } from '../schemas.generated.js'; -import { serializeCreateFolderLockRequestBodyArg } from '../managers/folderLocks.generated.js'; -import { deserializeCreateFolderLockRequestBodyArg } from '../managers/folderLocks.generated.js'; -import { serializeCreateFolderLockRequestBodyArgFolderField } from '../managers/folderLocks.generated.js'; -import { deserializeCreateFolderLockRequestBodyArgFolderField } from '../managers/folderLocks.generated.js'; -import { serializeCreateFolderLockRequestBodyArgLockedOperationsField } from '../managers/folderLocks.generated.js'; -import { deserializeCreateFolderLockRequestBodyArgLockedOperationsField } from '../managers/folderLocks.generated.js'; +import { serializeCreateFolderLockRequestBody } from '../managers/folderLocks.generated.js'; +import { deserializeCreateFolderLockRequestBody } from '../managers/folderLocks.generated.js'; +import { serializeCreateFolderLockRequestBodyFolderField } from '../managers/folderLocks.generated.js'; +import { deserializeCreateFolderLockRequestBodyFolderField } from '../managers/folderLocks.generated.js'; +import { serializeCreateFolderLockRequestBodyLockedOperationsField } from '../managers/folderLocks.generated.js'; +import { deserializeCreateFolderLockRequestBodyLockedOperationsField } from '../managers/folderLocks.generated.js'; import { BoxClient } from '../client.generated.js'; import { FolderFull } from '../schemas.generated.js'; import { FolderLocks } from '../schemas.generated.js'; -import { GetFolderLocksQueryParamsArg } from '../managers/folderLocks.generated.js'; +import { GetFolderLocksQueryParams } from '../managers/folderLocks.generated.js'; import { FolderLock } from '../schemas.generated.js'; -import { CreateFolderLockRequestBodyArg } from '../managers/folderLocks.generated.js'; -import { CreateFolderLockRequestBodyArgFolderField } from '../managers/folderLocks.generated.js'; -import { CreateFolderLockRequestBodyArgLockedOperationsField } from '../managers/folderLocks.generated.js'; +import { CreateFolderLockRequestBody } from '../managers/folderLocks.generated.js'; +import { CreateFolderLockRequestBodyFolderField } from '../managers/folderLocks.generated.js'; +import { CreateFolderLockRequestBodyLockedOperationsField } from '../managers/folderLocks.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; import { createNewFolder } from './commons.generated.js'; @@ -33,7 +33,7 @@ test('testFolderLocks', async function testFolderLocks(): Promise { const folder: FolderFull = await createNewFolder(); const folderLocks: FolderLocks = await client.folderLocks.getFolderLocks({ folderId: folder.id, - } satisfies GetFolderLocksQueryParamsArg); + } satisfies GetFolderLocksQueryParams); if (!(folderLocks.entries!.length == 0)) { throw 'Assertion failed'; } @@ -41,12 +41,12 @@ test('testFolderLocks', async function testFolderLocks(): Promise { folder: { id: folder.id, type: 'folder', - } satisfies CreateFolderLockRequestBodyArgFolderField, + } satisfies CreateFolderLockRequestBodyFolderField, lockedOperations: { move: true, delete: true, - } satisfies CreateFolderLockRequestBodyArgLockedOperationsField, - } satisfies CreateFolderLockRequestBodyArg); + } satisfies CreateFolderLockRequestBodyLockedOperationsField, + } satisfies CreateFolderLockRequestBody); if (!(folderLock.folder!.id == folder.id)) { throw 'Assertion failed'; } @@ -62,7 +62,7 @@ test('testFolderLocks', async function testFolderLocks(): Promise { }).rejects.toThrow(); const newFolderLocks: FolderLocks = await client.folderLocks.getFolderLocks({ folderId: folder.id, - } satisfies GetFolderLocksQueryParamsArg); + } satisfies GetFolderLocksQueryParams); if (!(newFolderLocks.entries!.length == 0)) { throw 'Assertion failed'; } diff --git a/src/test/folderMetadata.generated.test.ts b/src/test/folderMetadata.generated.test.ts index fe59ff70..7f244de5 100644 --- a/src/test/folderMetadata.generated.test.ts +++ b/src/test/folderMetadata.generated.test.ts @@ -4,28 +4,28 @@ import { serializeMetadatas } from '../schemas.generated.js'; import { deserializeMetadatas } from '../schemas.generated.js'; import { serializeMetadataFull } from '../schemas.generated.js'; import { deserializeMetadataFull } from '../schemas.generated.js'; -import { serializeCreateFolderMetadataByIdScopeArg } from '../managers/folderMetadata.generated.js'; -import { deserializeCreateFolderMetadataByIdScopeArg } from '../managers/folderMetadata.generated.js'; -import { serializeGetFolderMetadataByIdScopeArg } from '../managers/folderMetadata.generated.js'; -import { deserializeGetFolderMetadataByIdScopeArg } from '../managers/folderMetadata.generated.js'; -import { serializeUpdateFolderMetadataByIdScopeArg } from '../managers/folderMetadata.generated.js'; -import { deserializeUpdateFolderMetadataByIdScopeArg } from '../managers/folderMetadata.generated.js'; -import { serializeUpdateFolderMetadataByIdRequestBodyArg } from '../managers/folderMetadata.generated.js'; -import { deserializeUpdateFolderMetadataByIdRequestBodyArg } from '../managers/folderMetadata.generated.js'; -import { serializeUpdateFolderMetadataByIdRequestBodyArgOpField } from '../managers/folderMetadata.generated.js'; -import { deserializeUpdateFolderMetadataByIdRequestBodyArgOpField } from '../managers/folderMetadata.generated.js'; -import { serializeDeleteFolderMetadataByIdScopeArg } from '../managers/folderMetadata.generated.js'; -import { deserializeDeleteFolderMetadataByIdScopeArg } from '../managers/folderMetadata.generated.js'; +import { serializeCreateFolderMetadataByIdScope } from '../managers/folderMetadata.generated.js'; +import { deserializeCreateFolderMetadataByIdScope } from '../managers/folderMetadata.generated.js'; +import { serializeGetFolderMetadataByIdScope } from '../managers/folderMetadata.generated.js'; +import { deserializeGetFolderMetadataByIdScope } from '../managers/folderMetadata.generated.js'; +import { serializeUpdateFolderMetadataByIdScope } from '../managers/folderMetadata.generated.js'; +import { deserializeUpdateFolderMetadataByIdScope } from '../managers/folderMetadata.generated.js'; +import { serializeUpdateFolderMetadataByIdRequestBody } from '../managers/folderMetadata.generated.js'; +import { deserializeUpdateFolderMetadataByIdRequestBody } from '../managers/folderMetadata.generated.js'; +import { serializeUpdateFolderMetadataByIdRequestBodyOpField } from '../managers/folderMetadata.generated.js'; +import { deserializeUpdateFolderMetadataByIdRequestBodyOpField } from '../managers/folderMetadata.generated.js'; +import { serializeDeleteFolderMetadataByIdScope } from '../managers/folderMetadata.generated.js'; +import { deserializeDeleteFolderMetadataByIdScope } from '../managers/folderMetadata.generated.js'; import { BoxClient } from '../client.generated.js'; import { FolderFull } from '../schemas.generated.js'; import { Metadatas } from '../schemas.generated.js'; import { MetadataFull } from '../schemas.generated.js'; -import { CreateFolderMetadataByIdScopeArg } from '../managers/folderMetadata.generated.js'; -import { GetFolderMetadataByIdScopeArg } from '../managers/folderMetadata.generated.js'; -import { UpdateFolderMetadataByIdScopeArg } from '../managers/folderMetadata.generated.js'; -import { UpdateFolderMetadataByIdRequestBodyArg } from '../managers/folderMetadata.generated.js'; -import { UpdateFolderMetadataByIdRequestBodyArgOpField } from '../managers/folderMetadata.generated.js'; -import { DeleteFolderMetadataByIdScopeArg } from '../managers/folderMetadata.generated.js'; +import { CreateFolderMetadataByIdScope } from '../managers/folderMetadata.generated.js'; +import { GetFolderMetadataByIdScope } from '../managers/folderMetadata.generated.js'; +import { UpdateFolderMetadataByIdScope } from '../managers/folderMetadata.generated.js'; +import { UpdateFolderMetadataByIdRequestBody } from '../managers/folderMetadata.generated.js'; +import { UpdateFolderMetadataByIdRequestBodyOpField } from '../managers/folderMetadata.generated.js'; +import { DeleteFolderMetadataByIdScope } from '../managers/folderMetadata.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; import { createNewFolder } from './commons.generated.js'; @@ -50,7 +50,7 @@ test('testFolderMetadata', async function testFolderMetadata(): Promise { const createdMetadata: any = await client.folderMetadata.createFolderMetadataById( folder.id, - 'global' as CreateFolderMetadataByIdScopeArg, + 'global' as CreateFolderMetadataByIdScope, 'properties', { ['abc']: 'xyz' } ); @@ -66,7 +66,7 @@ test('testFolderMetadata', async function testFolderMetadata(): Promise { const receivedMetadata: any = await client.folderMetadata.getFolderMetadataById( folder.id, - 'global' as GetFolderMetadataByIdScopeArg, + 'global' as GetFolderMetadataByIdScope, 'properties' ); if (!(receivedMetadata.extraData!.abc == 'xyz')) { @@ -76,20 +76,20 @@ test('testFolderMetadata', async function testFolderMetadata(): Promise { const updatedMetadata: any = await client.folderMetadata.updateFolderMetadataById( folder.id, - 'global' as UpdateFolderMetadataByIdScopeArg, + 'global' as UpdateFolderMetadataByIdScope, 'properties', [ { - op: 'replace' as UpdateFolderMetadataByIdRequestBodyArgOpField, + op: 'replace' as UpdateFolderMetadataByIdRequestBodyOpField, path: '/abc', value: newValue, - } satisfies UpdateFolderMetadataByIdRequestBodyArg, + } satisfies UpdateFolderMetadataByIdRequestBody, ] ); const receivedUpdatedMetadata: any = await client.folderMetadata.getFolderMetadataById( folder.id, - 'global' as GetFolderMetadataByIdScopeArg, + 'global' as GetFolderMetadataByIdScope, 'properties' ); if (!(receivedUpdatedMetadata.extraData!.abc == newValue)) { @@ -97,13 +97,13 @@ test('testFolderMetadata', async function testFolderMetadata(): Promise { } await client.folderMetadata.deleteFolderMetadataById( folder.id, - 'global' as DeleteFolderMetadataByIdScopeArg, + 'global' as DeleteFolderMetadataByIdScope, 'properties' ); await expect(async () => { await client.folderMetadata.getFolderMetadataById( folder.id, - 'global' as GetFolderMetadataByIdScopeArg, + 'global' as GetFolderMetadataByIdScope, 'properties' ); }).rejects.toThrow(); diff --git a/src/test/folderWatermarks.generated.test.ts b/src/test/folderWatermarks.generated.test.ts index 299ffe2d..7594e6ae 100644 --- a/src/test/folderWatermarks.generated.test.ts +++ b/src/test/folderWatermarks.generated.test.ts @@ -1,25 +1,25 @@ import { serializeFolderFull } from '../schemas.generated.js'; import { deserializeFolderFull } from '../schemas.generated.js'; -import { serializeCreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { deserializeCreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { serializeCreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; -import { deserializeCreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; +import { serializeCreateFolderRequestBody } from '../managers/folders.generated.js'; +import { deserializeCreateFolderRequestBody } from '../managers/folders.generated.js'; +import { serializeCreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; +import { deserializeCreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; import { serializeWatermark } from '../schemas.generated.js'; import { deserializeWatermark } from '../schemas.generated.js'; -import { serializeUpdateFolderWatermarkRequestBodyArg } from '../managers/folderWatermarks.generated.js'; -import { deserializeUpdateFolderWatermarkRequestBodyArg } from '../managers/folderWatermarks.generated.js'; -import { serializeUpdateFolderWatermarkRequestBodyArgWatermarkField } from '../managers/folderWatermarks.generated.js'; -import { deserializeUpdateFolderWatermarkRequestBodyArgWatermarkField } from '../managers/folderWatermarks.generated.js'; -import { serializeUpdateFolderWatermarkRequestBodyArgWatermarkFieldImprintField } from '../managers/folderWatermarks.generated.js'; -import { deserializeUpdateFolderWatermarkRequestBodyArgWatermarkFieldImprintField } from '../managers/folderWatermarks.generated.js'; +import { serializeUpdateFolderWatermarkRequestBody } from '../managers/folderWatermarks.generated.js'; +import { deserializeUpdateFolderWatermarkRequestBody } from '../managers/folderWatermarks.generated.js'; +import { serializeUpdateFolderWatermarkRequestBodyWatermarkField } from '../managers/folderWatermarks.generated.js'; +import { deserializeUpdateFolderWatermarkRequestBodyWatermarkField } from '../managers/folderWatermarks.generated.js'; +import { serializeUpdateFolderWatermarkRequestBodyWatermarkImprintField } from '../managers/folderWatermarks.generated.js'; +import { deserializeUpdateFolderWatermarkRequestBodyWatermarkImprintField } from '../managers/folderWatermarks.generated.js'; import { BoxClient } from '../client.generated.js'; import { FolderFull } from '../schemas.generated.js'; -import { CreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { CreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; +import { CreateFolderRequestBody } from '../managers/folders.generated.js'; +import { CreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; import { Watermark } from '../schemas.generated.js'; -import { UpdateFolderWatermarkRequestBodyArg } from '../managers/folderWatermarks.generated.js'; -import { UpdateFolderWatermarkRequestBodyArgWatermarkField } from '../managers/folderWatermarks.generated.js'; -import { UpdateFolderWatermarkRequestBodyArgWatermarkFieldImprintField } from '../managers/folderWatermarks.generated.js'; +import { UpdateFolderWatermarkRequestBody } from '../managers/folderWatermarks.generated.js'; +import { UpdateFolderWatermarkRequestBodyWatermarkField } from '../managers/folderWatermarks.generated.js'; +import { UpdateFolderWatermarkRequestBodyWatermarkImprintField } from '../managers/folderWatermarks.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; import { SerializedData } from '../json.js'; @@ -34,15 +34,15 @@ test('testCreateGetDeleteFolderWatermark', async function testCreateGetDeleteFol const folderName: string = getUuid(); const folder: FolderFull = await client.folders.createFolder({ name: folderName, - parent: { id: '0' } satisfies CreateFolderRequestBodyArgParentField, - } satisfies CreateFolderRequestBodyArg); + parent: { id: '0' } satisfies CreateFolderRequestBodyParentField, + } satisfies CreateFolderRequestBody); const createdWatermark: Watermark = await client.folderWatermarks.updateFolderWatermark(folder.id, { watermark: { imprint: - 'default' as UpdateFolderWatermarkRequestBodyArgWatermarkFieldImprintField, - } satisfies UpdateFolderWatermarkRequestBodyArgWatermarkField, - } satisfies UpdateFolderWatermarkRequestBodyArg); + 'default' as UpdateFolderWatermarkRequestBodyWatermarkImprintField, + } satisfies UpdateFolderWatermarkRequestBodyWatermarkField, + } satisfies UpdateFolderWatermarkRequestBody); const watermark: Watermark = await client.folderWatermarks.getFolderWatermark( folder.id ); diff --git a/src/test/folders.generated.test.ts b/src/test/folders.generated.test.ts index a29c69e8..a49b9993 100644 --- a/src/test/folders.generated.test.ts +++ b/src/test/folders.generated.test.ts @@ -1,28 +1,28 @@ import { serializeFolderFull } from '../schemas.generated.js'; import { deserializeFolderFull } from '../schemas.generated.js'; -import { serializeCreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { deserializeCreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { serializeCreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; -import { deserializeCreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; -import { serializeUpdateFolderByIdRequestBodyArg } from '../managers/folders.generated.js'; -import { deserializeUpdateFolderByIdRequestBodyArg } from '../managers/folders.generated.js'; -import { serializeCopyFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { deserializeCopyFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { serializeCopyFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; -import { deserializeCopyFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; -import { serializeUpdateFolderByIdRequestBodyArgParentField } from '../managers/folders.generated.js'; -import { deserializeUpdateFolderByIdRequestBodyArgParentField } from '../managers/folders.generated.js'; +import { serializeCreateFolderRequestBody } from '../managers/folders.generated.js'; +import { deserializeCreateFolderRequestBody } from '../managers/folders.generated.js'; +import { serializeCreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; +import { deserializeCreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; +import { serializeUpdateFolderByIdRequestBody } from '../managers/folders.generated.js'; +import { deserializeUpdateFolderByIdRequestBody } from '../managers/folders.generated.js'; +import { serializeCopyFolderRequestBody } from '../managers/folders.generated.js'; +import { deserializeCopyFolderRequestBody } from '../managers/folders.generated.js'; +import { serializeCopyFolderRequestBodyParentField } from '../managers/folders.generated.js'; +import { deserializeCopyFolderRequestBodyParentField } from '../managers/folders.generated.js'; +import { serializeUpdateFolderByIdRequestBodyParentField } from '../managers/folders.generated.js'; +import { deserializeUpdateFolderByIdRequestBodyParentField } from '../managers/folders.generated.js'; import { serializeItems } from '../schemas.generated.js'; import { deserializeItems } from '../schemas.generated.js'; import { BoxClient } from '../client.generated.js'; import { FolderFull } from '../schemas.generated.js'; -import { GetFolderByIdQueryParamsArg } from '../managers/folders.generated.js'; -import { CreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { CreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; -import { UpdateFolderByIdRequestBodyArg } from '../managers/folders.generated.js'; -import { CopyFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { CopyFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; -import { UpdateFolderByIdRequestBodyArgParentField } from '../managers/folders.generated.js'; +import { GetFolderByIdQueryParams } from '../managers/folders.generated.js'; +import { CreateFolderRequestBody } from '../managers/folders.generated.js'; +import { CreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; +import { UpdateFolderByIdRequestBody } from '../managers/folders.generated.js'; +import { CopyFolderRequestBody } from '../managers/folders.generated.js'; +import { CopyFolderRequestBodyParentField } from '../managers/folders.generated.js'; +import { UpdateFolderByIdRequestBodyParentField } from '../managers/folders.generated.js'; import { Items } from '../schemas.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; @@ -46,7 +46,7 @@ test('test_get_folder_info', async function test_get_folder_info(): Promise test('test_get_folder_full_info_with_extra_fields', async function test_get_folder_full_info_with_extra_fields(): Promise { const rootFolder: FolderFull = await client.folders.getFolderById('0', { fields: ['has_collaborations' as '', 'tags' as ''], - } satisfies GetFolderByIdQueryParamsArg); + } satisfies GetFolderByIdQueryParams); if (!(rootFolder.id == '0')) { throw 'Assertion failed'; } @@ -62,8 +62,8 @@ test('test_create_and_delete_folder', async function test_create_and_delete_fold const newFolderName: string = getUuid(); const newFolder: FolderFull = await client.folders.createFolder({ name: newFolderName, - parent: { id: '0' } satisfies CreateFolderRequestBodyArgParentField, - } satisfies CreateFolderRequestBodyArg); + parent: { id: '0' } satisfies CreateFolderRequestBodyParentField, + } satisfies CreateFolderRequestBody); const createdFolder: FolderFull = await client.folders.getFolderById( newFolder.id ); @@ -79,15 +79,15 @@ test('test_update_folder', async function test_update_folder(): Promise { const folderToUpdateName: string = getUuid(); const folderToUpdate: FolderFull = await client.folders.createFolder({ name: folderToUpdateName, - parent: { id: '0' } satisfies CreateFolderRequestBodyArgParentField, - } satisfies CreateFolderRequestBodyArg); + parent: { id: '0' } satisfies CreateFolderRequestBodyParentField, + } satisfies CreateFolderRequestBody); const updatedName: string = getUuid(); const updatedFolder: FolderFull = await client.folders.updateFolderById( folderToUpdate.id, { name: updatedName, description: 'Updated description', - } satisfies UpdateFolderByIdRequestBodyArg + } satisfies UpdateFolderByIdRequestBody ); if (!(updatedFolder.name == updatedName)) { throw 'Assertion failed'; @@ -101,15 +101,15 @@ test('test_copy_move_folder_and_list_folder_items', async function test_copy_mov const folderOriginName: string = getUuid(); const folderOrigin: FolderFull = await client.folders.createFolder({ name: folderOriginName, - parent: { id: '0' } satisfies CreateFolderRequestBodyArgParentField, - } satisfies CreateFolderRequestBodyArg); + parent: { id: '0' } satisfies CreateFolderRequestBodyParentField, + } satisfies CreateFolderRequestBody); const copiedFolderName: string = getUuid(); const copiedFolder: FolderFull = await client.folders.copyFolder( folderOrigin.id, { - parent: { id: '0' } satisfies CopyFolderRequestBodyArgParentField, + parent: { id: '0' } satisfies CopyFolderRequestBodyParentField, name: copiedFolderName, - } satisfies CopyFolderRequestBodyArg + } satisfies CopyFolderRequestBody ); if (!(copiedFolder.parent!.id == '0')) { throw 'Assertion failed'; @@ -120,9 +120,9 @@ test('test_copy_move_folder_and_list_folder_items', async function test_copy_mov { parent: { id: folderOrigin.id, - } satisfies UpdateFolderByIdRequestBodyArgParentField, + } satisfies UpdateFolderByIdRequestBodyParentField, name: movedFolderName, - } satisfies UpdateFolderByIdRequestBodyArg + } satisfies UpdateFolderByIdRequestBody ); if (!(movedFolder.parent!.id == folderOrigin.id)) { throw 'Assertion failed'; diff --git a/src/test/groups.generated.test.ts b/src/test/groups.generated.test.ts index acddab2d..722b2d60 100644 --- a/src/test/groups.generated.test.ts +++ b/src/test/groups.generated.test.ts @@ -2,16 +2,16 @@ import { serializeGroups } from '../schemas.generated.js'; import { deserializeGroups } from '../schemas.generated.js'; import { serializeGroupFull } from '../schemas.generated.js'; import { deserializeGroupFull } from '../schemas.generated.js'; -import { serializeCreateGroupRequestBodyArg } from '../managers/groups.generated.js'; -import { deserializeCreateGroupRequestBodyArg } from '../managers/groups.generated.js'; -import { serializeUpdateGroupByIdRequestBodyArg } from '../managers/groups.generated.js'; -import { deserializeUpdateGroupByIdRequestBodyArg } from '../managers/groups.generated.js'; +import { serializeCreateGroupRequestBody } from '../managers/groups.generated.js'; +import { deserializeCreateGroupRequestBody } from '../managers/groups.generated.js'; +import { serializeUpdateGroupByIdRequestBody } from '../managers/groups.generated.js'; +import { deserializeUpdateGroupByIdRequestBody } from '../managers/groups.generated.js'; import { BoxClient } from '../client.generated.js'; import { Groups } from '../schemas.generated.js'; import { GroupFull } from '../schemas.generated.js'; -import { CreateGroupRequestBodyArg } from '../managers/groups.generated.js'; -import { GetGroupByIdQueryParamsArg } from '../managers/groups.generated.js'; -import { UpdateGroupByIdRequestBodyArg } from '../managers/groups.generated.js'; +import { CreateGroupRequestBody } from '../managers/groups.generated.js'; +import { GetGroupByIdQueryParams } from '../managers/groups.generated.js'; +import { UpdateGroupByIdRequestBody } from '../managers/groups.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; import { SerializedData } from '../json.js'; @@ -34,13 +34,13 @@ test('test_create_get_delete_group', async function test_create_get_delete_group const group: GroupFull = await client.groups.createGroup({ name: groupName, description: groupDescription, - } satisfies CreateGroupRequestBodyArg); + } satisfies CreateGroupRequestBody); if (!(group.name == groupName)) { throw 'Assertion failed'; } const groupById: GroupFull = await client.groups.getGroupById(group.id, { fields: ['id' as '', 'name' as '', 'description' as '', 'group_type' as ''], - } satisfies GetGroupByIdQueryParamsArg); + } satisfies GetGroupByIdQueryParams); if (!(groupById.id == group.id)) { throw 'Assertion failed'; } @@ -50,7 +50,7 @@ test('test_create_get_delete_group', async function test_create_get_delete_group const updatedGroupName: string = getUuid(); const updatedGroup: GroupFull = await client.groups.updateGroupById( group.id, - { name: updatedGroupName } satisfies UpdateGroupByIdRequestBodyArg + { name: updatedGroupName } satisfies UpdateGroupByIdRequestBody ); if (!(updatedGroup.name == updatedGroupName)) { throw 'Assertion failed'; diff --git a/src/test/invites.generated.test.ts b/src/test/invites.generated.test.ts index e38da47c..e72b9f4e 100644 --- a/src/test/invites.generated.test.ts +++ b/src/test/invites.generated.test.ts @@ -2,19 +2,19 @@ import { serializeUserFull } from '../schemas.generated.js'; import { deserializeUserFull } from '../schemas.generated.js'; import { serializeInvite } from '../schemas.generated.js'; import { deserializeInvite } from '../schemas.generated.js'; -import { serializeCreateInviteRequestBodyArg } from '../managers/invites.generated.js'; -import { deserializeCreateInviteRequestBodyArg } from '../managers/invites.generated.js'; -import { serializeCreateInviteRequestBodyArgEnterpriseField } from '../managers/invites.generated.js'; -import { deserializeCreateInviteRequestBodyArgEnterpriseField } from '../managers/invites.generated.js'; -import { serializeCreateInviteRequestBodyArgActionableByField } from '../managers/invites.generated.js'; -import { deserializeCreateInviteRequestBodyArgActionableByField } from '../managers/invites.generated.js'; +import { serializeCreateInviteRequestBody } from '../managers/invites.generated.js'; +import { deserializeCreateInviteRequestBody } from '../managers/invites.generated.js'; +import { serializeCreateInviteRequestBodyEnterpriseField } from '../managers/invites.generated.js'; +import { deserializeCreateInviteRequestBodyEnterpriseField } from '../managers/invites.generated.js'; +import { serializeCreateInviteRequestBodyActionableByField } from '../managers/invites.generated.js'; +import { deserializeCreateInviteRequestBodyActionableByField } from '../managers/invites.generated.js'; import { BoxClient } from '../client.generated.js'; import { UserFull } from '../schemas.generated.js'; -import { GetUserMeQueryParamsArg } from '../managers/users.generated.js'; +import { GetUserMeQueryParams } from '../managers/users.generated.js'; import { Invite } from '../schemas.generated.js'; -import { CreateInviteRequestBodyArg } from '../managers/invites.generated.js'; -import { CreateInviteRequestBodyArgEnterpriseField } from '../managers/invites.generated.js'; -import { CreateInviteRequestBodyArgActionableByField } from '../managers/invites.generated.js'; +import { CreateInviteRequestBody } from '../managers/invites.generated.js'; +import { CreateInviteRequestBodyEnterpriseField } from '../managers/invites.generated.js'; +import { CreateInviteRequestBodyActionableByField } from '../managers/invites.generated.js'; import { getUuid } from '../utils.js'; import { getEnvVar } from '../utils.js'; import { getDefaultClientAsUser } from './commons.generated.js'; @@ -32,16 +32,16 @@ test('testInvites', async function testInvites(): Promise { const client: BoxClient = await getDefaultClientAsUser(userId); const currentUser: UserFull = await client.users.getUserMe({ fields: ['enterprise' as ''], - } satisfies GetUserMeQueryParamsArg); + } satisfies GetUserMeQueryParams); const email: string = getEnvVar('BOX_EXTERNAL_USER_EMAIL'); const invitation: Invite = await client.invites.createInvite({ enterprise: { id: currentUser.enterprise!.id!, - } satisfies CreateInviteRequestBodyArgEnterpriseField, + } satisfies CreateInviteRequestBodyEnterpriseField, actionableBy: { login: email, - } satisfies CreateInviteRequestBodyArgActionableByField, - } satisfies CreateInviteRequestBodyArg); + } satisfies CreateInviteRequestBodyActionableByField, + } satisfies CreateInviteRequestBody); if (!((toString(invitation.type) as string) == 'invite')) { throw 'Assertion failed'; } diff --git a/src/test/legalHoldPolicies.generated.test.ts b/src/test/legalHoldPolicies.generated.test.ts index 880d77b8..7dcc5585 100644 --- a/src/test/legalHoldPolicies.generated.test.ts +++ b/src/test/legalHoldPolicies.generated.test.ts @@ -1,15 +1,15 @@ import { serializeLegalHoldPolicy } from '../schemas.generated.js'; import { deserializeLegalHoldPolicy } from '../schemas.generated.js'; -import { serializeCreateLegalHoldPolicyRequestBodyArg } from '../managers/legalHoldPolicies.generated.js'; -import { deserializeCreateLegalHoldPolicyRequestBodyArg } from '../managers/legalHoldPolicies.generated.js'; +import { serializeCreateLegalHoldPolicyRequestBody } from '../managers/legalHoldPolicies.generated.js'; +import { deserializeCreateLegalHoldPolicyRequestBody } from '../managers/legalHoldPolicies.generated.js'; import { serializeLegalHoldPolicies } from '../schemas.generated.js'; import { deserializeLegalHoldPolicies } from '../schemas.generated.js'; -import { serializeUpdateLegalHoldPolicyByIdRequestBodyArg } from '../managers/legalHoldPolicies.generated.js'; -import { deserializeUpdateLegalHoldPolicyByIdRequestBodyArg } from '../managers/legalHoldPolicies.generated.js'; +import { serializeUpdateLegalHoldPolicyByIdRequestBody } from '../managers/legalHoldPolicies.generated.js'; +import { deserializeUpdateLegalHoldPolicyByIdRequestBody } from '../managers/legalHoldPolicies.generated.js'; import { LegalHoldPolicy } from '../schemas.generated.js'; -import { CreateLegalHoldPolicyRequestBodyArg } from '../managers/legalHoldPolicies.generated.js'; +import { CreateLegalHoldPolicyRequestBody } from '../managers/legalHoldPolicies.generated.js'; import { LegalHoldPolicies } from '../schemas.generated.js'; -import { UpdateLegalHoldPolicyByIdRequestBodyArg } from '../managers/legalHoldPolicies.generated.js'; +import { UpdateLegalHoldPolicyByIdRequestBody } from '../managers/legalHoldPolicies.generated.js'; import { getUuid } from '../utils.js'; import { BoxClient } from '../client.generated.js'; import { getDefaultClient } from './commons.generated.js'; @@ -29,7 +29,7 @@ test('testCreateUpdateGetDeleteLegalHoldPolicy', async function testCreateUpdate policyName: legalHoldPolicyName, description: legalHoldDescription, isOngoing: true, - } satisfies CreateLegalHoldPolicyRequestBodyArg); + } satisfies CreateLegalHoldPolicyRequestBody); if (!(legalHoldPolicy.policyName == legalHoldPolicyName)) { throw 'Assertion failed'; } @@ -53,7 +53,7 @@ test('testCreateUpdateGetDeleteLegalHoldPolicy', async function testCreateUpdate legalHoldPolicyId, { policyName: updatedLegalHoldPolicyName, - } satisfies UpdateLegalHoldPolicyByIdRequestBodyArg + } satisfies UpdateLegalHoldPolicyByIdRequestBody ); if (!(updatedLegalHoldPolicy.policyName == updatedLegalHoldPolicyName)) { throw 'Assertion failed'; diff --git a/src/test/listCollaborations.generated.test.ts b/src/test/listCollaborations.generated.test.ts index d3b23b20..3daddade 100644 --- a/src/test/listCollaborations.generated.test.ts +++ b/src/test/listCollaborations.generated.test.ts @@ -4,41 +4,41 @@ import { serializeFileFull } from '../schemas.generated.js'; import { deserializeFileFull } from '../schemas.generated.js'; import { serializeGroupFull } from '../schemas.generated.js'; import { deserializeGroupFull } from '../schemas.generated.js'; -import { serializeCreateGroupRequestBodyArg } from '../managers/groups.generated.js'; -import { deserializeCreateGroupRequestBodyArg } from '../managers/groups.generated.js'; +import { serializeCreateGroupRequestBody } from '../managers/groups.generated.js'; +import { deserializeCreateGroupRequestBody } from '../managers/groups.generated.js'; import { serializeCollaboration } from '../schemas.generated.js'; import { deserializeCollaboration } from '../schemas.generated.js'; -import { serializeCreateCollaborationRequestBodyArg } from '../managers/userCollaborations.generated.js'; -import { deserializeCreateCollaborationRequestBodyArg } from '../managers/userCollaborations.generated.js'; -import { serializeCreateCollaborationRequestBodyArgItemField } from '../managers/userCollaborations.generated.js'; -import { deserializeCreateCollaborationRequestBodyArgItemField } from '../managers/userCollaborations.generated.js'; -import { serializeCreateCollaborationRequestBodyArgItemFieldTypeField } from '../managers/userCollaborations.generated.js'; -import { deserializeCreateCollaborationRequestBodyArgItemFieldTypeField } from '../managers/userCollaborations.generated.js'; -import { serializeCreateCollaborationRequestBodyArgAccessibleByField } from '../managers/userCollaborations.generated.js'; -import { deserializeCreateCollaborationRequestBodyArgAccessibleByField } from '../managers/userCollaborations.generated.js'; -import { serializeCreateCollaborationRequestBodyArgAccessibleByFieldTypeField } from '../managers/userCollaborations.generated.js'; -import { deserializeCreateCollaborationRequestBodyArgAccessibleByFieldTypeField } from '../managers/userCollaborations.generated.js'; -import { serializeCreateCollaborationRequestBodyArgRoleField } from '../managers/userCollaborations.generated.js'; -import { deserializeCreateCollaborationRequestBodyArgRoleField } from '../managers/userCollaborations.generated.js'; +import { serializeCreateCollaborationRequestBody } from '../managers/userCollaborations.generated.js'; +import { deserializeCreateCollaborationRequestBody } from '../managers/userCollaborations.generated.js'; +import { serializeCreateCollaborationRequestBodyItemField } from '../managers/userCollaborations.generated.js'; +import { deserializeCreateCollaborationRequestBodyItemField } from '../managers/userCollaborations.generated.js'; +import { serializeCreateCollaborationRequestBodyItemTypeField } from '../managers/userCollaborations.generated.js'; +import { deserializeCreateCollaborationRequestBodyItemTypeField } from '../managers/userCollaborations.generated.js'; +import { serializeCreateCollaborationRequestBodyAccessibleByField } from '../managers/userCollaborations.generated.js'; +import { deserializeCreateCollaborationRequestBodyAccessibleByField } from '../managers/userCollaborations.generated.js'; +import { serializeCreateCollaborationRequestBodyAccessibleByTypeField } from '../managers/userCollaborations.generated.js'; +import { deserializeCreateCollaborationRequestBodyAccessibleByTypeField } from '../managers/userCollaborations.generated.js'; +import { serializeCreateCollaborationRequestBodyRoleField } from '../managers/userCollaborations.generated.js'; +import { deserializeCreateCollaborationRequestBodyRoleField } from '../managers/userCollaborations.generated.js'; import { serializeCollaborations } from '../schemas.generated.js'; import { deserializeCollaborations } from '../schemas.generated.js'; -import { serializeGetCollaborationsQueryParamsArgStatusField } from '../managers/listCollaborations.generated.js'; -import { deserializeGetCollaborationsQueryParamsArgStatusField } from '../managers/listCollaborations.generated.js'; +import { serializeGetCollaborationsQueryParamsStatusField } from '../managers/listCollaborations.generated.js'; +import { deserializeGetCollaborationsQueryParamsStatusField } from '../managers/listCollaborations.generated.js'; import { BoxClient } from '../client.generated.js'; import { FolderFull } from '../schemas.generated.js'; import { FileFull } from '../schemas.generated.js'; import { GroupFull } from '../schemas.generated.js'; -import { CreateGroupRequestBodyArg } from '../managers/groups.generated.js'; +import { CreateGroupRequestBody } from '../managers/groups.generated.js'; import { Collaboration } from '../schemas.generated.js'; -import { CreateCollaborationRequestBodyArg } from '../managers/userCollaborations.generated.js'; -import { CreateCollaborationRequestBodyArgItemField } from '../managers/userCollaborations.generated.js'; -import { CreateCollaborationRequestBodyArgItemFieldTypeField } from '../managers/userCollaborations.generated.js'; -import { CreateCollaborationRequestBodyArgAccessibleByField } from '../managers/userCollaborations.generated.js'; -import { CreateCollaborationRequestBodyArgAccessibleByFieldTypeField } from '../managers/userCollaborations.generated.js'; -import { CreateCollaborationRequestBodyArgRoleField } from '../managers/userCollaborations.generated.js'; +import { CreateCollaborationRequestBody } from '../managers/userCollaborations.generated.js'; +import { CreateCollaborationRequestBodyItemField } from '../managers/userCollaborations.generated.js'; +import { CreateCollaborationRequestBodyItemTypeField } from '../managers/userCollaborations.generated.js'; +import { CreateCollaborationRequestBodyAccessibleByField } from '../managers/userCollaborations.generated.js'; +import { CreateCollaborationRequestBodyAccessibleByTypeField } from '../managers/userCollaborations.generated.js'; +import { CreateCollaborationRequestBodyRoleField } from '../managers/userCollaborations.generated.js'; import { Collaborations } from '../schemas.generated.js'; -import { GetCollaborationsQueryParamsArg } from '../managers/listCollaborations.generated.js'; -import { GetCollaborationsQueryParamsArgStatusField } from '../managers/listCollaborations.generated.js'; +import { GetCollaborationsQueryParams } from '../managers/listCollaborations.generated.js'; +import { GetCollaborationsQueryParamsStatusField } from '../managers/listCollaborations.generated.js'; import { getUuid } from '../utils.js'; import { getEnvVar } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; @@ -59,31 +59,31 @@ test('testListCollaborations', async function testListCollaborations(): Promise< const file: FileFull = await uploadNewFile(); const group: GroupFull = await client.groups.createGroup({ name: getUuid(), - } satisfies CreateGroupRequestBodyArg); + } satisfies CreateGroupRequestBody); const groupCollaboration: Collaboration = await client.userCollaborations.createCollaboration({ item: { - type: 'folder' as CreateCollaborationRequestBodyArgItemFieldTypeField, + type: 'folder' as CreateCollaborationRequestBodyItemTypeField, id: folder.id, - } satisfies CreateCollaborationRequestBodyArgItemField, + } satisfies CreateCollaborationRequestBodyItemField, accessibleBy: { - type: 'group' as CreateCollaborationRequestBodyArgAccessibleByFieldTypeField, + type: 'group' as CreateCollaborationRequestBodyAccessibleByTypeField, id: group.id, - } satisfies CreateCollaborationRequestBodyArgAccessibleByField, - role: 'editor' as CreateCollaborationRequestBodyArgRoleField, - } satisfies CreateCollaborationRequestBodyArg); + } satisfies CreateCollaborationRequestBodyAccessibleByField, + role: 'editor' as CreateCollaborationRequestBodyRoleField, + } satisfies CreateCollaborationRequestBody); const fileCollaboration: Collaboration = await client.userCollaborations.createCollaboration({ item: { - type: 'file' as CreateCollaborationRequestBodyArgItemFieldTypeField, + type: 'file' as CreateCollaborationRequestBodyItemTypeField, id: file.id, - } satisfies CreateCollaborationRequestBodyArgItemField, + } satisfies CreateCollaborationRequestBodyItemField, accessibleBy: { - type: 'user' as CreateCollaborationRequestBodyArgAccessibleByFieldTypeField, + type: 'user' as CreateCollaborationRequestBodyAccessibleByTypeField, id: getEnvVar('USER_ID'), - } satisfies CreateCollaborationRequestBodyArgAccessibleByField, - role: 'editor' as CreateCollaborationRequestBodyArgRoleField, - } satisfies CreateCollaborationRequestBodyArg); + } satisfies CreateCollaborationRequestBodyAccessibleByField, + role: 'editor' as CreateCollaborationRequestBodyRoleField, + } satisfies CreateCollaborationRequestBody); if (!((toString(groupCollaboration.role) as string) == 'editor')) { throw 'Assertion failed'; } @@ -102,8 +102,8 @@ test('testListCollaborations', async function testListCollaborations(): Promise< } const pendingCollaborations: Collaborations = await client.listCollaborations.getCollaborations({ - status: 'pending' as GetCollaborationsQueryParamsArgStatusField, - } satisfies GetCollaborationsQueryParamsArg); + status: 'pending' as GetCollaborationsQueryParamsStatusField, + } satisfies GetCollaborationsQueryParams); if (!(pendingCollaborations.entries!.length >= 0)) { throw 'Assertion failed'; } diff --git a/src/test/memberships.generated.test.ts b/src/test/memberships.generated.test.ts index 6b4ff458..47502ccc 100644 --- a/src/test/memberships.generated.test.ts +++ b/src/test/memberships.generated.test.ts @@ -1,37 +1,37 @@ import { serializeUserFull } from '../schemas.generated.js'; import { deserializeUserFull } from '../schemas.generated.js'; -import { serializeCreateUserRequestBodyArg } from '../managers/users.generated.js'; -import { deserializeCreateUserRequestBodyArg } from '../managers/users.generated.js'; +import { serializeCreateUserRequestBody } from '../managers/users.generated.js'; +import { deserializeCreateUserRequestBody } from '../managers/users.generated.js'; import { serializeGroupMemberships } from '../schemas.generated.js'; import { deserializeGroupMemberships } from '../schemas.generated.js'; import { serializeGroupFull } from '../schemas.generated.js'; import { deserializeGroupFull } from '../schemas.generated.js'; -import { serializeCreateGroupRequestBodyArg } from '../managers/groups.generated.js'; -import { deserializeCreateGroupRequestBodyArg } from '../managers/groups.generated.js'; +import { serializeCreateGroupRequestBody } from '../managers/groups.generated.js'; +import { deserializeCreateGroupRequestBody } from '../managers/groups.generated.js'; import { serializeGroupMembership } from '../schemas.generated.js'; import { deserializeGroupMembership } from '../schemas.generated.js'; -import { serializeCreateGroupMembershipRequestBodyArg } from '../managers/memberships.generated.js'; -import { deserializeCreateGroupMembershipRequestBodyArg } from '../managers/memberships.generated.js'; -import { serializeCreateGroupMembershipRequestBodyArgUserField } from '../managers/memberships.generated.js'; -import { deserializeCreateGroupMembershipRequestBodyArgUserField } from '../managers/memberships.generated.js'; -import { serializeCreateGroupMembershipRequestBodyArgGroupField } from '../managers/memberships.generated.js'; -import { deserializeCreateGroupMembershipRequestBodyArgGroupField } from '../managers/memberships.generated.js'; -import { serializeUpdateGroupMembershipByIdRequestBodyArg } from '../managers/memberships.generated.js'; -import { deserializeUpdateGroupMembershipByIdRequestBodyArg } from '../managers/memberships.generated.js'; -import { serializeUpdateGroupMembershipByIdRequestBodyArgRoleField } from '../managers/memberships.generated.js'; -import { deserializeUpdateGroupMembershipByIdRequestBodyArgRoleField } from '../managers/memberships.generated.js'; +import { serializeCreateGroupMembershipRequestBody } from '../managers/memberships.generated.js'; +import { deserializeCreateGroupMembershipRequestBody } from '../managers/memberships.generated.js'; +import { serializeCreateGroupMembershipRequestBodyUserField } from '../managers/memberships.generated.js'; +import { deserializeCreateGroupMembershipRequestBodyUserField } from '../managers/memberships.generated.js'; +import { serializeCreateGroupMembershipRequestBodyGroupField } from '../managers/memberships.generated.js'; +import { deserializeCreateGroupMembershipRequestBodyGroupField } from '../managers/memberships.generated.js'; +import { serializeUpdateGroupMembershipByIdRequestBody } from '../managers/memberships.generated.js'; +import { deserializeUpdateGroupMembershipByIdRequestBody } from '../managers/memberships.generated.js'; +import { serializeUpdateGroupMembershipByIdRequestBodyRoleField } from '../managers/memberships.generated.js'; +import { deserializeUpdateGroupMembershipByIdRequestBodyRoleField } from '../managers/memberships.generated.js'; import { BoxClient } from '../client.generated.js'; import { UserFull } from '../schemas.generated.js'; -import { CreateUserRequestBodyArg } from '../managers/users.generated.js'; +import { CreateUserRequestBody } from '../managers/users.generated.js'; import { GroupMemberships } from '../schemas.generated.js'; import { GroupFull } from '../schemas.generated.js'; -import { CreateGroupRequestBodyArg } from '../managers/groups.generated.js'; +import { CreateGroupRequestBody } from '../managers/groups.generated.js'; import { GroupMembership } from '../schemas.generated.js'; -import { CreateGroupMembershipRequestBodyArg } from '../managers/memberships.generated.js'; -import { CreateGroupMembershipRequestBodyArgUserField } from '../managers/memberships.generated.js'; -import { CreateGroupMembershipRequestBodyArgGroupField } from '../managers/memberships.generated.js'; -import { UpdateGroupMembershipByIdRequestBodyArg } from '../managers/memberships.generated.js'; -import { UpdateGroupMembershipByIdRequestBodyArgRoleField } from '../managers/memberships.generated.js'; +import { CreateGroupMembershipRequestBody } from '../managers/memberships.generated.js'; +import { CreateGroupMembershipRequestBodyUserField } from '../managers/memberships.generated.js'; +import { CreateGroupMembershipRequestBodyGroupField } from '../managers/memberships.generated.js'; +import { UpdateGroupMembershipByIdRequestBody } from '../managers/memberships.generated.js'; +import { UpdateGroupMembershipByIdRequestBodyRoleField } from '../managers/memberships.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; import { toString } from '../utils.js'; @@ -48,7 +48,7 @@ test('testMemberships', async function testMemberships(): Promise { const user: UserFull = await client.users.createUser({ name: getUuid(), login: ''.concat(getUuid(), '@boxdemo.com') as string, - } satisfies CreateUserRequestBodyArg); + } satisfies CreateUserRequestBody); const userMemberships: GroupMemberships = await client.memberships.getUserMemberships(user.id); if (!(userMemberships.totalCount == 0)) { @@ -56,7 +56,7 @@ test('testMemberships', async function testMemberships(): Promise { } const group: GroupFull = await client.groups.createGroup({ name: getUuid(), - } satisfies CreateGroupRequestBodyArg); + } satisfies CreateGroupRequestBody); const groupMemberships: GroupMemberships = await client.memberships.getGroupMemberships(group.id); if (!(groupMemberships.totalCount == 0)) { @@ -64,13 +64,11 @@ test('testMemberships', async function testMemberships(): Promise { } const groupMembership: GroupMembership = await client.memberships.createGroupMembership({ - user: { - id: user.id, - } satisfies CreateGroupMembershipRequestBodyArgUserField, + user: { id: user.id } satisfies CreateGroupMembershipRequestBodyUserField, group: { id: group.id, - } satisfies CreateGroupMembershipRequestBodyArgGroupField, - } satisfies CreateGroupMembershipRequestBodyArg); + } satisfies CreateGroupMembershipRequestBodyGroupField, + } satisfies CreateGroupMembershipRequestBody); if (!(groupMembership.user!.id == user.id)) { throw 'Assertion failed'; } @@ -87,8 +85,8 @@ test('testMemberships', async function testMemberships(): Promise { } const updatedGroupMembership: GroupMembership = await client.memberships.updateGroupMembershipById(groupMembership.id!, { - role: 'admin' as UpdateGroupMembershipByIdRequestBodyArgRoleField, - } satisfies UpdateGroupMembershipByIdRequestBodyArg); + role: 'admin' as UpdateGroupMembershipByIdRequestBodyRoleField, + } satisfies UpdateGroupMembershipByIdRequestBody); if (!(updatedGroupMembership.id == groupMembership.id)) { throw 'Assertion failed'; } diff --git a/src/test/metadataCascadePolicies.generated.test.ts b/src/test/metadataCascadePolicies.generated.test.ts index 6d931072..54369768 100644 --- a/src/test/metadataCascadePolicies.generated.test.ts +++ b/src/test/metadataCascadePolicies.generated.test.ts @@ -1,38 +1,38 @@ -import { serializeCreateMetadataTemplateRequestBodyArg } from '../managers/metadataTemplates.generated.js'; -import { deserializeCreateMetadataTemplateRequestBodyArg } from '../managers/metadataTemplates.generated.js'; -import { serializeCreateMetadataTemplateRequestBodyArgFieldsField } from '../managers/metadataTemplates.generated.js'; -import { deserializeCreateMetadataTemplateRequestBodyArgFieldsField } from '../managers/metadataTemplates.generated.js'; -import { serializeCreateMetadataTemplateRequestBodyArgFieldsFieldTypeField } from '../managers/metadataTemplates.generated.js'; -import { deserializeCreateMetadataTemplateRequestBodyArgFieldsFieldTypeField } from '../managers/metadataTemplates.generated.js'; +import { serializeCreateMetadataTemplateRequestBody } from '../managers/metadataTemplates.generated.js'; +import { deserializeCreateMetadataTemplateRequestBody } from '../managers/metadataTemplates.generated.js'; +import { serializeCreateMetadataTemplateRequestBodyFieldsField } from '../managers/metadataTemplates.generated.js'; +import { deserializeCreateMetadataTemplateRequestBodyFieldsField } from '../managers/metadataTemplates.generated.js'; +import { serializeCreateMetadataTemplateRequestBodyFieldsTypeField } from '../managers/metadataTemplates.generated.js'; +import { deserializeCreateMetadataTemplateRequestBodyFieldsTypeField } from '../managers/metadataTemplates.generated.js'; import { serializeFolderFull } from '../schemas.generated.js'; import { deserializeFolderFull } from '../schemas.generated.js'; import { serializeMetadataCascadePolicy } from '../schemas.generated.js'; import { deserializeMetadataCascadePolicy } from '../schemas.generated.js'; -import { serializeCreateMetadataCascadePolicyRequestBodyArg } from '../managers/metadataCascadePolicies.generated.js'; -import { deserializeCreateMetadataCascadePolicyRequestBodyArg } from '../managers/metadataCascadePolicies.generated.js'; -import { serializeCreateMetadataCascadePolicyRequestBodyArgScopeField } from '../managers/metadataCascadePolicies.generated.js'; -import { deserializeCreateMetadataCascadePolicyRequestBodyArgScopeField } from '../managers/metadataCascadePolicies.generated.js'; +import { serializeCreateMetadataCascadePolicyRequestBody } from '../managers/metadataCascadePolicies.generated.js'; +import { deserializeCreateMetadataCascadePolicyRequestBody } from '../managers/metadataCascadePolicies.generated.js'; +import { serializeCreateMetadataCascadePolicyRequestBodyScopeField } from '../managers/metadataCascadePolicies.generated.js'; +import { deserializeCreateMetadataCascadePolicyRequestBodyScopeField } from '../managers/metadataCascadePolicies.generated.js'; import { serializeMetadataCascadePolicies } from '../schemas.generated.js'; import { deserializeMetadataCascadePolicies } from '../schemas.generated.js'; -import { serializeCreateMetadataCascadePolicyApplyRequestBodyArg } from '../managers/metadataCascadePolicies.generated.js'; -import { deserializeCreateMetadataCascadePolicyApplyRequestBodyArg } from '../managers/metadataCascadePolicies.generated.js'; -import { serializeCreateMetadataCascadePolicyApplyRequestBodyArgConflictResolutionField } from '../managers/metadataCascadePolicies.generated.js'; -import { deserializeCreateMetadataCascadePolicyApplyRequestBodyArgConflictResolutionField } from '../managers/metadataCascadePolicies.generated.js'; -import { serializeCreateFolderMetadataByIdScopeArg } from '../managers/folderMetadata.generated.js'; -import { deserializeCreateFolderMetadataByIdScopeArg } from '../managers/folderMetadata.generated.js'; +import { serializeCreateMetadataCascadePolicyApplyRequestBody } from '../managers/metadataCascadePolicies.generated.js'; +import { deserializeCreateMetadataCascadePolicyApplyRequestBody } from '../managers/metadataCascadePolicies.generated.js'; +import { serializeCreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField } from '../managers/metadataCascadePolicies.generated.js'; +import { deserializeCreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField } from '../managers/metadataCascadePolicies.generated.js'; +import { serializeCreateFolderMetadataByIdScope } from '../managers/folderMetadata.generated.js'; +import { deserializeCreateFolderMetadataByIdScope } from '../managers/folderMetadata.generated.js'; import { BoxClient } from '../client.generated.js'; -import { CreateMetadataTemplateRequestBodyArg } from '../managers/metadataTemplates.generated.js'; -import { CreateMetadataTemplateRequestBodyArgFieldsField } from '../managers/metadataTemplates.generated.js'; -import { CreateMetadataTemplateRequestBodyArgFieldsFieldTypeField } from '../managers/metadataTemplates.generated.js'; +import { CreateMetadataTemplateRequestBody } from '../managers/metadataTemplates.generated.js'; +import { CreateMetadataTemplateRequestBodyFieldsField } from '../managers/metadataTemplates.generated.js'; +import { CreateMetadataTemplateRequestBodyFieldsTypeField } from '../managers/metadataTemplates.generated.js'; import { FolderFull } from '../schemas.generated.js'; import { MetadataCascadePolicy } from '../schemas.generated.js'; -import { CreateMetadataCascadePolicyRequestBodyArg } from '../managers/metadataCascadePolicies.generated.js'; -import { CreateMetadataCascadePolicyRequestBodyArgScopeField } from '../managers/metadataCascadePolicies.generated.js'; +import { CreateMetadataCascadePolicyRequestBody } from '../managers/metadataCascadePolicies.generated.js'; +import { CreateMetadataCascadePolicyRequestBodyScopeField } from '../managers/metadataCascadePolicies.generated.js'; import { MetadataCascadePolicies } from '../schemas.generated.js'; -import { GetMetadataCascadePoliciesQueryParamsArg } from '../managers/metadataCascadePolicies.generated.js'; -import { CreateMetadataCascadePolicyApplyRequestBodyArg } from '../managers/metadataCascadePolicies.generated.js'; -import { CreateMetadataCascadePolicyApplyRequestBodyArgConflictResolutionField } from '../managers/metadataCascadePolicies.generated.js'; -import { CreateFolderMetadataByIdScopeArg } from '../managers/folderMetadata.generated.js'; +import { GetMetadataCascadePoliciesQueryParams } from '../managers/metadataCascadePolicies.generated.js'; +import { CreateMetadataCascadePolicyApplyRequestBody } from '../managers/metadataCascadePolicies.generated.js'; +import { CreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField } from '../managers/metadataCascadePolicies.generated.js'; +import { CreateFolderMetadataByIdScope } from '../managers/folderMetadata.generated.js'; import { getUuid } from '../utils.js'; import { getEnvVar } from '../utils.js'; import { toString } from '../utils.js'; @@ -56,21 +56,20 @@ test('testMetadataCascadePolicies', async function testMetadataCascadePolicies() templateKey: templateKey, fields: [ { - type: 'string' as CreateMetadataTemplateRequestBodyArgFieldsFieldTypeField, + type: 'string' as CreateMetadataTemplateRequestBodyFieldsTypeField, key: 'testName', displayName: 'testName', - } satisfies CreateMetadataTemplateRequestBodyArgFieldsField, + } satisfies CreateMetadataTemplateRequestBodyFieldsField, ], - } satisfies CreateMetadataTemplateRequestBodyArg); + } satisfies CreateMetadataTemplateRequestBody); const folder: FolderFull = await createNewFolder(); const enterpriseId: string = getEnvVar('ENTERPRISE_ID'); const cascadePolicy: MetadataCascadePolicy = await client.metadataCascadePolicies.createMetadataCascadePolicy({ folderId: folder.id, - scope: - 'enterprise' as CreateMetadataCascadePolicyRequestBodyArgScopeField, + scope: 'enterprise' as CreateMetadataCascadePolicyRequestBodyScopeField, templateKey: templateKey, - } satisfies CreateMetadataCascadePolicyRequestBodyArg); + } satisfies CreateMetadataCascadePolicyRequestBody); if ( !((toString(cascadePolicy.type) as string) == 'metadata_cascade_policy') ) { @@ -116,7 +115,7 @@ test('testMetadataCascadePolicies', async function testMetadataCascadePolicies() const policies: MetadataCascadePolicies = await client.metadataCascadePolicies.getMetadataCascadePolicies({ folderId: folder.id, - } satisfies GetMetadataCascadePoliciesQueryParamsArg); + } satisfies GetMetadataCascadePoliciesQueryParams); if (!(policies.entries!.length == 1)) { throw 'Assertion failed'; } @@ -125,8 +124,8 @@ test('testMetadataCascadePolicies', async function testMetadataCascadePolicies() cascadePolicyId, { conflictResolution: - 'overwrite' as CreateMetadataCascadePolicyApplyRequestBodyArgConflictResolutionField, - } satisfies CreateMetadataCascadePolicyApplyRequestBodyArg + 'overwrite' as CreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField, + } satisfies CreateMetadataCascadePolicyApplyRequestBody ); }).rejects.toThrow(); const data: { @@ -134,7 +133,7 @@ test('testMetadataCascadePolicies', async function testMetadataCascadePolicies() } = { ['testName']: 'xyz' }; await client.folderMetadata.createFolderMetadataById( folder.id, - 'enterprise' as CreateFolderMetadataByIdScopeArg, + 'enterprise' as CreateFolderMetadataByIdScope, templateKey, data ); @@ -142,8 +141,8 @@ test('testMetadataCascadePolicies', async function testMetadataCascadePolicies() cascadePolicyId, { conflictResolution: - 'overwrite' as CreateMetadataCascadePolicyApplyRequestBodyArgConflictResolutionField, - } satisfies CreateMetadataCascadePolicyApplyRequestBodyArg + 'overwrite' as CreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField, + } satisfies CreateMetadataCascadePolicyApplyRequestBody ); await client.metadataCascadePolicies.deleteMetadataCascadePolicyById( cascadePolicyId diff --git a/src/test/metadataTemplates.generated.test.ts b/src/test/metadataTemplates.generated.test.ts index 6ae1ab22..5eef46b2 100644 --- a/src/test/metadataTemplates.generated.test.ts +++ b/src/test/metadataTemplates.generated.test.ts @@ -1,47 +1,47 @@ import { serializeMetadataTemplate } from '../schemas.generated.js'; import { deserializeMetadataTemplate } from '../schemas.generated.js'; -import { serializeCreateMetadataTemplateRequestBodyArg } from '../managers/metadataTemplates.generated.js'; -import { deserializeCreateMetadataTemplateRequestBodyArg } from '../managers/metadataTemplates.generated.js'; -import { serializeCreateMetadataTemplateRequestBodyArgFieldsField } from '../managers/metadataTemplates.generated.js'; -import { deserializeCreateMetadataTemplateRequestBodyArgFieldsField } from '../managers/metadataTemplates.generated.js'; -import { serializeCreateMetadataTemplateRequestBodyArgFieldsFieldTypeField } from '../managers/metadataTemplates.generated.js'; -import { deserializeCreateMetadataTemplateRequestBodyArgFieldsFieldTypeField } from '../managers/metadataTemplates.generated.js'; -import { serializeUpdateMetadataTemplateScopeArg } from '../managers/metadataTemplates.generated.js'; -import { deserializeUpdateMetadataTemplateScopeArg } from '../managers/metadataTemplates.generated.js'; -import { serializeUpdateMetadataTemplateRequestBodyArg } from '../managers/metadataTemplates.generated.js'; -import { deserializeUpdateMetadataTemplateRequestBodyArg } from '../managers/metadataTemplates.generated.js'; -import { serializeUpdateMetadataTemplateRequestBodyArgOpField } from '../managers/metadataTemplates.generated.js'; -import { deserializeUpdateMetadataTemplateRequestBodyArgOpField } from '../managers/metadataTemplates.generated.js'; -import { serializeGetMetadataTemplateScopeArg } from '../managers/metadataTemplates.generated.js'; -import { deserializeGetMetadataTemplateScopeArg } from '../managers/metadataTemplates.generated.js'; +import { serializeCreateMetadataTemplateRequestBody } from '../managers/metadataTemplates.generated.js'; +import { deserializeCreateMetadataTemplateRequestBody } from '../managers/metadataTemplates.generated.js'; +import { serializeCreateMetadataTemplateRequestBodyFieldsField } from '../managers/metadataTemplates.generated.js'; +import { deserializeCreateMetadataTemplateRequestBodyFieldsField } from '../managers/metadataTemplates.generated.js'; +import { serializeCreateMetadataTemplateRequestBodyFieldsTypeField } from '../managers/metadataTemplates.generated.js'; +import { deserializeCreateMetadataTemplateRequestBodyFieldsTypeField } from '../managers/metadataTemplates.generated.js'; +import { serializeUpdateMetadataTemplateScope } from '../managers/metadataTemplates.generated.js'; +import { deserializeUpdateMetadataTemplateScope } from '../managers/metadataTemplates.generated.js'; +import { serializeUpdateMetadataTemplateRequestBody } from '../managers/metadataTemplates.generated.js'; +import { deserializeUpdateMetadataTemplateRequestBody } from '../managers/metadataTemplates.generated.js'; +import { serializeUpdateMetadataTemplateRequestBodyOpField } from '../managers/metadataTemplates.generated.js'; +import { deserializeUpdateMetadataTemplateRequestBodyOpField } from '../managers/metadataTemplates.generated.js'; +import { serializeGetMetadataTemplateScope } from '../managers/metadataTemplates.generated.js'; +import { deserializeGetMetadataTemplateScope } from '../managers/metadataTemplates.generated.js'; import { serializeMetadataTemplates } from '../schemas.generated.js'; import { deserializeMetadataTemplates } from '../schemas.generated.js'; -import { serializeDeleteMetadataTemplateScopeArg } from '../managers/metadataTemplates.generated.js'; -import { deserializeDeleteMetadataTemplateScopeArg } from '../managers/metadataTemplates.generated.js'; +import { serializeDeleteMetadataTemplateScope } from '../managers/metadataTemplates.generated.js'; +import { deserializeDeleteMetadataTemplateScope } from '../managers/metadataTemplates.generated.js'; import { serializeFileFull } from '../schemas.generated.js'; import { deserializeFileFull } from '../schemas.generated.js'; import { serializeMetadataFull } from '../schemas.generated.js'; import { deserializeMetadataFull } from '../schemas.generated.js'; -import { serializeCreateFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; -import { deserializeCreateFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; -import { serializeDeleteFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; -import { deserializeDeleteFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; +import { serializeCreateFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; +import { deserializeCreateFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; +import { serializeDeleteFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; +import { deserializeDeleteFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; import { BoxClient } from '../client.generated.js'; import { MetadataTemplate } from '../schemas.generated.js'; -import { CreateMetadataTemplateRequestBodyArg } from '../managers/metadataTemplates.generated.js'; -import { CreateMetadataTemplateRequestBodyArgFieldsField } from '../managers/metadataTemplates.generated.js'; -import { CreateMetadataTemplateRequestBodyArgFieldsFieldTypeField } from '../managers/metadataTemplates.generated.js'; -import { UpdateMetadataTemplateScopeArg } from '../managers/metadataTemplates.generated.js'; -import { UpdateMetadataTemplateRequestBodyArg } from '../managers/metadataTemplates.generated.js'; -import { UpdateMetadataTemplateRequestBodyArgOpField } from '../managers/metadataTemplates.generated.js'; -import { GetMetadataTemplateScopeArg } from '../managers/metadataTemplates.generated.js'; +import { CreateMetadataTemplateRequestBody } from '../managers/metadataTemplates.generated.js'; +import { CreateMetadataTemplateRequestBodyFieldsField } from '../managers/metadataTemplates.generated.js'; +import { CreateMetadataTemplateRequestBodyFieldsTypeField } from '../managers/metadataTemplates.generated.js'; +import { UpdateMetadataTemplateScope } from '../managers/metadataTemplates.generated.js'; +import { UpdateMetadataTemplateRequestBody } from '../managers/metadataTemplates.generated.js'; +import { UpdateMetadataTemplateRequestBodyOpField } from '../managers/metadataTemplates.generated.js'; +import { GetMetadataTemplateScope } from '../managers/metadataTemplates.generated.js'; import { MetadataTemplates } from '../schemas.generated.js'; -import { DeleteMetadataTemplateScopeArg } from '../managers/metadataTemplates.generated.js'; +import { DeleteMetadataTemplateScope } from '../managers/metadataTemplates.generated.js'; import { FileFull } from '../schemas.generated.js'; import { MetadataFull } from '../schemas.generated.js'; -import { CreateFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; -import { GetMetadataTemplatesByInstanceIdQueryParamsArg } from '../managers/metadataTemplates.generated.js'; -import { DeleteFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; +import { CreateFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; +import { GetMetadataTemplatesByInstanceIdQueryParams } from '../managers/metadataTemplates.generated.js'; +import { DeleteFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; import { uploadNewFile } from './commons.generated.js'; @@ -61,12 +61,12 @@ test('testMetadataTemplates', async function testMetadataTemplates(): Promise { await client.metadataTemplates.deleteMetadataTemplate( - 'enterprise' as DeleteMetadataTemplateScopeArg, + 'enterprise' as DeleteMetadataTemplateScope, template.templateKey! ); }).rejects.toThrow(); @@ -146,23 +146,23 @@ test('testGetMetadataTemplateByInstance', async function testGetMetadataTemplate templateKey: templateKey, fields: [ { - type: 'string' as CreateMetadataTemplateRequestBodyArgFieldsFieldTypeField, + type: 'string' as CreateMetadataTemplateRequestBodyFieldsTypeField, key: 'testName', displayName: 'testName', - } satisfies CreateMetadataTemplateRequestBodyArgFieldsField, + } satisfies CreateMetadataTemplateRequestBodyFieldsField, ], - } satisfies CreateMetadataTemplateRequestBodyArg); + } satisfies CreateMetadataTemplateRequestBody); const createdMetadataInstance: any = await client.fileMetadata.createFileMetadataById( file.id, - 'enterprise' as CreateFileMetadataByIdScopeArg, + 'enterprise' as CreateFileMetadataByIdScope, templateKey, { ['testName']: 'xyz' } ); const metadataTemplates: any = await client.metadataTemplates.getMetadataTemplatesByInstanceId({ metadataInstanceId: createdMetadataInstance.id!, - } satisfies GetMetadataTemplatesByInstanceIdQueryParamsArg); + } satisfies GetMetadataTemplatesByInstanceIdQueryParams); if (!(metadataTemplates.entries!.length == 1)) { throw 'Assertion failed'; } @@ -174,11 +174,11 @@ test('testGetMetadataTemplateByInstance', async function testGetMetadataTemplate } await client.fileMetadata.deleteFileMetadataById( file.id, - 'enterprise' as DeleteFileMetadataByIdScopeArg, + 'enterprise' as DeleteFileMetadataByIdScope, templateKey ); await client.metadataTemplates.deleteMetadataTemplate( - 'enterprise' as DeleteMetadataTemplateScopeArg, + 'enterprise' as DeleteMetadataTemplateScope, template.templateKey! ); await client.files.deleteFileById(file.id); diff --git a/src/test/retentionPolicies.generated.test.ts b/src/test/retentionPolicies.generated.test.ts index 759a622b..90b342cb 100644 --- a/src/test/retentionPolicies.generated.test.ts +++ b/src/test/retentionPolicies.generated.test.ts @@ -1,24 +1,24 @@ import { serializeRetentionPolicy } from '../schemas.generated.js'; import { deserializeRetentionPolicy } from '../schemas.generated.js'; -import { serializeCreateRetentionPolicyRequestBodyArg } from '../managers/retentionPolicies.generated.js'; -import { deserializeCreateRetentionPolicyRequestBodyArg } from '../managers/retentionPolicies.generated.js'; -import { serializeCreateRetentionPolicyRequestBodyArgPolicyTypeField } from '../managers/retentionPolicies.generated.js'; -import { deserializeCreateRetentionPolicyRequestBodyArgPolicyTypeField } from '../managers/retentionPolicies.generated.js'; -import { serializeCreateRetentionPolicyRequestBodyArgDispositionActionField } from '../managers/retentionPolicies.generated.js'; -import { deserializeCreateRetentionPolicyRequestBodyArgDispositionActionField } from '../managers/retentionPolicies.generated.js'; -import { serializeCreateRetentionPolicyRequestBodyArgRetentionTypeField } from '../managers/retentionPolicies.generated.js'; -import { deserializeCreateRetentionPolicyRequestBodyArgRetentionTypeField } from '../managers/retentionPolicies.generated.js'; +import { serializeCreateRetentionPolicyRequestBody } from '../managers/retentionPolicies.generated.js'; +import { deserializeCreateRetentionPolicyRequestBody } from '../managers/retentionPolicies.generated.js'; +import { serializeCreateRetentionPolicyRequestBodyPolicyTypeField } from '../managers/retentionPolicies.generated.js'; +import { deserializeCreateRetentionPolicyRequestBodyPolicyTypeField } from '../managers/retentionPolicies.generated.js'; +import { serializeCreateRetentionPolicyRequestBodyDispositionActionField } from '../managers/retentionPolicies.generated.js'; +import { deserializeCreateRetentionPolicyRequestBodyDispositionActionField } from '../managers/retentionPolicies.generated.js'; +import { serializeCreateRetentionPolicyRequestBodyRetentionTypeField } from '../managers/retentionPolicies.generated.js'; +import { deserializeCreateRetentionPolicyRequestBodyRetentionTypeField } from '../managers/retentionPolicies.generated.js'; import { serializeRetentionPolicies } from '../schemas.generated.js'; import { deserializeRetentionPolicies } from '../schemas.generated.js'; -import { serializeUpdateRetentionPolicyByIdRequestBodyArg } from '../managers/retentionPolicies.generated.js'; -import { deserializeUpdateRetentionPolicyByIdRequestBodyArg } from '../managers/retentionPolicies.generated.js'; +import { serializeUpdateRetentionPolicyByIdRequestBody } from '../managers/retentionPolicies.generated.js'; +import { deserializeUpdateRetentionPolicyByIdRequestBody } from '../managers/retentionPolicies.generated.js'; import { RetentionPolicy } from '../schemas.generated.js'; -import { CreateRetentionPolicyRequestBodyArg } from '../managers/retentionPolicies.generated.js'; -import { CreateRetentionPolicyRequestBodyArgPolicyTypeField } from '../managers/retentionPolicies.generated.js'; -import { CreateRetentionPolicyRequestBodyArgDispositionActionField } from '../managers/retentionPolicies.generated.js'; -import { CreateRetentionPolicyRequestBodyArgRetentionTypeField } from '../managers/retentionPolicies.generated.js'; +import { CreateRetentionPolicyRequestBody } from '../managers/retentionPolicies.generated.js'; +import { CreateRetentionPolicyRequestBodyPolicyTypeField } from '../managers/retentionPolicies.generated.js'; +import { CreateRetentionPolicyRequestBodyDispositionActionField } from '../managers/retentionPolicies.generated.js'; +import { CreateRetentionPolicyRequestBodyRetentionTypeField } from '../managers/retentionPolicies.generated.js'; import { RetentionPolicies } from '../schemas.generated.js'; -import { UpdateRetentionPolicyByIdRequestBodyArg } from '../managers/retentionPolicies.generated.js'; +import { UpdateRetentionPolicyByIdRequestBody } from '../managers/retentionPolicies.generated.js'; import { getUuid } from '../utils.js'; import { BoxClient } from '../client.generated.js'; import { getDefaultClient } from './commons.generated.js'; @@ -36,17 +36,16 @@ test('testCreateUpdateGetDeleteRetentionPolicy', async function testCreateUpdate const retentionPolicy: RetentionPolicy = await client.retentionPolicies.createRetentionPolicy({ policyName: retentionPolicyName, - policyType: - 'finite' as CreateRetentionPolicyRequestBodyArgPolicyTypeField, + policyType: 'finite' as CreateRetentionPolicyRequestBodyPolicyTypeField, areOwnersNotified: true, canOwnerExtendRetention: true, description: retentionDescription, dispositionAction: - 'remove_retention' as CreateRetentionPolicyRequestBodyArgDispositionActionField, + 'remove_retention' as CreateRetentionPolicyRequestBodyDispositionActionField, retentionLength: '1', retentionType: - 'modifiable' as CreateRetentionPolicyRequestBodyArgRetentionTypeField, - } satisfies CreateRetentionPolicyRequestBodyArg); + 'modifiable' as CreateRetentionPolicyRequestBodyRetentionTypeField, + } satisfies CreateRetentionPolicyRequestBody); if (!(retentionPolicy.policyName == retentionPolicyName)) { throw 'Assertion failed'; } @@ -69,7 +68,7 @@ test('testCreateUpdateGetDeleteRetentionPolicy', async function testCreateUpdate retentionPolicy.id, { policyName: updatedRetentionPolicyName, - } satisfies UpdateRetentionPolicyByIdRequestBodyArg + } satisfies UpdateRetentionPolicyByIdRequestBody ); if (!(updatedRetentionPolicy.policyName == updatedRetentionPolicyName)) { throw 'Assertion failed'; diff --git a/src/test/search.generated.test.ts b/src/test/search.generated.test.ts index 9a6834ad..225ca338 100644 --- a/src/test/search.generated.test.ts +++ b/src/test/search.generated.test.ts @@ -1,58 +1,58 @@ import { serializeMetadataTemplate } from '../schemas.generated.js'; import { deserializeMetadataTemplate } from '../schemas.generated.js'; -import { serializeCreateMetadataTemplateRequestBodyArg } from '../managers/metadataTemplates.generated.js'; -import { deserializeCreateMetadataTemplateRequestBodyArg } from '../managers/metadataTemplates.generated.js'; -import { serializeCreateMetadataTemplateRequestBodyArgFieldsField } from '../managers/metadataTemplates.generated.js'; -import { deserializeCreateMetadataTemplateRequestBodyArgFieldsField } from '../managers/metadataTemplates.generated.js'; -import { serializeCreateMetadataTemplateRequestBodyArgFieldsFieldTypeField } from '../managers/metadataTemplates.generated.js'; -import { deserializeCreateMetadataTemplateRequestBodyArgFieldsFieldTypeField } from '../managers/metadataTemplates.generated.js'; +import { serializeCreateMetadataTemplateRequestBody } from '../managers/metadataTemplates.generated.js'; +import { deserializeCreateMetadataTemplateRequestBody } from '../managers/metadataTemplates.generated.js'; +import { serializeCreateMetadataTemplateRequestBodyFieldsField } from '../managers/metadataTemplates.generated.js'; +import { deserializeCreateMetadataTemplateRequestBodyFieldsField } from '../managers/metadataTemplates.generated.js'; +import { serializeCreateMetadataTemplateRequestBodyFieldsTypeField } from '../managers/metadataTemplates.generated.js'; +import { deserializeCreateMetadataTemplateRequestBodyFieldsTypeField } from '../managers/metadataTemplates.generated.js'; import { serializeFiles } from '../schemas.generated.js'; import { deserializeFiles } from '../schemas.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; import { serializeFileFull } from '../schemas.generated.js'; import { deserializeFileFull } from '../schemas.generated.js'; import { serializeMetadataFull } from '../schemas.generated.js'; import { deserializeMetadataFull } from '../schemas.generated.js'; -import { serializeCreateFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; -import { deserializeCreateFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; +import { serializeCreateFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; +import { deserializeCreateFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; import { serializeMetadataQueryResults } from '../schemas.generated.js'; import { deserializeMetadataQueryResults } from '../schemas.generated.js'; import { serializeMetadataQuery } from '../schemas.generated.js'; import { deserializeMetadataQuery } from '../schemas.generated.js'; -import { serializeDeleteMetadataTemplateScopeArg } from '../managers/metadataTemplates.generated.js'; -import { deserializeDeleteMetadataTemplateScopeArg } from '../managers/metadataTemplates.generated.js'; +import { serializeDeleteMetadataTemplateScope } from '../managers/metadataTemplates.generated.js'; +import { deserializeDeleteMetadataTemplateScope } from '../managers/metadataTemplates.generated.js'; import { serializeMetadataQueryIndices } from '../schemas.generated.js'; import { deserializeMetadataQueryIndices } from '../schemas.generated.js'; -import { serializeGetMetadataQueryIndicesQueryParamsArgScopeField } from '../managers/search.generated.js'; -import { deserializeGetMetadataQueryIndicesQueryParamsArgScopeField } from '../managers/search.generated.js'; +import { serializeGetMetadataQueryIndicesQueryParamsScopeField } from '../managers/search.generated.js'; +import { deserializeGetMetadataQueryIndicesQueryParamsScopeField } from '../managers/search.generated.js'; import { serializeSearchResultsOrSearchResultsWithSharedLinks } from '../schemas.generated.js'; import { deserializeSearchResultsOrSearchResultsWithSharedLinks } from '../schemas.generated.js'; -import { serializeGetSearchQueryParamsArgTrashContentField } from '../managers/search.generated.js'; -import { deserializeGetSearchQueryParamsArgTrashContentField } from '../managers/search.generated.js'; +import { serializeGetSearchQueryParamsTrashContentField } from '../managers/search.generated.js'; +import { deserializeGetSearchQueryParamsTrashContentField } from '../managers/search.generated.js'; import { BoxClient } from '../client.generated.js'; import { MetadataTemplate } from '../schemas.generated.js'; -import { CreateMetadataTemplateRequestBodyArg } from '../managers/metadataTemplates.generated.js'; -import { CreateMetadataTemplateRequestBodyArgFieldsField } from '../managers/metadataTemplates.generated.js'; -import { CreateMetadataTemplateRequestBodyArgFieldsFieldTypeField } from '../managers/metadataTemplates.generated.js'; +import { CreateMetadataTemplateRequestBody } from '../managers/metadataTemplates.generated.js'; +import { CreateMetadataTemplateRequestBodyFieldsField } from '../managers/metadataTemplates.generated.js'; +import { CreateMetadataTemplateRequestBodyFieldsTypeField } from '../managers/metadataTemplates.generated.js'; import { Files } from '../schemas.generated.js'; -import { UploadFileRequestBodyArg } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBody } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; import { FileFull } from '../schemas.generated.js'; import { MetadataFull } from '../schemas.generated.js'; -import { CreateFileMetadataByIdScopeArg } from '../managers/fileMetadata.generated.js'; +import { CreateFileMetadataByIdScope } from '../managers/fileMetadata.generated.js'; import { MetadataQueryResults } from '../schemas.generated.js'; import { MetadataQuery } from '../schemas.generated.js'; -import { DeleteMetadataTemplateScopeArg } from '../managers/metadataTemplates.generated.js'; +import { DeleteMetadataTemplateScope } from '../managers/metadataTemplates.generated.js'; import { MetadataQueryIndices } from '../schemas.generated.js'; -import { GetMetadataQueryIndicesQueryParamsArg } from '../managers/search.generated.js'; -import { GetMetadataQueryIndicesQueryParamsArgScopeField } from '../managers/search.generated.js'; +import { GetMetadataQueryIndicesQueryParams } from '../managers/search.generated.js'; +import { GetMetadataQueryIndicesQueryParamsScopeField } from '../managers/search.generated.js'; import { SearchResultsOrSearchResultsWithSharedLinks } from '../schemas.generated.js'; -import { GetSearchQueryParamsArg } from '../managers/search.generated.js'; -import { GetSearchQueryParamsArgTrashContentField } from '../managers/search.generated.js'; +import { GetSearchQueryParams } from '../managers/search.generated.js'; +import { GetSearchQueryParamsTrashContentField } from '../managers/search.generated.js'; import { getUuid } from '../utils.js'; import { generateByteStream } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; @@ -74,28 +74,26 @@ test('testCreateMetaDataQueryExecuteRead', async function testCreateMetaDataQuer templateKey: templateKey, fields: [ { - type: 'float' as CreateMetadataTemplateRequestBodyArgFieldsFieldTypeField, + type: 'float' as CreateMetadataTemplateRequestBodyFieldsTypeField, key: 'testName', displayName: 'testName', - } satisfies CreateMetadataTemplateRequestBodyArgFieldsField, + } satisfies CreateMetadataTemplateRequestBodyFieldsField, ], - } satisfies CreateMetadataTemplateRequestBodyArg); + } satisfies CreateMetadataTemplateRequestBody); if (!(template.templateKey == templateKey)) { throw 'Assertion failed'; } const files: any = await client.uploads.uploadFile({ attributes: { name: getUuid(), - parent: { - id: '0', - } satisfies UploadFileRequestBodyArgAttributesFieldParentField, - } satisfies UploadFileRequestBodyArgAttributesField, + parent: { id: '0' } satisfies UploadFileRequestBodyAttributesParentField, + } satisfies UploadFileRequestBodyAttributesField, file: generateByteStream(10), - } satisfies UploadFileRequestBodyArg); + } satisfies UploadFileRequestBody); const file: any = files.entries![0]; const metadata: any = await client.fileMetadata.createFileMetadataById( file.id, - 'enterprise' as CreateFileMetadataByIdScopeArg, + 'enterprise' as CreateFileMetadataByIdScope, templateKey, { ['testName']: 1 } ); @@ -120,7 +118,7 @@ test('testCreateMetaDataQueryExecuteRead', async function testCreateMetaDataQuer throw 'Assertion failed'; } await client.metadataTemplates.deleteMetadataTemplate( - 'enterprise' as DeleteMetadataTemplateScopeArg, + 'enterprise' as DeleteMetadataTemplateScope, template.templateKey ); await client.files.deleteFileById(file.id); @@ -133,24 +131,24 @@ test('testGetMetadataQueryIndices', async function testGetMetadataQueryIndices() templateKey: templateKey, fields: [ { - type: 'string' as CreateMetadataTemplateRequestBodyArgFieldsFieldTypeField, + type: 'string' as CreateMetadataTemplateRequestBodyFieldsTypeField, key: 'testName', displayName: 'testName', - } satisfies CreateMetadataTemplateRequestBodyArgFieldsField, + } satisfies CreateMetadataTemplateRequestBodyFieldsField, ], - } satisfies CreateMetadataTemplateRequestBodyArg); + } satisfies CreateMetadataTemplateRequestBody); if (!(template.templateKey == templateKey)) { throw 'Assertion failed'; } const indices: any = await client.search.getMetadataQueryIndices({ - scope: 'enterprise' as GetMetadataQueryIndicesQueryParamsArgScopeField, + scope: 'enterprise' as GetMetadataQueryIndicesQueryParamsScopeField, templateKey: templateKey, - } satisfies GetMetadataQueryIndicesQueryParamsArg); + } satisfies GetMetadataQueryIndicesQueryParams); if (!(indices.entries!.length >= 0)) { throw 'Assertion failed'; } await client.metadataTemplates.deleteMetadataTemplate( - 'enterprise' as DeleteMetadataTemplateScopeArg, + 'enterprise' as DeleteMetadataTemplateScope, template.templateKey ); }); @@ -159,9 +157,8 @@ test('testGetSearch', async function testGetSearch(): Promise { const search: any = await client.search.getSearch({ ancestorFolderIds: ['0' as ''], query: keyword, - trashContent: - 'non_trashed_only' as GetSearchQueryParamsArgTrashContentField, - } satisfies GetSearchQueryParamsArg); + trashContent: 'non_trashed_only' as GetSearchQueryParamsTrashContentField, + } satisfies GetSearchQueryParams); if (!(search.entries!.length >= 0)) { throw 'Assertion failed'; } @@ -171,10 +168,9 @@ test('testGetSearch', async function testGetSearch(): Promise { const searchWithSharedLink: any = await client.search.getSearch({ ancestorFolderIds: ['0' as ''], query: keyword, - trashContent: - 'non_trashed_only' as GetSearchQueryParamsArgTrashContentField, + trashContent: 'non_trashed_only' as GetSearchQueryParamsTrashContentField, includeRecentSharedLinks: true, - } satisfies GetSearchQueryParamsArg); + } satisfies GetSearchQueryParams); if (!(searchWithSharedLink.entries!.length >= 0)) { throw 'Assertion failed'; } diff --git a/src/test/sessionTermination.generated.test.ts b/src/test/sessionTermination.generated.test.ts index 46877d7d..3e4e4b21 100644 --- a/src/test/sessionTermination.generated.test.ts +++ b/src/test/sessionTermination.generated.test.ts @@ -2,21 +2,21 @@ import { serializeUserFull } from '../schemas.generated.js'; import { deserializeUserFull } from '../schemas.generated.js'; import { serializeSessionTerminationMessage } from '../schemas.generated.js'; import { deserializeSessionTerminationMessage } from '../schemas.generated.js'; -import { serializeCreateUserTerminateSessionRequestBodyArg } from '../managers/sessionTermination.generated.js'; -import { deserializeCreateUserTerminateSessionRequestBodyArg } from '../managers/sessionTermination.generated.js'; +import { serializeCreateUserTerminateSessionRequestBody } from '../managers/sessionTermination.generated.js'; +import { deserializeCreateUserTerminateSessionRequestBody } from '../managers/sessionTermination.generated.js'; import { serializeGroupFull } from '../schemas.generated.js'; import { deserializeGroupFull } from '../schemas.generated.js'; -import { serializeCreateGroupRequestBodyArg } from '../managers/groups.generated.js'; -import { deserializeCreateGroupRequestBodyArg } from '../managers/groups.generated.js'; -import { serializeCreateGroupTerminateSessionRequestBodyArg } from '../managers/sessionTermination.generated.js'; -import { deserializeCreateGroupTerminateSessionRequestBodyArg } from '../managers/sessionTermination.generated.js'; +import { serializeCreateGroupRequestBody } from '../managers/groups.generated.js'; +import { deserializeCreateGroupRequestBody } from '../managers/groups.generated.js'; +import { serializeCreateGroupTerminateSessionRequestBody } from '../managers/sessionTermination.generated.js'; +import { deserializeCreateGroupTerminateSessionRequestBody } from '../managers/sessionTermination.generated.js'; import { BoxClient } from '../client.generated.js'; import { UserFull } from '../schemas.generated.js'; import { SessionTerminationMessage } from '../schemas.generated.js'; -import { CreateUserTerminateSessionRequestBodyArg } from '../managers/sessionTermination.generated.js'; +import { CreateUserTerminateSessionRequestBody } from '../managers/sessionTermination.generated.js'; import { GroupFull } from '../schemas.generated.js'; -import { CreateGroupRequestBodyArg } from '../managers/groups.generated.js'; -import { CreateGroupTerminateSessionRequestBodyArg } from '../managers/sessionTermination.generated.js'; +import { CreateGroupRequestBody } from '../managers/groups.generated.js'; +import { CreateGroupTerminateSessionRequestBody } from '../managers/sessionTermination.generated.js'; import { getUuid } from '../utils.js'; import { getEnvVar } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; @@ -38,7 +38,7 @@ test('testSessionTerminationUser', async function testSessionTerminationUser(): await client.sessionTermination.createUserTerminateSession({ userIds: [getEnvVar('USER_ID')], userLogins: [user.login!], - } satisfies CreateUserTerminateSessionRequestBodyArg); + } satisfies CreateUserTerminateSessionRequestBody); if ( !( result.message == @@ -52,11 +52,11 @@ test('testSessionTerminationGroup', async function testSessionTerminationGroup() const groupName: string = getUuid(); const group: GroupFull = await client.groups.createGroup({ name: groupName, - } satisfies CreateGroupRequestBodyArg); + } satisfies CreateGroupRequestBody); const result: SessionTerminationMessage = await client.sessionTermination.createGroupTerminateSession({ groupIds: [group.id], - } satisfies CreateGroupTerminateSessionRequestBodyArg); + } satisfies CreateGroupTerminateSessionRequestBody); if ( !( result.message == diff --git a/src/test/sharedLinksFiles.generated.test.ts b/src/test/sharedLinksFiles.generated.test.ts index 6b591d69..6b86f7ee 100644 --- a/src/test/sharedLinksFiles.generated.test.ts +++ b/src/test/sharedLinksFiles.generated.test.ts @@ -1,40 +1,40 @@ import { serializeFiles } from '../schemas.generated.js'; import { deserializeFiles } from '../schemas.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; -import { serializeUpdateFileAddSharedLinkRequestBodyArg } from '../managers/sharedLinksFiles.generated.js'; -import { deserializeUpdateFileAddSharedLinkRequestBodyArg } from '../managers/sharedLinksFiles.generated.js'; -import { serializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkField } from '../managers/sharedLinksFiles.generated.js'; -import { deserializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkField } from '../managers/sharedLinksFiles.generated.js'; -import { serializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldAccessField } from '../managers/sharedLinksFiles.generated.js'; -import { deserializeUpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldAccessField } from '../managers/sharedLinksFiles.generated.js'; +import { serializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; +import { serializeUpdateFileAddSharedLinkRequestBody } from '../managers/sharedLinksFiles.generated.js'; +import { deserializeUpdateFileAddSharedLinkRequestBody } from '../managers/sharedLinksFiles.generated.js'; +import { serializeUpdateFileAddSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFiles.generated.js'; +import { deserializeUpdateFileAddSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFiles.generated.js'; +import { serializeUpdateFileAddSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFiles.generated.js'; +import { deserializeUpdateFileAddSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFiles.generated.js'; import { serializeFileFull } from '../schemas.generated.js'; import { deserializeFileFull } from '../schemas.generated.js'; -import { serializeUpdateFileUpdateSharedLinkRequestBodyArg } from '../managers/sharedLinksFiles.generated.js'; -import { deserializeUpdateFileUpdateSharedLinkRequestBodyArg } from '../managers/sharedLinksFiles.generated.js'; -import { serializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkField } from '../managers/sharedLinksFiles.generated.js'; -import { deserializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkField } from '../managers/sharedLinksFiles.generated.js'; -import { serializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField } from '../managers/sharedLinksFiles.generated.js'; -import { deserializeUpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField } from '../managers/sharedLinksFiles.generated.js'; +import { serializeUpdateFileUpdateSharedLinkRequestBody } from '../managers/sharedLinksFiles.generated.js'; +import { deserializeUpdateFileUpdateSharedLinkRequestBody } from '../managers/sharedLinksFiles.generated.js'; +import { serializeUpdateFileUpdateSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFiles.generated.js'; +import { deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFiles.generated.js'; +import { serializeUpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFiles.generated.js'; +import { deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFiles.generated.js'; import { BoxClient } from '../client.generated.js'; import { Files } from '../schemas.generated.js'; -import { UploadFileRequestBodyArg } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; -import { UpdateFileAddSharedLinkRequestBodyArg } from '../managers/sharedLinksFiles.generated.js'; -import { UpdateFileAddSharedLinkRequestBodyArgSharedLinkField } from '../managers/sharedLinksFiles.generated.js'; -import { UpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldAccessField } from '../managers/sharedLinksFiles.generated.js'; -import { UpdateFileAddSharedLinkQueryParamsArg } from '../managers/sharedLinksFiles.generated.js'; +import { UploadFileRequestBody } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; +import { UpdateFileAddSharedLinkRequestBody } from '../managers/sharedLinksFiles.generated.js'; +import { UpdateFileAddSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFiles.generated.js'; +import { UpdateFileAddSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFiles.generated.js'; +import { UpdateFileAddSharedLinkQueryParams } from '../managers/sharedLinksFiles.generated.js'; import { FileFull } from '../schemas.generated.js'; -import { GetFileGetSharedLinkQueryParamsArg } from '../managers/sharedLinksFiles.generated.js'; -import { GetSharedItemsQueryParamsArg } from '../managers/sharedLinksFiles.generated.js'; -import { GetSharedItemsHeadersArg } from '../managers/sharedLinksFiles.generated.js'; -import { UpdateFileUpdateSharedLinkRequestBodyArg } from '../managers/sharedLinksFiles.generated.js'; -import { UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkField } from '../managers/sharedLinksFiles.generated.js'; -import { UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField } from '../managers/sharedLinksFiles.generated.js'; -import { UpdateFileUpdateSharedLinkQueryParamsArg } from '../managers/sharedLinksFiles.generated.js'; +import { GetFileGetSharedLinkQueryParams } from '../managers/sharedLinksFiles.generated.js'; +import { GetSharedItemsQueryParams } from '../managers/sharedLinksFiles.generated.js'; +import { GetSharedItemsHeaders } from '../managers/sharedLinksFiles.generated.js'; +import { UpdateFileUpdateSharedLinkRequestBody } from '../managers/sharedLinksFiles.generated.js'; +import { UpdateFileUpdateSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFiles.generated.js'; +import { UpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFiles.generated.js'; +import { UpdateFileUpdateSharedLinkQueryParams } from '../managers/sharedLinksFiles.generated.js'; import { getUuid } from '../utils.js'; import { generateByteStream } from '../utils.js'; import { getEnvVar } from '../utils.js'; @@ -54,28 +54,26 @@ test('testSharedLinksFiles', async function testSharedLinksFiles(): Promise const uploadedFiles: Files = await client.uploads.uploadFile({ attributes: { name: getUuid(), - parent: { - id: '0', - } satisfies UploadFileRequestBodyArgAttributesFieldParentField, - } satisfies UploadFileRequestBodyArgAttributesField, + parent: { id: '0' } satisfies UploadFileRequestBodyAttributesParentField, + } satisfies UploadFileRequestBodyAttributesField, file: generateByteStream(10), - } satisfies UploadFileRequestBodyArg); + } satisfies UploadFileRequestBody); const fileId: string = uploadedFiles.entries![0].id; await client.sharedLinksFiles.updateFileAddSharedLink( fileId, { sharedLink: { access: - 'open' as UpdateFileAddSharedLinkRequestBodyArgSharedLinkFieldAccessField, + 'open' as UpdateFileAddSharedLinkRequestBodySharedLinkAccessField, password: 'Secret123@', - } satisfies UpdateFileAddSharedLinkRequestBodyArgSharedLinkField, - } satisfies UpdateFileAddSharedLinkRequestBodyArg, - { fields: 'shared_link' } satisfies UpdateFileAddSharedLinkQueryParamsArg + } satisfies UpdateFileAddSharedLinkRequestBodySharedLinkField, + } satisfies UpdateFileAddSharedLinkRequestBody, + { fields: 'shared_link' } satisfies UpdateFileAddSharedLinkQueryParams ); const fileFromApi: FileFull = await client.sharedLinksFiles.getFileGetSharedLink(fileId, { fields: 'shared_link', - } satisfies GetFileGetSharedLinkQueryParamsArg); + } satisfies GetFileGetSharedLinkQueryParams); if (!((toString(fileFromApi.sharedLink!.access) as string) == 'open')) { throw 'Assertion failed'; } @@ -83,8 +81,8 @@ test('testSharedLinksFiles', async function testSharedLinksFiles(): Promise const userClient: BoxClient = await getDefaultClientAsUser(userId); const fileFromSharedLinkPassword: FileFull = await userClient.sharedLinksFiles.getSharedItems( - {} satisfies GetSharedItemsQueryParamsArg, - new GetSharedItemsHeadersArg({ + {} satisfies GetSharedItemsQueryParams, + new GetSharedItemsHeaders({ boxapi: ''.concat( 'shared_link=', fileFromApi.sharedLink!.url, @@ -97,8 +95,8 @@ test('testSharedLinksFiles', async function testSharedLinksFiles(): Promise } await expect(async () => { await userClient.sharedLinksFiles.getSharedItems( - {} satisfies GetSharedItemsQueryParamsArg, - new GetSharedItemsHeadersArg({ + {} satisfies GetSharedItemsQueryParams, + new GetSharedItemsHeaders({ boxapi: ''.concat( 'shared_link=', fileFromApi.sharedLink!.url, @@ -113,12 +111,10 @@ test('testSharedLinksFiles', async function testSharedLinksFiles(): Promise { sharedLink: { access: - 'collaborators' as UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField, - } satisfies UpdateFileUpdateSharedLinkRequestBodyArgSharedLinkField, - } satisfies UpdateFileUpdateSharedLinkRequestBodyArg, - { - fields: 'shared_link', - } satisfies UpdateFileUpdateSharedLinkQueryParamsArg + 'collaborators' as UpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField, + } satisfies UpdateFileUpdateSharedLinkRequestBodySharedLinkField, + } satisfies UpdateFileUpdateSharedLinkRequestBody, + { fields: 'shared_link' } satisfies UpdateFileUpdateSharedLinkQueryParams ); if ( !((toString(updatedFile.sharedLink!.access) as string) == 'collaborators') diff --git a/src/test/sharedLinksFolders.generated.test.ts b/src/test/sharedLinksFolders.generated.test.ts index 3c07bf60..00abc20d 100644 --- a/src/test/sharedLinksFolders.generated.test.ts +++ b/src/test/sharedLinksFolders.generated.test.ts @@ -1,36 +1,36 @@ import { serializeFolderFull } from '../schemas.generated.js'; import { deserializeFolderFull } from '../schemas.generated.js'; -import { serializeCreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { deserializeCreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { serializeCreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; -import { deserializeCreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; -import { serializeUpdateFolderAddSharedLinkRequestBodyArg } from '../managers/sharedLinksFolders.generated.js'; -import { deserializeUpdateFolderAddSharedLinkRequestBodyArg } from '../managers/sharedLinksFolders.generated.js'; -import { serializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkField } from '../managers/sharedLinksFolders.generated.js'; -import { deserializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkField } from '../managers/sharedLinksFolders.generated.js'; -import { serializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldAccessField } from '../managers/sharedLinksFolders.generated.js'; -import { deserializeUpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldAccessField } from '../managers/sharedLinksFolders.generated.js'; -import { serializeUpdateFolderUpdateSharedLinkRequestBodyArg } from '../managers/sharedLinksFolders.generated.js'; -import { deserializeUpdateFolderUpdateSharedLinkRequestBodyArg } from '../managers/sharedLinksFolders.generated.js'; -import { serializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkField } from '../managers/sharedLinksFolders.generated.js'; -import { deserializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkField } from '../managers/sharedLinksFolders.generated.js'; -import { serializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField } from '../managers/sharedLinksFolders.generated.js'; -import { deserializeUpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField } from '../managers/sharedLinksFolders.generated.js'; +import { serializeCreateFolderRequestBody } from '../managers/folders.generated.js'; +import { deserializeCreateFolderRequestBody } from '../managers/folders.generated.js'; +import { serializeCreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; +import { deserializeCreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; +import { serializeUpdateFolderAddSharedLinkRequestBody } from '../managers/sharedLinksFolders.generated.js'; +import { deserializeUpdateFolderAddSharedLinkRequestBody } from '../managers/sharedLinksFolders.generated.js'; +import { serializeUpdateFolderAddSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFolders.generated.js'; +import { deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFolders.generated.js'; +import { serializeUpdateFolderAddSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFolders.generated.js'; +import { deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFolders.generated.js'; +import { serializeUpdateFolderUpdateSharedLinkRequestBody } from '../managers/sharedLinksFolders.generated.js'; +import { deserializeUpdateFolderUpdateSharedLinkRequestBody } from '../managers/sharedLinksFolders.generated.js'; +import { serializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFolders.generated.js'; +import { deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFolders.generated.js'; +import { serializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFolders.generated.js'; +import { deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFolders.generated.js'; import { BoxClient } from '../client.generated.js'; import { FolderFull } from '../schemas.generated.js'; -import { CreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { CreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; -import { UpdateFolderAddSharedLinkRequestBodyArg } from '../managers/sharedLinksFolders.generated.js'; -import { UpdateFolderAddSharedLinkRequestBodyArgSharedLinkField } from '../managers/sharedLinksFolders.generated.js'; -import { UpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldAccessField } from '../managers/sharedLinksFolders.generated.js'; -import { UpdateFolderAddSharedLinkQueryParamsArg } from '../managers/sharedLinksFolders.generated.js'; -import { GetFolderGetSharedLinkQueryParamsArg } from '../managers/sharedLinksFolders.generated.js'; -import { GetSharedItemFoldersQueryParamsArg } from '../managers/sharedLinksFolders.generated.js'; -import { GetSharedItemFoldersHeadersArg } from '../managers/sharedLinksFolders.generated.js'; -import { UpdateFolderUpdateSharedLinkRequestBodyArg } from '../managers/sharedLinksFolders.generated.js'; -import { UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkField } from '../managers/sharedLinksFolders.generated.js'; -import { UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField } from '../managers/sharedLinksFolders.generated.js'; -import { UpdateFolderUpdateSharedLinkQueryParamsArg } from '../managers/sharedLinksFolders.generated.js'; +import { CreateFolderRequestBody } from '../managers/folders.generated.js'; +import { CreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; +import { UpdateFolderAddSharedLinkRequestBody } from '../managers/sharedLinksFolders.generated.js'; +import { UpdateFolderAddSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFolders.generated.js'; +import { UpdateFolderAddSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFolders.generated.js'; +import { UpdateFolderAddSharedLinkQueryParams } from '../managers/sharedLinksFolders.generated.js'; +import { GetFolderGetSharedLinkQueryParams } from '../managers/sharedLinksFolders.generated.js'; +import { GetSharedItemFoldersQueryParams } from '../managers/sharedLinksFolders.generated.js'; +import { GetSharedItemFoldersHeaders } from '../managers/sharedLinksFolders.generated.js'; +import { UpdateFolderUpdateSharedLinkRequestBody } from '../managers/sharedLinksFolders.generated.js'; +import { UpdateFolderUpdateSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFolders.generated.js'; +import { UpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFolders.generated.js'; +import { UpdateFolderUpdateSharedLinkQueryParams } from '../managers/sharedLinksFolders.generated.js'; import { getUuid } from '../utils.js'; import { generateByteStream } from '../utils.js'; import { getEnvVar } from '../utils.js'; @@ -49,23 +49,23 @@ const client: BoxClient = getDefaultClient(); test('testSharedLinksFolders', async function testSharedLinksFolders(): Promise { const folder: FolderFull = await client.folders.createFolder({ name: getUuid(), - parent: { id: '0' } satisfies CreateFolderRequestBodyArgParentField, - } satisfies CreateFolderRequestBodyArg); + parent: { id: '0' } satisfies CreateFolderRequestBodyParentField, + } satisfies CreateFolderRequestBody); await client.sharedLinksFolders.updateFolderAddSharedLink( folder.id, { sharedLink: { access: - 'open' as UpdateFolderAddSharedLinkRequestBodyArgSharedLinkFieldAccessField, + 'open' as UpdateFolderAddSharedLinkRequestBodySharedLinkAccessField, password: 'Secret123@', - } satisfies UpdateFolderAddSharedLinkRequestBodyArgSharedLinkField, - } satisfies UpdateFolderAddSharedLinkRequestBodyArg, - { fields: 'shared_link' } satisfies UpdateFolderAddSharedLinkQueryParamsArg + } satisfies UpdateFolderAddSharedLinkRequestBodySharedLinkField, + } satisfies UpdateFolderAddSharedLinkRequestBody, + { fields: 'shared_link' } satisfies UpdateFolderAddSharedLinkQueryParams ); const folderFromApi: FolderFull = await client.sharedLinksFolders.getFolderGetSharedLink(folder.id, { fields: 'shared_link', - } satisfies GetFolderGetSharedLinkQueryParamsArg); + } satisfies GetFolderGetSharedLinkQueryParams); if (!((toString(folderFromApi.sharedLink!.access) as string) == 'open')) { throw 'Assertion failed'; } @@ -73,8 +73,8 @@ test('testSharedLinksFolders', async function testSharedLinksFolders(): Promise< const userClient: BoxClient = await getDefaultClientAsUser(userId); const folderFromSharedLinkPassword: FolderFull = await userClient.sharedLinksFolders.getSharedItemFolders( - {} satisfies GetSharedItemFoldersQueryParamsArg, - new GetSharedItemFoldersHeadersArg({ + {} satisfies GetSharedItemFoldersQueryParams, + new GetSharedItemFoldersHeaders({ boxapi: ''.concat( 'shared_link=', folderFromApi.sharedLink!.url, @@ -87,8 +87,8 @@ test('testSharedLinksFolders', async function testSharedLinksFolders(): Promise< } await expect(async () => { await userClient.sharedLinksFolders.getSharedItemFolders( - {} satisfies GetSharedItemFoldersQueryParamsArg, - new GetSharedItemFoldersHeadersArg({ + {} satisfies GetSharedItemFoldersQueryParams, + new GetSharedItemFoldersHeaders({ boxapi: ''.concat( 'shared_link=', folderFromApi.sharedLink!.url, @@ -103,12 +103,12 @@ test('testSharedLinksFolders', async function testSharedLinksFolders(): Promise< { sharedLink: { access: - 'collaborators' as UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField, - } satisfies UpdateFolderUpdateSharedLinkRequestBodyArgSharedLinkField, - } satisfies UpdateFolderUpdateSharedLinkRequestBodyArg, + 'collaborators' as UpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField, + } satisfies UpdateFolderUpdateSharedLinkRequestBodySharedLinkField, + } satisfies UpdateFolderUpdateSharedLinkRequestBody, { fields: 'shared_link', - } satisfies UpdateFolderUpdateSharedLinkQueryParamsArg + } satisfies UpdateFolderUpdateSharedLinkQueryParams ); if ( !((toString(updatedFolder.sharedLink!.access) as string) == 'collaborators') diff --git a/src/test/sharedLinksWebLinks.generated.test.ts b/src/test/sharedLinksWebLinks.generated.test.ts index a9927c36..8e5472f2 100644 --- a/src/test/sharedLinksWebLinks.generated.test.ts +++ b/src/test/sharedLinksWebLinks.generated.test.ts @@ -2,38 +2,38 @@ import { serializeFolderFull } from '../schemas.generated.js'; import { deserializeFolderFull } from '../schemas.generated.js'; import { serializeWebLink } from '../schemas.generated.js'; import { deserializeWebLink } from '../schemas.generated.js'; -import { serializeCreateWebLinkRequestBodyArg } from '../managers/webLinks.generated.js'; -import { deserializeCreateWebLinkRequestBodyArg } from '../managers/webLinks.generated.js'; -import { serializeCreateWebLinkRequestBodyArgParentField } from '../managers/webLinks.generated.js'; -import { deserializeCreateWebLinkRequestBodyArgParentField } from '../managers/webLinks.generated.js'; -import { serializeUpdateWebLinkAddSharedLinkRequestBodyArg } from '../managers/sharedLinksWebLinks.generated.js'; -import { deserializeUpdateWebLinkAddSharedLinkRequestBodyArg } from '../managers/sharedLinksWebLinks.generated.js'; -import { serializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; -import { deserializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; -import { serializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldAccessField } from '../managers/sharedLinksWebLinks.generated.js'; -import { deserializeUpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldAccessField } from '../managers/sharedLinksWebLinks.generated.js'; -import { serializeUpdateWebLinkUpdateSharedLinkRequestBodyArg } from '../managers/sharedLinksWebLinks.generated.js'; -import { deserializeUpdateWebLinkUpdateSharedLinkRequestBodyArg } from '../managers/sharedLinksWebLinks.generated.js'; -import { serializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; -import { deserializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; -import { serializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField } from '../managers/sharedLinksWebLinks.generated.js'; -import { deserializeUpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField } from '../managers/sharedLinksWebLinks.generated.js'; +import { serializeCreateWebLinkRequestBody } from '../managers/webLinks.generated.js'; +import { deserializeCreateWebLinkRequestBody } from '../managers/webLinks.generated.js'; +import { serializeCreateWebLinkRequestBodyParentField } from '../managers/webLinks.generated.js'; +import { deserializeCreateWebLinkRequestBodyParentField } from '../managers/webLinks.generated.js'; +import { serializeUpdateWebLinkAddSharedLinkRequestBody } from '../managers/sharedLinksWebLinks.generated.js'; +import { deserializeUpdateWebLinkAddSharedLinkRequestBody } from '../managers/sharedLinksWebLinks.generated.js'; +import { serializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; +import { deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; +import { serializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksWebLinks.generated.js'; +import { deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksWebLinks.generated.js'; +import { serializeUpdateWebLinkUpdateSharedLinkRequestBody } from '../managers/sharedLinksWebLinks.generated.js'; +import { deserializeUpdateWebLinkUpdateSharedLinkRequestBody } from '../managers/sharedLinksWebLinks.generated.js'; +import { serializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; +import { deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; +import { serializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksWebLinks.generated.js'; +import { deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksWebLinks.generated.js'; import { BoxClient } from '../client.generated.js'; import { FolderFull } from '../schemas.generated.js'; import { WebLink } from '../schemas.generated.js'; -import { CreateWebLinkRequestBodyArg } from '../managers/webLinks.generated.js'; -import { CreateWebLinkRequestBodyArgParentField } from '../managers/webLinks.generated.js'; -import { UpdateWebLinkAddSharedLinkRequestBodyArg } from '../managers/sharedLinksWebLinks.generated.js'; -import { UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; -import { UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldAccessField } from '../managers/sharedLinksWebLinks.generated.js'; -import { UpdateWebLinkAddSharedLinkQueryParamsArg } from '../managers/sharedLinksWebLinks.generated.js'; -import { GetWebLinkGetSharedLinkQueryParamsArg } from '../managers/sharedLinksWebLinks.generated.js'; -import { GetSharedItemWebLinksQueryParamsArg } from '../managers/sharedLinksWebLinks.generated.js'; -import { GetSharedItemWebLinksHeadersArg } from '../managers/sharedLinksWebLinks.generated.js'; -import { UpdateWebLinkUpdateSharedLinkRequestBodyArg } from '../managers/sharedLinksWebLinks.generated.js'; -import { UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; -import { UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField } from '../managers/sharedLinksWebLinks.generated.js'; -import { UpdateWebLinkUpdateSharedLinkQueryParamsArg } from '../managers/sharedLinksWebLinks.generated.js'; +import { CreateWebLinkRequestBody } from '../managers/webLinks.generated.js'; +import { CreateWebLinkRequestBodyParentField } from '../managers/webLinks.generated.js'; +import { UpdateWebLinkAddSharedLinkRequestBody } from '../managers/sharedLinksWebLinks.generated.js'; +import { UpdateWebLinkAddSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; +import { UpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksWebLinks.generated.js'; +import { UpdateWebLinkAddSharedLinkQueryParams } from '../managers/sharedLinksWebLinks.generated.js'; +import { GetWebLinkGetSharedLinkQueryParams } from '../managers/sharedLinksWebLinks.generated.js'; +import { GetSharedItemWebLinksQueryParams } from '../managers/sharedLinksWebLinks.generated.js'; +import { GetSharedItemWebLinksHeaders } from '../managers/sharedLinksWebLinks.generated.js'; +import { UpdateWebLinkUpdateSharedLinkRequestBody } from '../managers/sharedLinksWebLinks.generated.js'; +import { UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; +import { UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksWebLinks.generated.js'; +import { UpdateWebLinkUpdateSharedLinkQueryParams } from '../managers/sharedLinksWebLinks.generated.js'; import { getUuid } from '../utils.js'; import { generateByteStream } from '../utils.js'; import { getEnvVar } from '../utils.js'; @@ -53,26 +53,26 @@ test('testSharedLinksWebLinks', async function testSharedLinksWebLinks(): Promis const parent: FolderFull = await client.folders.getFolderById('0'); const webLink: WebLink = await client.webLinks.createWebLink({ url: 'https://www.box.com', - parent: { id: parent.id } satisfies CreateWebLinkRequestBodyArgParentField, + parent: { id: parent.id } satisfies CreateWebLinkRequestBodyParentField, name: getUuid(), description: 'Weblink description', - } satisfies CreateWebLinkRequestBodyArg); + } satisfies CreateWebLinkRequestBody); const webLinkId: string = webLink.id; await client.sharedLinksWebLinks.updateWebLinkAddSharedLink( webLinkId, { sharedLink: { access: - 'open' as UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkFieldAccessField, + 'open' as UpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField, password: 'Secret123@', - } satisfies UpdateWebLinkAddSharedLinkRequestBodyArgSharedLinkField, - } satisfies UpdateWebLinkAddSharedLinkRequestBodyArg, - { fields: 'shared_link' } satisfies UpdateWebLinkAddSharedLinkQueryParamsArg + } satisfies UpdateWebLinkAddSharedLinkRequestBodySharedLinkField, + } satisfies UpdateWebLinkAddSharedLinkRequestBody, + { fields: 'shared_link' } satisfies UpdateWebLinkAddSharedLinkQueryParams ); const webLinkFromApi: WebLink = await client.sharedLinksWebLinks.getWebLinkGetSharedLink(webLinkId, { fields: 'shared_link', - } satisfies GetWebLinkGetSharedLinkQueryParamsArg); + } satisfies GetWebLinkGetSharedLinkQueryParams); if (!((toString(webLinkFromApi.sharedLink!.access) as string) == 'open')) { throw 'Assertion failed'; } @@ -80,8 +80,8 @@ test('testSharedLinksWebLinks', async function testSharedLinksWebLinks(): Promis const userClient: BoxClient = await getDefaultClientAsUser(userId); const webLinkFromSharedLinkPassword: WebLink = await userClient.sharedLinksWebLinks.getSharedItemWebLinks( - {} satisfies GetSharedItemWebLinksQueryParamsArg, - new GetSharedItemWebLinksHeadersArg({ + {} satisfies GetSharedItemWebLinksQueryParams, + new GetSharedItemWebLinksHeaders({ boxapi: ''.concat( 'shared_link=', webLinkFromApi.sharedLink!.url, @@ -94,8 +94,8 @@ test('testSharedLinksWebLinks', async function testSharedLinksWebLinks(): Promis } await expect(async () => { await userClient.sharedLinksWebLinks.getSharedItemWebLinks( - {} satisfies GetSharedItemWebLinksQueryParamsArg, - new GetSharedItemWebLinksHeadersArg({ + {} satisfies GetSharedItemWebLinksQueryParams, + new GetSharedItemWebLinksHeaders({ boxapi: ''.concat( 'shared_link=', webLinkFromApi.sharedLink!.url, @@ -110,12 +110,12 @@ test('testSharedLinksWebLinks', async function testSharedLinksWebLinks(): Promis { sharedLink: { access: - 'collaborators' as UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkFieldAccessField, - } satisfies UpdateWebLinkUpdateSharedLinkRequestBodyArgSharedLinkField, - } satisfies UpdateWebLinkUpdateSharedLinkRequestBodyArg, + 'collaborators' as UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField, + } satisfies UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField, + } satisfies UpdateWebLinkUpdateSharedLinkRequestBody, { fields: 'shared_link', - } satisfies UpdateWebLinkUpdateSharedLinkQueryParamsArg + } satisfies UpdateWebLinkUpdateSharedLinkQueryParams ); if ( !( diff --git a/src/test/shieldInformationBarrierReports.generated.test.ts b/src/test/shieldInformationBarrierReports.generated.test.ts index 38465600..3080ac33 100644 --- a/src/test/shieldInformationBarrierReports.generated.test.ts +++ b/src/test/shieldInformationBarrierReports.generated.test.ts @@ -11,7 +11,7 @@ import { deserializeShieldInformationBarrierBaseTypeField } from '../schemas.gen import { serializeShieldInformationBarrier } from '../schemas.generated.js'; import { deserializeShieldInformationBarrier } from '../schemas.generated.js'; import { ShieldInformationBarrierReports } from '../schemas.generated.js'; -import { GetShieldInformationBarrierReportsQueryParamsArg } from '../managers/shieldInformationBarrierReports.generated.js'; +import { GetShieldInformationBarrierReportsQueryParams } from '../managers/shieldInformationBarrierReports.generated.js'; import { ShieldInformationBarrierReport } from '../schemas.generated.js'; import { ShieldInformationBarrierReference } from '../schemas.generated.js'; import { ShieldInformationBarrierBase } from '../schemas.generated.js'; @@ -52,7 +52,7 @@ test('shieldInformationBarrierReports', async function shieldInformationBarrierR await client.shieldInformationBarrierReports.getShieldInformationBarrierReports( { shieldInformationBarrierId: barrierId, - } satisfies GetShieldInformationBarrierReportsQueryParamsArg + } satisfies GetShieldInformationBarrierReportsQueryParams ); if (existingReports.entries!.length > 0) { return void 0; @@ -85,7 +85,7 @@ test('shieldInformationBarrierReports', async function shieldInformationBarrierR await client.shieldInformationBarrierReports.getShieldInformationBarrierReports( { shieldInformationBarrierId: barrierId, - } satisfies GetShieldInformationBarrierReportsQueryParamsArg + } satisfies GetShieldInformationBarrierReportsQueryParams ); if (!(retrievedReports.entries!.length > 0)) { throw 'Assertion failed'; diff --git a/src/test/shieldInformationBarrierSegmentMembers.generated.test.ts b/src/test/shieldInformationBarrierSegmentMembers.generated.test.ts index 42e187ef..fbfeeea3 100644 --- a/src/test/shieldInformationBarrierSegmentMembers.generated.test.ts +++ b/src/test/shieldInformationBarrierSegmentMembers.generated.test.ts @@ -2,20 +2,20 @@ import { serializeShieldInformationBarrier } from '../schemas.generated.js'; import { deserializeShieldInformationBarrier } from '../schemas.generated.js'; import { serializeShieldInformationBarrierSegment } from '../schemas.generated.js'; import { deserializeShieldInformationBarrierSegment } from '../schemas.generated.js'; -import { serializeCreateShieldInformationBarrierSegmentRequestBodyArg } from '../managers/shieldInformationBarrierSegments.generated.js'; -import { deserializeCreateShieldInformationBarrierSegmentRequestBodyArg } from '../managers/shieldInformationBarrierSegments.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentRequestBody } from '../managers/shieldInformationBarrierSegments.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentRequestBody } from '../managers/shieldInformationBarrierSegments.generated.js'; import { serializeShieldInformationBarrierBase } from '../schemas.generated.js'; import { deserializeShieldInformationBarrierBase } from '../schemas.generated.js'; import { serializeShieldInformationBarrierBaseTypeField } from '../schemas.generated.js'; import { deserializeShieldInformationBarrierBaseTypeField } from '../schemas.generated.js'; import { serializeShieldInformationBarrierSegmentMember } from '../schemas.generated.js'; import { deserializeShieldInformationBarrierSegmentMember } from '../schemas.generated.js'; -import { serializeCreateShieldInformationBarrierSegmentMemberRequestBodyArg } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; -import { deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyArg } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; -import { serializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; -import { deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; -import { serializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; -import { deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentMemberRequestBody } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentMemberRequestBody } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; import { serializeUserBase } from '../schemas.generated.js'; import { deserializeUserBase } from '../schemas.generated.js'; import { serializeUserBaseTypeField } from '../schemas.generated.js'; @@ -25,17 +25,17 @@ import { deserializeShieldInformationBarrierSegmentMembers } from '../schemas.ge import { BoxClient } from '../client.generated.js'; import { ShieldInformationBarrier } from '../schemas.generated.js'; import { ShieldInformationBarrierSegment } from '../schemas.generated.js'; -import { CreateShieldInformationBarrierSegmentRequestBodyArg } from '../managers/shieldInformationBarrierSegments.generated.js'; +import { CreateShieldInformationBarrierSegmentRequestBody } from '../managers/shieldInformationBarrierSegments.generated.js'; import { ShieldInformationBarrierBase } from '../schemas.generated.js'; import { ShieldInformationBarrierBaseTypeField } from '../schemas.generated.js'; import { ShieldInformationBarrierSegmentMember } from '../schemas.generated.js'; -import { CreateShieldInformationBarrierSegmentMemberRequestBodyArg } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; -import { CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; -import { CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { CreateShieldInformationBarrierSegmentMemberRequestBody } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; import { UserBase } from '../schemas.generated.js'; import { UserBaseTypeField } from '../schemas.generated.js'; import { ShieldInformationBarrierSegmentMembers } from '../schemas.generated.js'; -import { GetShieldInformationBarrierSegmentMembersQueryParamsArg } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; +import { GetShieldInformationBarrierSegmentMembersQueryParams } from '../managers/shieldInformationBarrierSegmentMembers.generated.js'; import { getEnvVar } from '../utils.js'; import { getUuid } from '../utils.js'; import { getDefaultClientAsUser } from './commons.generated.js'; @@ -62,7 +62,7 @@ test('testShieldInformationBarrierSegmentMembers', async function testShieldInfo type: 'shield_information_barrier' as ShieldInformationBarrierBaseTypeField, } satisfies ShieldInformationBarrierBase, name: segmentName, - } satisfies CreateShieldInformationBarrierSegmentRequestBodyArg + } satisfies CreateShieldInformationBarrierSegmentRequestBody ); if (!(segment.name! == segmentName)) { throw 'Assertion failed'; @@ -72,13 +72,13 @@ test('testShieldInformationBarrierSegmentMembers', async function testShieldInfo { shieldInformationBarrierSegment: { id: segment.id!, - type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentFieldTypeField, - } satisfies CreateShieldInformationBarrierSegmentMemberRequestBodyArgShieldInformationBarrierSegmentField, + type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField, + } satisfies CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField, user: { id: getEnvVar('USER_ID'), type: 'user' as UserBaseTypeField, } satisfies UserBase, - } satisfies CreateShieldInformationBarrierSegmentMemberRequestBodyArg + } satisfies CreateShieldInformationBarrierSegmentMemberRequestBody ); if (!(segmentMember.user!.id == getEnvVar('USER_ID'))) { throw 'Assertion failed'; @@ -90,7 +90,7 @@ test('testShieldInformationBarrierSegmentMembers', async function testShieldInfo await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMembers( { shieldInformationBarrierSegmentId: segment.id!, - } satisfies GetShieldInformationBarrierSegmentMembersQueryParamsArg + } satisfies GetShieldInformationBarrierSegmentMembersQueryParams ); if (!(segmentMembers.entries!.length > 0)) { throw 'Assertion failed'; diff --git a/src/test/shieldInformationBarrierSegmentRestrictions.generated.test.ts b/src/test/shieldInformationBarrierSegmentRestrictions.generated.test.ts index 2f4d0505..1d4852b5 100644 --- a/src/test/shieldInformationBarrierSegmentRestrictions.generated.test.ts +++ b/src/test/shieldInformationBarrierSegmentRestrictions.generated.test.ts @@ -2,43 +2,43 @@ import { serializeShieldInformationBarrier } from '../schemas.generated.js'; import { deserializeShieldInformationBarrier } from '../schemas.generated.js'; import { serializeShieldInformationBarrierSegment } from '../schemas.generated.js'; import { deserializeShieldInformationBarrierSegment } from '../schemas.generated.js'; -import { serializeCreateShieldInformationBarrierSegmentRequestBodyArg } from '../managers/shieldInformationBarrierSegments.generated.js'; -import { deserializeCreateShieldInformationBarrierSegmentRequestBodyArg } from '../managers/shieldInformationBarrierSegments.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentRequestBody } from '../managers/shieldInformationBarrierSegments.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentRequestBody } from '../managers/shieldInformationBarrierSegments.generated.js'; import { serializeShieldInformationBarrierBase } from '../schemas.generated.js'; import { deserializeShieldInformationBarrierBase } from '../schemas.generated.js'; import { serializeShieldInformationBarrierBaseTypeField } from '../schemas.generated.js'; import { deserializeShieldInformationBarrierBaseTypeField } from '../schemas.generated.js'; import { serializeShieldInformationBarrierSegmentRestriction } from '../schemas.generated.js'; import { deserializeShieldInformationBarrierSegmentRestriction } from '../schemas.generated.js'; -import { serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArg } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; -import { deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArg } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; -import { serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; -import { deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; -import { serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; -import { deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; -import { serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; -import { deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; -import { serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; -import { deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; -import { serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; -import { deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentRestrictionRequestBody } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBody } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; import { serializeShieldInformationBarrierSegmentRestrictions } from '../schemas.generated.js'; import { deserializeShieldInformationBarrierSegmentRestrictions } from '../schemas.generated.js'; import { BoxClient } from '../client.generated.js'; import { ShieldInformationBarrier } from '../schemas.generated.js'; import { ShieldInformationBarrierSegment } from '../schemas.generated.js'; -import { CreateShieldInformationBarrierSegmentRequestBodyArg } from '../managers/shieldInformationBarrierSegments.generated.js'; +import { CreateShieldInformationBarrierSegmentRequestBody } from '../managers/shieldInformationBarrierSegments.generated.js'; import { ShieldInformationBarrierBase } from '../schemas.generated.js'; import { ShieldInformationBarrierBaseTypeField } from '../schemas.generated.js'; import { ShieldInformationBarrierSegmentRestriction } from '../schemas.generated.js'; -import { CreateShieldInformationBarrierSegmentRestrictionRequestBodyArg } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; -import { CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; -import { CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; -import { CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; -import { CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; -import { CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { CreateShieldInformationBarrierSegmentRestrictionRequestBody } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { CreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; import { ShieldInformationBarrierSegmentRestrictions } from '../schemas.generated.js'; -import { GetShieldInformationBarrierSegmentRestrictionsQueryParamsArg } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; +import { GetShieldInformationBarrierSegmentRestrictionsQueryParams } from '../managers/shieldInformationBarrierSegmentRestrictions.generated.js'; import { getEnvVar } from '../utils.js'; import { getUuid } from '../utils.js'; import { getDefaultClientAsUser } from './commons.generated.js'; @@ -65,7 +65,7 @@ test('testShieldInformationBarrierSegmentRestrictions', async function testShiel } satisfies ShieldInformationBarrierBase, name: getUuid(), description: 'barrier segment description', - } satisfies CreateShieldInformationBarrierSegmentRequestBodyArg + } satisfies CreateShieldInformationBarrierSegmentRequestBody ); const segmentId: string = segment.id!; const segmentToRestrict: ShieldInformationBarrierSegment = @@ -77,7 +77,7 @@ test('testShieldInformationBarrierSegmentRestrictions', async function testShiel } satisfies ShieldInformationBarrierBase, name: getUuid(), description: 'barrier segment description', - } satisfies CreateShieldInformationBarrierSegmentRequestBodyArg + } satisfies CreateShieldInformationBarrierSegmentRequestBody ); const segmentToRestrictId: string = segmentToRestrict.id!; const segmentRestriction: ShieldInformationBarrierSegmentRestriction = @@ -85,14 +85,14 @@ test('testShieldInformationBarrierSegmentRestrictions', async function testShiel { restrictedSegment: { id: segmentToRestrictId, - type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentFieldTypeField, - } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgRestrictedSegmentField, + type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField, + } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField, shieldInformationBarrierSegment: { id: segmentId, - type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentFieldTypeField, - } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgShieldInformationBarrierSegmentField, - type: 'shield_information_barrier_segment_restriction' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyArgTypeField, - } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyArg + type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField, + } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField, + type: 'shield_information_barrier_segment_restriction' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField, + } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBody ); const segmentRestrictionId: string = segmentRestriction.id!; if (!(segmentRestriction.shieldInformationBarrierSegment.id == segmentId)) { @@ -102,7 +102,7 @@ test('testShieldInformationBarrierSegmentRestrictions', async function testShiel await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictions( { shieldInformationBarrierSegmentId: segmentId, - } satisfies GetShieldInformationBarrierSegmentRestrictionsQueryParamsArg + } satisfies GetShieldInformationBarrierSegmentRestrictionsQueryParams ); if (!(segmentRestrictions.entries!.length > 0)) { throw 'Assertion failed'; diff --git a/src/test/shieldInformationBarrierSegments.generated.test.ts b/src/test/shieldInformationBarrierSegments.generated.test.ts index 169619dc..c9e1b5cf 100644 --- a/src/test/shieldInformationBarrierSegments.generated.test.ts +++ b/src/test/shieldInformationBarrierSegments.generated.test.ts @@ -2,25 +2,25 @@ import { serializeShieldInformationBarrier } from '../schemas.generated.js'; import { deserializeShieldInformationBarrier } from '../schemas.generated.js'; import { serializeShieldInformationBarrierSegment } from '../schemas.generated.js'; import { deserializeShieldInformationBarrierSegment } from '../schemas.generated.js'; -import { serializeCreateShieldInformationBarrierSegmentRequestBodyArg } from '../managers/shieldInformationBarrierSegments.generated.js'; -import { deserializeCreateShieldInformationBarrierSegmentRequestBodyArg } from '../managers/shieldInformationBarrierSegments.generated.js'; +import { serializeCreateShieldInformationBarrierSegmentRequestBody } from '../managers/shieldInformationBarrierSegments.generated.js'; +import { deserializeCreateShieldInformationBarrierSegmentRequestBody } from '../managers/shieldInformationBarrierSegments.generated.js'; import { serializeShieldInformationBarrierBase } from '../schemas.generated.js'; import { deserializeShieldInformationBarrierBase } from '../schemas.generated.js'; import { serializeShieldInformationBarrierBaseTypeField } from '../schemas.generated.js'; import { deserializeShieldInformationBarrierBaseTypeField } from '../schemas.generated.js'; import { serializeShieldInformationBarrierSegments } from '../schemas.generated.js'; import { deserializeShieldInformationBarrierSegments } from '../schemas.generated.js'; -import { serializeUpdateShieldInformationBarrierSegmentByIdRequestBodyArg } from '../managers/shieldInformationBarrierSegments.generated.js'; -import { deserializeUpdateShieldInformationBarrierSegmentByIdRequestBodyArg } from '../managers/shieldInformationBarrierSegments.generated.js'; +import { serializeUpdateShieldInformationBarrierSegmentByIdRequestBody } from '../managers/shieldInformationBarrierSegments.generated.js'; +import { deserializeUpdateShieldInformationBarrierSegmentByIdRequestBody } from '../managers/shieldInformationBarrierSegments.generated.js'; import { BoxClient } from '../client.generated.js'; import { ShieldInformationBarrier } from '../schemas.generated.js'; import { ShieldInformationBarrierSegment } from '../schemas.generated.js'; -import { CreateShieldInformationBarrierSegmentRequestBodyArg } from '../managers/shieldInformationBarrierSegments.generated.js'; +import { CreateShieldInformationBarrierSegmentRequestBody } from '../managers/shieldInformationBarrierSegments.generated.js'; import { ShieldInformationBarrierBase } from '../schemas.generated.js'; import { ShieldInformationBarrierBaseTypeField } from '../schemas.generated.js'; import { ShieldInformationBarrierSegments } from '../schemas.generated.js'; -import { GetShieldInformationBarrierSegmentsQueryParamsArg } from '../managers/shieldInformationBarrierSegments.generated.js'; -import { UpdateShieldInformationBarrierSegmentByIdRequestBodyArg } from '../managers/shieldInformationBarrierSegments.generated.js'; +import { GetShieldInformationBarrierSegmentsQueryParams } from '../managers/shieldInformationBarrierSegments.generated.js'; +import { UpdateShieldInformationBarrierSegmentByIdRequestBody } from '../managers/shieldInformationBarrierSegments.generated.js'; import { getEnvVar } from '../utils.js'; import { getUuid } from '../utils.js'; import { getDefaultClientAsUser } from './commons.generated.js'; @@ -51,7 +51,7 @@ test('testShieldInformationBarrierSegments', async function testShieldInformatio } satisfies ShieldInformationBarrierBase, name: segmentName, description: segmentDescription, - } satisfies CreateShieldInformationBarrierSegmentRequestBodyArg + } satisfies CreateShieldInformationBarrierSegmentRequestBody ); if (!(segment.name! == segmentName)) { throw 'Assertion failed'; @@ -60,7 +60,7 @@ test('testShieldInformationBarrierSegments', async function testShieldInformatio await client.shieldInformationBarrierSegments.getShieldInformationBarrierSegments( { shieldInformationBarrierId: barrierId, - } satisfies GetShieldInformationBarrierSegmentsQueryParamsArg + } satisfies GetShieldInformationBarrierSegmentsQueryParams ); if (!(segments.entries!.length > 0)) { throw 'Assertion failed'; @@ -97,7 +97,7 @@ test('testShieldInformationBarrierSegments', async function testShieldInformatio segmentId, { description: updatedSegmentDescription, - } satisfies UpdateShieldInformationBarrierSegmentByIdRequestBodyArg + } satisfies UpdateShieldInformationBarrierSegmentByIdRequestBody ); if (!(updatedSegment.description! == updatedSegmentDescription)) { throw 'Assertion failed'; diff --git a/src/test/shieldInformationBarriers.generated.test.ts b/src/test/shieldInformationBarriers.generated.test.ts index d4af87cb..20fa42c2 100644 --- a/src/test/shieldInformationBarriers.generated.test.ts +++ b/src/test/shieldInformationBarriers.generated.test.ts @@ -2,15 +2,15 @@ import { serializeShieldInformationBarrier } from '../schemas.generated.js'; import { deserializeShieldInformationBarrier } from '../schemas.generated.js'; import { serializeShieldInformationBarriers } from '../schemas.generated.js'; import { deserializeShieldInformationBarriers } from '../schemas.generated.js'; -import { serializeCreateShieldInformationBarrierChangeStatusRequestBodyArg } from '../managers/shieldInformationBarriers.generated.js'; -import { deserializeCreateShieldInformationBarrierChangeStatusRequestBodyArg } from '../managers/shieldInformationBarriers.generated.js'; -import { serializeCreateShieldInformationBarrierChangeStatusRequestBodyArgStatusField } from '../managers/shieldInformationBarriers.generated.js'; -import { deserializeCreateShieldInformationBarrierChangeStatusRequestBodyArgStatusField } from '../managers/shieldInformationBarriers.generated.js'; +import { serializeCreateShieldInformationBarrierChangeStatusRequestBody } from '../managers/shieldInformationBarriers.generated.js'; +import { deserializeCreateShieldInformationBarrierChangeStatusRequestBody } from '../managers/shieldInformationBarriers.generated.js'; +import { serializeCreateShieldInformationBarrierChangeStatusRequestBodyStatusField } from '../managers/shieldInformationBarriers.generated.js'; +import { deserializeCreateShieldInformationBarrierChangeStatusRequestBodyStatusField } from '../managers/shieldInformationBarriers.generated.js'; import { BoxClient } from '../client.generated.js'; import { ShieldInformationBarrier } from '../schemas.generated.js'; import { ShieldInformationBarriers } from '../schemas.generated.js'; -import { CreateShieldInformationBarrierChangeStatusRequestBodyArg } from '../managers/shieldInformationBarriers.generated.js'; -import { CreateShieldInformationBarrierChangeStatusRequestBodyArgStatusField } from '../managers/shieldInformationBarriers.generated.js'; +import { CreateShieldInformationBarrierChangeStatusRequestBody } from '../managers/shieldInformationBarriers.generated.js'; +import { CreateShieldInformationBarrierChangeStatusRequestBodyStatusField } from '../managers/shieldInformationBarriers.generated.js'; import { getEnvVar } from '../utils.js'; import { getDefaultClientAsUser } from './commons.generated.js'; import { getOrCreateShieldInformationBarrier } from './commons.generated.js'; @@ -58,8 +58,8 @@ test('testShieldInformationBarriers', async function testShieldInformationBarrie { id: barrierId, status: - 'disabled' as CreateShieldInformationBarrierChangeStatusRequestBodyArgStatusField, - } satisfies CreateShieldInformationBarrierChangeStatusRequestBodyArg + 'disabled' as CreateShieldInformationBarrierChangeStatusRequestBodyStatusField, + } satisfies CreateShieldInformationBarrierChangeStatusRequestBody ); }).rejects.toThrow(); }); diff --git a/src/test/signRequests.generated.test.ts b/src/test/signRequests.generated.test.ts index a18f53ea..d567e634 100644 --- a/src/test/signRequests.generated.test.ts +++ b/src/test/signRequests.generated.test.ts @@ -25,7 +25,7 @@ import { SignRequest } from '../schemas.generated.js'; import { FolderBaseTypeField } from '../schemas.generated.js'; import { FileBaseTypeField } from '../schemas.generated.js'; import { SignRequests } from '../schemas.generated.js'; -import { DeleteFolderByIdQueryParamsArg } from '../managers/folders.generated.js'; +import { DeleteFolderByIdQueryParams } from '../managers/folders.generated.js'; import { getUuid } from '../utils.js'; import { uploadNewFile } from './commons.generated.js'; import { createNewFolder } from './commons.generated.js'; @@ -96,7 +96,7 @@ test('test_create_get_cancel_and_list_sign_request', async function test_create_ } await client.folders.deleteFolderById(destinationFolder.id, { recursive: true, - } satisfies DeleteFolderByIdQueryParamsArg); + } satisfies DeleteFolderByIdQueryParams); await client.files.deleteFileById(fileToSign.id); }); export {}; diff --git a/src/test/signTemplates.generated.test.ts b/src/test/signTemplates.generated.test.ts index cdcc0016..73fc190e 100644 --- a/src/test/signTemplates.generated.test.ts +++ b/src/test/signTemplates.generated.test.ts @@ -4,7 +4,7 @@ import { serializeSignTemplate } from '../schemas.generated.js'; import { deserializeSignTemplate } from '../schemas.generated.js'; import { BoxClient } from '../client.generated.js'; import { SignTemplates } from '../schemas.generated.js'; -import { GetSignTemplatesQueryParamsArg } from '../managers/signTemplates.generated.js'; +import { GetSignTemplatesQueryParams } from '../managers/signTemplates.generated.js'; import { SignTemplate } from '../schemas.generated.js'; import { decodeBase64 } from '../utils.js'; import { getEnvVar } from '../utils.js'; @@ -21,7 +21,7 @@ test('testGetSignTemplates', async function testGetSignTemplates(): Promise const signTemplates: SignTemplates = await client.signTemplates.getSignTemplates({ limit: 2, - } satisfies GetSignTemplatesQueryParamsArg); + } satisfies GetSignTemplatesQueryParams); if (!(signTemplates.entries!.length >= 0)) { throw 'Assertion failed'; } @@ -31,7 +31,7 @@ test('testGetSignTemplate', async function testGetSignTemplate(): Promise { const signTemplates: SignTemplates = await client.signTemplates.getSignTemplates({ limit: 2, - } satisfies GetSignTemplatesQueryParamsArg); + } satisfies GetSignTemplatesQueryParams); if (!(signTemplates.entries!.length >= 0)) { throw 'Assertion failed'; } diff --git a/src/test/tasks.generated.test.ts b/src/test/tasks.generated.test.ts index 1074e5cd..1cb0d443 100644 --- a/src/test/tasks.generated.test.ts +++ b/src/test/tasks.generated.test.ts @@ -1,41 +1,41 @@ import { serializeFiles } from '../schemas.generated.js'; import { deserializeFiles } from '../schemas.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; import { serializeFileFull } from '../schemas.generated.js'; import { deserializeFileFull } from '../schemas.generated.js'; import { serializeTask } from '../schemas.generated.js'; import { deserializeTask } from '../schemas.generated.js'; -import { serializeCreateTaskRequestBodyArg } from '../managers/tasks.generated.js'; -import { deserializeCreateTaskRequestBodyArg } from '../managers/tasks.generated.js'; -import { serializeCreateTaskRequestBodyArgItemField } from '../managers/tasks.generated.js'; -import { deserializeCreateTaskRequestBodyArgItemField } from '../managers/tasks.generated.js'; -import { serializeCreateTaskRequestBodyArgItemFieldTypeField } from '../managers/tasks.generated.js'; -import { deserializeCreateTaskRequestBodyArgItemFieldTypeField } from '../managers/tasks.generated.js'; -import { serializeCreateTaskRequestBodyArgActionField } from '../managers/tasks.generated.js'; -import { deserializeCreateTaskRequestBodyArgActionField } from '../managers/tasks.generated.js'; -import { serializeCreateTaskRequestBodyArgCompletionRuleField } from '../managers/tasks.generated.js'; -import { deserializeCreateTaskRequestBodyArgCompletionRuleField } from '../managers/tasks.generated.js'; +import { serializeCreateTaskRequestBody } from '../managers/tasks.generated.js'; +import { deserializeCreateTaskRequestBody } from '../managers/tasks.generated.js'; +import { serializeCreateTaskRequestBodyItemField } from '../managers/tasks.generated.js'; +import { deserializeCreateTaskRequestBodyItemField } from '../managers/tasks.generated.js'; +import { serializeCreateTaskRequestBodyItemTypeField } from '../managers/tasks.generated.js'; +import { deserializeCreateTaskRequestBodyItemTypeField } from '../managers/tasks.generated.js'; +import { serializeCreateTaskRequestBodyActionField } from '../managers/tasks.generated.js'; +import { deserializeCreateTaskRequestBodyActionField } from '../managers/tasks.generated.js'; +import { serializeCreateTaskRequestBodyCompletionRuleField } from '../managers/tasks.generated.js'; +import { deserializeCreateTaskRequestBodyCompletionRuleField } from '../managers/tasks.generated.js'; import { serializeTasks } from '../schemas.generated.js'; import { deserializeTasks } from '../schemas.generated.js'; -import { serializeUpdateTaskByIdRequestBodyArg } from '../managers/tasks.generated.js'; -import { deserializeUpdateTaskByIdRequestBodyArg } from '../managers/tasks.generated.js'; +import { serializeUpdateTaskByIdRequestBody } from '../managers/tasks.generated.js'; +import { deserializeUpdateTaskByIdRequestBody } from '../managers/tasks.generated.js'; import { BoxClient } from '../client.generated.js'; import { Files } from '../schemas.generated.js'; -import { UploadFileRequestBodyArg } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBody } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; import { FileFull } from '../schemas.generated.js'; import { Task } from '../schemas.generated.js'; -import { CreateTaskRequestBodyArg } from '../managers/tasks.generated.js'; -import { CreateTaskRequestBodyArgItemField } from '../managers/tasks.generated.js'; -import { CreateTaskRequestBodyArgItemFieldTypeField } from '../managers/tasks.generated.js'; -import { CreateTaskRequestBodyArgActionField } from '../managers/tasks.generated.js'; -import { CreateTaskRequestBodyArgCompletionRuleField } from '../managers/tasks.generated.js'; +import { CreateTaskRequestBody } from '../managers/tasks.generated.js'; +import { CreateTaskRequestBodyItemField } from '../managers/tasks.generated.js'; +import { CreateTaskRequestBodyItemTypeField } from '../managers/tasks.generated.js'; +import { CreateTaskRequestBodyActionField } from '../managers/tasks.generated.js'; +import { CreateTaskRequestBodyCompletionRuleField } from '../managers/tasks.generated.js'; import { Tasks } from '../schemas.generated.js'; -import { UpdateTaskByIdRequestBodyArg } from '../managers/tasks.generated.js'; +import { UpdateTaskByIdRequestBody } from '../managers/tasks.generated.js'; import { getUuid } from '../utils.js'; import { generateByteStream } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; @@ -51,24 +51,21 @@ test('testCreateUpdateGetDeleteTask', async function testCreateUpdateGetDeleteTa const files: Files = await client.uploads.uploadFile({ attributes: { name: getUuid(), - parent: { - id: '0', - } satisfies UploadFileRequestBodyArgAttributesFieldParentField, - } satisfies UploadFileRequestBodyArgAttributesField, + parent: { id: '0' } satisfies UploadFileRequestBodyAttributesParentField, + } satisfies UploadFileRequestBodyAttributesField, file: generateByteStream(10), - } satisfies UploadFileRequestBodyArg); + } satisfies UploadFileRequestBody); const file: FileFull = files.entries![0]; const task: Task = await client.tasks.createTask({ item: { - type: 'file' as CreateTaskRequestBodyArgItemFieldTypeField, + type: 'file' as CreateTaskRequestBodyItemTypeField, id: file.id, - } satisfies CreateTaskRequestBodyArgItemField, + } satisfies CreateTaskRequestBodyItemField, message: 'test message', dueAt: '2035-01-01T00:00:00Z', - action: 'review' as CreateTaskRequestBodyArgActionField, - completionRule: - 'all_assignees' as CreateTaskRequestBodyArgCompletionRuleField, - } satisfies CreateTaskRequestBodyArg); + action: 'review' as CreateTaskRequestBodyActionField, + completionRule: 'all_assignees' as CreateTaskRequestBodyCompletionRuleField, + } satisfies CreateTaskRequestBody); if (!(task.message == 'test message')) { throw 'Assertion failed'; } @@ -85,7 +82,7 @@ test('testCreateUpdateGetDeleteTask', async function testCreateUpdateGetDeleteTa } const updatedTask: Task = await client.tasks.updateTaskById(task.id!, { message: 'updated message', - } satisfies UpdateTaskByIdRequestBodyArg); + } satisfies UpdateTaskByIdRequestBody); if (!(updatedTask.message == 'updated message')) { throw 'Assertion failed'; } diff --git a/src/test/transfer.generated.test.ts b/src/test/transfer.generated.test.ts index ab536433..b9aa6099 100644 --- a/src/test/transfer.generated.test.ts +++ b/src/test/transfer.generated.test.ts @@ -1,22 +1,22 @@ import { serializeUserFull } from '../schemas.generated.js'; import { deserializeUserFull } from '../schemas.generated.js'; -import { serializeCreateUserRequestBodyArg } from '../managers/users.generated.js'; -import { deserializeCreateUserRequestBodyArg } from '../managers/users.generated.js'; +import { serializeCreateUserRequestBody } from '../managers/users.generated.js'; +import { deserializeCreateUserRequestBody } from '../managers/users.generated.js'; import { serializeFolderFull } from '../schemas.generated.js'; import { deserializeFolderFull } from '../schemas.generated.js'; -import { serializeTransferOwnedFolderRequestBodyArg } from '../managers/transfer.generated.js'; -import { deserializeTransferOwnedFolderRequestBodyArg } from '../managers/transfer.generated.js'; -import { serializeTransferOwnedFolderRequestBodyArgOwnedByField } from '../managers/transfer.generated.js'; -import { deserializeTransferOwnedFolderRequestBodyArgOwnedByField } from '../managers/transfer.generated.js'; +import { serializeTransferOwnedFolderRequestBody } from '../managers/transfer.generated.js'; +import { deserializeTransferOwnedFolderRequestBody } from '../managers/transfer.generated.js'; +import { serializeTransferOwnedFolderRequestBodyOwnedByField } from '../managers/transfer.generated.js'; +import { deserializeTransferOwnedFolderRequestBodyOwnedByField } from '../managers/transfer.generated.js'; import { BoxClient } from '../client.generated.js'; import { UserFull } from '../schemas.generated.js'; -import { CreateUserRequestBodyArg } from '../managers/users.generated.js'; +import { CreateUserRequestBody } from '../managers/users.generated.js'; import { FolderFull } from '../schemas.generated.js'; -import { TransferOwnedFolderRequestBodyArg } from '../managers/transfer.generated.js'; -import { TransferOwnedFolderRequestBodyArgOwnedByField } from '../managers/transfer.generated.js'; -import { TransferOwnedFolderQueryParamsArg } from '../managers/transfer.generated.js'; -import { DeleteFolderByIdQueryParamsArg } from '../managers/folders.generated.js'; -import { DeleteUserByIdQueryParamsArg } from '../managers/users.generated.js'; +import { TransferOwnedFolderRequestBody } from '../managers/transfer.generated.js'; +import { TransferOwnedFolderRequestBodyOwnedByField } from '../managers/transfer.generated.js'; +import { TransferOwnedFolderQueryParams } from '../managers/transfer.generated.js'; +import { DeleteFolderByIdQueryParams } from '../managers/folders.generated.js'; +import { DeleteUserByIdQueryParams } from '../managers/users.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; import { SerializedData } from '../json.js'; @@ -32,7 +32,7 @@ test('testTransferUserContent', async function testTransferUserContent(): Promis const newUser: UserFull = await client.users.createUser({ name: newUserName, isPlatformAccessOnly: true, - } satisfies CreateUserRequestBodyArg); + } satisfies CreateUserRequestBody); const currentUser: UserFull = await client.users.getUserMe(); const transferedFolder: FolderFull = await client.transfer.transferOwnedFolder( @@ -40,19 +40,19 @@ test('testTransferUserContent', async function testTransferUserContent(): Promis { ownedBy: { id: currentUser.id, - } satisfies TransferOwnedFolderRequestBodyArgOwnedByField, - } satisfies TransferOwnedFolderRequestBodyArg, - { notify: false } satisfies TransferOwnedFolderQueryParamsArg + } satisfies TransferOwnedFolderRequestBodyOwnedByField, + } satisfies TransferOwnedFolderRequestBody, + { notify: false } satisfies TransferOwnedFolderQueryParams ); if (!(transferedFolder.ownedBy!.id == currentUser.id)) { throw 'Assertion failed'; } await client.folders.deleteFolderById(transferedFolder.id, { recursive: true, - } satisfies DeleteFolderByIdQueryParamsArg); + } satisfies DeleteFolderByIdQueryParams); await client.users.deleteUserById(newUser.id, { notify: false, force: true, - } satisfies DeleteUserByIdQueryParamsArg); + } satisfies DeleteUserByIdQueryParams); }); export {}; diff --git a/src/test/trashedFiles.generated.test.ts b/src/test/trashedFiles.generated.test.ts index 055341b0..0dd4e18a 100644 --- a/src/test/trashedFiles.generated.test.ts +++ b/src/test/trashedFiles.generated.test.ts @@ -1,9 +1,9 @@ import { serializeFiles } from '../schemas.generated.js'; import { deserializeFiles } from '../schemas.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; import { serializeFileFull } from '../schemas.generated.js'; import { deserializeFileFull } from '../schemas.generated.js'; import { serializeTrashFile } from '../schemas.generated.js'; @@ -13,9 +13,9 @@ import { deserializeTrashFileRestored } from '../schemas.generated.js'; import { BoxClient } from '../client.generated.js'; import { ByteStream } from '../utils.js'; import { Files } from '../schemas.generated.js'; -import { UploadFileRequestBodyArg } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBody } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; import { FileFull } from '../schemas.generated.js'; import { TrashFile } from '../schemas.generated.js'; import { TrashFileRestored } from '../schemas.generated.js'; @@ -39,12 +39,10 @@ test('testTrashedFiles', async function testTrashedFiles(): Promise { const files: Files = await client.uploads.uploadFile({ attributes: { name: fileName, - parent: { - id: '0', - } satisfies UploadFileRequestBodyArgAttributesFieldParentField, - } satisfies UploadFileRequestBodyArgAttributesField, + parent: { id: '0' } satisfies UploadFileRequestBodyAttributesParentField, + } satisfies UploadFileRequestBodyAttributesField, file: fileByteStream, - } satisfies UploadFileRequestBodyArg); + } satisfies UploadFileRequestBody); const file: FileFull = files.entries![0]; await client.files.deleteFileById(file.id); const fromTrash: TrashFile = await client.trashedFiles.getFileTrash(file.id); diff --git a/src/test/trashedFolders.generated.test.ts b/src/test/trashedFolders.generated.test.ts index 2ae6b24b..a049bce1 100644 --- a/src/test/trashedFolders.generated.test.ts +++ b/src/test/trashedFolders.generated.test.ts @@ -1,17 +1,17 @@ import { serializeFolderFull } from '../schemas.generated.js'; import { deserializeFolderFull } from '../schemas.generated.js'; -import { serializeCreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { deserializeCreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { serializeCreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; -import { deserializeCreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; +import { serializeCreateFolderRequestBody } from '../managers/folders.generated.js'; +import { deserializeCreateFolderRequestBody } from '../managers/folders.generated.js'; +import { serializeCreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; +import { deserializeCreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; import { serializeTrashFolder } from '../schemas.generated.js'; import { deserializeTrashFolder } from '../schemas.generated.js'; import { serializeTrashFolderRestored } from '../schemas.generated.js'; import { deserializeTrashFolderRestored } from '../schemas.generated.js'; import { BoxClient } from '../client.generated.js'; import { FolderFull } from '../schemas.generated.js'; -import { CreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { CreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; +import { CreateFolderRequestBody } from '../managers/folders.generated.js'; +import { CreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; import { TrashFolder } from '../schemas.generated.js'; import { TrashFolderRestored } from '../schemas.generated.js'; import { getUuid } from '../utils.js'; @@ -27,8 +27,8 @@ const client: BoxClient = getDefaultClient(); test('testTrashedFolders', async function testTrashedFolders(): Promise { const folder: FolderFull = await client.folders.createFolder({ name: getUuid(), - parent: { id: '0' } satisfies CreateFolderRequestBodyArgParentField, - } satisfies CreateFolderRequestBodyArg); + parent: { id: '0' } satisfies CreateFolderRequestBodyParentField, + } satisfies CreateFolderRequestBody); await client.folders.deleteFolderById(folder.id); const fromTrash: TrashFolder = await client.trashedFolders.getFolderTrash( folder.id diff --git a/src/test/trashedWebLinks.generated.test.ts b/src/test/trashedWebLinks.generated.test.ts index 225416f7..241355df 100644 --- a/src/test/trashedWebLinks.generated.test.ts +++ b/src/test/trashedWebLinks.generated.test.ts @@ -2,10 +2,10 @@ import { serializeFolderFull } from '../schemas.generated.js'; import { deserializeFolderFull } from '../schemas.generated.js'; import { serializeWebLink } from '../schemas.generated.js'; import { deserializeWebLink } from '../schemas.generated.js'; -import { serializeCreateWebLinkRequestBodyArg } from '../managers/webLinks.generated.js'; -import { deserializeCreateWebLinkRequestBodyArg } from '../managers/webLinks.generated.js'; -import { serializeCreateWebLinkRequestBodyArgParentField } from '../managers/webLinks.generated.js'; -import { deserializeCreateWebLinkRequestBodyArgParentField } from '../managers/webLinks.generated.js'; +import { serializeCreateWebLinkRequestBody } from '../managers/webLinks.generated.js'; +import { deserializeCreateWebLinkRequestBody } from '../managers/webLinks.generated.js'; +import { serializeCreateWebLinkRequestBodyParentField } from '../managers/webLinks.generated.js'; +import { deserializeCreateWebLinkRequestBodyParentField } from '../managers/webLinks.generated.js'; import { serializeTrashWebLink } from '../schemas.generated.js'; import { deserializeTrashWebLink } from '../schemas.generated.js'; import { serializeTrashWebLinkRestored } from '../schemas.generated.js'; @@ -13,8 +13,8 @@ import { deserializeTrashWebLinkRestored } from '../schemas.generated.js'; import { BoxClient } from '../client.generated.js'; import { FolderFull } from '../schemas.generated.js'; import { WebLink } from '../schemas.generated.js'; -import { CreateWebLinkRequestBodyArg } from '../managers/webLinks.generated.js'; -import { CreateWebLinkRequestBodyArgParentField } from '../managers/webLinks.generated.js'; +import { CreateWebLinkRequestBody } from '../managers/webLinks.generated.js'; +import { CreateWebLinkRequestBodyParentField } from '../managers/webLinks.generated.js'; import { TrashWebLink } from '../schemas.generated.js'; import { TrashWebLinkRestored } from '../schemas.generated.js'; import { getUuid } from '../utils.js'; @@ -36,10 +36,10 @@ test('testTrashedWebLinks', async function testTrashedWebLinks(): Promise { const description: string = 'Weblink description'; const weblink: WebLink = await client.webLinks.createWebLink({ url: url, - parent: { id: parent.id } satisfies CreateWebLinkRequestBodyArgParentField, + parent: { id: parent.id } satisfies CreateWebLinkRequestBodyParentField, name: name, description: description, - } satisfies CreateWebLinkRequestBodyArg); + } satisfies CreateWebLinkRequestBody); await client.webLinks.deleteWebLinkById(weblink.id); const fromTrash: TrashWebLink = await client.trashedWebLinks.getWebLinkTrash( weblink.id diff --git a/src/test/uploads.generated.test.ts b/src/test/uploads.generated.test.ts index f2112c54..e4b27ceb 100644 --- a/src/test/uploads.generated.test.ts +++ b/src/test/uploads.generated.test.ts @@ -1,24 +1,24 @@ import { serializeFiles } from '../schemas.generated.js'; import { deserializeFiles } from '../schemas.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { serializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { serializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; import { serializeFileFull } from '../schemas.generated.js'; import { deserializeFileFull } from '../schemas.generated.js'; -import { serializeUploadFileVersionRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { deserializeUploadFileVersionRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; +import { serializeUploadFileVersionRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { deserializeUploadFileVersionRequestBodyAttributesField } from '../managers/uploads.generated.js'; import { ByteStream } from '../utils.js'; import { Files } from '../schemas.generated.js'; -import { UploadFileRequestBodyArg } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; -import { UploadFileRequestBodyArgAttributesFieldParentField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBody } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; +import { UploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; import { FileFull } from '../schemas.generated.js'; -import { UploadFileVersionRequestBodyArg } from '../managers/uploads.generated.js'; -import { UploadFileVersionRequestBodyArgAttributesField } from '../managers/uploads.generated.js'; +import { UploadFileVersionRequestBody } from '../managers/uploads.generated.js'; +import { UploadFileVersionRequestBodyAttributesField } from '../managers/uploads.generated.js'; import { CancellationToken } from '../utils.js'; -import { UploadFileQueryParamsArg } from '../managers/uploads.generated.js'; -import { UploadFileHeadersArg } from '../managers/uploads.generated.js'; +import { UploadFileQueryParams } from '../managers/uploads.generated.js'; +import { UploadFileHeaders } from '../managers/uploads.generated.js'; import { getUuid } from '../utils.js'; import { generateByteStream } from '../utils.js'; import { createTokenAndCancelAfter } from '../utils.js'; @@ -38,12 +38,10 @@ test('testUploadFileAndFileVersion', async function testUploadFileAndFileVersion const uploadedFiles: Files = await client.uploads.uploadFile({ attributes: { name: newFileName, - parent: { - id: '0', - } satisfies UploadFileRequestBodyArgAttributesFieldParentField, - } satisfies UploadFileRequestBodyArgAttributesField, + parent: { id: '0' } satisfies UploadFileRequestBodyAttributesParentField, + } satisfies UploadFileRequestBodyAttributesField, file: fileContentStream, - } satisfies UploadFileRequestBodyArg); + } satisfies UploadFileRequestBody); const uploadedFile: FileFull = uploadedFiles.entries![0]; if (!(uploadedFile.name == newFileName)) { throw 'Assertion failed'; @@ -55,9 +53,9 @@ test('testUploadFileAndFileVersion', async function testUploadFileAndFileVersion { attributes: { name: newFileVersionName, - } satisfies UploadFileVersionRequestBodyArgAttributesField, + } satisfies UploadFileVersionRequestBodyAttributesField, file: newFileContentStream, - } satisfies UploadFileVersionRequestBodyArg + } satisfies UploadFileVersionRequestBody ); const newFileVersion: FileFull = uploadedFilesVersion.entries![0]; if (!(newFileVersion.name == newFileVersionName)) { @@ -77,12 +75,12 @@ test('testRequestCancellation', async function testRequestCancellation(): Promis name: fileName, parent: { id: '0', - } satisfies UploadFileRequestBodyArgAttributesFieldParentField, - } satisfies UploadFileRequestBodyArgAttributesField, + } satisfies UploadFileRequestBodyAttributesParentField, + } satisfies UploadFileRequestBodyAttributesField, file: fileByteStream, - } satisfies UploadFileRequestBodyArg, - {} satisfies UploadFileQueryParamsArg, - new UploadFileHeadersArg({}), + } satisfies UploadFileRequestBody, + {} satisfies UploadFileQueryParams, + new UploadFileHeaders({}), cancellationToken ); }).rejects.toThrow(); diff --git a/src/test/userCollaborations.generated.test.ts b/src/test/userCollaborations.generated.test.ts index 086c0039..6cdd88b6 100644 --- a/src/test/userCollaborations.generated.test.ts +++ b/src/test/userCollaborations.generated.test.ts @@ -1,40 +1,40 @@ import { serializeUserFull } from '../schemas.generated.js'; import { deserializeUserFull } from '../schemas.generated.js'; -import { serializeCreateUserRequestBodyArg } from '../managers/users.generated.js'; -import { deserializeCreateUserRequestBodyArg } from '../managers/users.generated.js'; +import { serializeCreateUserRequestBody } from '../managers/users.generated.js'; +import { deserializeCreateUserRequestBody } from '../managers/users.generated.js'; import { serializeFolderFull } from '../schemas.generated.js'; import { deserializeFolderFull } from '../schemas.generated.js'; import { serializeCollaboration } from '../schemas.generated.js'; import { deserializeCollaboration } from '../schemas.generated.js'; -import { serializeCreateCollaborationRequestBodyArg } from '../managers/userCollaborations.generated.js'; -import { deserializeCreateCollaborationRequestBodyArg } from '../managers/userCollaborations.generated.js'; -import { serializeCreateCollaborationRequestBodyArgItemField } from '../managers/userCollaborations.generated.js'; -import { deserializeCreateCollaborationRequestBodyArgItemField } from '../managers/userCollaborations.generated.js'; -import { serializeCreateCollaborationRequestBodyArgItemFieldTypeField } from '../managers/userCollaborations.generated.js'; -import { deserializeCreateCollaborationRequestBodyArgItemFieldTypeField } from '../managers/userCollaborations.generated.js'; -import { serializeCreateCollaborationRequestBodyArgAccessibleByField } from '../managers/userCollaborations.generated.js'; -import { deserializeCreateCollaborationRequestBodyArgAccessibleByField } from '../managers/userCollaborations.generated.js'; -import { serializeCreateCollaborationRequestBodyArgAccessibleByFieldTypeField } from '../managers/userCollaborations.generated.js'; -import { deserializeCreateCollaborationRequestBodyArgAccessibleByFieldTypeField } from '../managers/userCollaborations.generated.js'; -import { serializeCreateCollaborationRequestBodyArgRoleField } from '../managers/userCollaborations.generated.js'; -import { deserializeCreateCollaborationRequestBodyArgRoleField } from '../managers/userCollaborations.generated.js'; -import { serializeUpdateCollaborationByIdRequestBodyArg } from '../managers/userCollaborations.generated.js'; -import { deserializeUpdateCollaborationByIdRequestBodyArg } from '../managers/userCollaborations.generated.js'; -import { serializeUpdateCollaborationByIdRequestBodyArgRoleField } from '../managers/userCollaborations.generated.js'; -import { deserializeUpdateCollaborationByIdRequestBodyArgRoleField } from '../managers/userCollaborations.generated.js'; +import { serializeCreateCollaborationRequestBody } from '../managers/userCollaborations.generated.js'; +import { deserializeCreateCollaborationRequestBody } from '../managers/userCollaborations.generated.js'; +import { serializeCreateCollaborationRequestBodyItemField } from '../managers/userCollaborations.generated.js'; +import { deserializeCreateCollaborationRequestBodyItemField } from '../managers/userCollaborations.generated.js'; +import { serializeCreateCollaborationRequestBodyItemTypeField } from '../managers/userCollaborations.generated.js'; +import { deserializeCreateCollaborationRequestBodyItemTypeField } from '../managers/userCollaborations.generated.js'; +import { serializeCreateCollaborationRequestBodyAccessibleByField } from '../managers/userCollaborations.generated.js'; +import { deserializeCreateCollaborationRequestBodyAccessibleByField } from '../managers/userCollaborations.generated.js'; +import { serializeCreateCollaborationRequestBodyAccessibleByTypeField } from '../managers/userCollaborations.generated.js'; +import { deserializeCreateCollaborationRequestBodyAccessibleByTypeField } from '../managers/userCollaborations.generated.js'; +import { serializeCreateCollaborationRequestBodyRoleField } from '../managers/userCollaborations.generated.js'; +import { deserializeCreateCollaborationRequestBodyRoleField } from '../managers/userCollaborations.generated.js'; +import { serializeUpdateCollaborationByIdRequestBody } from '../managers/userCollaborations.generated.js'; +import { deserializeUpdateCollaborationByIdRequestBody } from '../managers/userCollaborations.generated.js'; +import { serializeUpdateCollaborationByIdRequestBodyRoleField } from '../managers/userCollaborations.generated.js'; +import { deserializeUpdateCollaborationByIdRequestBodyRoleField } from '../managers/userCollaborations.generated.js'; import { BoxClient } from '../client.generated.js'; import { UserFull } from '../schemas.generated.js'; -import { CreateUserRequestBodyArg } from '../managers/users.generated.js'; +import { CreateUserRequestBody } from '../managers/users.generated.js'; import { FolderFull } from '../schemas.generated.js'; import { Collaboration } from '../schemas.generated.js'; -import { CreateCollaborationRequestBodyArg } from '../managers/userCollaborations.generated.js'; -import { CreateCollaborationRequestBodyArgItemField } from '../managers/userCollaborations.generated.js'; -import { CreateCollaborationRequestBodyArgItemFieldTypeField } from '../managers/userCollaborations.generated.js'; -import { CreateCollaborationRequestBodyArgAccessibleByField } from '../managers/userCollaborations.generated.js'; -import { CreateCollaborationRequestBodyArgAccessibleByFieldTypeField } from '../managers/userCollaborations.generated.js'; -import { CreateCollaborationRequestBodyArgRoleField } from '../managers/userCollaborations.generated.js'; -import { UpdateCollaborationByIdRequestBodyArg } from '../managers/userCollaborations.generated.js'; -import { UpdateCollaborationByIdRequestBodyArgRoleField } from '../managers/userCollaborations.generated.js'; +import { CreateCollaborationRequestBody } from '../managers/userCollaborations.generated.js'; +import { CreateCollaborationRequestBodyItemField } from '../managers/userCollaborations.generated.js'; +import { CreateCollaborationRequestBodyItemTypeField } from '../managers/userCollaborations.generated.js'; +import { CreateCollaborationRequestBodyAccessibleByField } from '../managers/userCollaborations.generated.js'; +import { CreateCollaborationRequestBodyAccessibleByTypeField } from '../managers/userCollaborations.generated.js'; +import { CreateCollaborationRequestBodyRoleField } from '../managers/userCollaborations.generated.js'; +import { UpdateCollaborationByIdRequestBody } from '../managers/userCollaborations.generated.js'; +import { UpdateCollaborationByIdRequestBodyRoleField } from '../managers/userCollaborations.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; import { createNewFolder } from './commons.generated.js'; @@ -55,20 +55,20 @@ test('testUserCollaborations', async function testUserCollaborations(): Promise< name: userName, login: userLogin, isPlatformAccessOnly: true, - } satisfies CreateUserRequestBodyArg); + } satisfies CreateUserRequestBody); const folder: FolderFull = await createNewFolder(); const collaboration: Collaboration = await client.userCollaborations.createCollaboration({ item: { - type: 'folder' as CreateCollaborationRequestBodyArgItemFieldTypeField, + type: 'folder' as CreateCollaborationRequestBodyItemTypeField, id: folder.id, - } satisfies CreateCollaborationRequestBodyArgItemField, + } satisfies CreateCollaborationRequestBodyItemField, accessibleBy: { - type: 'user' as CreateCollaborationRequestBodyArgAccessibleByFieldTypeField, + type: 'user' as CreateCollaborationRequestBodyAccessibleByTypeField, id: user.id, - } satisfies CreateCollaborationRequestBodyArgAccessibleByField, - role: 'editor' as CreateCollaborationRequestBodyArgRoleField, - } satisfies CreateCollaborationRequestBodyArg); + } satisfies CreateCollaborationRequestBodyAccessibleByField, + role: 'editor' as CreateCollaborationRequestBodyRoleField, + } satisfies CreateCollaborationRequestBody); if (!((toString(collaboration.role!) as string) == 'editor')) { throw 'Assertion failed'; } @@ -89,8 +89,8 @@ test('testUserCollaborations', async function testUserCollaborations(): Promise< } const updatedCollaboration: Collaboration = await client.userCollaborations.updateCollaborationById(collaborationId, { - role: 'viewer' as UpdateCollaborationByIdRequestBodyArgRoleField, - } satisfies UpdateCollaborationByIdRequestBodyArg); + role: 'viewer' as UpdateCollaborationByIdRequestBodyRoleField, + } satisfies UpdateCollaborationByIdRequestBody); if (!((toString(updatedCollaboration.role!) as string) == 'viewer')) { throw 'Assertion failed'; } @@ -108,15 +108,15 @@ test('testExternalUserCollaborations', async function testExternalUserCollaborat const collaboration: Collaboration = await client.userCollaborations.createCollaboration({ item: { - type: 'folder' as CreateCollaborationRequestBodyArgItemFieldTypeField, + type: 'folder' as CreateCollaborationRequestBodyItemTypeField, id: folder.id, - } satisfies CreateCollaborationRequestBodyArgItemField, + } satisfies CreateCollaborationRequestBodyItemField, accessibleBy: { - type: 'user' as CreateCollaborationRequestBodyArgAccessibleByFieldTypeField, + type: 'user' as CreateCollaborationRequestBodyAccessibleByTypeField, login: userLogin, - } satisfies CreateCollaborationRequestBodyArgAccessibleByField, - role: 'editor' as CreateCollaborationRequestBodyArgRoleField, - } satisfies CreateCollaborationRequestBodyArg); + } satisfies CreateCollaborationRequestBodyAccessibleByField, + role: 'editor' as CreateCollaborationRequestBodyRoleField, + } satisfies CreateCollaborationRequestBody); if (!((toString(collaboration.role!) as string) == 'editor')) { throw 'Assertion failed'; } @@ -137,8 +137,8 @@ test('testExternalUserCollaborations', async function testExternalUserCollaborat } const updatedCollaboration: Collaboration = await client.userCollaborations.updateCollaborationById(collaborationId, { - role: 'viewer' as UpdateCollaborationByIdRequestBodyArgRoleField, - } satisfies UpdateCollaborationByIdRequestBodyArg); + role: 'viewer' as UpdateCollaborationByIdRequestBodyRoleField, + } satisfies UpdateCollaborationByIdRequestBody); if (!((toString(updatedCollaboration.role!) as string) == 'viewer')) { throw 'Assertion failed'; } diff --git a/src/test/users.generated.test.ts b/src/test/users.generated.test.ts index ec4cc1b9..62cbe654 100644 --- a/src/test/users.generated.test.ts +++ b/src/test/users.generated.test.ts @@ -2,15 +2,15 @@ import { serializeUsers } from '../schemas.generated.js'; import { deserializeUsers } from '../schemas.generated.js'; import { serializeUserFull } from '../schemas.generated.js'; import { deserializeUserFull } from '../schemas.generated.js'; -import { serializeCreateUserRequestBodyArg } from '../managers/users.generated.js'; -import { deserializeCreateUserRequestBodyArg } from '../managers/users.generated.js'; -import { serializeUpdateUserByIdRequestBodyArg } from '../managers/users.generated.js'; -import { deserializeUpdateUserByIdRequestBodyArg } from '../managers/users.generated.js'; +import { serializeCreateUserRequestBody } from '../managers/users.generated.js'; +import { deserializeCreateUserRequestBody } from '../managers/users.generated.js'; +import { serializeUpdateUserByIdRequestBody } from '../managers/users.generated.js'; +import { deserializeUpdateUserByIdRequestBody } from '../managers/users.generated.js'; import { BoxClient } from '../client.generated.js'; import { Users } from '../schemas.generated.js'; import { UserFull } from '../schemas.generated.js'; -import { CreateUserRequestBodyArg } from '../managers/users.generated.js'; -import { UpdateUserByIdRequestBodyArg } from '../managers/users.generated.js'; +import { CreateUserRequestBody } from '../managers/users.generated.js'; +import { UpdateUserByIdRequestBody } from '../managers/users.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; import { toString } from '../utils.js'; @@ -42,7 +42,7 @@ test('test_create_update_get_delete_user', async function test_create_update_get name: userName, login: userLogin, isPlatformAccessOnly: true, - } satisfies CreateUserRequestBodyArg); + } satisfies CreateUserRequestBody); if (!(user.name == userName)) { throw 'Assertion failed'; } @@ -53,7 +53,7 @@ test('test_create_update_get_delete_user', async function test_create_update_get const updatedUserName: string = getUuid(); const updatedUser: UserFull = await client.users.updateUserById(user.id, { name: updatedUserName, - } satisfies UpdateUserByIdRequestBodyArg); + } satisfies UpdateUserByIdRequestBody); if (!(updatedUser.name == updatedUserName)) { throw 'Assertion failed'; } diff --git a/src/test/webhooks.generated.test.ts b/src/test/webhooks.generated.test.ts index 721356ce..a9ddf24d 100644 --- a/src/test/webhooks.generated.test.ts +++ b/src/test/webhooks.generated.test.ts @@ -1,34 +1,34 @@ import { serializeFolderFull } from '../schemas.generated.js'; import { deserializeFolderFull } from '../schemas.generated.js'; -import { serializeCreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { deserializeCreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { serializeCreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; -import { deserializeCreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; +import { serializeCreateFolderRequestBody } from '../managers/folders.generated.js'; +import { deserializeCreateFolderRequestBody } from '../managers/folders.generated.js'; +import { serializeCreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; +import { deserializeCreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; import { serializeWebhook } from '../schemas.generated.js'; import { deserializeWebhook } from '../schemas.generated.js'; -import { serializeCreateWebhookRequestBodyArg } from '../managers/webhooks.generated.js'; -import { deserializeCreateWebhookRequestBodyArg } from '../managers/webhooks.generated.js'; -import { serializeCreateWebhookRequestBodyArgTargetField } from '../managers/webhooks.generated.js'; -import { deserializeCreateWebhookRequestBodyArgTargetField } from '../managers/webhooks.generated.js'; -import { serializeCreateWebhookRequestBodyArgTargetFieldTypeField } from '../managers/webhooks.generated.js'; -import { deserializeCreateWebhookRequestBodyArgTargetFieldTypeField } from '../managers/webhooks.generated.js'; -import { serializeCreateWebhookRequestBodyArgTriggersField } from '../managers/webhooks.generated.js'; -import { deserializeCreateWebhookRequestBodyArgTriggersField } from '../managers/webhooks.generated.js'; +import { serializeCreateWebhookRequestBody } from '../managers/webhooks.generated.js'; +import { deserializeCreateWebhookRequestBody } from '../managers/webhooks.generated.js'; +import { serializeCreateWebhookRequestBodyTargetField } from '../managers/webhooks.generated.js'; +import { deserializeCreateWebhookRequestBodyTargetField } from '../managers/webhooks.generated.js'; +import { serializeCreateWebhookRequestBodyTargetTypeField } from '../managers/webhooks.generated.js'; +import { deserializeCreateWebhookRequestBodyTargetTypeField } from '../managers/webhooks.generated.js'; +import { serializeCreateWebhookRequestBodyTriggersField } from '../managers/webhooks.generated.js'; +import { deserializeCreateWebhookRequestBodyTriggersField } from '../managers/webhooks.generated.js'; import { serializeWebhooks } from '../schemas.generated.js'; import { deserializeWebhooks } from '../schemas.generated.js'; -import { serializeUpdateWebhookByIdRequestBodyArg } from '../managers/webhooks.generated.js'; -import { deserializeUpdateWebhookByIdRequestBodyArg } from '../managers/webhooks.generated.js'; +import { serializeUpdateWebhookByIdRequestBody } from '../managers/webhooks.generated.js'; +import { deserializeUpdateWebhookByIdRequestBody } from '../managers/webhooks.generated.js'; import { BoxClient } from '../client.generated.js'; import { FolderFull } from '../schemas.generated.js'; -import { CreateFolderRequestBodyArg } from '../managers/folders.generated.js'; -import { CreateFolderRequestBodyArgParentField } from '../managers/folders.generated.js'; +import { CreateFolderRequestBody } from '../managers/folders.generated.js'; +import { CreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; import { Webhook } from '../schemas.generated.js'; -import { CreateWebhookRequestBodyArg } from '../managers/webhooks.generated.js'; -import { CreateWebhookRequestBodyArgTargetField } from '../managers/webhooks.generated.js'; -import { CreateWebhookRequestBodyArgTargetFieldTypeField } from '../managers/webhooks.generated.js'; -import { CreateWebhookRequestBodyArgTriggersField } from '../managers/webhooks.generated.js'; +import { CreateWebhookRequestBody } from '../managers/webhooks.generated.js'; +import { CreateWebhookRequestBodyTargetField } from '../managers/webhooks.generated.js'; +import { CreateWebhookRequestBodyTargetTypeField } from '../managers/webhooks.generated.js'; +import { CreateWebhookRequestBodyTriggersField } from '../managers/webhooks.generated.js'; import { Webhooks } from '../schemas.generated.js'; -import { UpdateWebhookByIdRequestBodyArg } from '../managers/webhooks.generated.js'; +import { UpdateWebhookByIdRequestBody } from '../managers/webhooks.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; import { toString } from '../utils.js'; @@ -44,16 +44,16 @@ const client: BoxClient = getDefaultClient(); test('testWebhooksCRUD', async function testWebhooksCRUD(): Promise { const folder: FolderFull = await client.folders.createFolder({ name: getUuid(), - parent: { id: '0' } satisfies CreateFolderRequestBodyArgParentField, - } satisfies CreateFolderRequestBodyArg); + parent: { id: '0' } satisfies CreateFolderRequestBodyParentField, + } satisfies CreateFolderRequestBody); const webhook: Webhook = await client.webhooks.createWebhook({ target: { id: folder.id, - type: 'folder' as CreateWebhookRequestBodyArgTargetFieldTypeField, - } satisfies CreateWebhookRequestBodyArgTargetField, + type: 'folder' as CreateWebhookRequestBodyTargetTypeField, + } satisfies CreateWebhookRequestBodyTargetField, address: 'https://example.com/new-webhook', - triggers: ['FILE.UPLOADED' as CreateWebhookRequestBodyArgTriggersField], - } satisfies CreateWebhookRequestBodyArg); + triggers: ['FILE.UPLOADED' as CreateWebhookRequestBodyTriggersField], + } satisfies CreateWebhookRequestBody); if (!(webhook.target!.id == folder.id)) { throw 'Assertion failed'; } @@ -86,7 +86,7 @@ test('testWebhooksCRUD', async function testWebhooksCRUD(): Promise { webhook.id!, { address: 'https://example.com/updated-webhook', - } satisfies UpdateWebhookByIdRequestBodyArg + } satisfies UpdateWebhookByIdRequestBody ); if (!(updatedWebhook.id == webhook.id)) { throw 'Assertion failed'; diff --git a/src/test/weblinks.generated.test.ts b/src/test/weblinks.generated.test.ts index aef9b867..930b5a9d 100644 --- a/src/test/weblinks.generated.test.ts +++ b/src/test/weblinks.generated.test.ts @@ -2,21 +2,21 @@ import { serializeFolderFull } from '../schemas.generated.js'; import { deserializeFolderFull } from '../schemas.generated.js'; import { serializeWebLink } from '../schemas.generated.js'; import { deserializeWebLink } from '../schemas.generated.js'; -import { serializeCreateWebLinkRequestBodyArg } from '../managers/webLinks.generated.js'; -import { deserializeCreateWebLinkRequestBodyArg } from '../managers/webLinks.generated.js'; -import { serializeCreateWebLinkRequestBodyArgParentField } from '../managers/webLinks.generated.js'; -import { deserializeCreateWebLinkRequestBodyArgParentField } from '../managers/webLinks.generated.js'; -import { serializeUpdateWebLinkByIdRequestBodyArg } from '../managers/webLinks.generated.js'; -import { deserializeUpdateWebLinkByIdRequestBodyArg } from '../managers/webLinks.generated.js'; -import { serializeUpdateWebLinkByIdRequestBodyArgSharedLinkField } from '../managers/webLinks.generated.js'; -import { deserializeUpdateWebLinkByIdRequestBodyArgSharedLinkField } from '../managers/webLinks.generated.js'; +import { serializeCreateWebLinkRequestBody } from '../managers/webLinks.generated.js'; +import { deserializeCreateWebLinkRequestBody } from '../managers/webLinks.generated.js'; +import { serializeCreateWebLinkRequestBodyParentField } from '../managers/webLinks.generated.js'; +import { deserializeCreateWebLinkRequestBodyParentField } from '../managers/webLinks.generated.js'; +import { serializeUpdateWebLinkByIdRequestBody } from '../managers/webLinks.generated.js'; +import { deserializeUpdateWebLinkByIdRequestBody } from '../managers/webLinks.generated.js'; +import { serializeUpdateWebLinkByIdRequestBodySharedLinkField } from '../managers/webLinks.generated.js'; +import { deserializeUpdateWebLinkByIdRequestBodySharedLinkField } from '../managers/webLinks.generated.js'; import { BoxClient } from '../client.generated.js'; import { FolderFull } from '../schemas.generated.js'; import { WebLink } from '../schemas.generated.js'; -import { CreateWebLinkRequestBodyArg } from '../managers/webLinks.generated.js'; -import { CreateWebLinkRequestBodyArgParentField } from '../managers/webLinks.generated.js'; -import { UpdateWebLinkByIdRequestBodyArg } from '../managers/webLinks.generated.js'; -import { UpdateWebLinkByIdRequestBodyArgSharedLinkField } from '../managers/webLinks.generated.js'; +import { CreateWebLinkRequestBody } from '../managers/webLinks.generated.js'; +import { CreateWebLinkRequestBodyParentField } from '../managers/webLinks.generated.js'; +import { UpdateWebLinkByIdRequestBody } from '../managers/webLinks.generated.js'; +import { UpdateWebLinkByIdRequestBodySharedLinkField } from '../managers/webLinks.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; import { SerializedData } from '../json.js'; @@ -36,10 +36,10 @@ test('test_create_get_delete_weblink', async function test_create_get_delete_web const password: any = 'super-secret-password'; const weblink: any = await client.webLinks.createWebLink({ url: url, - parent: { id: parent.id } satisfies CreateWebLinkRequestBodyArgParentField, + parent: { id: parent.id } satisfies CreateWebLinkRequestBodyParentField, name: name, description: description, - } satisfies CreateWebLinkRequestBodyArg); + } satisfies CreateWebLinkRequestBody); if (!(weblink.url == url)) { throw 'Assertion failed'; } @@ -67,8 +67,8 @@ test('test_create_get_delete_weblink', async function test_create_get_delete_web sharedLink: { access: sharedAccess, password: password, - } satisfies UpdateWebLinkByIdRequestBodyArgSharedLinkField, - } satisfies UpdateWebLinkByIdRequestBodyArg + } satisfies UpdateWebLinkByIdRequestBodySharedLinkField, + } satisfies UpdateWebLinkByIdRequestBody ); if (!(updatedWeblink.name == updatedName)) { throw 'Assertion failed'; diff --git a/src/test/zipDownloads.generated.test.ts b/src/test/zipDownloads.generated.test.ts index 389de584..931524ac 100644 --- a/src/test/zipDownloads.generated.test.ts +++ b/src/test/zipDownloads.generated.test.ts @@ -6,8 +6,8 @@ import { serializeZipDownloadRequest } from '../schemas.generated.js'; import { deserializeZipDownloadRequest } from '../schemas.generated.js'; import { serializeZipDownloadRequestItemsField } from '../schemas.generated.js'; import { deserializeZipDownloadRequestItemsField } from '../schemas.generated.js'; -import { serializeZipDownloadRequestItemsFieldTypeField } from '../schemas.generated.js'; -import { deserializeZipDownloadRequestItemsFieldTypeField } from '../schemas.generated.js'; +import { serializeZipDownloadRequestItemsTypeField } from '../schemas.generated.js'; +import { deserializeZipDownloadRequestItemsTypeField } from '../schemas.generated.js'; import { serializeZipDownload } from '../schemas.generated.js'; import { deserializeZipDownload } from '../schemas.generated.js'; import { serializeZipDownloadStatus } from '../schemas.generated.js'; @@ -18,7 +18,7 @@ import { FolderFull } from '../schemas.generated.js'; import { ByteStream } from '../utils.js'; import { ZipDownloadRequest } from '../schemas.generated.js'; import { ZipDownloadRequestItemsField } from '../schemas.generated.js'; -import { ZipDownloadRequestItemsFieldTypeField } from '../schemas.generated.js'; +import { ZipDownloadRequestItemsTypeField } from '../schemas.generated.js'; import { ZipDownload } from '../schemas.generated.js'; import { ZipDownloadStatus } from '../schemas.generated.js'; import { getDefaultClient } from './commons.generated.js'; @@ -45,15 +45,15 @@ test('testZipDownload', async function testZipDownload(): Promise { items: [ { id: file1.id, - type: 'file' as ZipDownloadRequestItemsFieldTypeField, + type: 'file' as ZipDownloadRequestItemsTypeField, } satisfies ZipDownloadRequestItemsField, { id: file2.id, - type: 'file' as ZipDownloadRequestItemsFieldTypeField, + type: 'file' as ZipDownloadRequestItemsTypeField, } satisfies ZipDownloadRequestItemsField, { id: folder1.id, - type: 'folder' as ZipDownloadRequestItemsFieldTypeField, + type: 'folder' as ZipDownloadRequestItemsTypeField, } satisfies ZipDownloadRequestItemsField, ], downloadFileName: 'zip', @@ -78,15 +78,15 @@ test('testManualZipDownloadAndCheckStatus', async function testManualZipDownload items: [ { id: file1.id, - type: 'file' as ZipDownloadRequestItemsFieldTypeField, + type: 'file' as ZipDownloadRequestItemsTypeField, } satisfies ZipDownloadRequestItemsField, { id: file2.id, - type: 'file' as ZipDownloadRequestItemsFieldTypeField, + type: 'file' as ZipDownloadRequestItemsTypeField, } satisfies ZipDownloadRequestItemsField, { id: folder1.id, - type: 'folder' as ZipDownloadRequestItemsFieldTypeField, + type: 'folder' as ZipDownloadRequestItemsTypeField, } satisfies ZipDownloadRequestItemsField, ], downloadFileName: 'zip', From 54f390c9d801d0c165cf462431e7fe5c4d408620 Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Mon, 18 Dec 2023 01:11:12 -0800 Subject: [PATCH 7/8] generated with codegen at box/box-codegen@c6d3cfa and spec at box/box-openapi@fc21828 --- docs/authorization.md | 8 +- src/ccgAuth.ts | 2 +- src/jwtAuth.ts | 2 +- src/managers/authorization.generated.ts | 68 ++--- src/managers/integrationMappings.generated.ts | 96 +++--- .../metadataCascadePolicies.generated.ts | 51 ++-- .../retentionPolicyAssignments.generated.ts | 38 +-- src/managers/search.generated.ts | 115 +++---- src/managers/sessionTermination.generated.ts | 58 ++-- src/managers/sharedLinksFiles.generated.ts | 280 ++++++++--------- src/managers/sharedLinksFolders.generated.ts | 274 ++++++++--------- src/managers/sharedLinksWebLinks.generated.ts | 270 ++++++++--------- .../shieldInformationBarriers.generated.ts | 51 ++-- src/managers/skills.generated.ts | 286 ++++++++---------- .../termsOfServiceUserStatuses.generated.ts | 167 +++++----- src/managers/termsOfServices.generated.ts | 162 +++++----- src/managers/trashedFiles.generated.ts | 30 +- src/managers/trashedFolders.generated.ts | 30 +- src/managers/trashedItems.generated.ts | 44 +-- src/managers/trashedWebLinks.generated.ts | 32 +- src/managers/uploads.generated.ts | 50 +-- src/managers/workflows.generated.ts | 203 ++++++------- src/oauth.generated.ts | 8 +- src/test/classifications.generated.test.ts | 14 +- src/test/commons.generated.ts | 2 +- .../fileClassifications.generated.test.ts | 12 +- src/test/files.generated.test.ts | 2 +- .../folderClassifications.generated.test.ts | 12 +- .../metadataCascadePolicies.generated.test.ts | 24 +- src/test/search.generated.test.ts | 24 +- src/test/sessionTermination.generated.test.ts | 20 +- src/test/sharedLinksFiles.generated.test.ts | 83 +++-- src/test/sharedLinksFolders.generated.test.ts | 85 +++--- .../sharedLinksWebLinks.generated.test.ts | 85 +++--- ...hieldInformationBarriers.generated.test.ts | 18 +- src/test/trashedFiles.generated.test.ts | 8 +- src/test/trashedFolders.generated.test.ts | 9 +- src/test/trashedItems.generated.test.ts | 2 +- src/test/trashedWebLinks.generated.test.ts | 9 +- 39 files changed, 1346 insertions(+), 1388 deletions(-) diff --git a/docs/authorization.md b/docs/authorization.md index 6cad9ab7..546bea11 100644 --- a/docs/authorization.md +++ b/docs/authorization.md @@ -5,12 +5,12 @@ ## -This operation is performed by calling function `createOauth2Token`. +This operation is performed by calling function `requestAccessToken`. See the endpoint docs at [API Reference](https://developer.box.com/reference//). -_Currently we don't have an example for calling `createOauth2Token` in integration tests_ +_Currently we don't have an example for calling `requestAccessToken` in integration tests_ ### Arguments @@ -23,12 +23,12 @@ This function returns a value of type `AccessToken`. ## -This operation is performed by calling function `createOauth2Revoke`. +This operation is performed by calling function `revokeAccessToken`. See the endpoint docs at [API Reference](https://developer.box.com/reference//). -_Currently we don't have an example for calling `createOauth2Revoke` in integration tests_ +_Currently we don't have an example for calling `revokeAccessToken` in integration tests_ ### Arguments diff --git a/src/ccgAuth.ts b/src/ccgAuth.ts index bbee6c8c..fa5a9e14 100644 --- a/src/ccgAuth.ts +++ b/src/ccgAuth.ts @@ -69,7 +69,7 @@ export class BoxCcgAuth implements Authentication { const authManager: AuthorizationManager = !(networkSession == void 0) ? new AuthorizationManager({ networkSession: networkSession }) : new AuthorizationManager({}); - const newToken = await authManager.createOauth2Token({ + const newToken = await authManager.requestAccessToken({ grantType: 'client_credentials' satisfies TokenRequestGrantType, clientId: this.config.clientId, clientSecret: this.config.clientSecret, diff --git a/src/jwtAuth.ts b/src/jwtAuth.ts index e31768f5..c121e46c 100644 --- a/src/jwtAuth.ts +++ b/src/jwtAuth.ts @@ -217,7 +217,7 @@ export class BoxJwtAuth implements Authentication { const authManager: AuthorizationManager = !(networkSession == void 0) ? new AuthorizationManager({ networkSession: networkSession }) : new AuthorizationManager({}); - const newToken = await authManager.createOauth2Token({ + const newToken = await authManager.requestAccessToken({ grantType: BOX_JWT_GRANT_TYPE, assertion, clientId: this.config.clientId, diff --git a/src/managers/authorization.generated.ts b/src/managers/authorization.generated.ts index de601105..eacb706c 100644 --- a/src/managers/authorization.generated.ts +++ b/src/managers/authorization.generated.ts @@ -30,58 +30,58 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export type GetAuthorizeQueryParamsResponseTypeField = 'code'; -export interface GetAuthorizeQueryParams { - readonly responseType: GetAuthorizeQueryParamsResponseTypeField; +export type AuthorizeUserQueryParamsResponseTypeField = 'code'; +export interface AuthorizeUserQueryParams { + readonly responseType: AuthorizeUserQueryParamsResponseTypeField; readonly clientId: string; readonly redirectUri?: string; readonly state?: string; readonly scope?: string; } -export class GetAuthorizeHeaders { +export class AuthorizeUserHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class CreateOauth2TokenHeaders { +export class RequestAccessTokenHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class CreateOauth2TokenRefreshHeaders { +export class RefreshAccessTokenHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class CreateOauth2RevokeHeaders { +export class RevokeAccessTokenHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } @@ -94,18 +94,18 @@ export class AuthorizationManager { | Omit< AuthorizationManager, | 'networkSession' - | 'getAuthorize' - | 'createOauth2Token' - | 'createOauth2TokenRefresh' - | 'createOauth2Revoke' + | 'authorizeUser' + | 'requestAccessToken' + | 'refreshAccessToken' + | 'revokeAccessToken' > | Partial> ) { Object.assign(this, fields); } - async getAuthorize( - queryParams: GetAuthorizeQueryParams, - headers: GetAuthorizeHeaders = new GetAuthorizeHeaders({}), + async authorizeUser( + queryParams: AuthorizeUserQueryParams, + headers: AuthorizeUserHeaders = new AuthorizeUserHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -134,9 +134,9 @@ export class AuthorizationManager { )) as FetchResponse; return void 0; } - async createOauth2Token( + async requestAccessToken( requestBody: PostOAuth2Token, - headers: CreateOauth2TokenHeaders = new CreateOauth2TokenHeaders({}), + headers: RequestAccessTokenHeaders = new RequestAccessTokenHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -157,11 +157,9 @@ export class AuthorizationManager { )) as FetchResponse; return deserializeAccessToken(response.data); } - async createOauth2TokenRefresh( + async refreshAccessToken( requestBody: PostOAuth2TokenRefreshAccessToken, - headers: CreateOauth2TokenRefreshHeaders = new CreateOauth2TokenRefreshHeaders( - {} - ), + headers: RefreshAccessTokenHeaders = new RefreshAccessTokenHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -182,9 +180,9 @@ export class AuthorizationManager { )) as FetchResponse; return deserializeAccessToken(response.data); } - async createOauth2Revoke( + async revokeAccessToken( requestBody: PostOAuth2Revoke, - headers: CreateOauth2RevokeHeaders = new CreateOauth2RevokeHeaders({}), + headers: RevokeAccessTokenHeaders = new RevokeAccessTokenHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -206,16 +204,16 @@ export class AuthorizationManager { return void 0; } } -export function serializeGetAuthorizeQueryParamsResponseTypeField( - val: GetAuthorizeQueryParamsResponseTypeField +export function serializeAuthorizeUserQueryParamsResponseTypeField( + val: AuthorizeUserQueryParamsResponseTypeField ): SerializedData { return val; } -export function deserializeGetAuthorizeQueryParamsResponseTypeField( +export function deserializeAuthorizeUserQueryParamsResponseTypeField( val: any -): GetAuthorizeQueryParamsResponseTypeField { +): AuthorizeUserQueryParamsResponseTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetAuthorizeQueryParamsResponseTypeField"'; + throw 'Expecting a string for "AuthorizeUserQueryParamsResponseTypeField"'; } if (val == 'code') { return 'code'; diff --git a/src/managers/integrationMappings.generated.ts b/src/managers/integrationMappings.generated.ts index 8b3e55ba..ce3f6607 100644 --- a/src/managers/integrationMappings.generated.ts +++ b/src/managers/integrationMappings.generated.ts @@ -33,66 +33,66 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export type GetIntegrationMappingSlackQueryParamsPartnerItemTypeField = +export type GetSlackIntegrationMappingQueryParamsPartnerItemTypeField = 'channel'; -export type GetIntegrationMappingSlackQueryParamsBoxItemTypeField = 'folder'; -export interface GetIntegrationMappingSlackQueryParams { +export type GetSlackIntegrationMappingQueryParamsBoxItemTypeField = 'folder'; +export interface GetSlackIntegrationMappingQueryParams { readonly marker?: string; readonly limit?: number; - readonly partnerItemType?: GetIntegrationMappingSlackQueryParamsPartnerItemTypeField; + readonly partnerItemType?: GetSlackIntegrationMappingQueryParamsPartnerItemTypeField; readonly partnerItemId?: string; readonly boxItemId?: string; - readonly boxItemType?: GetIntegrationMappingSlackQueryParamsBoxItemTypeField; + readonly boxItemType?: GetSlackIntegrationMappingQueryParamsBoxItemTypeField; readonly isManuallyCreated?: boolean; } -export class GetIntegrationMappingSlackHeaders { +export class GetSlackIntegrationMappingHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class CreateIntegrationMappingSlackHeaders { +export class CreateSlackIntegrationMappingHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface UpdateIntegrationMappingSlackByIdRequestBody { +export interface UpdateSlackIntegrationMappingByIdRequestBody { readonly boxItem?: IntegrationMappingBoxItemSlack; readonly options?: IntegrationMappingSlackOptions; } -export class UpdateIntegrationMappingSlackByIdHeaders { +export class UpdateSlackIntegrationMappingByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteIntegrationMappingSlackByIdHeaders { +export class DeleteSlackIntegrationMappingByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } @@ -105,18 +105,18 @@ export class IntegrationMappingsManager { | Omit< IntegrationMappingsManager, | 'networkSession' - | 'getIntegrationMappingSlack' - | 'createIntegrationMappingSlack' - | 'updateIntegrationMappingSlackById' - | 'deleteIntegrationMappingSlackById' + | 'getSlackIntegrationMapping' + | 'createSlackIntegrationMapping' + | 'updateSlackIntegrationMappingById' + | 'deleteSlackIntegrationMappingById' > | Partial> ) { Object.assign(this, fields); } - async getIntegrationMappingSlack( - queryParams: GetIntegrationMappingSlackQueryParams = {} satisfies GetIntegrationMappingSlackQueryParams, - headers: GetIntegrationMappingSlackHeaders = new GetIntegrationMappingSlackHeaders( + async getSlackIntegrationMapping( + queryParams: GetSlackIntegrationMappingQueryParams = {} satisfies GetSlackIntegrationMappingQueryParams, + headers: GetSlackIntegrationMappingHeaders = new GetSlackIntegrationMappingHeaders( {} ), cancellationToken?: CancellationToken @@ -154,9 +154,9 @@ export class IntegrationMappingsManager { )) as FetchResponse; return deserializeIntegrationMappings(response.data); } - async createIntegrationMappingSlack( + async createSlackIntegrationMapping( requestBody: IntegrationMappingSlackCreateRequest, - headers: CreateIntegrationMappingSlackHeaders = new CreateIntegrationMappingSlackHeaders( + headers: CreateSlackIntegrationMappingHeaders = new CreateSlackIntegrationMappingHeaders( {} ), cancellationToken?: CancellationToken @@ -182,10 +182,10 @@ export class IntegrationMappingsManager { )) as FetchResponse; return deserializeIntegrationMapping(response.data); } - async updateIntegrationMappingSlackById( + async updateSlackIntegrationMappingById( integrationMappingId: string, - requestBody: UpdateIntegrationMappingSlackByIdRequestBody = {} satisfies UpdateIntegrationMappingSlackByIdRequestBody, - headers: UpdateIntegrationMappingSlackByIdHeaders = new UpdateIntegrationMappingSlackByIdHeaders( + requestBody: UpdateSlackIntegrationMappingByIdRequestBody = {} satisfies UpdateSlackIntegrationMappingByIdRequestBody, + headers: UpdateSlackIntegrationMappingByIdHeaders = new UpdateSlackIntegrationMappingByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -202,7 +202,7 @@ export class IntegrationMappingsManager { { method: 'PUT', headers: headersMap, - data: serializeUpdateIntegrationMappingSlackByIdRequestBody( + data: serializeUpdateSlackIntegrationMappingByIdRequestBody( requestBody ), contentType: 'application/json', @@ -214,9 +214,9 @@ export class IntegrationMappingsManager { )) as FetchResponse; return deserializeIntegrationMapping(response.data); } - async deleteIntegrationMappingSlackById( + async deleteSlackIntegrationMappingById( integrationMappingId: string, - headers: DeleteIntegrationMappingSlackByIdHeaders = new DeleteIntegrationMappingSlackByIdHeaders( + headers: DeleteSlackIntegrationMappingByIdHeaders = new DeleteSlackIntegrationMappingByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -242,40 +242,40 @@ export class IntegrationMappingsManager { return void 0; } } -export function serializeGetIntegrationMappingSlackQueryParamsPartnerItemTypeField( - val: GetIntegrationMappingSlackQueryParamsPartnerItemTypeField +export function serializeGetSlackIntegrationMappingQueryParamsPartnerItemTypeField( + val: GetSlackIntegrationMappingQueryParamsPartnerItemTypeField ): SerializedData { return val; } -export function deserializeGetIntegrationMappingSlackQueryParamsPartnerItemTypeField( +export function deserializeGetSlackIntegrationMappingQueryParamsPartnerItemTypeField( val: any -): GetIntegrationMappingSlackQueryParamsPartnerItemTypeField { +): GetSlackIntegrationMappingQueryParamsPartnerItemTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetIntegrationMappingSlackQueryParamsPartnerItemTypeField"'; + throw 'Expecting a string for "GetSlackIntegrationMappingQueryParamsPartnerItemTypeField"'; } if (val == 'channel') { return 'channel'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeGetIntegrationMappingSlackQueryParamsBoxItemTypeField( - val: GetIntegrationMappingSlackQueryParamsBoxItemTypeField +export function serializeGetSlackIntegrationMappingQueryParamsBoxItemTypeField( + val: GetSlackIntegrationMappingQueryParamsBoxItemTypeField ): SerializedData { return val; } -export function deserializeGetIntegrationMappingSlackQueryParamsBoxItemTypeField( +export function deserializeGetSlackIntegrationMappingQueryParamsBoxItemTypeField( val: any -): GetIntegrationMappingSlackQueryParamsBoxItemTypeField { +): GetSlackIntegrationMappingQueryParamsBoxItemTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetIntegrationMappingSlackQueryParamsBoxItemTypeField"'; + throw 'Expecting a string for "GetSlackIntegrationMappingQueryParamsBoxItemTypeField"'; } if (val == 'folder') { return 'folder'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateIntegrationMappingSlackByIdRequestBody( - val: UpdateIntegrationMappingSlackByIdRequestBody +export function serializeUpdateSlackIntegrationMappingByIdRequestBody( + val: UpdateSlackIntegrationMappingByIdRequestBody ): SerializedData { return { ['box_item']: @@ -288,9 +288,9 @@ export function serializeUpdateIntegrationMappingSlackByIdRequestBody( : serializeIntegrationMappingSlackOptions(val.options), }; } -export function deserializeUpdateIntegrationMappingSlackByIdRequestBody( +export function deserializeUpdateSlackIntegrationMappingByIdRequestBody( val: any -): UpdateIntegrationMappingSlackByIdRequestBody { +): UpdateSlackIntegrationMappingByIdRequestBody { const boxItem: undefined | IntegrationMappingBoxItemSlack = val.box_item == void 0 ? void 0 @@ -302,5 +302,5 @@ export function deserializeUpdateIntegrationMappingSlackByIdRequestBody( return { boxItem: boxItem, options: options, - } satisfies UpdateIntegrationMappingSlackByIdRequestBody; + } satisfies UpdateSlackIntegrationMappingByIdRequestBody; } diff --git a/src/managers/metadataCascadePolicies.generated.ts b/src/managers/metadataCascadePolicies.generated.ts index f50d78cd..9bfa7501 100644 --- a/src/managers/metadataCascadePolicies.generated.ts +++ b/src/managers/metadataCascadePolicies.generated.ts @@ -89,19 +89,20 @@ export class DeleteMetadataCascadePolicyByIdHeaders { Object.assign(this, fields); } } -export type CreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField = - 'none' | 'overwrite'; -export interface CreateMetadataCascadePolicyApplyRequestBody { - readonly conflictResolution: CreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField; +export type ApplyMetadataCascadePolicyRequestBodyConflictResolutionField = + | 'none' + | 'overwrite'; +export interface ApplyMetadataCascadePolicyRequestBody { + readonly conflictResolution: ApplyMetadataCascadePolicyRequestBodyConflictResolutionField; } -export class CreateMetadataCascadePolicyApplyHeaders { +export class ApplyMetadataCascadePolicyHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } @@ -118,7 +119,7 @@ export class MetadataCascadePoliciesManager { | 'createMetadataCascadePolicy' | 'getMetadataCascadePolicyById' | 'deleteMetadataCascadePolicyById' - | 'createMetadataCascadePolicyApply' + | 'applyMetadataCascadePolicy' > | Partial> ) { @@ -243,10 +244,10 @@ export class MetadataCascadePoliciesManager { )) as FetchResponse; return void 0; } - async createMetadataCascadePolicyApply( + async applyMetadataCascadePolicy( metadataCascadePolicyId: string, - requestBody: CreateMetadataCascadePolicyApplyRequestBody, - headers: CreateMetadataCascadePolicyApplyHeaders = new CreateMetadataCascadePolicyApplyHeaders( + requestBody: ApplyMetadataCascadePolicyRequestBody, + headers: ApplyMetadataCascadePolicyHeaders = new ApplyMetadataCascadePolicyHeaders( {} ), cancellationToken?: CancellationToken @@ -264,7 +265,7 @@ export class MetadataCascadePoliciesManager { { method: 'POST', headers: headersMap, - data: serializeCreateMetadataCascadePolicyApplyRequestBody(requestBody), + data: serializeApplyMetadataCascadePolicyRequestBody(requestBody), contentType: 'application/json', responseFormat: void 0, auth: this.auth, @@ -318,16 +319,16 @@ export function deserializeCreateMetadataCascadePolicyRequestBody( templateKey: templateKey, } satisfies CreateMetadataCascadePolicyRequestBody; } -export function serializeCreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField( - val: CreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField +export function serializeApplyMetadataCascadePolicyRequestBodyConflictResolutionField( + val: ApplyMetadataCascadePolicyRequestBodyConflictResolutionField ): SerializedData { return val; } -export function deserializeCreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField( +export function deserializeApplyMetadataCascadePolicyRequestBodyConflictResolutionField( val: any -): CreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField { +): ApplyMetadataCascadePolicyRequestBodyConflictResolutionField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField"'; + throw 'Expecting a string for "ApplyMetadataCascadePolicyRequestBodyConflictResolutionField"'; } if (val == 'none') { return 'none'; @@ -337,24 +338,24 @@ export function deserializeCreateMetadataCascadePolicyApplyRequestBodyConflictRe } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateMetadataCascadePolicyApplyRequestBody( - val: CreateMetadataCascadePolicyApplyRequestBody +export function serializeApplyMetadataCascadePolicyRequestBody( + val: ApplyMetadataCascadePolicyRequestBody ): SerializedData { return { ['conflict_resolution']: - serializeCreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField( + serializeApplyMetadataCascadePolicyRequestBodyConflictResolutionField( val.conflictResolution ), }; } -export function deserializeCreateMetadataCascadePolicyApplyRequestBody( +export function deserializeApplyMetadataCascadePolicyRequestBody( val: any -): CreateMetadataCascadePolicyApplyRequestBody { - const conflictResolution: CreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField = - deserializeCreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField( +): ApplyMetadataCascadePolicyRequestBody { + const conflictResolution: ApplyMetadataCascadePolicyRequestBodyConflictResolutionField = + deserializeApplyMetadataCascadePolicyRequestBodyConflictResolutionField( val.conflict_resolution ); return { conflictResolution: conflictResolution, - } satisfies CreateMetadataCascadePolicyApplyRequestBody; + } satisfies ApplyMetadataCascadePolicyRequestBody; } diff --git a/src/managers/retentionPolicyAssignments.generated.ts b/src/managers/retentionPolicyAssignments.generated.ts index 40000f49..e43d03d0 100644 --- a/src/managers/retentionPolicyAssignments.generated.ts +++ b/src/managers/retentionPolicyAssignments.generated.ts @@ -108,47 +108,41 @@ export class DeleteRetentionPolicyAssignmentByIdHeaders { Object.assign(this, fields); } } -export interface GetRetentionPolicyAssignmentFileUnderRetentionQueryParams { +export interface GetFilesUnderRetentionPolicyAssignmentQueryParams { readonly marker?: string; readonly limit?: number; } -export class GetRetentionPolicyAssignmentFileUnderRetentionHeaders { +export class GetFilesUnderRetentionPolicyAssignmentHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit< - GetRetentionPolicyAssignmentFileUnderRetentionHeaders, - 'extraHeaders' - > + | Omit | Partial< - Pick< - GetRetentionPolicyAssignmentFileUnderRetentionHeaders, - 'extraHeaders' - > + Pick > ) { Object.assign(this, fields); } } -export interface GetRetentionPolicyAssignmentFileVersionUnderRetentionQueryParams { +export interface GetFileVersionsUnderRetentionPolicyAssignmentQueryParams { readonly marker?: string; readonly limit?: number; } -export class GetRetentionPolicyAssignmentFileVersionUnderRetentionHeaders { +export class GetFileVersionsUnderRetentionPolicyAssignmentHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: | Omit< - GetRetentionPolicyAssignmentFileVersionUnderRetentionHeaders, + GetFileVersionsUnderRetentionPolicyAssignmentHeaders, 'extraHeaders' > | Partial< Pick< - GetRetentionPolicyAssignmentFileVersionUnderRetentionHeaders, + GetFileVersionsUnderRetentionPolicyAssignmentHeaders, 'extraHeaders' > > @@ -168,8 +162,8 @@ export class RetentionPolicyAssignmentsManager { | 'createRetentionPolicyAssignment' | 'getRetentionPolicyAssignmentById' | 'deleteRetentionPolicyAssignmentById' - | 'getRetentionPolicyAssignmentFileUnderRetention' - | 'getRetentionPolicyAssignmentFileVersionUnderRetention' + | 'getFilesUnderRetentionPolicyAssignment' + | 'getFileVersionsUnderRetentionPolicyAssignment' > | Partial> ) { @@ -306,10 +300,10 @@ export class RetentionPolicyAssignmentsManager { )) as FetchResponse; return void 0; } - async getRetentionPolicyAssignmentFileUnderRetention( + async getFilesUnderRetentionPolicyAssignment( retentionPolicyAssignmentId: string, - queryParams: GetRetentionPolicyAssignmentFileUnderRetentionQueryParams = {} satisfies GetRetentionPolicyAssignmentFileUnderRetentionQueryParams, - headers: GetRetentionPolicyAssignmentFileUnderRetentionHeaders = new GetRetentionPolicyAssignmentFileUnderRetentionHeaders( + queryParams: GetFilesUnderRetentionPolicyAssignmentQueryParams = {} satisfies GetFilesUnderRetentionPolicyAssignmentQueryParams, + headers: GetFilesUnderRetentionPolicyAssignmentHeaders = new GetFilesUnderRetentionPolicyAssignmentHeaders( {} ), cancellationToken?: CancellationToken @@ -342,10 +336,10 @@ export class RetentionPolicyAssignmentsManager { )) as FetchResponse; return deserializeFilesUnderRetention(response.data); } - async getRetentionPolicyAssignmentFileVersionUnderRetention( + async getFileVersionsUnderRetentionPolicyAssignment( retentionPolicyAssignmentId: string, - queryParams: GetRetentionPolicyAssignmentFileVersionUnderRetentionQueryParams = {} satisfies GetRetentionPolicyAssignmentFileVersionUnderRetentionQueryParams, - headers: GetRetentionPolicyAssignmentFileVersionUnderRetentionHeaders = new GetRetentionPolicyAssignmentFileVersionUnderRetentionHeaders( + queryParams: GetFileVersionsUnderRetentionPolicyAssignmentQueryParams = {} satisfies GetFileVersionsUnderRetentionPolicyAssignmentQueryParams, + headers: GetFileVersionsUnderRetentionPolicyAssignmentHeaders = new GetFileVersionsUnderRetentionPolicyAssignmentHeaders( {} ), cancellationToken?: CancellationToken diff --git a/src/managers/search.generated.ts b/src/managers/search.generated.ts index 7773b604..ee2cfd82 100644 --- a/src/managers/search.generated.ts +++ b/src/managers/search.generated.ts @@ -33,14 +33,14 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class CreateMetadataQueryExecuteReadHeaders { +export class SearchByMetadataQueryHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } @@ -64,25 +64,28 @@ export class GetMetadataQueryIndicesHeaders { Object.assign(this, fields); } } -export type GetSearchQueryParamsScopeField = +export type SearchForContentQueryParamsScopeField = | 'user_content' | 'enterprise_content'; -export type GetSearchQueryParamsContentTypesField = +export type SearchForContentQueryParamsContentTypesField = | 'name' | 'description' | 'file_content' | 'comments' | 'tag'; -export type GetSearchQueryParamsTypeField = 'file' | 'folder' | 'web_link'; -export type GetSearchQueryParamsTrashContentField = +export type SearchForContentQueryParamsTypeField = + | 'file' + | 'folder' + | 'web_link'; +export type SearchForContentQueryParamsTrashContentField = | 'non_trashed_only' | 'trashed_only' | 'all_items'; -export type GetSearchQueryParamsSortField = 'modified_at' | 'relevance'; -export type GetSearchQueryParamsDirectionField = 'DESC' | 'ASC'; -export interface GetSearchQueryParams { +export type SearchForContentQueryParamsSortField = 'modified_at' | 'relevance'; +export type SearchForContentQueryParamsDirectionField = 'DESC' | 'ASC'; +export interface SearchForContentQueryParams { readonly query?: string; - readonly scope?: GetSearchQueryParamsScopeField; + readonly scope?: SearchForContentQueryParamsScopeField; readonly fileExtensions?: readonly string[]; readonly createdAtRange?: readonly string[]; readonly updatedAtRange?: readonly string[]; @@ -90,12 +93,12 @@ export interface GetSearchQueryParams { readonly ownerUserIds?: readonly string[]; readonly recentUpdaterUserIds?: readonly string[]; readonly ancestorFolderIds?: readonly string[]; - readonly contentTypes?: readonly GetSearchQueryParamsContentTypesField[]; - readonly type?: GetSearchQueryParamsTypeField; - readonly trashContent?: GetSearchQueryParamsTrashContentField; + readonly contentTypes?: readonly SearchForContentQueryParamsContentTypesField[]; + readonly type?: SearchForContentQueryParamsTypeField; + readonly trashContent?: SearchForContentQueryParamsTrashContentField; readonly mdfilters?: readonly MetadataFilter[]; - readonly sort?: GetSearchQueryParamsSortField; - readonly direction?: GetSearchQueryParamsDirectionField; + readonly sort?: SearchForContentQueryParamsSortField; + readonly direction?: SearchForContentQueryParamsDirectionField; readonly limit?: number; readonly includeRecentSharedLinks?: boolean; readonly fields?: readonly string[]; @@ -103,14 +106,14 @@ export interface GetSearchQueryParams { readonly deletedUserIds?: readonly string[]; readonly deletedAtRange?: readonly string[]; } -export class GetSearchHeaders { +export class SearchForContentHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } @@ -123,17 +126,17 @@ export class SearchManager { | Omit< SearchManager, | 'networkSession' - | 'createMetadataQueryExecuteRead' + | 'searchByMetadataQuery' | 'getMetadataQueryIndices' - | 'getSearch' + | 'searchForContent' > | Partial> ) { Object.assign(this, fields); } - async createMetadataQueryExecuteRead( + async searchByMetadataQuery( requestBody: MetadataQuery, - headers: CreateMetadataQueryExecuteReadHeaders = new CreateMetadataQueryExecuteReadHeaders( + headers: SearchByMetadataQueryHeaders = new SearchByMetadataQueryHeaders( {} ), cancellationToken?: CancellationToken @@ -192,9 +195,9 @@ export class SearchManager { )) as FetchResponse; return deserializeMetadataQueryIndices(response.data); } - async getSearch( - queryParams: GetSearchQueryParams = {} satisfies GetSearchQueryParams, - headers: GetSearchHeaders = new GetSearchHeaders({}), + async searchForContent( + queryParams: SearchForContentQueryParams = {} satisfies SearchForContentQueryParams, + headers: SearchForContentHeaders = new SearchForContentHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -287,16 +290,16 @@ export function deserializeGetMetadataQueryIndicesQueryParamsScopeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeGetSearchQueryParamsScopeField( - val: GetSearchQueryParamsScopeField +export function serializeSearchForContentQueryParamsScopeField( + val: SearchForContentQueryParamsScopeField ): SerializedData { return val; } -export function deserializeGetSearchQueryParamsScopeField( +export function deserializeSearchForContentQueryParamsScopeField( val: any -): GetSearchQueryParamsScopeField { +): SearchForContentQueryParamsScopeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetSearchQueryParamsScopeField"'; + throw 'Expecting a string for "SearchForContentQueryParamsScopeField"'; } if (val == 'user_content') { return 'user_content'; @@ -306,16 +309,16 @@ export function deserializeGetSearchQueryParamsScopeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeGetSearchQueryParamsContentTypesField( - val: GetSearchQueryParamsContentTypesField +export function serializeSearchForContentQueryParamsContentTypesField( + val: SearchForContentQueryParamsContentTypesField ): SerializedData { return val; } -export function deserializeGetSearchQueryParamsContentTypesField( +export function deserializeSearchForContentQueryParamsContentTypesField( val: any -): GetSearchQueryParamsContentTypesField { +): SearchForContentQueryParamsContentTypesField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetSearchQueryParamsContentTypesField"'; + throw 'Expecting a string for "SearchForContentQueryParamsContentTypesField"'; } if (val == 'name') { return 'name'; @@ -334,16 +337,16 @@ export function deserializeGetSearchQueryParamsContentTypesField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeGetSearchQueryParamsTypeField( - val: GetSearchQueryParamsTypeField +export function serializeSearchForContentQueryParamsTypeField( + val: SearchForContentQueryParamsTypeField ): SerializedData { return val; } -export function deserializeGetSearchQueryParamsTypeField( +export function deserializeSearchForContentQueryParamsTypeField( val: any -): GetSearchQueryParamsTypeField { +): SearchForContentQueryParamsTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetSearchQueryParamsTypeField"'; + throw 'Expecting a string for "SearchForContentQueryParamsTypeField"'; } if (val == 'file') { return 'file'; @@ -356,16 +359,16 @@ export function deserializeGetSearchQueryParamsTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeGetSearchQueryParamsTrashContentField( - val: GetSearchQueryParamsTrashContentField +export function serializeSearchForContentQueryParamsTrashContentField( + val: SearchForContentQueryParamsTrashContentField ): SerializedData { return val; } -export function deserializeGetSearchQueryParamsTrashContentField( +export function deserializeSearchForContentQueryParamsTrashContentField( val: any -): GetSearchQueryParamsTrashContentField { +): SearchForContentQueryParamsTrashContentField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetSearchQueryParamsTrashContentField"'; + throw 'Expecting a string for "SearchForContentQueryParamsTrashContentField"'; } if (val == 'non_trashed_only') { return 'non_trashed_only'; @@ -378,16 +381,16 @@ export function deserializeGetSearchQueryParamsTrashContentField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeGetSearchQueryParamsSortField( - val: GetSearchQueryParamsSortField +export function serializeSearchForContentQueryParamsSortField( + val: SearchForContentQueryParamsSortField ): SerializedData { return val; } -export function deserializeGetSearchQueryParamsSortField( +export function deserializeSearchForContentQueryParamsSortField( val: any -): GetSearchQueryParamsSortField { +): SearchForContentQueryParamsSortField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetSearchQueryParamsSortField"'; + throw 'Expecting a string for "SearchForContentQueryParamsSortField"'; } if (val == 'modified_at') { return 'modified_at'; @@ -397,16 +400,16 @@ export function deserializeGetSearchQueryParamsSortField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeGetSearchQueryParamsDirectionField( - val: GetSearchQueryParamsDirectionField +export function serializeSearchForContentQueryParamsDirectionField( + val: SearchForContentQueryParamsDirectionField ): SerializedData { return val; } -export function deserializeGetSearchQueryParamsDirectionField( +export function deserializeSearchForContentQueryParamsDirectionField( val: any -): GetSearchQueryParamsDirectionField { +): SearchForContentQueryParamsDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetSearchQueryParamsDirectionField"'; + throw 'Expecting a string for "SearchForContentQueryParamsDirectionField"'; } if (val == 'DESC') { return 'DESC'; diff --git a/src/managers/sessionTermination.generated.ts b/src/managers/sessionTermination.generated.ts index d87e4813..edd917d7 100644 --- a/src/managers/sessionTermination.generated.ts +++ b/src/managers/sessionTermination.generated.ts @@ -20,33 +20,33 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface CreateUserTerminateSessionRequestBody { +export interface TerminateUsersSessionsRequestBody { readonly userIds: readonly string[]; readonly userLogins: readonly string[]; } -export class CreateUserTerminateSessionHeaders { +export class TerminateUsersSessionsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface CreateGroupTerminateSessionRequestBody { +export interface TerminateGroupsSessionsRequestBody { readonly groupIds: readonly string[]; } -export class CreateGroupTerminateSessionHeaders { +export class TerminateGroupsSessionsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } @@ -59,16 +59,16 @@ export class SessionTerminationManager { | Omit< SessionTerminationManager, | 'networkSession' - | 'createUserTerminateSession' - | 'createGroupTerminateSession' + | 'terminateUsersSessions' + | 'terminateGroupsSessions' > | Partial> ) { Object.assign(this, fields); } - async createUserTerminateSession( - requestBody: CreateUserTerminateSessionRequestBody, - headers: CreateUserTerminateSessionHeaders = new CreateUserTerminateSessionHeaders( + async terminateUsersSessions( + requestBody: TerminateUsersSessionsRequestBody, + headers: TerminateUsersSessionsHeaders = new TerminateUsersSessionsHeaders( {} ), cancellationToken?: CancellationToken @@ -84,7 +84,7 @@ export class SessionTerminationManager { { method: 'POST', headers: headersMap, - data: serializeCreateUserTerminateSessionRequestBody(requestBody), + data: serializeTerminateUsersSessionsRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -94,9 +94,9 @@ export class SessionTerminationManager { )) as FetchResponse; return deserializeSessionTerminationMessage(response.data); } - async createGroupTerminateSession( - requestBody: CreateGroupTerminateSessionRequestBody, - headers: CreateGroupTerminateSessionHeaders = new CreateGroupTerminateSessionHeaders( + async terminateGroupsSessions( + requestBody: TerminateGroupsSessionsRequestBody, + headers: TerminateGroupsSessionsHeaders = new TerminateGroupsSessionsHeaders( {} ), cancellationToken?: CancellationToken @@ -112,7 +112,7 @@ export class SessionTerminationManager { { method: 'POST', headers: headersMap, - data: serializeCreateGroupTerminateSessionRequestBody(requestBody), + data: serializeTerminateGroupsSessionsRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -123,8 +123,8 @@ export class SessionTerminationManager { return deserializeSessionTerminationMessage(response.data); } } -export function serializeCreateUserTerminateSessionRequestBody( - val: CreateUserTerminateSessionRequestBody +export function serializeTerminateUsersSessionsRequestBody( + val: TerminateUsersSessionsRequestBody ): SerializedData { return { ['user_ids']: val.userIds.map(function (item: string): any { @@ -135,9 +135,9 @@ export function serializeCreateUserTerminateSessionRequestBody( }) as readonly any[], }; } -export function deserializeCreateUserTerminateSessionRequestBody( +export function deserializeTerminateUsersSessionsRequestBody( val: any -): CreateUserTerminateSessionRequestBody { +): TerminateUsersSessionsRequestBody { const userIds: readonly string[] = sdIsList(val.user_ids) ? (val.user_ids.map(function (itm: SerializedData): any { return itm; @@ -151,10 +151,10 @@ export function deserializeCreateUserTerminateSessionRequestBody( return { userIds: userIds, userLogins: userLogins, - } satisfies CreateUserTerminateSessionRequestBody; + } satisfies TerminateUsersSessionsRequestBody; } -export function serializeCreateGroupTerminateSessionRequestBody( - val: CreateGroupTerminateSessionRequestBody +export function serializeTerminateGroupsSessionsRequestBody( + val: TerminateGroupsSessionsRequestBody ): SerializedData { return { ['group_ids']: val.groupIds.map(function (item: string): any { @@ -162,15 +162,13 @@ export function serializeCreateGroupTerminateSessionRequestBody( }) as readonly any[], }; } -export function deserializeCreateGroupTerminateSessionRequestBody( +export function deserializeTerminateGroupsSessionsRequestBody( val: any -): CreateGroupTerminateSessionRequestBody { +): TerminateGroupsSessionsRequestBody { const groupIds: readonly string[] = sdIsList(val.group_ids) ? (val.group_ids.map(function (itm: SerializedData): any { return itm; }) as readonly any[]) : []; - return { - groupIds: groupIds, - } satisfies CreateGroupTerminateSessionRequestBody; + return { groupIds: groupIds } satisfies TerminateGroupsSessionsRequestBody; } diff --git a/src/managers/sharedLinksFiles.generated.ts b/src/managers/sharedLinksFiles.generated.ts index ab6644a5..b794c215 100644 --- a/src/managers/sharedLinksFiles.generated.ts +++ b/src/managers/sharedLinksFiles.generated.ts @@ -21,10 +21,10 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetSharedItemsQueryParams { +export interface FindFileForSharedLinkQueryParams { readonly fields?: readonly string[]; } -export class GetSharedItemsHeaders { +export class FindFileForSharedLinkHeaders { readonly ifNoneMatch?: string; readonly boxapi!: string; readonly extraHeaders?: { @@ -32,110 +32,110 @@ export class GetSharedItemsHeaders { } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetFileGetSharedLinkQueryParams { +export interface GetSharedLinkForFileQueryParams { readonly fields: string; } -export class GetFileGetSharedLinkHeaders { +export class GetSharedLinkForFileHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateFileAddSharedLinkRequestBodySharedLinkAccessField = +export type AddShareLinkToFileRequestBodySharedLinkAccessField = | 'open' | 'company' | 'collaborators'; -export interface UpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField { +export interface AddShareLinkToFileRequestBodySharedLinkPermissionsField { readonly canDownload?: boolean; readonly canPreview?: boolean; readonly canEdit?: boolean; } -export interface UpdateFileAddSharedLinkRequestBodySharedLinkField { - readonly access?: UpdateFileAddSharedLinkRequestBodySharedLinkAccessField; +export interface AddShareLinkToFileRequestBodySharedLinkField { + readonly access?: AddShareLinkToFileRequestBodySharedLinkAccessField; readonly password?: string; readonly vanityName?: string; readonly unsharedAt?: string; - readonly permissions?: UpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField; + readonly permissions?: AddShareLinkToFileRequestBodySharedLinkPermissionsField; } -export interface UpdateFileAddSharedLinkRequestBody { - readonly sharedLink?: UpdateFileAddSharedLinkRequestBodySharedLinkField; +export interface AddShareLinkToFileRequestBody { + readonly sharedLink?: AddShareLinkToFileRequestBodySharedLinkField; } -export interface UpdateFileAddSharedLinkQueryParams { +export interface AddShareLinkToFileQueryParams { readonly fields: string; } -export class UpdateFileAddSharedLinkHeaders { +export class AddShareLinkToFileHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField = +export type UpdateSharedLinkOnFileRequestBodySharedLinkAccessField = | 'open' | 'company' | 'collaborators'; -export interface UpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField { +export interface UpdateSharedLinkOnFileRequestBodySharedLinkPermissionsField { readonly canDownload?: boolean; readonly canPreview?: boolean; readonly canEdit?: boolean; } -export interface UpdateFileUpdateSharedLinkRequestBodySharedLinkField { - readonly access?: UpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField; +export interface UpdateSharedLinkOnFileRequestBodySharedLinkField { + readonly access?: UpdateSharedLinkOnFileRequestBodySharedLinkAccessField; readonly password?: string; readonly vanityName?: string; readonly unsharedAt?: string; - readonly permissions?: UpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField; + readonly permissions?: UpdateSharedLinkOnFileRequestBodySharedLinkPermissionsField; } -export interface UpdateFileUpdateSharedLinkRequestBody { - readonly sharedLink?: UpdateFileUpdateSharedLinkRequestBodySharedLinkField; +export interface UpdateSharedLinkOnFileRequestBody { + readonly sharedLink?: UpdateSharedLinkOnFileRequestBodySharedLinkField; } -export interface UpdateFileUpdateSharedLinkQueryParams { +export interface UpdateSharedLinkOnFileQueryParams { readonly fields: string; } -export class UpdateFileUpdateSharedLinkHeaders { +export class UpdateSharedLinkOnFileHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface UpdateFileRemoveSharedLinkRequestBodySharedLinkField {} -export interface UpdateFileRemoveSharedLinkRequestBody { - readonly sharedLink?: UpdateFileRemoveSharedLinkRequestBodySharedLinkField; +export interface RemoveSharedLinkFromFileRequestBodySharedLinkField {} +export interface RemoveSharedLinkFromFileRequestBody { + readonly sharedLink?: RemoveSharedLinkFromFileRequestBodySharedLinkField; } -export interface UpdateFileRemoveSharedLinkQueryParams { +export interface RemoveSharedLinkFromFileQueryParams { readonly fields: string; } -export class UpdateFileRemoveSharedLinkHeaders { +export class RemoveSharedLinkFromFileHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } @@ -148,19 +148,19 @@ export class SharedLinksFilesManager { | Omit< SharedLinksFilesManager, | 'networkSession' - | 'getSharedItems' - | 'getFileGetSharedLink' - | 'updateFileAddSharedLink' - | 'updateFileUpdateSharedLink' - | 'updateFileRemoveSharedLink' + | 'findFileForSharedLink' + | 'getSharedLinkForFile' + | 'addShareLinkToFile' + | 'updateSharedLinkOnFile' + | 'removeSharedLinkFromFile' > | Partial> ) { Object.assign(this, fields); } - async getSharedItems( - queryParams: GetSharedItemsQueryParams = {} satisfies GetSharedItemsQueryParams, - headers: GetSharedItemsHeaders, + async findFileForSharedLink( + queryParams: FindFileForSharedLinkQueryParams = {} satisfies FindFileForSharedLinkQueryParams, + headers: FindFileForSharedLinkHeaders, cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -196,10 +196,10 @@ export class SharedLinksFilesManager { )) as FetchResponse; return deserializeFileFull(response.data); } - async getFileGetSharedLink( + async getSharedLinkForFile( fileId: string, - queryParams: GetFileGetSharedLinkQueryParams, - headers: GetFileGetSharedLinkHeaders = new GetFileGetSharedLinkHeaders({}), + queryParams: GetSharedLinkForFileQueryParams, + headers: GetSharedLinkForFileHeaders = new GetSharedLinkForFileHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -227,13 +227,11 @@ export class SharedLinksFilesManager { )) as FetchResponse; return deserializeFileFull(response.data); } - async updateFileAddSharedLink( + async addShareLinkToFile( fileId: string, - requestBody: UpdateFileAddSharedLinkRequestBody = {} satisfies UpdateFileAddSharedLinkRequestBody, - queryParams: UpdateFileAddSharedLinkQueryParams, - headers: UpdateFileAddSharedLinkHeaders = new UpdateFileAddSharedLinkHeaders( - {} - ), + requestBody: AddShareLinkToFileRequestBody = {} satisfies AddShareLinkToFileRequestBody, + queryParams: AddShareLinkToFileQueryParams, + headers: AddShareLinkToFileHeaders = new AddShareLinkToFileHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -253,7 +251,7 @@ export class SharedLinksFilesManager { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateFileAddSharedLinkRequestBody(requestBody), + data: serializeAddShareLinkToFileRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -263,11 +261,11 @@ export class SharedLinksFilesManager { )) as FetchResponse; return deserializeFileFull(response.data); } - async updateFileUpdateSharedLink( + async updateSharedLinkOnFile( fileId: string, - requestBody: UpdateFileUpdateSharedLinkRequestBody = {} satisfies UpdateFileUpdateSharedLinkRequestBody, - queryParams: UpdateFileUpdateSharedLinkQueryParams, - headers: UpdateFileUpdateSharedLinkHeaders = new UpdateFileUpdateSharedLinkHeaders( + requestBody: UpdateSharedLinkOnFileRequestBody = {} satisfies UpdateSharedLinkOnFileRequestBody, + queryParams: UpdateSharedLinkOnFileQueryParams, + headers: UpdateSharedLinkOnFileHeaders = new UpdateSharedLinkOnFileHeaders( {} ), cancellationToken?: CancellationToken @@ -289,7 +287,7 @@ export class SharedLinksFilesManager { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateFileUpdateSharedLinkRequestBody(requestBody), + data: serializeUpdateSharedLinkOnFileRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -299,11 +297,11 @@ export class SharedLinksFilesManager { )) as FetchResponse; return deserializeFileFull(response.data); } - async updateFileRemoveSharedLink( + async removeSharedLinkFromFile( fileId: string, - requestBody: UpdateFileRemoveSharedLinkRequestBody = {} satisfies UpdateFileRemoveSharedLinkRequestBody, - queryParams: UpdateFileRemoveSharedLinkQueryParams, - headers: UpdateFileRemoveSharedLinkHeaders = new UpdateFileRemoveSharedLinkHeaders( + requestBody: RemoveSharedLinkFromFileRequestBody = {} satisfies RemoveSharedLinkFromFileRequestBody, + queryParams: RemoveSharedLinkFromFileQueryParams, + headers: RemoveSharedLinkFromFileHeaders = new RemoveSharedLinkFromFileHeaders( {} ), cancellationToken?: CancellationToken @@ -325,7 +323,7 @@ export class SharedLinksFilesManager { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateFileRemoveSharedLinkRequestBody(requestBody), + data: serializeRemoveSharedLinkFromFileRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -336,16 +334,16 @@ export class SharedLinksFilesManager { return deserializeFileFull(response.data); } } -export function serializeUpdateFileAddSharedLinkRequestBodySharedLinkAccessField( - val: UpdateFileAddSharedLinkRequestBodySharedLinkAccessField +export function serializeAddShareLinkToFileRequestBodySharedLinkAccessField( + val: AddShareLinkToFileRequestBodySharedLinkAccessField ): SerializedData { return val; } -export function deserializeUpdateFileAddSharedLinkRequestBodySharedLinkAccessField( +export function deserializeAddShareLinkToFileRequestBodySharedLinkAccessField( val: any -): UpdateFileAddSharedLinkRequestBodySharedLinkAccessField { +): AddShareLinkToFileRequestBodySharedLinkAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFileAddSharedLinkRequestBodySharedLinkAccessField"'; + throw 'Expecting a string for "AddShareLinkToFileRequestBodySharedLinkAccessField"'; } if (val == 'open') { return 'open'; @@ -358,8 +356,8 @@ export function deserializeUpdateFileAddSharedLinkRequestBodySharedLinkAccessFie } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField( - val: UpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField +export function serializeAddShareLinkToFileRequestBodySharedLinkPermissionsField( + val: AddShareLinkToFileRequestBodySharedLinkPermissionsField ): SerializedData { return { ['can_download']: val.canDownload == void 0 ? void 0 : val.canDownload, @@ -367,9 +365,9 @@ export function serializeUpdateFileAddSharedLinkRequestBodySharedLinkPermissions ['can_edit']: val.canEdit == void 0 ? void 0 : val.canEdit, }; } -export function deserializeUpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField( +export function deserializeAddShareLinkToFileRequestBodySharedLinkPermissionsField( val: any -): UpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField { +): AddShareLinkToFileRequestBodySharedLinkPermissionsField { const canDownload: undefined | boolean = val.can_download == void 0 ? void 0 : val.can_download; const canPreview: undefined | boolean = @@ -380,16 +378,16 @@ export function deserializeUpdateFileAddSharedLinkRequestBodySharedLinkPermissio canDownload: canDownload, canPreview: canPreview, canEdit: canEdit, - } satisfies UpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField; + } satisfies AddShareLinkToFileRequestBodySharedLinkPermissionsField; } -export function serializeUpdateFileAddSharedLinkRequestBodySharedLinkField( - val: UpdateFileAddSharedLinkRequestBodySharedLinkField +export function serializeAddShareLinkToFileRequestBodySharedLinkField( + val: AddShareLinkToFileRequestBodySharedLinkField ): SerializedData { return { ['access']: val.access == void 0 ? void 0 - : serializeUpdateFileAddSharedLinkRequestBodySharedLinkAccessField( + : serializeAddShareLinkToFileRequestBodySharedLinkAccessField( val.access ), ['password']: val.password == void 0 ? void 0 : val.password, @@ -398,20 +396,18 @@ export function serializeUpdateFileAddSharedLinkRequestBodySharedLinkField( ['permissions']: val.permissions == void 0 ? void 0 - : serializeUpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField( + : serializeAddShareLinkToFileRequestBodySharedLinkPermissionsField( val.permissions ), }; } -export function deserializeUpdateFileAddSharedLinkRequestBodySharedLinkField( +export function deserializeAddShareLinkToFileRequestBodySharedLinkField( val: any -): UpdateFileAddSharedLinkRequestBodySharedLinkField { - const access: - | undefined - | UpdateFileAddSharedLinkRequestBodySharedLinkAccessField = +): AddShareLinkToFileRequestBodySharedLinkField { + const access: undefined | AddShareLinkToFileRequestBodySharedLinkAccessField = val.access == void 0 ? void 0 - : deserializeUpdateFileAddSharedLinkRequestBodySharedLinkAccessField( + : deserializeAddShareLinkToFileRequestBodySharedLinkAccessField( val.access ); const password: undefined | string = @@ -422,10 +418,10 @@ export function deserializeUpdateFileAddSharedLinkRequestBodySharedLinkField( val.unshared_at == void 0 ? void 0 : val.unshared_at; const permissions: | undefined - | UpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField = + | AddShareLinkToFileRequestBodySharedLinkPermissionsField = val.permissions == void 0 ? void 0 - : deserializeUpdateFileAddSharedLinkRequestBodySharedLinkPermissionsField( + : deserializeAddShareLinkToFileRequestBodySharedLinkPermissionsField( val.permissions ); return { @@ -434,45 +430,39 @@ export function deserializeUpdateFileAddSharedLinkRequestBodySharedLinkField( vanityName: vanityName, unsharedAt: unsharedAt, permissions: permissions, - } satisfies UpdateFileAddSharedLinkRequestBodySharedLinkField; + } satisfies AddShareLinkToFileRequestBodySharedLinkField; } -export function serializeUpdateFileAddSharedLinkRequestBody( - val: UpdateFileAddSharedLinkRequestBody +export function serializeAddShareLinkToFileRequestBody( + val: AddShareLinkToFileRequestBody ): SerializedData { return { ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateFileAddSharedLinkRequestBodySharedLinkField( - val.sharedLink - ), + : serializeAddShareLinkToFileRequestBodySharedLinkField(val.sharedLink), }; } -export function deserializeUpdateFileAddSharedLinkRequestBody( +export function deserializeAddShareLinkToFileRequestBody( val: any -): UpdateFileAddSharedLinkRequestBody { - const sharedLink: - | undefined - | UpdateFileAddSharedLinkRequestBodySharedLinkField = +): AddShareLinkToFileRequestBody { + const sharedLink: undefined | AddShareLinkToFileRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateFileAddSharedLinkRequestBodySharedLinkField( + : deserializeAddShareLinkToFileRequestBodySharedLinkField( val.shared_link ); - return { - sharedLink: sharedLink, - } satisfies UpdateFileAddSharedLinkRequestBody; + return { sharedLink: sharedLink } satisfies AddShareLinkToFileRequestBody; } -export function serializeUpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField( - val: UpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField +export function serializeUpdateSharedLinkOnFileRequestBodySharedLinkAccessField( + val: UpdateSharedLinkOnFileRequestBodySharedLinkAccessField ): SerializedData { return val; } -export function deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField( +export function deserializeUpdateSharedLinkOnFileRequestBodySharedLinkAccessField( val: any -): UpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField { +): UpdateSharedLinkOnFileRequestBodySharedLinkAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField"'; + throw 'Expecting a string for "UpdateSharedLinkOnFileRequestBodySharedLinkAccessField"'; } if (val == 'open') { return 'open'; @@ -485,8 +475,8 @@ export function deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkAccess } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField( - val: UpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField +export function serializeUpdateSharedLinkOnFileRequestBodySharedLinkPermissionsField( + val: UpdateSharedLinkOnFileRequestBodySharedLinkPermissionsField ): SerializedData { return { ['can_download']: val.canDownload == void 0 ? void 0 : val.canDownload, @@ -494,9 +484,9 @@ export function serializeUpdateFileUpdateSharedLinkRequestBodySharedLinkPermissi ['can_edit']: val.canEdit == void 0 ? void 0 : val.canEdit, }; } -export function deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField( +export function deserializeUpdateSharedLinkOnFileRequestBodySharedLinkPermissionsField( val: any -): UpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField { +): UpdateSharedLinkOnFileRequestBodySharedLinkPermissionsField { const canDownload: undefined | boolean = val.can_download == void 0 ? void 0 : val.can_download; const canPreview: undefined | boolean = @@ -507,16 +497,16 @@ export function deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkPermis canDownload: canDownload, canPreview: canPreview, canEdit: canEdit, - } satisfies UpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField; + } satisfies UpdateSharedLinkOnFileRequestBodySharedLinkPermissionsField; } -export function serializeUpdateFileUpdateSharedLinkRequestBodySharedLinkField( - val: UpdateFileUpdateSharedLinkRequestBodySharedLinkField +export function serializeUpdateSharedLinkOnFileRequestBodySharedLinkField( + val: UpdateSharedLinkOnFileRequestBodySharedLinkField ): SerializedData { return { ['access']: val.access == void 0 ? void 0 - : serializeUpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField( + : serializeUpdateSharedLinkOnFileRequestBodySharedLinkAccessField( val.access ), ['password']: val.password == void 0 ? void 0 : val.password, @@ -525,20 +515,20 @@ export function serializeUpdateFileUpdateSharedLinkRequestBodySharedLinkField( ['permissions']: val.permissions == void 0 ? void 0 - : serializeUpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField( + : serializeUpdateSharedLinkOnFileRequestBodySharedLinkPermissionsField( val.permissions ), }; } -export function deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkField( +export function deserializeUpdateSharedLinkOnFileRequestBodySharedLinkField( val: any -): UpdateFileUpdateSharedLinkRequestBodySharedLinkField { +): UpdateSharedLinkOnFileRequestBodySharedLinkField { const access: | undefined - | UpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField = + | UpdateSharedLinkOnFileRequestBodySharedLinkAccessField = val.access == void 0 ? void 0 - : deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField( + : deserializeUpdateSharedLinkOnFileRequestBodySharedLinkAccessField( val.access ); const password: undefined | string = @@ -549,10 +539,10 @@ export function deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkField( val.unshared_at == void 0 ? void 0 : val.unshared_at; const permissions: | undefined - | UpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField = + | UpdateSharedLinkOnFileRequestBodySharedLinkPermissionsField = val.permissions == void 0 ? void 0 - : deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkPermissionsField( + : deserializeUpdateSharedLinkOnFileRequestBodySharedLinkPermissionsField( val.permissions ); return { @@ -561,69 +551,67 @@ export function deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkField( vanityName: vanityName, unsharedAt: unsharedAt, permissions: permissions, - } satisfies UpdateFileUpdateSharedLinkRequestBodySharedLinkField; + } satisfies UpdateSharedLinkOnFileRequestBodySharedLinkField; } -export function serializeUpdateFileUpdateSharedLinkRequestBody( - val: UpdateFileUpdateSharedLinkRequestBody +export function serializeUpdateSharedLinkOnFileRequestBody( + val: UpdateSharedLinkOnFileRequestBody ): SerializedData { return { ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateFileUpdateSharedLinkRequestBodySharedLinkField( + : serializeUpdateSharedLinkOnFileRequestBodySharedLinkField( val.sharedLink ), }; } -export function deserializeUpdateFileUpdateSharedLinkRequestBody( +export function deserializeUpdateSharedLinkOnFileRequestBody( val: any -): UpdateFileUpdateSharedLinkRequestBody { +): UpdateSharedLinkOnFileRequestBody { const sharedLink: | undefined - | UpdateFileUpdateSharedLinkRequestBodySharedLinkField = + | UpdateSharedLinkOnFileRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkField( + : deserializeUpdateSharedLinkOnFileRequestBodySharedLinkField( val.shared_link ); - return { - sharedLink: sharedLink, - } satisfies UpdateFileUpdateSharedLinkRequestBody; + return { sharedLink: sharedLink } satisfies UpdateSharedLinkOnFileRequestBody; } -export function serializeUpdateFileRemoveSharedLinkRequestBodySharedLinkField( - val: UpdateFileRemoveSharedLinkRequestBodySharedLinkField +export function serializeRemoveSharedLinkFromFileRequestBodySharedLinkField( + val: RemoveSharedLinkFromFileRequestBodySharedLinkField ): SerializedData { return {}; } -export function deserializeUpdateFileRemoveSharedLinkRequestBodySharedLinkField( +export function deserializeRemoveSharedLinkFromFileRequestBodySharedLinkField( val: any -): UpdateFileRemoveSharedLinkRequestBodySharedLinkField { - return {} satisfies UpdateFileRemoveSharedLinkRequestBodySharedLinkField; +): RemoveSharedLinkFromFileRequestBodySharedLinkField { + return {} satisfies RemoveSharedLinkFromFileRequestBodySharedLinkField; } -export function serializeUpdateFileRemoveSharedLinkRequestBody( - val: UpdateFileRemoveSharedLinkRequestBody +export function serializeRemoveSharedLinkFromFileRequestBody( + val: RemoveSharedLinkFromFileRequestBody ): SerializedData { return { ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateFileRemoveSharedLinkRequestBodySharedLinkField( + : serializeRemoveSharedLinkFromFileRequestBodySharedLinkField( val.sharedLink ), }; } -export function deserializeUpdateFileRemoveSharedLinkRequestBody( +export function deserializeRemoveSharedLinkFromFileRequestBody( val: any -): UpdateFileRemoveSharedLinkRequestBody { +): RemoveSharedLinkFromFileRequestBody { const sharedLink: | undefined - | UpdateFileRemoveSharedLinkRequestBodySharedLinkField = + | RemoveSharedLinkFromFileRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateFileRemoveSharedLinkRequestBodySharedLinkField( + : deserializeRemoveSharedLinkFromFileRequestBodySharedLinkField( val.shared_link ); return { sharedLink: sharedLink, - } satisfies UpdateFileRemoveSharedLinkRequestBody; + } satisfies RemoveSharedLinkFromFileRequestBody; } diff --git a/src/managers/sharedLinksFolders.generated.ts b/src/managers/sharedLinksFolders.generated.ts index 625290ca..88d97af3 100644 --- a/src/managers/sharedLinksFolders.generated.ts +++ b/src/managers/sharedLinksFolders.generated.ts @@ -21,10 +21,10 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetSharedItemFoldersQueryParams { +export interface FindFolderForSharedLinkQueryParams { readonly fields?: readonly string[]; } -export class GetSharedItemFoldersHeaders { +export class FindFolderForSharedLinkHeaders { readonly ifNoneMatch?: string; readonly boxapi!: string; readonly extraHeaders?: { @@ -32,110 +32,110 @@ export class GetSharedItemFoldersHeaders { } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetFolderGetSharedLinkQueryParams { +export interface GetSharedLinkForFolderQueryParams { readonly fields: string; } -export class GetFolderGetSharedLinkHeaders { +export class GetSharedLinkForFolderHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateFolderAddSharedLinkRequestBodySharedLinkAccessField = +export type AddShareLinkToFolderRequestBodySharedLinkAccessField = | 'open' | 'company' | 'collaborators'; -export interface UpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField { +export interface AddShareLinkToFolderRequestBodySharedLinkPermissionsField { readonly canDownload?: boolean; readonly canPreview?: boolean; readonly canEdit?: boolean; } -export interface UpdateFolderAddSharedLinkRequestBodySharedLinkField { - readonly access?: UpdateFolderAddSharedLinkRequestBodySharedLinkAccessField; +export interface AddShareLinkToFolderRequestBodySharedLinkField { + readonly access?: AddShareLinkToFolderRequestBodySharedLinkAccessField; readonly password?: string; readonly vanityName?: string; readonly unsharedAt?: string; - readonly permissions?: UpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField; + readonly permissions?: AddShareLinkToFolderRequestBodySharedLinkPermissionsField; } -export interface UpdateFolderAddSharedLinkRequestBody { - readonly sharedLink?: UpdateFolderAddSharedLinkRequestBodySharedLinkField; +export interface AddShareLinkToFolderRequestBody { + readonly sharedLink?: AddShareLinkToFolderRequestBodySharedLinkField; } -export interface UpdateFolderAddSharedLinkQueryParams { +export interface AddShareLinkToFolderQueryParams { readonly fields: string; } -export class UpdateFolderAddSharedLinkHeaders { +export class AddShareLinkToFolderHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField = +export type UpdateSharedLinkOnFolderRequestBodySharedLinkAccessField = | 'open' | 'company' | 'collaborators'; -export interface UpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField { +export interface UpdateSharedLinkOnFolderRequestBodySharedLinkPermissionsField { readonly canDownload?: boolean; readonly canPreview?: boolean; readonly canEdit?: boolean; } -export interface UpdateFolderUpdateSharedLinkRequestBodySharedLinkField { - readonly access?: UpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField; +export interface UpdateSharedLinkOnFolderRequestBodySharedLinkField { + readonly access?: UpdateSharedLinkOnFolderRequestBodySharedLinkAccessField; readonly password?: string; readonly vanityName?: string; readonly unsharedAt?: string; - readonly permissions?: UpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField; + readonly permissions?: UpdateSharedLinkOnFolderRequestBodySharedLinkPermissionsField; } -export interface UpdateFolderUpdateSharedLinkRequestBody { - readonly sharedLink?: UpdateFolderUpdateSharedLinkRequestBodySharedLinkField; +export interface UpdateSharedLinkOnFolderRequestBody { + readonly sharedLink?: UpdateSharedLinkOnFolderRequestBodySharedLinkField; } -export interface UpdateFolderUpdateSharedLinkQueryParams { +export interface UpdateSharedLinkOnFolderQueryParams { readonly fields: string; } -export class UpdateFolderUpdateSharedLinkHeaders { +export class UpdateSharedLinkOnFolderHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface UpdateFolderRemoveSharedLinkRequestBodySharedLinkField {} -export interface UpdateFolderRemoveSharedLinkRequestBody { - readonly sharedLink?: UpdateFolderRemoveSharedLinkRequestBodySharedLinkField; +export interface RemoveSharedLinkFromFolderRequestBodySharedLinkField {} +export interface RemoveSharedLinkFromFolderRequestBody { + readonly sharedLink?: RemoveSharedLinkFromFolderRequestBodySharedLinkField; } -export interface UpdateFolderRemoveSharedLinkQueryParams { +export interface RemoveSharedLinkFromFolderQueryParams { readonly fields: string; } -export class UpdateFolderRemoveSharedLinkHeaders { +export class RemoveSharedLinkFromFolderHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } @@ -148,19 +148,19 @@ export class SharedLinksFoldersManager { | Omit< SharedLinksFoldersManager, | 'networkSession' - | 'getSharedItemFolders' - | 'getFolderGetSharedLink' - | 'updateFolderAddSharedLink' - | 'updateFolderUpdateSharedLink' - | 'updateFolderRemoveSharedLink' + | 'findFolderForSharedLink' + | 'getSharedLinkForFolder' + | 'addShareLinkToFolder' + | 'updateSharedLinkOnFolder' + | 'removeSharedLinkFromFolder' > | Partial> ) { Object.assign(this, fields); } - async getSharedItemFolders( - queryParams: GetSharedItemFoldersQueryParams = {} satisfies GetSharedItemFoldersQueryParams, - headers: GetSharedItemFoldersHeaders, + async findFolderForSharedLink( + queryParams: FindFolderForSharedLinkQueryParams = {} satisfies FindFolderForSharedLinkQueryParams, + headers: FindFolderForSharedLinkHeaders, cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -196,10 +196,10 @@ export class SharedLinksFoldersManager { )) as FetchResponse; return deserializeFolderFull(response.data); } - async getFolderGetSharedLink( + async getSharedLinkForFolder( folderId: string, - queryParams: GetFolderGetSharedLinkQueryParams, - headers: GetFolderGetSharedLinkHeaders = new GetFolderGetSharedLinkHeaders( + queryParams: GetSharedLinkForFolderQueryParams, + headers: GetSharedLinkForFolderHeaders = new GetSharedLinkForFolderHeaders( {} ), cancellationToken?: CancellationToken @@ -229,13 +229,11 @@ export class SharedLinksFoldersManager { )) as FetchResponse; return deserializeFolderFull(response.data); } - async updateFolderAddSharedLink( + async addShareLinkToFolder( folderId: string, - requestBody: UpdateFolderAddSharedLinkRequestBody = {} satisfies UpdateFolderAddSharedLinkRequestBody, - queryParams: UpdateFolderAddSharedLinkQueryParams, - headers: UpdateFolderAddSharedLinkHeaders = new UpdateFolderAddSharedLinkHeaders( - {} - ), + requestBody: AddShareLinkToFolderRequestBody = {} satisfies AddShareLinkToFolderRequestBody, + queryParams: AddShareLinkToFolderQueryParams, + headers: AddShareLinkToFolderHeaders = new AddShareLinkToFolderHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -255,7 +253,7 @@ export class SharedLinksFoldersManager { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateFolderAddSharedLinkRequestBody(requestBody), + data: serializeAddShareLinkToFolderRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -265,11 +263,11 @@ export class SharedLinksFoldersManager { )) as FetchResponse; return deserializeFolderFull(response.data); } - async updateFolderUpdateSharedLink( + async updateSharedLinkOnFolder( folderId: string, - requestBody: UpdateFolderUpdateSharedLinkRequestBody = {} satisfies UpdateFolderUpdateSharedLinkRequestBody, - queryParams: UpdateFolderUpdateSharedLinkQueryParams, - headers: UpdateFolderUpdateSharedLinkHeaders = new UpdateFolderUpdateSharedLinkHeaders( + requestBody: UpdateSharedLinkOnFolderRequestBody = {} satisfies UpdateSharedLinkOnFolderRequestBody, + queryParams: UpdateSharedLinkOnFolderQueryParams, + headers: UpdateSharedLinkOnFolderHeaders = new UpdateSharedLinkOnFolderHeaders( {} ), cancellationToken?: CancellationToken @@ -291,7 +289,7 @@ export class SharedLinksFoldersManager { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateFolderUpdateSharedLinkRequestBody(requestBody), + data: serializeUpdateSharedLinkOnFolderRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -301,11 +299,11 @@ export class SharedLinksFoldersManager { )) as FetchResponse; return deserializeFolderFull(response.data); } - async updateFolderRemoveSharedLink( + async removeSharedLinkFromFolder( folderId: string, - requestBody: UpdateFolderRemoveSharedLinkRequestBody = {} satisfies UpdateFolderRemoveSharedLinkRequestBody, - queryParams: UpdateFolderRemoveSharedLinkQueryParams, - headers: UpdateFolderRemoveSharedLinkHeaders = new UpdateFolderRemoveSharedLinkHeaders( + requestBody: RemoveSharedLinkFromFolderRequestBody = {} satisfies RemoveSharedLinkFromFolderRequestBody, + queryParams: RemoveSharedLinkFromFolderQueryParams, + headers: RemoveSharedLinkFromFolderHeaders = new RemoveSharedLinkFromFolderHeaders( {} ), cancellationToken?: CancellationToken @@ -327,7 +325,7 @@ export class SharedLinksFoldersManager { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateFolderRemoveSharedLinkRequestBody(requestBody), + data: serializeRemoveSharedLinkFromFolderRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -338,16 +336,16 @@ export class SharedLinksFoldersManager { return deserializeFolderFull(response.data); } } -export function serializeUpdateFolderAddSharedLinkRequestBodySharedLinkAccessField( - val: UpdateFolderAddSharedLinkRequestBodySharedLinkAccessField +export function serializeAddShareLinkToFolderRequestBodySharedLinkAccessField( + val: AddShareLinkToFolderRequestBodySharedLinkAccessField ): SerializedData { return val; } -export function deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkAccessField( +export function deserializeAddShareLinkToFolderRequestBodySharedLinkAccessField( val: any -): UpdateFolderAddSharedLinkRequestBodySharedLinkAccessField { +): AddShareLinkToFolderRequestBodySharedLinkAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFolderAddSharedLinkRequestBodySharedLinkAccessField"'; + throw 'Expecting a string for "AddShareLinkToFolderRequestBodySharedLinkAccessField"'; } if (val == 'open') { return 'open'; @@ -360,8 +358,8 @@ export function deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkAccessF } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField( - val: UpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField +export function serializeAddShareLinkToFolderRequestBodySharedLinkPermissionsField( + val: AddShareLinkToFolderRequestBodySharedLinkPermissionsField ): SerializedData { return { ['can_download']: val.canDownload == void 0 ? void 0 : val.canDownload, @@ -369,9 +367,9 @@ export function serializeUpdateFolderAddSharedLinkRequestBodySharedLinkPermissio ['can_edit']: val.canEdit == void 0 ? void 0 : val.canEdit, }; } -export function deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField( +export function deserializeAddShareLinkToFolderRequestBodySharedLinkPermissionsField( val: any -): UpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField { +): AddShareLinkToFolderRequestBodySharedLinkPermissionsField { const canDownload: undefined | boolean = val.can_download == void 0 ? void 0 : val.can_download; const canPreview: undefined | boolean = @@ -382,16 +380,16 @@ export function deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkPermiss canDownload: canDownload, canPreview: canPreview, canEdit: canEdit, - } satisfies UpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField; + } satisfies AddShareLinkToFolderRequestBodySharedLinkPermissionsField; } -export function serializeUpdateFolderAddSharedLinkRequestBodySharedLinkField( - val: UpdateFolderAddSharedLinkRequestBodySharedLinkField +export function serializeAddShareLinkToFolderRequestBodySharedLinkField( + val: AddShareLinkToFolderRequestBodySharedLinkField ): SerializedData { return { ['access']: val.access == void 0 ? void 0 - : serializeUpdateFolderAddSharedLinkRequestBodySharedLinkAccessField( + : serializeAddShareLinkToFolderRequestBodySharedLinkAccessField( val.access ), ['password']: val.password == void 0 ? void 0 : val.password, @@ -400,20 +398,20 @@ export function serializeUpdateFolderAddSharedLinkRequestBodySharedLinkField( ['permissions']: val.permissions == void 0 ? void 0 - : serializeUpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField( + : serializeAddShareLinkToFolderRequestBodySharedLinkPermissionsField( val.permissions ), }; } -export function deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkField( +export function deserializeAddShareLinkToFolderRequestBodySharedLinkField( val: any -): UpdateFolderAddSharedLinkRequestBodySharedLinkField { +): AddShareLinkToFolderRequestBodySharedLinkField { const access: | undefined - | UpdateFolderAddSharedLinkRequestBodySharedLinkAccessField = + | AddShareLinkToFolderRequestBodySharedLinkAccessField = val.access == void 0 ? void 0 - : deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkAccessField( + : deserializeAddShareLinkToFolderRequestBodySharedLinkAccessField( val.access ); const password: undefined | string = @@ -424,10 +422,10 @@ export function deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkField( val.unshared_at == void 0 ? void 0 : val.unshared_at; const permissions: | undefined - | UpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField = + | AddShareLinkToFolderRequestBodySharedLinkPermissionsField = val.permissions == void 0 ? void 0 - : deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkPermissionsField( + : deserializeAddShareLinkToFolderRequestBodySharedLinkPermissionsField( val.permissions ); return { @@ -436,45 +434,41 @@ export function deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkField( vanityName: vanityName, unsharedAt: unsharedAt, permissions: permissions, - } satisfies UpdateFolderAddSharedLinkRequestBodySharedLinkField; + } satisfies AddShareLinkToFolderRequestBodySharedLinkField; } -export function serializeUpdateFolderAddSharedLinkRequestBody( - val: UpdateFolderAddSharedLinkRequestBody +export function serializeAddShareLinkToFolderRequestBody( + val: AddShareLinkToFolderRequestBody ): SerializedData { return { ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateFolderAddSharedLinkRequestBodySharedLinkField( + : serializeAddShareLinkToFolderRequestBodySharedLinkField( val.sharedLink ), }; } -export function deserializeUpdateFolderAddSharedLinkRequestBody( +export function deserializeAddShareLinkToFolderRequestBody( val: any -): UpdateFolderAddSharedLinkRequestBody { - const sharedLink: - | undefined - | UpdateFolderAddSharedLinkRequestBodySharedLinkField = +): AddShareLinkToFolderRequestBody { + const sharedLink: undefined | AddShareLinkToFolderRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkField( + : deserializeAddShareLinkToFolderRequestBodySharedLinkField( val.shared_link ); - return { - sharedLink: sharedLink, - } satisfies UpdateFolderAddSharedLinkRequestBody; + return { sharedLink: sharedLink } satisfies AddShareLinkToFolderRequestBody; } -export function serializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField( - val: UpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField +export function serializeUpdateSharedLinkOnFolderRequestBodySharedLinkAccessField( + val: UpdateSharedLinkOnFolderRequestBodySharedLinkAccessField ): SerializedData { return val; } -export function deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField( +export function deserializeUpdateSharedLinkOnFolderRequestBodySharedLinkAccessField( val: any -): UpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField { +): UpdateSharedLinkOnFolderRequestBodySharedLinkAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField"'; + throw 'Expecting a string for "UpdateSharedLinkOnFolderRequestBodySharedLinkAccessField"'; } if (val == 'open') { return 'open'; @@ -487,8 +481,8 @@ export function deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkAcce } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField( - val: UpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField +export function serializeUpdateSharedLinkOnFolderRequestBodySharedLinkPermissionsField( + val: UpdateSharedLinkOnFolderRequestBodySharedLinkPermissionsField ): SerializedData { return { ['can_download']: val.canDownload == void 0 ? void 0 : val.canDownload, @@ -496,9 +490,9 @@ export function serializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkPermis ['can_edit']: val.canEdit == void 0 ? void 0 : val.canEdit, }; } -export function deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField( +export function deserializeUpdateSharedLinkOnFolderRequestBodySharedLinkPermissionsField( val: any -): UpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField { +): UpdateSharedLinkOnFolderRequestBodySharedLinkPermissionsField { const canDownload: undefined | boolean = val.can_download == void 0 ? void 0 : val.can_download; const canPreview: undefined | boolean = @@ -509,16 +503,16 @@ export function deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkPerm canDownload: canDownload, canPreview: canPreview, canEdit: canEdit, - } satisfies UpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField; + } satisfies UpdateSharedLinkOnFolderRequestBodySharedLinkPermissionsField; } -export function serializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkField( - val: UpdateFolderUpdateSharedLinkRequestBodySharedLinkField +export function serializeUpdateSharedLinkOnFolderRequestBodySharedLinkField( + val: UpdateSharedLinkOnFolderRequestBodySharedLinkField ): SerializedData { return { ['access']: val.access == void 0 ? void 0 - : serializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField( + : serializeUpdateSharedLinkOnFolderRequestBodySharedLinkAccessField( val.access ), ['password']: val.password == void 0 ? void 0 : val.password, @@ -527,20 +521,20 @@ export function serializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkField( ['permissions']: val.permissions == void 0 ? void 0 - : serializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField( + : serializeUpdateSharedLinkOnFolderRequestBodySharedLinkPermissionsField( val.permissions ), }; } -export function deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkField( +export function deserializeUpdateSharedLinkOnFolderRequestBodySharedLinkField( val: any -): UpdateFolderUpdateSharedLinkRequestBodySharedLinkField { +): UpdateSharedLinkOnFolderRequestBodySharedLinkField { const access: | undefined - | UpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField = + | UpdateSharedLinkOnFolderRequestBodySharedLinkAccessField = val.access == void 0 ? void 0 - : deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField( + : deserializeUpdateSharedLinkOnFolderRequestBodySharedLinkAccessField( val.access ); const password: undefined | string = @@ -551,10 +545,10 @@ export function deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkFiel val.unshared_at == void 0 ? void 0 : val.unshared_at; const permissions: | undefined - | UpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField = + | UpdateSharedLinkOnFolderRequestBodySharedLinkPermissionsField = val.permissions == void 0 ? void 0 - : deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkPermissionsField( + : deserializeUpdateSharedLinkOnFolderRequestBodySharedLinkPermissionsField( val.permissions ); return { @@ -563,69 +557,69 @@ export function deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkFiel vanityName: vanityName, unsharedAt: unsharedAt, permissions: permissions, - } satisfies UpdateFolderUpdateSharedLinkRequestBodySharedLinkField; + } satisfies UpdateSharedLinkOnFolderRequestBodySharedLinkField; } -export function serializeUpdateFolderUpdateSharedLinkRequestBody( - val: UpdateFolderUpdateSharedLinkRequestBody +export function serializeUpdateSharedLinkOnFolderRequestBody( + val: UpdateSharedLinkOnFolderRequestBody ): SerializedData { return { ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkField( + : serializeUpdateSharedLinkOnFolderRequestBodySharedLinkField( val.sharedLink ), }; } -export function deserializeUpdateFolderUpdateSharedLinkRequestBody( +export function deserializeUpdateSharedLinkOnFolderRequestBody( val: any -): UpdateFolderUpdateSharedLinkRequestBody { +): UpdateSharedLinkOnFolderRequestBody { const sharedLink: | undefined - | UpdateFolderUpdateSharedLinkRequestBodySharedLinkField = + | UpdateSharedLinkOnFolderRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkField( + : deserializeUpdateSharedLinkOnFolderRequestBodySharedLinkField( val.shared_link ); return { sharedLink: sharedLink, - } satisfies UpdateFolderUpdateSharedLinkRequestBody; + } satisfies UpdateSharedLinkOnFolderRequestBody; } -export function serializeUpdateFolderRemoveSharedLinkRequestBodySharedLinkField( - val: UpdateFolderRemoveSharedLinkRequestBodySharedLinkField +export function serializeRemoveSharedLinkFromFolderRequestBodySharedLinkField( + val: RemoveSharedLinkFromFolderRequestBodySharedLinkField ): SerializedData { return {}; } -export function deserializeUpdateFolderRemoveSharedLinkRequestBodySharedLinkField( +export function deserializeRemoveSharedLinkFromFolderRequestBodySharedLinkField( val: any -): UpdateFolderRemoveSharedLinkRequestBodySharedLinkField { - return {} satisfies UpdateFolderRemoveSharedLinkRequestBodySharedLinkField; +): RemoveSharedLinkFromFolderRequestBodySharedLinkField { + return {} satisfies RemoveSharedLinkFromFolderRequestBodySharedLinkField; } -export function serializeUpdateFolderRemoveSharedLinkRequestBody( - val: UpdateFolderRemoveSharedLinkRequestBody +export function serializeRemoveSharedLinkFromFolderRequestBody( + val: RemoveSharedLinkFromFolderRequestBody ): SerializedData { return { ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateFolderRemoveSharedLinkRequestBodySharedLinkField( + : serializeRemoveSharedLinkFromFolderRequestBodySharedLinkField( val.sharedLink ), }; } -export function deserializeUpdateFolderRemoveSharedLinkRequestBody( +export function deserializeRemoveSharedLinkFromFolderRequestBody( val: any -): UpdateFolderRemoveSharedLinkRequestBody { +): RemoveSharedLinkFromFolderRequestBody { const sharedLink: | undefined - | UpdateFolderRemoveSharedLinkRequestBodySharedLinkField = + | RemoveSharedLinkFromFolderRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateFolderRemoveSharedLinkRequestBodySharedLinkField( + : deserializeRemoveSharedLinkFromFolderRequestBodySharedLinkField( val.shared_link ); return { sharedLink: sharedLink, - } satisfies UpdateFolderRemoveSharedLinkRequestBody; + } satisfies RemoveSharedLinkFromFolderRequestBody; } diff --git a/src/managers/sharedLinksWebLinks.generated.ts b/src/managers/sharedLinksWebLinks.generated.ts index babffef5..74d06ddc 100644 --- a/src/managers/sharedLinksWebLinks.generated.ts +++ b/src/managers/sharedLinksWebLinks.generated.ts @@ -21,10 +21,10 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetSharedItemWebLinksQueryParams { +export interface FindWebLinkForSharedLinkQueryParams { readonly fields?: readonly string[]; } -export class GetSharedItemWebLinksHeaders { +export class FindWebLinkForSharedLinkHeaders { readonly ifNoneMatch?: string; readonly boxapi!: string; readonly extraHeaders?: { @@ -32,110 +32,110 @@ export class GetSharedItemWebLinksHeaders { } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface GetWebLinkGetSharedLinkQueryParams { +export interface GetSharedLinkForWebLinkQueryParams { readonly fields: string; } -export class GetWebLinkGetSharedLinkHeaders { +export class GetSharedLinkForWebLinkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField = +export type AddShareLinkToWebLinkRequestBodySharedLinkAccessField = | 'open' | 'company' | 'collaborators'; -export interface UpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField { +export interface AddShareLinkToWebLinkRequestBodySharedLinkPermissionsField { readonly canDownload?: boolean; readonly canPreview?: boolean; readonly canEdit?: boolean; } -export interface UpdateWebLinkAddSharedLinkRequestBodySharedLinkField { - readonly access?: UpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField; +export interface AddShareLinkToWebLinkRequestBodySharedLinkField { + readonly access?: AddShareLinkToWebLinkRequestBodySharedLinkAccessField; readonly password?: string; readonly vanityName?: string; readonly unsharedAt?: string; - readonly permissions?: UpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField; + readonly permissions?: AddShareLinkToWebLinkRequestBodySharedLinkPermissionsField; } -export interface UpdateWebLinkAddSharedLinkRequestBody { - readonly sharedLink?: UpdateWebLinkAddSharedLinkRequestBodySharedLinkField; +export interface AddShareLinkToWebLinkRequestBody { + readonly sharedLink?: AddShareLinkToWebLinkRequestBodySharedLinkField; } -export interface UpdateWebLinkAddSharedLinkQueryParams { +export interface AddShareLinkToWebLinkQueryParams { readonly fields: string; } -export class UpdateWebLinkAddSharedLinkHeaders { +export class AddShareLinkToWebLinkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField = +export type UpdateSharedLinkOnWebLinkRequestBodySharedLinkAccessField = | 'open' | 'company' | 'collaborators'; -export interface UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField { +export interface UpdateSharedLinkOnWebLinkRequestBodySharedLinkPermissionsField { readonly canDownload?: boolean; readonly canPreview?: boolean; readonly canEdit?: boolean; } -export interface UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField { - readonly access?: UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField; +export interface UpdateSharedLinkOnWebLinkRequestBodySharedLinkField { + readonly access?: UpdateSharedLinkOnWebLinkRequestBodySharedLinkAccessField; readonly password?: string; readonly vanityName?: string; readonly unsharedAt?: string; - readonly permissions?: UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField; + readonly permissions?: UpdateSharedLinkOnWebLinkRequestBodySharedLinkPermissionsField; } -export interface UpdateWebLinkUpdateSharedLinkRequestBody { - readonly sharedLink?: UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField; +export interface UpdateSharedLinkOnWebLinkRequestBody { + readonly sharedLink?: UpdateSharedLinkOnWebLinkRequestBodySharedLinkField; } -export interface UpdateWebLinkUpdateSharedLinkQueryParams { +export interface UpdateSharedLinkOnWebLinkQueryParams { readonly fields: string; } -export class UpdateWebLinkUpdateSharedLinkHeaders { +export class UpdateSharedLinkOnWebLinkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface UpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField {} -export interface UpdateWebLinkRemoveSharedLinkRequestBody { - readonly sharedLink?: UpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField; +export interface RemoveSharedLinkFromWebLinkRequestBodySharedLinkField {} +export interface RemoveSharedLinkFromWebLinkRequestBody { + readonly sharedLink?: RemoveSharedLinkFromWebLinkRequestBodySharedLinkField; } -export interface UpdateWebLinkRemoveSharedLinkQueryParams { +export interface RemoveSharedLinkFromWebLinkQueryParams { readonly fields: string; } -export class UpdateWebLinkRemoveSharedLinkHeaders { +export class RemoveSharedLinkFromWebLinkHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } @@ -148,19 +148,19 @@ export class SharedLinksWebLinksManager { | Omit< SharedLinksWebLinksManager, | 'networkSession' - | 'getSharedItemWebLinks' - | 'getWebLinkGetSharedLink' - | 'updateWebLinkAddSharedLink' - | 'updateWebLinkUpdateSharedLink' - | 'updateWebLinkRemoveSharedLink' + | 'findWebLinkForSharedLink' + | 'getSharedLinkForWebLink' + | 'addShareLinkToWebLink' + | 'updateSharedLinkOnWebLink' + | 'removeSharedLinkFromWebLink' > | Partial> ) { Object.assign(this, fields); } - async getSharedItemWebLinks( - queryParams: GetSharedItemWebLinksQueryParams = {} satisfies GetSharedItemWebLinksQueryParams, - headers: GetSharedItemWebLinksHeaders, + async findWebLinkForSharedLink( + queryParams: FindWebLinkForSharedLinkQueryParams = {} satisfies FindWebLinkForSharedLinkQueryParams, + headers: FindWebLinkForSharedLinkHeaders, cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -196,10 +196,10 @@ export class SharedLinksWebLinksManager { )) as FetchResponse; return deserializeWebLink(response.data); } - async getWebLinkGetSharedLink( + async getSharedLinkForWebLink( webLinkId: string, - queryParams: GetWebLinkGetSharedLinkQueryParams, - headers: GetWebLinkGetSharedLinkHeaders = new GetWebLinkGetSharedLinkHeaders( + queryParams: GetSharedLinkForWebLinkQueryParams, + headers: GetSharedLinkForWebLinkHeaders = new GetSharedLinkForWebLinkHeaders( {} ), cancellationToken?: CancellationToken @@ -229,11 +229,11 @@ export class SharedLinksWebLinksManager { )) as FetchResponse; return deserializeWebLink(response.data); } - async updateWebLinkAddSharedLink( + async addShareLinkToWebLink( webLinkId: string, - requestBody: UpdateWebLinkAddSharedLinkRequestBody = {} satisfies UpdateWebLinkAddSharedLinkRequestBody, - queryParams: UpdateWebLinkAddSharedLinkQueryParams, - headers: UpdateWebLinkAddSharedLinkHeaders = new UpdateWebLinkAddSharedLinkHeaders( + requestBody: AddShareLinkToWebLinkRequestBody = {} satisfies AddShareLinkToWebLinkRequestBody, + queryParams: AddShareLinkToWebLinkQueryParams, + headers: AddShareLinkToWebLinkHeaders = new AddShareLinkToWebLinkHeaders( {} ), cancellationToken?: CancellationToken @@ -255,7 +255,7 @@ export class SharedLinksWebLinksManager { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateWebLinkAddSharedLinkRequestBody(requestBody), + data: serializeAddShareLinkToWebLinkRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -265,11 +265,11 @@ export class SharedLinksWebLinksManager { )) as FetchResponse; return deserializeWebLink(response.data); } - async updateWebLinkUpdateSharedLink( + async updateSharedLinkOnWebLink( webLinkId: string, - requestBody: UpdateWebLinkUpdateSharedLinkRequestBody = {} satisfies UpdateWebLinkUpdateSharedLinkRequestBody, - queryParams: UpdateWebLinkUpdateSharedLinkQueryParams, - headers: UpdateWebLinkUpdateSharedLinkHeaders = new UpdateWebLinkUpdateSharedLinkHeaders( + requestBody: UpdateSharedLinkOnWebLinkRequestBody = {} satisfies UpdateSharedLinkOnWebLinkRequestBody, + queryParams: UpdateSharedLinkOnWebLinkQueryParams, + headers: UpdateSharedLinkOnWebLinkHeaders = new UpdateSharedLinkOnWebLinkHeaders( {} ), cancellationToken?: CancellationToken @@ -291,7 +291,7 @@ export class SharedLinksWebLinksManager { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateWebLinkUpdateSharedLinkRequestBody(requestBody), + data: serializeUpdateSharedLinkOnWebLinkRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -301,11 +301,11 @@ export class SharedLinksWebLinksManager { )) as FetchResponse; return deserializeWebLink(response.data); } - async updateWebLinkRemoveSharedLink( + async removeSharedLinkFromWebLink( webLinkId: string, - requestBody: UpdateWebLinkRemoveSharedLinkRequestBody = {} satisfies UpdateWebLinkRemoveSharedLinkRequestBody, - queryParams: UpdateWebLinkRemoveSharedLinkQueryParams, - headers: UpdateWebLinkRemoveSharedLinkHeaders = new UpdateWebLinkRemoveSharedLinkHeaders( + requestBody: RemoveSharedLinkFromWebLinkRequestBody = {} satisfies RemoveSharedLinkFromWebLinkRequestBody, + queryParams: RemoveSharedLinkFromWebLinkQueryParams, + headers: RemoveSharedLinkFromWebLinkHeaders = new RemoveSharedLinkFromWebLinkHeaders( {} ), cancellationToken?: CancellationToken @@ -327,7 +327,7 @@ export class SharedLinksWebLinksManager { method: 'PUT', params: queryParamsMap, headers: headersMap, - data: serializeUpdateWebLinkRemoveSharedLinkRequestBody(requestBody), + data: serializeRemoveSharedLinkFromWebLinkRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -338,16 +338,16 @@ export class SharedLinksWebLinksManager { return deserializeWebLink(response.data); } } -export function serializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField( - val: UpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField +export function serializeAddShareLinkToWebLinkRequestBodySharedLinkAccessField( + val: AddShareLinkToWebLinkRequestBodySharedLinkAccessField ): SerializedData { return val; } -export function deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField( +export function deserializeAddShareLinkToWebLinkRequestBodySharedLinkAccessField( val: any -): UpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField { +): AddShareLinkToWebLinkRequestBodySharedLinkAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField"'; + throw 'Expecting a string for "AddShareLinkToWebLinkRequestBodySharedLinkAccessField"'; } if (val == 'open') { return 'open'; @@ -360,8 +360,8 @@ export function deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkAccess } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField( - val: UpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField +export function serializeAddShareLinkToWebLinkRequestBodySharedLinkPermissionsField( + val: AddShareLinkToWebLinkRequestBodySharedLinkPermissionsField ): SerializedData { return { ['can_download']: val.canDownload == void 0 ? void 0 : val.canDownload, @@ -369,9 +369,9 @@ export function serializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissi ['can_edit']: val.canEdit == void 0 ? void 0 : val.canEdit, }; } -export function deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField( +export function deserializeAddShareLinkToWebLinkRequestBodySharedLinkPermissionsField( val: any -): UpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField { +): AddShareLinkToWebLinkRequestBodySharedLinkPermissionsField { const canDownload: undefined | boolean = val.can_download == void 0 ? void 0 : val.can_download; const canPreview: undefined | boolean = @@ -382,16 +382,16 @@ export function deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkPermis canDownload: canDownload, canPreview: canPreview, canEdit: canEdit, - } satisfies UpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField; + } satisfies AddShareLinkToWebLinkRequestBodySharedLinkPermissionsField; } -export function serializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkField( - val: UpdateWebLinkAddSharedLinkRequestBodySharedLinkField +export function serializeAddShareLinkToWebLinkRequestBodySharedLinkField( + val: AddShareLinkToWebLinkRequestBodySharedLinkField ): SerializedData { return { ['access']: val.access == void 0 ? void 0 - : serializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField( + : serializeAddShareLinkToWebLinkRequestBodySharedLinkAccessField( val.access ), ['password']: val.password == void 0 ? void 0 : val.password, @@ -400,20 +400,20 @@ export function serializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkField( ['permissions']: val.permissions == void 0 ? void 0 - : serializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField( + : serializeAddShareLinkToWebLinkRequestBodySharedLinkPermissionsField( val.permissions ), }; } -export function deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkField( +export function deserializeAddShareLinkToWebLinkRequestBodySharedLinkField( val: any -): UpdateWebLinkAddSharedLinkRequestBodySharedLinkField { +): AddShareLinkToWebLinkRequestBodySharedLinkField { const access: | undefined - | UpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField = + | AddShareLinkToWebLinkRequestBodySharedLinkAccessField = val.access == void 0 ? void 0 - : deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField( + : deserializeAddShareLinkToWebLinkRequestBodySharedLinkAccessField( val.access ); const password: undefined | string = @@ -424,10 +424,10 @@ export function deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkField( val.unshared_at == void 0 ? void 0 : val.unshared_at; const permissions: | undefined - | UpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField = + | AddShareLinkToWebLinkRequestBodySharedLinkPermissionsField = val.permissions == void 0 ? void 0 - : deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkPermissionsField( + : deserializeAddShareLinkToWebLinkRequestBodySharedLinkPermissionsField( val.permissions ); return { @@ -436,45 +436,43 @@ export function deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkField( vanityName: vanityName, unsharedAt: unsharedAt, permissions: permissions, - } satisfies UpdateWebLinkAddSharedLinkRequestBodySharedLinkField; + } satisfies AddShareLinkToWebLinkRequestBodySharedLinkField; } -export function serializeUpdateWebLinkAddSharedLinkRequestBody( - val: UpdateWebLinkAddSharedLinkRequestBody +export function serializeAddShareLinkToWebLinkRequestBody( + val: AddShareLinkToWebLinkRequestBody ): SerializedData { return { ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkField( + : serializeAddShareLinkToWebLinkRequestBodySharedLinkField( val.sharedLink ), }; } -export function deserializeUpdateWebLinkAddSharedLinkRequestBody( +export function deserializeAddShareLinkToWebLinkRequestBody( val: any -): UpdateWebLinkAddSharedLinkRequestBody { +): AddShareLinkToWebLinkRequestBody { const sharedLink: | undefined - | UpdateWebLinkAddSharedLinkRequestBodySharedLinkField = + | AddShareLinkToWebLinkRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkField( + : deserializeAddShareLinkToWebLinkRequestBodySharedLinkField( val.shared_link ); - return { - sharedLink: sharedLink, - } satisfies UpdateWebLinkAddSharedLinkRequestBody; + return { sharedLink: sharedLink } satisfies AddShareLinkToWebLinkRequestBody; } -export function serializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField( - val: UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField +export function serializeUpdateSharedLinkOnWebLinkRequestBodySharedLinkAccessField( + val: UpdateSharedLinkOnWebLinkRequestBodySharedLinkAccessField ): SerializedData { return val; } -export function deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField( +export function deserializeUpdateSharedLinkOnWebLinkRequestBodySharedLinkAccessField( val: any -): UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField { +): UpdateSharedLinkOnWebLinkRequestBodySharedLinkAccessField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField"'; + throw 'Expecting a string for "UpdateSharedLinkOnWebLinkRequestBodySharedLinkAccessField"'; } if (val == 'open') { return 'open'; @@ -487,8 +485,8 @@ export function deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAcc } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField( - val: UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField +export function serializeUpdateSharedLinkOnWebLinkRequestBodySharedLinkPermissionsField( + val: UpdateSharedLinkOnWebLinkRequestBodySharedLinkPermissionsField ): SerializedData { return { ['can_download']: val.canDownload == void 0 ? void 0 : val.canDownload, @@ -496,9 +494,9 @@ export function serializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermi ['can_edit']: val.canEdit == void 0 ? void 0 : val.canEdit, }; } -export function deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField( +export function deserializeUpdateSharedLinkOnWebLinkRequestBodySharedLinkPermissionsField( val: any -): UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField { +): UpdateSharedLinkOnWebLinkRequestBodySharedLinkPermissionsField { const canDownload: undefined | boolean = val.can_download == void 0 ? void 0 : val.can_download; const canPreview: undefined | boolean = @@ -509,16 +507,16 @@ export function deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPer canDownload: canDownload, canPreview: canPreview, canEdit: canEdit, - } satisfies UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField; + } satisfies UpdateSharedLinkOnWebLinkRequestBodySharedLinkPermissionsField; } -export function serializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField( - val: UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField +export function serializeUpdateSharedLinkOnWebLinkRequestBodySharedLinkField( + val: UpdateSharedLinkOnWebLinkRequestBodySharedLinkField ): SerializedData { return { ['access']: val.access == void 0 ? void 0 - : serializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField( + : serializeUpdateSharedLinkOnWebLinkRequestBodySharedLinkAccessField( val.access ), ['password']: val.password == void 0 ? void 0 : val.password, @@ -527,20 +525,20 @@ export function serializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField ['permissions']: val.permissions == void 0 ? void 0 - : serializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField( + : serializeUpdateSharedLinkOnWebLinkRequestBodySharedLinkPermissionsField( val.permissions ), }; } -export function deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField( +export function deserializeUpdateSharedLinkOnWebLinkRequestBodySharedLinkField( val: any -): UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField { +): UpdateSharedLinkOnWebLinkRequestBodySharedLinkField { const access: | undefined - | UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField = + | UpdateSharedLinkOnWebLinkRequestBodySharedLinkAccessField = val.access == void 0 ? void 0 - : deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField( + : deserializeUpdateSharedLinkOnWebLinkRequestBodySharedLinkAccessField( val.access ); const password: undefined | string = @@ -551,10 +549,10 @@ export function deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkFie val.unshared_at == void 0 ? void 0 : val.unshared_at; const permissions: | undefined - | UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField = + | UpdateSharedLinkOnWebLinkRequestBodySharedLinkPermissionsField = val.permissions == void 0 ? void 0 - : deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkPermissionsField( + : deserializeUpdateSharedLinkOnWebLinkRequestBodySharedLinkPermissionsField( val.permissions ); return { @@ -563,69 +561,69 @@ export function deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkFie vanityName: vanityName, unsharedAt: unsharedAt, permissions: permissions, - } satisfies UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField; + } satisfies UpdateSharedLinkOnWebLinkRequestBodySharedLinkField; } -export function serializeUpdateWebLinkUpdateSharedLinkRequestBody( - val: UpdateWebLinkUpdateSharedLinkRequestBody +export function serializeUpdateSharedLinkOnWebLinkRequestBody( + val: UpdateSharedLinkOnWebLinkRequestBody ): SerializedData { return { ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField( + : serializeUpdateSharedLinkOnWebLinkRequestBodySharedLinkField( val.sharedLink ), }; } -export function deserializeUpdateWebLinkUpdateSharedLinkRequestBody( +export function deserializeUpdateSharedLinkOnWebLinkRequestBody( val: any -): UpdateWebLinkUpdateSharedLinkRequestBody { +): UpdateSharedLinkOnWebLinkRequestBody { const sharedLink: | undefined - | UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField = + | UpdateSharedLinkOnWebLinkRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField( + : deserializeUpdateSharedLinkOnWebLinkRequestBodySharedLinkField( val.shared_link ); return { sharedLink: sharedLink, - } satisfies UpdateWebLinkUpdateSharedLinkRequestBody; + } satisfies UpdateSharedLinkOnWebLinkRequestBody; } -export function serializeUpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField( - val: UpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField +export function serializeRemoveSharedLinkFromWebLinkRequestBodySharedLinkField( + val: RemoveSharedLinkFromWebLinkRequestBodySharedLinkField ): SerializedData { return {}; } -export function deserializeUpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField( +export function deserializeRemoveSharedLinkFromWebLinkRequestBodySharedLinkField( val: any -): UpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField { - return {} satisfies UpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField; +): RemoveSharedLinkFromWebLinkRequestBodySharedLinkField { + return {} satisfies RemoveSharedLinkFromWebLinkRequestBodySharedLinkField; } -export function serializeUpdateWebLinkRemoveSharedLinkRequestBody( - val: UpdateWebLinkRemoveSharedLinkRequestBody +export function serializeRemoveSharedLinkFromWebLinkRequestBody( + val: RemoveSharedLinkFromWebLinkRequestBody ): SerializedData { return { ['shared_link']: val.sharedLink == void 0 ? void 0 - : serializeUpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField( + : serializeRemoveSharedLinkFromWebLinkRequestBodySharedLinkField( val.sharedLink ), }; } -export function deserializeUpdateWebLinkRemoveSharedLinkRequestBody( +export function deserializeRemoveSharedLinkFromWebLinkRequestBody( val: any -): UpdateWebLinkRemoveSharedLinkRequestBody { +): RemoveSharedLinkFromWebLinkRequestBody { const sharedLink: | undefined - | UpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField = + | RemoveSharedLinkFromWebLinkRequestBodySharedLinkField = val.shared_link == void 0 ? void 0 - : deserializeUpdateWebLinkRemoveSharedLinkRequestBodySharedLinkField( + : deserializeRemoveSharedLinkFromWebLinkRequestBodySharedLinkField( val.shared_link ); return { sharedLink: sharedLink, - } satisfies UpdateWebLinkRemoveSharedLinkRequestBody; + } satisfies RemoveSharedLinkFromWebLinkRequestBody; } diff --git a/src/managers/shieldInformationBarriers.generated.ts b/src/managers/shieldInformationBarriers.generated.ts index ee1f184e..a9c1a3c5 100644 --- a/src/managers/shieldInformationBarriers.generated.ts +++ b/src/managers/shieldInformationBarriers.generated.ts @@ -39,25 +39,22 @@ export class GetShieldInformationBarrierByIdHeaders { Object.assign(this, fields); } } -export type CreateShieldInformationBarrierChangeStatusRequestBodyStatusField = +export type UpdateShieldInformationBarrierStatusRequestBodyStatusField = | 'pending' | 'disabled'; -export interface CreateShieldInformationBarrierChangeStatusRequestBody { +export interface UpdateShieldInformationBarrierStatusRequestBody { readonly id: string; - readonly status: CreateShieldInformationBarrierChangeStatusRequestBodyStatusField; + readonly status: UpdateShieldInformationBarrierStatusRequestBodyStatusField; } -export class CreateShieldInformationBarrierChangeStatusHeaders { +export class UpdateShieldInformationBarrierStatusHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit + | Omit | Partial< - Pick< - CreateShieldInformationBarrierChangeStatusHeaders, - 'extraHeaders' - > + Pick > ) { Object.assign(this, fields); @@ -103,7 +100,7 @@ export class ShieldInformationBarriersManager { ShieldInformationBarriersManager, | 'networkSession' | 'getShieldInformationBarrierById' - | 'createShieldInformationBarrierChangeStatus' + | 'updateShieldInformationBarrierStatus' | 'getShieldInformationBarriers' | 'createShieldInformationBarrier' > @@ -138,9 +135,9 @@ export class ShieldInformationBarriersManager { )) as FetchResponse; return deserializeShieldInformationBarrier(response.data); } - async createShieldInformationBarrierChangeStatus( - requestBody: CreateShieldInformationBarrierChangeStatusRequestBody, - headers: CreateShieldInformationBarrierChangeStatusHeaders = new CreateShieldInformationBarrierChangeStatusHeaders( + async updateShieldInformationBarrierStatus( + requestBody: UpdateShieldInformationBarrierStatusRequestBody, + headers: UpdateShieldInformationBarrierStatusHeaders = new UpdateShieldInformationBarrierStatusHeaders( {} ), cancellationToken?: CancellationToken @@ -156,7 +153,7 @@ export class ShieldInformationBarriersManager { { method: 'POST', headers: headersMap, - data: serializeCreateShieldInformationBarrierChangeStatusRequestBody( + data: serializeUpdateShieldInformationBarrierStatusRequestBody( requestBody ), contentType: 'application/json', @@ -230,16 +227,16 @@ export class ShieldInformationBarriersManager { return deserializeShieldInformationBarrier(response.data); } } -export function serializeCreateShieldInformationBarrierChangeStatusRequestBodyStatusField( - val: CreateShieldInformationBarrierChangeStatusRequestBodyStatusField +export function serializeUpdateShieldInformationBarrierStatusRequestBodyStatusField( + val: UpdateShieldInformationBarrierStatusRequestBodyStatusField ): SerializedData { return val; } -export function deserializeCreateShieldInformationBarrierChangeStatusRequestBodyStatusField( +export function deserializeUpdateShieldInformationBarrierStatusRequestBodyStatusField( val: any -): CreateShieldInformationBarrierChangeStatusRequestBodyStatusField { +): UpdateShieldInformationBarrierStatusRequestBodyStatusField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateShieldInformationBarrierChangeStatusRequestBodyStatusField"'; + throw 'Expecting a string for "UpdateShieldInformationBarrierStatusRequestBodyStatusField"'; } if (val == 'pending') { return 'pending'; @@ -249,29 +246,29 @@ export function deserializeCreateShieldInformationBarrierChangeStatusRequestBody } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateShieldInformationBarrierChangeStatusRequestBody( - val: CreateShieldInformationBarrierChangeStatusRequestBody +export function serializeUpdateShieldInformationBarrierStatusRequestBody( + val: UpdateShieldInformationBarrierStatusRequestBody ): SerializedData { return { ['id']: val.id, ['status']: - serializeCreateShieldInformationBarrierChangeStatusRequestBodyStatusField( + serializeUpdateShieldInformationBarrierStatusRequestBodyStatusField( val.status ), }; } -export function deserializeCreateShieldInformationBarrierChangeStatusRequestBody( +export function deserializeUpdateShieldInformationBarrierStatusRequestBody( val: any -): CreateShieldInformationBarrierChangeStatusRequestBody { +): UpdateShieldInformationBarrierStatusRequestBody { const id: string = val.id; - const status: CreateShieldInformationBarrierChangeStatusRequestBodyStatusField = - deserializeCreateShieldInformationBarrierChangeStatusRequestBodyStatusField( + const status: UpdateShieldInformationBarrierStatusRequestBodyStatusField = + deserializeUpdateShieldInformationBarrierStatusRequestBodyStatusField( val.status ); return { id: id, status: status, - } satisfies CreateShieldInformationBarrierChangeStatusRequestBody; + } satisfies UpdateShieldInformationBarrierStatusRequestBody; } export function serializeCreateShieldInformationBarrierRequestBody( val: CreateShieldInformationBarrierRequestBody diff --git a/src/managers/skills.generated.ts b/src/managers/skills.generated.ts index e37c5f5a..58d084eb 100644 --- a/src/managers/skills.generated.ts +++ b/src/managers/skills.generated.ts @@ -24,110 +24,102 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export class GetFileMetadataGlobalBoxSkillsCardsHeaders { +export class GetBoxSkillCardsOnFileHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial< - Pick - > + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface CreateFileMetadataGlobalBoxSkillsCardRequestBody { +export interface CreateBoxSkillCardsOnFileRequestBody { readonly cards: readonly KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard[]; } -export class CreateFileMetadataGlobalBoxSkillsCardHeaders { +export class CreateBoxSkillCardsOnFileHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial< - Pick - > + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField = 'replace'; -export interface UpdateFileMetadataGlobalBoxSkillsCardRequestBody { - readonly op?: UpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField; +export type UpdateBoxSkillCardsOnFileRequestBodyOpField = 'replace'; +export interface UpdateBoxSkillCardsOnFileRequestBody { + readonly op?: UpdateBoxSkillCardsOnFileRequestBodyOpField; readonly path?: string; readonly value?: KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard; } -export class UpdateFileMetadataGlobalBoxSkillsCardHeaders { +export class UpdateBoxSkillCardsOnFileHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial< - Pick - > + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteFileMetadataGlobalBoxSkillsCardHeaders { +export class DeleteBoxSkillCardsFromFileHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial< - Pick - > + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateSkillInvocationByIdRequestBodyStatusField = +export type UpdateAllSkillCardsOnFileRequestBodyStatusField = | 'invoked' | 'processing' | 'success' | 'transient_failure' | 'permanent_failure'; -export interface UpdateSkillInvocationByIdRequestBodyMetadataField { +export interface UpdateAllSkillCardsOnFileRequestBodyMetadataField { readonly cards?: readonly KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard[]; } -export type UpdateSkillInvocationByIdRequestBodyFileTypeField = 'file'; -export interface UpdateSkillInvocationByIdRequestBodyFileField { - readonly type?: UpdateSkillInvocationByIdRequestBodyFileTypeField; +export type UpdateAllSkillCardsOnFileRequestBodyFileTypeField = 'file'; +export interface UpdateAllSkillCardsOnFileRequestBodyFileField { + readonly type?: UpdateAllSkillCardsOnFileRequestBodyFileTypeField; readonly id?: string; } -export type UpdateSkillInvocationByIdRequestBodyFileVersionTypeField = +export type UpdateAllSkillCardsOnFileRequestBodyFileVersionTypeField = 'file_version'; -export interface UpdateSkillInvocationByIdRequestBodyFileVersionField { - readonly type?: UpdateSkillInvocationByIdRequestBodyFileVersionTypeField; +export interface UpdateAllSkillCardsOnFileRequestBodyFileVersionField { + readonly type?: UpdateAllSkillCardsOnFileRequestBodyFileVersionTypeField; readonly id?: string; } -export interface UpdateSkillInvocationByIdRequestBodyUsageField { +export interface UpdateAllSkillCardsOnFileRequestBodyUsageField { readonly unit?: string; readonly value?: number; } -export interface UpdateSkillInvocationByIdRequestBody { - readonly status: UpdateSkillInvocationByIdRequestBodyStatusField; - readonly metadata: UpdateSkillInvocationByIdRequestBodyMetadataField; - readonly file: UpdateSkillInvocationByIdRequestBodyFileField; - readonly fileVersion?: UpdateSkillInvocationByIdRequestBodyFileVersionField; - readonly usage?: UpdateSkillInvocationByIdRequestBodyUsageField; +export interface UpdateAllSkillCardsOnFileRequestBody { + readonly status: UpdateAllSkillCardsOnFileRequestBodyStatusField; + readonly metadata: UpdateAllSkillCardsOnFileRequestBodyMetadataField; + readonly file: UpdateAllSkillCardsOnFileRequestBodyFileField; + readonly fileVersion?: UpdateAllSkillCardsOnFileRequestBodyFileVersionField; + readonly usage?: UpdateAllSkillCardsOnFileRequestBodyUsageField; } -export class UpdateSkillInvocationByIdHeaders { +export class UpdateAllSkillCardsOnFileHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } @@ -140,19 +132,19 @@ export class SkillsManager { | Omit< SkillsManager, | 'networkSession' - | 'getFileMetadataGlobalBoxSkillsCards' - | 'createFileMetadataGlobalBoxSkillsCard' - | 'updateFileMetadataGlobalBoxSkillsCard' - | 'deleteFileMetadataGlobalBoxSkillsCard' - | 'updateSkillInvocationById' + | 'getBoxSkillCardsOnFile' + | 'createBoxSkillCardsOnFile' + | 'updateBoxSkillCardsOnFile' + | 'deleteBoxSkillCardsFromFile' + | 'updateAllSkillCardsOnFile' > | Partial> ) { Object.assign(this, fields); } - async getFileMetadataGlobalBoxSkillsCards( + async getBoxSkillCardsOnFile( fileId: string, - headers: GetFileMetadataGlobalBoxSkillsCardsHeaders = new GetFileMetadataGlobalBoxSkillsCardsHeaders( + headers: GetBoxSkillCardsOnFileHeaders = new GetBoxSkillCardsOnFileHeaders( {} ), cancellationToken?: CancellationToken @@ -178,10 +170,10 @@ export class SkillsManager { )) as FetchResponse; return deserializeSkillCardsMetadata(response.data); } - async createFileMetadataGlobalBoxSkillsCard( + async createBoxSkillCardsOnFile( fileId: string, - requestBody: CreateFileMetadataGlobalBoxSkillsCardRequestBody, - headers: CreateFileMetadataGlobalBoxSkillsCardHeaders = new CreateFileMetadataGlobalBoxSkillsCardHeaders( + requestBody: CreateBoxSkillCardsOnFileRequestBody, + headers: CreateBoxSkillCardsOnFileHeaders = new CreateBoxSkillCardsOnFileHeaders( {} ), cancellationToken?: CancellationToken @@ -199,9 +191,7 @@ export class SkillsManager { { method: 'POST', headers: headersMap, - data: serializeCreateFileMetadataGlobalBoxSkillsCardRequestBody( - requestBody - ), + data: serializeCreateBoxSkillCardsOnFileRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -211,10 +201,10 @@ export class SkillsManager { )) as FetchResponse; return deserializeSkillCardsMetadata(response.data); } - async updateFileMetadataGlobalBoxSkillsCard( + async updateBoxSkillCardsOnFile( fileId: string, - requestBody: readonly UpdateFileMetadataGlobalBoxSkillsCardRequestBody[], - headers: UpdateFileMetadataGlobalBoxSkillsCardHeaders = new UpdateFileMetadataGlobalBoxSkillsCardHeaders( + requestBody: readonly UpdateBoxSkillCardsOnFileRequestBody[], + headers: UpdateBoxSkillCardsOnFileHeaders = new UpdateBoxSkillCardsOnFileHeaders( {} ), cancellationToken?: CancellationToken @@ -233,7 +223,7 @@ export class SkillsManager { method: 'PUT', headers: headersMap, data: requestBody.map( - serializeUpdateFileMetadataGlobalBoxSkillsCardRequestBody + serializeUpdateBoxSkillCardsOnFileRequestBody ) as readonly any[], contentType: 'application/json-patch+json', responseFormat: 'json', @@ -244,9 +234,9 @@ export class SkillsManager { )) as FetchResponse; return deserializeSkillCardsMetadata(response.data); } - async deleteFileMetadataGlobalBoxSkillsCard( + async deleteBoxSkillCardsFromFile( fileId: string, - headers: DeleteFileMetadataGlobalBoxSkillsCardHeaders = new DeleteFileMetadataGlobalBoxSkillsCardHeaders( + headers: DeleteBoxSkillCardsFromFileHeaders = new DeleteBoxSkillCardsFromFileHeaders( {} ), cancellationToken?: CancellationToken @@ -272,10 +262,10 @@ export class SkillsManager { )) as FetchResponse; return void 0; } - async updateSkillInvocationById( + async updateAllSkillCardsOnFile( skillId: string, - requestBody: UpdateSkillInvocationByIdRequestBody, - headers: UpdateSkillInvocationByIdHeaders = new UpdateSkillInvocationByIdHeaders( + requestBody: UpdateAllSkillCardsOnFileRequestBody, + headers: UpdateAllSkillCardsOnFileHeaders = new UpdateAllSkillCardsOnFileHeaders( {} ), cancellationToken?: CancellationToken @@ -292,7 +282,7 @@ export class SkillsManager { { method: 'PUT', headers: headersMap, - data: serializeUpdateSkillInvocationByIdRequestBody(requestBody), + data: serializeUpdateAllSkillCardsOnFileRequestBody(requestBody), contentType: 'application/json', responseFormat: void 0, auth: this.auth, @@ -303,8 +293,8 @@ export class SkillsManager { return void 0; } } -export function serializeCreateFileMetadataGlobalBoxSkillsCardRequestBody( - val: CreateFileMetadataGlobalBoxSkillsCardRequestBody +export function serializeCreateBoxSkillCardsOnFileRequestBody( + val: CreateBoxSkillCardsOnFileRequestBody ): SerializedData { return { ['cards']: val.cards.map(function ( @@ -316,9 +306,9 @@ export function serializeCreateFileMetadataGlobalBoxSkillsCardRequestBody( }) as readonly any[], }; } -export function deserializeCreateFileMetadataGlobalBoxSkillsCardRequestBody( +export function deserializeCreateBoxSkillCardsOnFileRequestBody( val: any -): CreateFileMetadataGlobalBoxSkillsCardRequestBody { +): CreateBoxSkillCardsOnFileRequestBody { const cards: readonly KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard[] = sdIsList(val.cards) ? (val.cards.map(function (itm: SerializedData): any { @@ -327,36 +317,32 @@ export function deserializeCreateFileMetadataGlobalBoxSkillsCardRequestBody( ); }) as readonly any[]) : []; - return { - cards: cards, - } satisfies CreateFileMetadataGlobalBoxSkillsCardRequestBody; + return { cards: cards } satisfies CreateBoxSkillCardsOnFileRequestBody; } -export function serializeUpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField( - val: UpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField +export function serializeUpdateBoxSkillCardsOnFileRequestBodyOpField( + val: UpdateBoxSkillCardsOnFileRequestBodyOpField ): SerializedData { return val; } -export function deserializeUpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField( +export function deserializeUpdateBoxSkillCardsOnFileRequestBodyOpField( val: any -): UpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField { +): UpdateBoxSkillCardsOnFileRequestBodyOpField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField"'; + throw 'Expecting a string for "UpdateBoxSkillCardsOnFileRequestBodyOpField"'; } if (val == 'replace') { return 'replace'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateFileMetadataGlobalBoxSkillsCardRequestBody( - val: UpdateFileMetadataGlobalBoxSkillsCardRequestBody +export function serializeUpdateBoxSkillCardsOnFileRequestBody( + val: UpdateBoxSkillCardsOnFileRequestBody ): SerializedData { return { ['op']: val.op == void 0 ? void 0 - : serializeUpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField( - val.op - ), + : serializeUpdateBoxSkillCardsOnFileRequestBodyOpField(val.op), ['path']: val.path == void 0 ? void 0 : val.path, ['value']: val.value == void 0 @@ -366,17 +352,13 @@ export function serializeUpdateFileMetadataGlobalBoxSkillsCardRequestBody( ), }; } -export function deserializeUpdateFileMetadataGlobalBoxSkillsCardRequestBody( +export function deserializeUpdateBoxSkillCardsOnFileRequestBody( val: any -): UpdateFileMetadataGlobalBoxSkillsCardRequestBody { - const op: - | undefined - | UpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField = +): UpdateBoxSkillCardsOnFileRequestBody { + const op: undefined | UpdateBoxSkillCardsOnFileRequestBodyOpField = val.op == void 0 ? void 0 - : deserializeUpdateFileMetadataGlobalBoxSkillsCardRequestBodyOpField( - val.op - ); + : deserializeUpdateBoxSkillCardsOnFileRequestBodyOpField(val.op); const path: undefined | string = val.path == void 0 ? void 0 : val.path; const value: | undefined @@ -390,18 +372,18 @@ export function deserializeUpdateFileMetadataGlobalBoxSkillsCardRequestBody( op: op, path: path, value: value, - } satisfies UpdateFileMetadataGlobalBoxSkillsCardRequestBody; + } satisfies UpdateBoxSkillCardsOnFileRequestBody; } -export function serializeUpdateSkillInvocationByIdRequestBodyStatusField( - val: UpdateSkillInvocationByIdRequestBodyStatusField +export function serializeUpdateAllSkillCardsOnFileRequestBodyStatusField( + val: UpdateAllSkillCardsOnFileRequestBodyStatusField ): SerializedData { return val; } -export function deserializeUpdateSkillInvocationByIdRequestBodyStatusField( +export function deserializeUpdateAllSkillCardsOnFileRequestBodyStatusField( val: any -): UpdateSkillInvocationByIdRequestBodyStatusField { +): UpdateAllSkillCardsOnFileRequestBodyStatusField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateSkillInvocationByIdRequestBodyStatusField"'; + throw 'Expecting a string for "UpdateAllSkillCardsOnFileRequestBodyStatusField"'; } if (val == 'invoked') { return 'invoked'; @@ -420,8 +402,8 @@ export function deserializeUpdateSkillInvocationByIdRequestBodyStatusField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateSkillInvocationByIdRequestBodyMetadataField( - val: UpdateSkillInvocationByIdRequestBodyMetadataField +export function serializeUpdateAllSkillCardsOnFileRequestBodyMetadataField( + val: UpdateAllSkillCardsOnFileRequestBodyMetadataField ): SerializedData { return { ['cards']: @@ -436,9 +418,9 @@ export function serializeUpdateSkillInvocationByIdRequestBodyMetadataField( }) as readonly any[]), }; } -export function deserializeUpdateSkillInvocationByIdRequestBodyMetadataField( +export function deserializeUpdateAllSkillCardsOnFileRequestBodyMetadataField( val: any -): UpdateSkillInvocationByIdRequestBodyMetadataField { +): UpdateAllSkillCardsOnFileRequestBodyMetadataField { const cards: | undefined | readonly KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard[] = @@ -453,161 +435,161 @@ export function deserializeUpdateSkillInvocationByIdRequestBodyMetadataField( : []; return { cards: cards, - } satisfies UpdateSkillInvocationByIdRequestBodyMetadataField; + } satisfies UpdateAllSkillCardsOnFileRequestBodyMetadataField; } -export function serializeUpdateSkillInvocationByIdRequestBodyFileTypeField( - val: UpdateSkillInvocationByIdRequestBodyFileTypeField +export function serializeUpdateAllSkillCardsOnFileRequestBodyFileTypeField( + val: UpdateAllSkillCardsOnFileRequestBodyFileTypeField ): SerializedData { return val; } -export function deserializeUpdateSkillInvocationByIdRequestBodyFileTypeField( +export function deserializeUpdateAllSkillCardsOnFileRequestBodyFileTypeField( val: any -): UpdateSkillInvocationByIdRequestBodyFileTypeField { +): UpdateAllSkillCardsOnFileRequestBodyFileTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateSkillInvocationByIdRequestBodyFileTypeField"'; + throw 'Expecting a string for "UpdateAllSkillCardsOnFileRequestBodyFileTypeField"'; } if (val == 'file') { return 'file'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateSkillInvocationByIdRequestBodyFileField( - val: UpdateSkillInvocationByIdRequestBodyFileField +export function serializeUpdateAllSkillCardsOnFileRequestBodyFileField( + val: UpdateAllSkillCardsOnFileRequestBodyFileField ): SerializedData { return { ['type']: val.type == void 0 ? void 0 - : serializeUpdateSkillInvocationByIdRequestBodyFileTypeField(val.type), + : serializeUpdateAllSkillCardsOnFileRequestBodyFileTypeField(val.type), ['id']: val.id == void 0 ? void 0 : val.id, }; } -export function deserializeUpdateSkillInvocationByIdRequestBodyFileField( +export function deserializeUpdateAllSkillCardsOnFileRequestBodyFileField( val: any -): UpdateSkillInvocationByIdRequestBodyFileField { - const type: undefined | UpdateSkillInvocationByIdRequestBodyFileTypeField = +): UpdateAllSkillCardsOnFileRequestBodyFileField { + const type: undefined | UpdateAllSkillCardsOnFileRequestBodyFileTypeField = val.type == void 0 ? void 0 - : deserializeUpdateSkillInvocationByIdRequestBodyFileTypeField(val.type); + : deserializeUpdateAllSkillCardsOnFileRequestBodyFileTypeField(val.type); const id: undefined | string = val.id == void 0 ? void 0 : val.id; return { type: type, id: id, - } satisfies UpdateSkillInvocationByIdRequestBodyFileField; + } satisfies UpdateAllSkillCardsOnFileRequestBodyFileField; } -export function serializeUpdateSkillInvocationByIdRequestBodyFileVersionTypeField( - val: UpdateSkillInvocationByIdRequestBodyFileVersionTypeField +export function serializeUpdateAllSkillCardsOnFileRequestBodyFileVersionTypeField( + val: UpdateAllSkillCardsOnFileRequestBodyFileVersionTypeField ): SerializedData { return val; } -export function deserializeUpdateSkillInvocationByIdRequestBodyFileVersionTypeField( +export function deserializeUpdateAllSkillCardsOnFileRequestBodyFileVersionTypeField( val: any -): UpdateSkillInvocationByIdRequestBodyFileVersionTypeField { +): UpdateAllSkillCardsOnFileRequestBodyFileVersionTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateSkillInvocationByIdRequestBodyFileVersionTypeField"'; + throw 'Expecting a string for "UpdateAllSkillCardsOnFileRequestBodyFileVersionTypeField"'; } if (val == 'file_version') { return 'file_version'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateSkillInvocationByIdRequestBodyFileVersionField( - val: UpdateSkillInvocationByIdRequestBodyFileVersionField +export function serializeUpdateAllSkillCardsOnFileRequestBodyFileVersionField( + val: UpdateAllSkillCardsOnFileRequestBodyFileVersionField ): SerializedData { return { ['type']: val.type == void 0 ? void 0 - : serializeUpdateSkillInvocationByIdRequestBodyFileVersionTypeField( + : serializeUpdateAllSkillCardsOnFileRequestBodyFileVersionTypeField( val.type ), ['id']: val.id == void 0 ? void 0 : val.id, }; } -export function deserializeUpdateSkillInvocationByIdRequestBodyFileVersionField( +export function deserializeUpdateAllSkillCardsOnFileRequestBodyFileVersionField( val: any -): UpdateSkillInvocationByIdRequestBodyFileVersionField { +): UpdateAllSkillCardsOnFileRequestBodyFileVersionField { const type: | undefined - | UpdateSkillInvocationByIdRequestBodyFileVersionTypeField = + | UpdateAllSkillCardsOnFileRequestBodyFileVersionTypeField = val.type == void 0 ? void 0 - : deserializeUpdateSkillInvocationByIdRequestBodyFileVersionTypeField( + : deserializeUpdateAllSkillCardsOnFileRequestBodyFileVersionTypeField( val.type ); const id: undefined | string = val.id == void 0 ? void 0 : val.id; return { type: type, id: id, - } satisfies UpdateSkillInvocationByIdRequestBodyFileVersionField; + } satisfies UpdateAllSkillCardsOnFileRequestBodyFileVersionField; } -export function serializeUpdateSkillInvocationByIdRequestBodyUsageField( - val: UpdateSkillInvocationByIdRequestBodyUsageField +export function serializeUpdateAllSkillCardsOnFileRequestBodyUsageField( + val: UpdateAllSkillCardsOnFileRequestBodyUsageField ): SerializedData { return { ['unit']: val.unit == void 0 ? void 0 : val.unit, ['value']: val.value == void 0 ? void 0 : val.value, }; } -export function deserializeUpdateSkillInvocationByIdRequestBodyUsageField( +export function deserializeUpdateAllSkillCardsOnFileRequestBodyUsageField( val: any -): UpdateSkillInvocationByIdRequestBodyUsageField { +): UpdateAllSkillCardsOnFileRequestBodyUsageField { const unit: undefined | string = val.unit == void 0 ? void 0 : val.unit; const value: undefined | number = val.value == void 0 ? void 0 : val.value; return { unit: unit, value: value, - } satisfies UpdateSkillInvocationByIdRequestBodyUsageField; + } satisfies UpdateAllSkillCardsOnFileRequestBodyUsageField; } -export function serializeUpdateSkillInvocationByIdRequestBody( - val: UpdateSkillInvocationByIdRequestBody +export function serializeUpdateAllSkillCardsOnFileRequestBody( + val: UpdateAllSkillCardsOnFileRequestBody ): SerializedData { return { - ['status']: serializeUpdateSkillInvocationByIdRequestBodyStatusField( + ['status']: serializeUpdateAllSkillCardsOnFileRequestBodyStatusField( val.status ), - ['metadata']: serializeUpdateSkillInvocationByIdRequestBodyMetadataField( + ['metadata']: serializeUpdateAllSkillCardsOnFileRequestBodyMetadataField( val.metadata ), - ['file']: serializeUpdateSkillInvocationByIdRequestBodyFileField(val.file), + ['file']: serializeUpdateAllSkillCardsOnFileRequestBodyFileField(val.file), ['file_version']: val.fileVersion == void 0 ? void 0 - : serializeUpdateSkillInvocationByIdRequestBodyFileVersionField( + : serializeUpdateAllSkillCardsOnFileRequestBodyFileVersionField( val.fileVersion ), ['usage']: val.usage == void 0 ? void 0 - : serializeUpdateSkillInvocationByIdRequestBodyUsageField(val.usage), + : serializeUpdateAllSkillCardsOnFileRequestBodyUsageField(val.usage), }; } -export function deserializeUpdateSkillInvocationByIdRequestBody( +export function deserializeUpdateAllSkillCardsOnFileRequestBody( val: any -): UpdateSkillInvocationByIdRequestBody { - const status: UpdateSkillInvocationByIdRequestBodyStatusField = - deserializeUpdateSkillInvocationByIdRequestBodyStatusField(val.status); - const metadata: UpdateSkillInvocationByIdRequestBodyMetadataField = - deserializeUpdateSkillInvocationByIdRequestBodyMetadataField(val.metadata); - const file: UpdateSkillInvocationByIdRequestBodyFileField = - deserializeUpdateSkillInvocationByIdRequestBodyFileField(val.file); +): UpdateAllSkillCardsOnFileRequestBody { + const status: UpdateAllSkillCardsOnFileRequestBodyStatusField = + deserializeUpdateAllSkillCardsOnFileRequestBodyStatusField(val.status); + const metadata: UpdateAllSkillCardsOnFileRequestBodyMetadataField = + deserializeUpdateAllSkillCardsOnFileRequestBodyMetadataField(val.metadata); + const file: UpdateAllSkillCardsOnFileRequestBodyFileField = + deserializeUpdateAllSkillCardsOnFileRequestBodyFileField(val.file); const fileVersion: | undefined - | UpdateSkillInvocationByIdRequestBodyFileVersionField = + | UpdateAllSkillCardsOnFileRequestBodyFileVersionField = val.file_version == void 0 ? void 0 - : deserializeUpdateSkillInvocationByIdRequestBodyFileVersionField( + : deserializeUpdateAllSkillCardsOnFileRequestBodyFileVersionField( val.file_version ); - const usage: undefined | UpdateSkillInvocationByIdRequestBodyUsageField = + const usage: undefined | UpdateAllSkillCardsOnFileRequestBodyUsageField = val.usage == void 0 ? void 0 - : deserializeUpdateSkillInvocationByIdRequestBodyUsageField(val.usage); + : deserializeUpdateAllSkillCardsOnFileRequestBodyUsageField(val.usage); return { status: status, metadata: metadata, file: file, fileVersion: fileVersion, usage: usage, - } satisfies UpdateSkillInvocationByIdRequestBody; + } satisfies UpdateAllSkillCardsOnFileRequestBody; } diff --git a/src/managers/termsOfServiceUserStatuses.generated.ts b/src/managers/termsOfServiceUserStatuses.generated.ts index aef4f720..2f7cc944 100644 --- a/src/managers/termsOfServiceUserStatuses.generated.ts +++ b/src/managers/termsOfServiceUserStatuses.generated.ts @@ -24,61 +24,63 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export interface GetTermOfServiceUserStatusesQueryParams { +export interface GetTermsOfServiceUserStatusesQueryParams { readonly tosId: string; readonly userId?: string; } -export class GetTermOfServiceUserStatusesHeaders { +export class GetTermsOfServiceUserStatusesHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateTermOfServiceUserStatusRequestBodyTosTypeField = +export type CreateTermsOfServiceStatusForUserRequestBodyTosTypeField = 'terms_of_service'; -export interface CreateTermOfServiceUserStatusRequestBodyTosField { - readonly type: CreateTermOfServiceUserStatusRequestBodyTosTypeField; +export interface CreateTermsOfServiceStatusForUserRequestBodyTosField { + readonly type: CreateTermsOfServiceStatusForUserRequestBodyTosTypeField; readonly id: string; } -export type CreateTermOfServiceUserStatusRequestBodyUserTypeField = 'user'; -export interface CreateTermOfServiceUserStatusRequestBodyUserField { - readonly type: CreateTermOfServiceUserStatusRequestBodyUserTypeField; +export type CreateTermsOfServiceStatusForUserRequestBodyUserTypeField = 'user'; +export interface CreateTermsOfServiceStatusForUserRequestBodyUserField { + readonly type: CreateTermsOfServiceStatusForUserRequestBodyUserTypeField; readonly id: string; } -export interface CreateTermOfServiceUserStatusRequestBody { - readonly tos: CreateTermOfServiceUserStatusRequestBodyTosField; - readonly user: CreateTermOfServiceUserStatusRequestBodyUserField; +export interface CreateTermsOfServiceStatusForUserRequestBody { + readonly tos: CreateTermsOfServiceStatusForUserRequestBodyTosField; + readonly user: CreateTermsOfServiceStatusForUserRequestBodyUserField; readonly isAccepted: boolean; } -export class CreateTermOfServiceUserStatusHeaders { +export class CreateTermsOfServiceStatusForUserHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export interface UpdateTermOfServiceUserStatusByIdRequestBody { +export interface UpdateTermsOfServiceStatusForUserByIdRequestBody { readonly isAccepted: boolean; } -export class UpdateTermOfServiceUserStatusByIdHeaders { +export class UpdateTermsOfServiceStatusForUserByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial< + Pick + > ) { Object.assign(this, fields); } @@ -91,17 +93,17 @@ export class TermsOfServiceUserStatusesManager { | Omit< TermsOfServiceUserStatusesManager, | 'networkSession' - | 'getTermOfServiceUserStatuses' - | 'createTermOfServiceUserStatus' - | 'updateTermOfServiceUserStatusById' + | 'getTermsOfServiceUserStatuses' + | 'createTermsOfServiceStatusForUser' + | 'updateTermsOfServiceStatusForUserById' > | Partial> ) { Object.assign(this, fields); } - async getTermOfServiceUserStatuses( - queryParams: GetTermOfServiceUserStatusesQueryParams, - headers: GetTermOfServiceUserStatusesHeaders = new GetTermOfServiceUserStatusesHeaders( + async getTermsOfServiceUserStatuses( + queryParams: GetTermsOfServiceUserStatusesQueryParams, + headers: GetTermsOfServiceUserStatusesHeaders = new GetTermsOfServiceUserStatusesHeaders( {} ), cancellationToken?: CancellationToken @@ -132,9 +134,9 @@ export class TermsOfServiceUserStatusesManager { )) as FetchResponse; return deserializeTermsOfServiceUserStatuses(response.data); } - async createTermOfServiceUserStatus( - requestBody: CreateTermOfServiceUserStatusRequestBody, - headers: CreateTermOfServiceUserStatusHeaders = new CreateTermOfServiceUserStatusHeaders( + async createTermsOfServiceStatusForUser( + requestBody: CreateTermsOfServiceStatusForUserRequestBody, + headers: CreateTermsOfServiceStatusForUserHeaders = new CreateTermsOfServiceStatusForUserHeaders( {} ), cancellationToken?: CancellationToken @@ -150,7 +152,9 @@ export class TermsOfServiceUserStatusesManager { { method: 'POST', headers: headersMap, - data: serializeCreateTermOfServiceUserStatusRequestBody(requestBody), + data: serializeCreateTermsOfServiceStatusForUserRequestBody( + requestBody + ), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -160,10 +164,10 @@ export class TermsOfServiceUserStatusesManager { )) as FetchResponse; return deserializeTermsOfServiceUserStatus(response.data); } - async updateTermOfServiceUserStatusById( + async updateTermsOfServiceStatusForUserById( termsOfServiceUserStatusId: string, - requestBody: UpdateTermOfServiceUserStatusByIdRequestBody, - headers: UpdateTermOfServiceUserStatusByIdHeaders = new UpdateTermOfServiceUserStatusByIdHeaders( + requestBody: UpdateTermsOfServiceStatusForUserByIdRequestBody, + headers: UpdateTermsOfServiceStatusForUserByIdHeaders = new UpdateTermsOfServiceStatusForUserByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -180,7 +184,7 @@ export class TermsOfServiceUserStatusesManager { { method: 'PUT', headers: headersMap, - data: serializeUpdateTermOfServiceUserStatusByIdRequestBody( + data: serializeUpdateTermsOfServiceStatusForUserByIdRequestBody( requestBody ), contentType: 'application/json', @@ -193,115 +197,122 @@ export class TermsOfServiceUserStatusesManager { return deserializeTermsOfServiceUserStatus(response.data); } } -export function serializeCreateTermOfServiceUserStatusRequestBodyTosTypeField( - val: CreateTermOfServiceUserStatusRequestBodyTosTypeField +export function serializeCreateTermsOfServiceStatusForUserRequestBodyTosTypeField( + val: CreateTermsOfServiceStatusForUserRequestBodyTosTypeField ): SerializedData { return val; } -export function deserializeCreateTermOfServiceUserStatusRequestBodyTosTypeField( +export function deserializeCreateTermsOfServiceStatusForUserRequestBodyTosTypeField( val: any -): CreateTermOfServiceUserStatusRequestBodyTosTypeField { +): CreateTermsOfServiceStatusForUserRequestBodyTosTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateTermOfServiceUserStatusRequestBodyTosTypeField"'; + throw 'Expecting a string for "CreateTermsOfServiceStatusForUserRequestBodyTosTypeField"'; } if (val == 'terms_of_service') { return 'terms_of_service'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateTermOfServiceUserStatusRequestBodyTosField( - val: CreateTermOfServiceUserStatusRequestBodyTosField +export function serializeCreateTermsOfServiceStatusForUserRequestBodyTosField( + val: CreateTermsOfServiceStatusForUserRequestBodyTosField ): SerializedData { return { - ['type']: serializeCreateTermOfServiceUserStatusRequestBodyTosTypeField( + ['type']: serializeCreateTermsOfServiceStatusForUserRequestBodyTosTypeField( val.type ), ['id']: val.id, }; } -export function deserializeCreateTermOfServiceUserStatusRequestBodyTosField( +export function deserializeCreateTermsOfServiceStatusForUserRequestBodyTosField( val: any -): CreateTermOfServiceUserStatusRequestBodyTosField { - const type: CreateTermOfServiceUserStatusRequestBodyTosTypeField = - deserializeCreateTermOfServiceUserStatusRequestBodyTosTypeField(val.type); +): CreateTermsOfServiceStatusForUserRequestBodyTosField { + const type: CreateTermsOfServiceStatusForUserRequestBodyTosTypeField = + deserializeCreateTermsOfServiceStatusForUserRequestBodyTosTypeField( + val.type + ); const id: string = val.id; return { type: type, id: id, - } satisfies CreateTermOfServiceUserStatusRequestBodyTosField; + } satisfies CreateTermsOfServiceStatusForUserRequestBodyTosField; } -export function serializeCreateTermOfServiceUserStatusRequestBodyUserTypeField( - val: CreateTermOfServiceUserStatusRequestBodyUserTypeField +export function serializeCreateTermsOfServiceStatusForUserRequestBodyUserTypeField( + val: CreateTermsOfServiceStatusForUserRequestBodyUserTypeField ): SerializedData { return val; } -export function deserializeCreateTermOfServiceUserStatusRequestBodyUserTypeField( +export function deserializeCreateTermsOfServiceStatusForUserRequestBodyUserTypeField( val: any -): CreateTermOfServiceUserStatusRequestBodyUserTypeField { +): CreateTermsOfServiceStatusForUserRequestBodyUserTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateTermOfServiceUserStatusRequestBodyUserTypeField"'; + throw 'Expecting a string for "CreateTermsOfServiceStatusForUserRequestBodyUserTypeField"'; } if (val == 'user') { return 'user'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateTermOfServiceUserStatusRequestBodyUserField( - val: CreateTermOfServiceUserStatusRequestBodyUserField +export function serializeCreateTermsOfServiceStatusForUserRequestBodyUserField( + val: CreateTermsOfServiceStatusForUserRequestBodyUserField ): SerializedData { return { - ['type']: serializeCreateTermOfServiceUserStatusRequestBodyUserTypeField( - val.type - ), + ['type']: + serializeCreateTermsOfServiceStatusForUserRequestBodyUserTypeField( + val.type + ), ['id']: val.id, }; } -export function deserializeCreateTermOfServiceUserStatusRequestBodyUserField( +export function deserializeCreateTermsOfServiceStatusForUserRequestBodyUserField( val: any -): CreateTermOfServiceUserStatusRequestBodyUserField { - const type: CreateTermOfServiceUserStatusRequestBodyUserTypeField = - deserializeCreateTermOfServiceUserStatusRequestBodyUserTypeField(val.type); +): CreateTermsOfServiceStatusForUserRequestBodyUserField { + const type: CreateTermsOfServiceStatusForUserRequestBodyUserTypeField = + deserializeCreateTermsOfServiceStatusForUserRequestBodyUserTypeField( + val.type + ); const id: string = val.id; return { type: type, id: id, - } satisfies CreateTermOfServiceUserStatusRequestBodyUserField; + } satisfies CreateTermsOfServiceStatusForUserRequestBodyUserField; } -export function serializeCreateTermOfServiceUserStatusRequestBody( - val: CreateTermOfServiceUserStatusRequestBody +export function serializeCreateTermsOfServiceStatusForUserRequestBody( + val: CreateTermsOfServiceStatusForUserRequestBody ): SerializedData { return { - ['tos']: serializeCreateTermOfServiceUserStatusRequestBodyTosField(val.tos), - ['user']: serializeCreateTermOfServiceUserStatusRequestBodyUserField( + ['tos']: serializeCreateTermsOfServiceStatusForUserRequestBodyTosField( + val.tos + ), + ['user']: serializeCreateTermsOfServiceStatusForUserRequestBodyUserField( val.user ), ['is_accepted']: val.isAccepted, }; } -export function deserializeCreateTermOfServiceUserStatusRequestBody( +export function deserializeCreateTermsOfServiceStatusForUserRequestBody( val: any -): CreateTermOfServiceUserStatusRequestBody { - const tos: CreateTermOfServiceUserStatusRequestBodyTosField = - deserializeCreateTermOfServiceUserStatusRequestBodyTosField(val.tos); - const user: CreateTermOfServiceUserStatusRequestBodyUserField = - deserializeCreateTermOfServiceUserStatusRequestBodyUserField(val.user); +): CreateTermsOfServiceStatusForUserRequestBody { + const tos: CreateTermsOfServiceStatusForUserRequestBodyTosField = + deserializeCreateTermsOfServiceStatusForUserRequestBodyTosField(val.tos); + const user: CreateTermsOfServiceStatusForUserRequestBodyUserField = + deserializeCreateTermsOfServiceStatusForUserRequestBodyUserField(val.user); const isAccepted: boolean = val.is_accepted; return { tos: tos, user: user, isAccepted: isAccepted, - } satisfies CreateTermOfServiceUserStatusRequestBody; + } satisfies CreateTermsOfServiceStatusForUserRequestBody; } -export function serializeUpdateTermOfServiceUserStatusByIdRequestBody( - val: UpdateTermOfServiceUserStatusByIdRequestBody +export function serializeUpdateTermsOfServiceStatusForUserByIdRequestBody( + val: UpdateTermsOfServiceStatusForUserByIdRequestBody ): SerializedData { return { ['is_accepted']: val.isAccepted }; } -export function deserializeUpdateTermOfServiceUserStatusByIdRequestBody( +export function deserializeUpdateTermsOfServiceStatusForUserByIdRequestBody( val: any -): UpdateTermOfServiceUserStatusByIdRequestBody { +): UpdateTermsOfServiceStatusForUserByIdRequestBody { const isAccepted: boolean = val.is_accepted; return { isAccepted: isAccepted, - } satisfies UpdateTermOfServiceUserStatusByIdRequestBody; + } satisfies UpdateTermsOfServiceStatusForUserByIdRequestBody; } diff --git a/src/managers/termsOfServices.generated.ts b/src/managers/termsOfServices.generated.ts index 05d42410..713ff1ca 100644 --- a/src/managers/termsOfServices.generated.ts +++ b/src/managers/termsOfServices.generated.ts @@ -27,68 +27,70 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export type GetTermOfServicesQueryParamsTosTypeField = 'external' | 'managed'; -export interface GetTermOfServicesQueryParams { - readonly tosType?: GetTermOfServicesQueryParamsTosTypeField; +export type GetTermsOfServiceQueryParamsTosTypeField = 'external' | 'managed'; +export interface GetTermsOfServiceQueryParams { + readonly tosType?: GetTermsOfServiceQueryParamsTosTypeField; } -export class GetTermOfServicesHeaders { +export class GetTermsOfServiceHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type CreateTermOfServiceRequestBodyStatusField = 'enabled' | 'disabled'; -export type CreateTermOfServiceRequestBodyTosTypeField = 'external' | 'managed'; -export interface CreateTermOfServiceRequestBody { - readonly status: CreateTermOfServiceRequestBodyStatusField; - readonly tosType?: CreateTermOfServiceRequestBodyTosTypeField; +export type CreateTermsOfServiceRequestBodyStatusField = 'enabled' | 'disabled'; +export type CreateTermsOfServiceRequestBodyTosTypeField = + | 'external' + | 'managed'; +export interface CreateTermsOfServiceRequestBody { + readonly status: CreateTermsOfServiceRequestBodyStatusField; + readonly tosType?: CreateTermsOfServiceRequestBodyTosTypeField; readonly text: string; } -export class CreateTermOfServiceHeaders { +export class CreateTermsOfServiceHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class GetTermOfServiceByIdHeaders { +export class GetTermsOfServiceByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export type UpdateTermOfServiceByIdRequestBodyStatusField = +export type UpdateTermsOfServiceByIdRequestBodyStatusField = | 'enabled' | 'disabled'; -export interface UpdateTermOfServiceByIdRequestBody { - readonly status: UpdateTermOfServiceByIdRequestBodyStatusField; +export interface UpdateTermsOfServiceByIdRequestBody { + readonly status: UpdateTermsOfServiceByIdRequestBodyStatusField; readonly text: string; } -export class UpdateTermOfServiceByIdHeaders { +export class UpdateTermsOfServiceByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } @@ -101,18 +103,18 @@ export class TermsOfServicesManager { | Omit< TermsOfServicesManager, | 'networkSession' - | 'getTermOfServices' - | 'createTermOfService' - | 'getTermOfServiceById' - | 'updateTermOfServiceById' + | 'getTermsOfService' + | 'createTermsOfService' + | 'getTermsOfServiceById' + | 'updateTermsOfServiceById' > | Partial> ) { Object.assign(this, fields); } - async getTermOfServices( - queryParams: GetTermOfServicesQueryParams = {} satisfies GetTermOfServicesQueryParams, - headers: GetTermOfServicesHeaders = new GetTermOfServicesHeaders({}), + async getTermsOfService( + queryParams: GetTermsOfServiceQueryParams = {} satisfies GetTermsOfServiceQueryParams, + headers: GetTermsOfServiceHeaders = new GetTermsOfServiceHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -140,9 +142,9 @@ export class TermsOfServicesManager { )) as FetchResponse; return deserializeTermsOfServices(response.data); } - async createTermOfService( - requestBody: CreateTermOfServiceRequestBody, - headers: CreateTermOfServiceHeaders = new CreateTermOfServiceHeaders({}), + async createTermsOfService( + requestBody: CreateTermsOfServiceRequestBody, + headers: CreateTermsOfServiceHeaders = new CreateTermsOfServiceHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -156,7 +158,7 @@ export class TermsOfServicesManager { { method: 'POST', headers: headersMap, - data: serializeCreateTermOfServiceRequestBody(requestBody), + data: serializeCreateTermsOfServiceRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -166,9 +168,11 @@ export class TermsOfServicesManager { )) as FetchResponse; return deserializeTask(response.data); } - async getTermOfServiceById( + async getTermsOfServiceById( termsOfServiceId: string, - headers: GetTermOfServiceByIdHeaders = new GetTermOfServiceByIdHeaders({}), + headers: GetTermsOfServiceByIdHeaders = new GetTermsOfServiceByIdHeaders( + {} + ), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -191,10 +195,10 @@ export class TermsOfServicesManager { )) as FetchResponse; return deserializeTermsOfService(response.data); } - async updateTermOfServiceById( + async updateTermsOfServiceById( termsOfServiceId: string, - requestBody: UpdateTermOfServiceByIdRequestBody, - headers: UpdateTermOfServiceByIdHeaders = new UpdateTermOfServiceByIdHeaders( + requestBody: UpdateTermsOfServiceByIdRequestBody, + headers: UpdateTermsOfServiceByIdHeaders = new UpdateTermsOfServiceByIdHeaders( {} ), cancellationToken?: CancellationToken @@ -211,7 +215,7 @@ export class TermsOfServicesManager { { method: 'PUT', headers: headersMap, - data: serializeUpdateTermOfServiceByIdRequestBody(requestBody), + data: serializeUpdateTermsOfServiceByIdRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -222,16 +226,16 @@ export class TermsOfServicesManager { return deserializeTermsOfService(response.data); } } -export function serializeGetTermOfServicesQueryParamsTosTypeField( - val: GetTermOfServicesQueryParamsTosTypeField +export function serializeGetTermsOfServiceQueryParamsTosTypeField( + val: GetTermsOfServiceQueryParamsTosTypeField ): SerializedData { return val; } -export function deserializeGetTermOfServicesQueryParamsTosTypeField( +export function deserializeGetTermsOfServiceQueryParamsTosTypeField( val: any -): GetTermOfServicesQueryParamsTosTypeField { +): GetTermsOfServiceQueryParamsTosTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetTermOfServicesQueryParamsTosTypeField"'; + throw 'Expecting a string for "GetTermsOfServiceQueryParamsTosTypeField"'; } if (val == 'external') { return 'external'; @@ -241,16 +245,16 @@ export function deserializeGetTermOfServicesQueryParamsTosTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateTermOfServiceRequestBodyStatusField( - val: CreateTermOfServiceRequestBodyStatusField +export function serializeCreateTermsOfServiceRequestBodyStatusField( + val: CreateTermsOfServiceRequestBodyStatusField ): SerializedData { return val; } -export function deserializeCreateTermOfServiceRequestBodyStatusField( +export function deserializeCreateTermsOfServiceRequestBodyStatusField( val: any -): CreateTermOfServiceRequestBodyStatusField { +): CreateTermsOfServiceRequestBodyStatusField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateTermOfServiceRequestBodyStatusField"'; + throw 'Expecting a string for "CreateTermsOfServiceRequestBodyStatusField"'; } if (val == 'enabled') { return 'enabled'; @@ -260,16 +264,16 @@ export function deserializeCreateTermOfServiceRequestBodyStatusField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateTermOfServiceRequestBodyTosTypeField( - val: CreateTermOfServiceRequestBodyTosTypeField +export function serializeCreateTermsOfServiceRequestBodyTosTypeField( + val: CreateTermsOfServiceRequestBodyTosTypeField ): SerializedData { return val; } -export function deserializeCreateTermOfServiceRequestBodyTosTypeField( +export function deserializeCreateTermsOfServiceRequestBodyTosTypeField( val: any -): CreateTermOfServiceRequestBodyTosTypeField { +): CreateTermsOfServiceRequestBodyTosTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateTermOfServiceRequestBodyTosTypeField"'; + throw 'Expecting a string for "CreateTermsOfServiceRequestBodyTosTypeField"'; } if (val == 'external') { return 'external'; @@ -279,44 +283,44 @@ export function deserializeCreateTermOfServiceRequestBodyTosTypeField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateTermOfServiceRequestBody( - val: CreateTermOfServiceRequestBody +export function serializeCreateTermsOfServiceRequestBody( + val: CreateTermsOfServiceRequestBody ): SerializedData { return { - ['status']: serializeCreateTermOfServiceRequestBodyStatusField(val.status), + ['status']: serializeCreateTermsOfServiceRequestBodyStatusField(val.status), ['tos_type']: val.tosType == void 0 ? void 0 - : serializeCreateTermOfServiceRequestBodyTosTypeField(val.tosType), + : serializeCreateTermsOfServiceRequestBodyTosTypeField(val.tosType), ['text']: val.text, }; } -export function deserializeCreateTermOfServiceRequestBody( +export function deserializeCreateTermsOfServiceRequestBody( val: any -): CreateTermOfServiceRequestBody { - const status: CreateTermOfServiceRequestBodyStatusField = - deserializeCreateTermOfServiceRequestBodyStatusField(val.status); - const tosType: undefined | CreateTermOfServiceRequestBodyTosTypeField = +): CreateTermsOfServiceRequestBody { + const status: CreateTermsOfServiceRequestBodyStatusField = + deserializeCreateTermsOfServiceRequestBodyStatusField(val.status); + const tosType: undefined | CreateTermsOfServiceRequestBodyTosTypeField = val.tos_type == void 0 ? void 0 - : deserializeCreateTermOfServiceRequestBodyTosTypeField(val.tos_type); + : deserializeCreateTermsOfServiceRequestBodyTosTypeField(val.tos_type); const text: string = val.text; return { status: status, tosType: tosType, text: text, - } satisfies CreateTermOfServiceRequestBody; + } satisfies CreateTermsOfServiceRequestBody; } -export function serializeUpdateTermOfServiceByIdRequestBodyStatusField( - val: UpdateTermOfServiceByIdRequestBodyStatusField +export function serializeUpdateTermsOfServiceByIdRequestBodyStatusField( + val: UpdateTermsOfServiceByIdRequestBodyStatusField ): SerializedData { return val; } -export function deserializeUpdateTermOfServiceByIdRequestBodyStatusField( +export function deserializeUpdateTermsOfServiceByIdRequestBodyStatusField( val: any -): UpdateTermOfServiceByIdRequestBodyStatusField { +): UpdateTermsOfServiceByIdRequestBodyStatusField { if (!sdIsString(val)) { - throw 'Expecting a string for "UpdateTermOfServiceByIdRequestBodyStatusField"'; + throw 'Expecting a string for "UpdateTermsOfServiceByIdRequestBodyStatusField"'; } if (val == 'enabled') { return 'enabled'; @@ -326,24 +330,24 @@ export function deserializeUpdateTermOfServiceByIdRequestBodyStatusField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeUpdateTermOfServiceByIdRequestBody( - val: UpdateTermOfServiceByIdRequestBody +export function serializeUpdateTermsOfServiceByIdRequestBody( + val: UpdateTermsOfServiceByIdRequestBody ): SerializedData { return { - ['status']: serializeUpdateTermOfServiceByIdRequestBodyStatusField( + ['status']: serializeUpdateTermsOfServiceByIdRequestBodyStatusField( val.status ), ['text']: val.text, }; } -export function deserializeUpdateTermOfServiceByIdRequestBody( +export function deserializeUpdateTermsOfServiceByIdRequestBody( val: any -): UpdateTermOfServiceByIdRequestBody { - const status: UpdateTermOfServiceByIdRequestBodyStatusField = - deserializeUpdateTermOfServiceByIdRequestBodyStatusField(val.status); +): UpdateTermsOfServiceByIdRequestBody { + const status: UpdateTermsOfServiceByIdRequestBodyStatusField = + deserializeUpdateTermsOfServiceByIdRequestBodyStatusField(val.status); const text: string = val.text; return { status: status, text: text, - } satisfies UpdateTermOfServiceByIdRequestBody; + } satisfies UpdateTermsOfServiceByIdRequestBody; } diff --git a/src/managers/trashedFiles.generated.ts b/src/managers/trashedFiles.generated.ts index 9b7095db..a2538889 100644 --- a/src/managers/trashedFiles.generated.ts +++ b/src/managers/trashedFiles.generated.ts @@ -46,29 +46,29 @@ export class RestoreFileFromTrashHeaders { Object.assign(this, fields); } } -export interface GetFileTrashQueryParams { +export interface GetTrashedFileByIdQueryParams { readonly fields?: readonly string[]; } -export class GetFileTrashHeaders { +export class GetTrashedFileByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteFileTrashHeaders { +export class DeleteTrashedFileByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } @@ -82,8 +82,8 @@ export class TrashedFilesManager { TrashedFilesManager, | 'networkSession' | 'restoreFileFromTrash' - | 'getFileTrash' - | 'deleteFileTrash' + | 'getTrashedFileById' + | 'deleteTrashedFileById' > | Partial> ) { @@ -126,10 +126,10 @@ export class TrashedFilesManager { )) as FetchResponse; return deserializeTrashFileRestored(response.data); } - async getFileTrash( + async getTrashedFileById( fileId: string, - queryParams: GetFileTrashQueryParams = {} satisfies GetFileTrashQueryParams, - headers: GetFileTrashHeaders = new GetFileTrashHeaders({}), + queryParams: GetTrashedFileByIdQueryParams = {} satisfies GetTrashedFileByIdQueryParams, + headers: GetTrashedFileByIdHeaders = new GetTrashedFileByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -161,9 +161,11 @@ export class TrashedFilesManager { )) as FetchResponse; return deserializeTrashFile(response.data); } - async deleteFileTrash( + async deleteTrashedFileById( fileId: string, - headers: DeleteFileTrashHeaders = new DeleteFileTrashHeaders({}), + headers: DeleteTrashedFileByIdHeaders = new DeleteTrashedFileByIdHeaders( + {} + ), cancellationToken?: CancellationToken ): Promise { const headersMap: { diff --git a/src/managers/trashedFolders.generated.ts b/src/managers/trashedFolders.generated.ts index 3a9fb7e6..e2f24d64 100644 --- a/src/managers/trashedFolders.generated.ts +++ b/src/managers/trashedFolders.generated.ts @@ -46,29 +46,29 @@ export class RestoreFolderFromTrashHeaders { Object.assign(this, fields); } } -export interface GetFolderTrashQueryParams { +export interface GetTrashedFolderByIdQueryParams { readonly fields?: readonly string[]; } -export class GetFolderTrashHeaders { +export class GetTrashedFolderByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteFolderTrashHeaders { +export class DeleteTrashedFolderByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } @@ -82,8 +82,8 @@ export class TrashedFoldersManager { TrashedFoldersManager, | 'networkSession' | 'restoreFolderFromTrash' - | 'getFolderTrash' - | 'deleteFolderTrash' + | 'getTrashedFolderById' + | 'deleteTrashedFolderById' > | Partial> ) { @@ -128,10 +128,10 @@ export class TrashedFoldersManager { )) as FetchResponse; return deserializeTrashFolderRestored(response.data); } - async getFolderTrash( + async getTrashedFolderById( folderId: string, - queryParams: GetFolderTrashQueryParams = {} satisfies GetFolderTrashQueryParams, - headers: GetFolderTrashHeaders = new GetFolderTrashHeaders({}), + queryParams: GetTrashedFolderByIdQueryParams = {} satisfies GetTrashedFolderByIdQueryParams, + headers: GetTrashedFolderByIdHeaders = new GetTrashedFolderByIdHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -163,9 +163,11 @@ export class TrashedFoldersManager { )) as FetchResponse; return deserializeTrashFolder(response.data); } - async deleteFolderTrash( + async deleteTrashedFolderById( folderId: string, - headers: DeleteFolderTrashHeaders = new DeleteFolderTrashHeaders({}), + headers: DeleteTrashedFolderByIdHeaders = new DeleteTrashedFolderByIdHeaders( + {} + ), cancellationToken?: CancellationToken ): Promise { const headersMap: { diff --git a/src/managers/trashedItems.generated.ts b/src/managers/trashedItems.generated.ts index fd72f9c7..eb10ca40 100644 --- a/src/managers/trashedItems.generated.ts +++ b/src/managers/trashedItems.generated.ts @@ -21,25 +21,25 @@ import { sdIsNumber } from '../json.js'; import { sdIsString } from '../json.js'; import { sdIsList } from '../json.js'; import { sdIsMap } from '../json.js'; -export type GetFolderTrashItemsQueryParamsDirectionField = 'ASC' | 'DESC'; -export type GetFolderTrashItemsQueryParamsSortField = 'name' | 'date' | 'size'; -export interface GetFolderTrashItemsQueryParams { +export type GetTrashedItemsQueryParamsDirectionField = 'ASC' | 'DESC'; +export type GetTrashedItemsQueryParamsSortField = 'name' | 'date' | 'size'; +export interface GetTrashedItemsQueryParams { readonly fields?: readonly string[]; readonly limit?: number; readonly offset?: number; readonly usemarker?: boolean; readonly marker?: string; - readonly direction?: GetFolderTrashItemsQueryParamsDirectionField; - readonly sort?: GetFolderTrashItemsQueryParamsSortField; + readonly direction?: GetTrashedItemsQueryParamsDirectionField; + readonly sort?: GetTrashedItemsQueryParamsSortField; } -export class GetFolderTrashItemsHeaders { +export class GetTrashedItemsHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } @@ -49,14 +49,14 @@ export class TrashedItemsManager { readonly networkSession: NetworkSession = new NetworkSession({}); constructor( fields: - | Omit + | Omit | Partial> ) { Object.assign(this, fields); } - async getFolderTrashItems( - queryParams: GetFolderTrashItemsQueryParams = {} satisfies GetFolderTrashItemsQueryParams, - headers: GetFolderTrashItemsHeaders = new GetFolderTrashItemsHeaders({}), + async getTrashedItems( + queryParams: GetTrashedItemsQueryParams = {} satisfies GetTrashedItemsQueryParams, + headers: GetTrashedItemsHeaders = new GetTrashedItemsHeaders({}), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -93,16 +93,16 @@ export class TrashedItemsManager { return deserializeItems(response.data); } } -export function serializeGetFolderTrashItemsQueryParamsDirectionField( - val: GetFolderTrashItemsQueryParamsDirectionField +export function serializeGetTrashedItemsQueryParamsDirectionField( + val: GetTrashedItemsQueryParamsDirectionField ): SerializedData { return val; } -export function deserializeGetFolderTrashItemsQueryParamsDirectionField( +export function deserializeGetTrashedItemsQueryParamsDirectionField( val: any -): GetFolderTrashItemsQueryParamsDirectionField { +): GetTrashedItemsQueryParamsDirectionField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetFolderTrashItemsQueryParamsDirectionField"'; + throw 'Expecting a string for "GetTrashedItemsQueryParamsDirectionField"'; } if (val == 'ASC') { return 'ASC'; @@ -112,16 +112,16 @@ export function deserializeGetFolderTrashItemsQueryParamsDirectionField( } throw ''.concat('Invalid value: ', val) as string; } -export function serializeGetFolderTrashItemsQueryParamsSortField( - val: GetFolderTrashItemsQueryParamsSortField +export function serializeGetTrashedItemsQueryParamsSortField( + val: GetTrashedItemsQueryParamsSortField ): SerializedData { return val; } -export function deserializeGetFolderTrashItemsQueryParamsSortField( +export function deserializeGetTrashedItemsQueryParamsSortField( val: any -): GetFolderTrashItemsQueryParamsSortField { +): GetTrashedItemsQueryParamsSortField { if (!sdIsString(val)) { - throw 'Expecting a string for "GetFolderTrashItemsQueryParamsSortField"'; + throw 'Expecting a string for "GetTrashedItemsQueryParamsSortField"'; } if (val == 'name') { return 'name'; diff --git a/src/managers/trashedWebLinks.generated.ts b/src/managers/trashedWebLinks.generated.ts index 14ca0cda..b9bf2724 100644 --- a/src/managers/trashedWebLinks.generated.ts +++ b/src/managers/trashedWebLinks.generated.ts @@ -46,29 +46,29 @@ export class RestoreWeblinkFromTrashHeaders { Object.assign(this, fields); } } -export interface GetWebLinkTrashQueryParams { +export interface GetTrashedWebLinkByIdQueryParams { readonly fields?: readonly string[]; } -export class GetWebLinkTrashHeaders { +export class GetTrashedWebLinkByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } } -export class DeleteWebLinkTrashHeaders { +export class DeleteTrashedWebLinkByIdHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } @@ -82,8 +82,8 @@ export class TrashedWebLinksManager { TrashedWebLinksManager, | 'networkSession' | 'restoreWeblinkFromTrash' - | 'getWebLinkTrash' - | 'deleteWebLinkTrash' + | 'getTrashedWebLinkById' + | 'deleteTrashedWebLinkById' > | Partial> ) { @@ -128,10 +128,12 @@ export class TrashedWebLinksManager { )) as FetchResponse; return deserializeTrashWebLinkRestored(response.data); } - async getWebLinkTrash( + async getTrashedWebLinkById( webLinkId: string, - queryParams: GetWebLinkTrashQueryParams = {} satisfies GetWebLinkTrashQueryParams, - headers: GetWebLinkTrashHeaders = new GetWebLinkTrashHeaders({}), + queryParams: GetTrashedWebLinkByIdQueryParams = {} satisfies GetTrashedWebLinkByIdQueryParams, + headers: GetTrashedWebLinkByIdHeaders = new GetTrashedWebLinkByIdHeaders( + {} + ), cancellationToken?: CancellationToken ): Promise { const queryParamsMap: { @@ -163,9 +165,11 @@ export class TrashedWebLinksManager { )) as FetchResponse; return deserializeTrashWebLink(response.data); } - async deleteWebLinkTrash( + async deleteTrashedWebLinkById( webLinkId: string, - headers: DeleteWebLinkTrashHeaders = new DeleteWebLinkTrashHeaders({}), + headers: DeleteTrashedWebLinkByIdHeaders = new DeleteTrashedWebLinkByIdHeaders( + {} + ), cancellationToken?: CancellationToken ): Promise { const headersMap: { diff --git a/src/managers/uploads.generated.ts b/src/managers/uploads.generated.ts index 1ddc8e59..dba9283a 100644 --- a/src/managers/uploads.generated.ts +++ b/src/managers/uploads.generated.ts @@ -86,22 +86,22 @@ export class UploadFileHeaders { Object.assign(this, fields); } } -export interface PreflightFileUploadRequestBodyParentField { +export interface PreflightFileUploadCheckRequestBodyParentField { readonly id?: string; } -export interface PreflightFileUploadRequestBody { +export interface PreflightFileUploadCheckRequestBody { readonly name?: string; readonly size?: number; - readonly parent?: PreflightFileUploadRequestBodyParentField; + readonly parent?: PreflightFileUploadCheckRequestBodyParentField; } -export class PreflightFileUploadHeaders { +export class PreflightFileUploadCheckHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } @@ -116,7 +116,7 @@ export class UploadsManager { | 'networkSession' | 'uploadFileVersion' | 'uploadFile' - | 'preflightFileUpload' + | 'preflightFileUploadCheck' > | Partial> ) { @@ -230,9 +230,11 @@ export class UploadsManager { )) as FetchResponse; return deserializeFiles(response.data); } - async preflightFileUpload( - requestBody: PreflightFileUploadRequestBody = {} satisfies PreflightFileUploadRequestBody, - headers: PreflightFileUploadHeaders = new PreflightFileUploadHeaders({}), + async preflightFileUploadCheck( + requestBody: PreflightFileUploadCheckRequestBody = {} satisfies PreflightFileUploadCheckRequestBody, + headers: PreflightFileUploadCheckHeaders = new PreflightFileUploadCheckHeaders( + {} + ), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -246,7 +248,7 @@ export class UploadsManager { { method: 'OPTIONS', headers: headersMap, - data: serializePreflightFileUploadRequestBody(requestBody), + data: serializePreflightFileUploadCheckRequestBody(requestBody), contentType: 'application/json', responseFormat: 'json', auth: this.auth, @@ -317,19 +319,19 @@ export function deserializeUploadFileRequestBodyAttributesField( contentModifiedAt: contentModifiedAt, } satisfies UploadFileRequestBodyAttributesField; } -export function serializePreflightFileUploadRequestBodyParentField( - val: PreflightFileUploadRequestBodyParentField +export function serializePreflightFileUploadCheckRequestBodyParentField( + val: PreflightFileUploadCheckRequestBodyParentField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id }; } -export function deserializePreflightFileUploadRequestBodyParentField( +export function deserializePreflightFileUploadCheckRequestBodyParentField( val: any -): PreflightFileUploadRequestBodyParentField { +): PreflightFileUploadCheckRequestBodyParentField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - return { id: id } satisfies PreflightFileUploadRequestBodyParentField; + return { id: id } satisfies PreflightFileUploadCheckRequestBodyParentField; } -export function serializePreflightFileUploadRequestBody( - val: PreflightFileUploadRequestBody +export function serializePreflightFileUploadCheckRequestBody( + val: PreflightFileUploadCheckRequestBody ): SerializedData { return { ['name']: val.name == void 0 ? void 0 : val.name, @@ -337,21 +339,21 @@ export function serializePreflightFileUploadRequestBody( ['parent']: val.parent == void 0 ? void 0 - : serializePreflightFileUploadRequestBodyParentField(val.parent), + : serializePreflightFileUploadCheckRequestBodyParentField(val.parent), }; } -export function deserializePreflightFileUploadRequestBody( +export function deserializePreflightFileUploadCheckRequestBody( val: any -): PreflightFileUploadRequestBody { +): PreflightFileUploadCheckRequestBody { const name: undefined | string = val.name == void 0 ? void 0 : val.name; const size: undefined | number = val.size == void 0 ? void 0 : val.size; - const parent: undefined | PreflightFileUploadRequestBodyParentField = + const parent: undefined | PreflightFileUploadCheckRequestBodyParentField = val.parent == void 0 ? void 0 - : deserializePreflightFileUploadRequestBodyParentField(val.parent); + : deserializePreflightFileUploadCheckRequestBodyParentField(val.parent); return { name: name, size: size, parent: parent, - } satisfies PreflightFileUploadRequestBody; + } satisfies PreflightFileUploadCheckRequestBody; } diff --git a/src/managers/workflows.generated.ts b/src/managers/workflows.generated.ts index 731addcc..d22079d0 100644 --- a/src/managers/workflows.generated.ts +++ b/src/managers/workflows.generated.ts @@ -39,42 +39,42 @@ export class GetWorkflowsHeaders { Object.assign(this, fields); } } -export type CreateWorkflowStartRequestBodyTypeField = 'workflow_parameters'; -export interface CreateWorkflowStartRequestBodyFlowField { +export type StartWorkflowRequestBodyTypeField = 'workflow_parameters'; +export interface StartWorkflowRequestBodyFlowField { readonly type?: string; readonly id?: string; } -export type CreateWorkflowStartRequestBodyFilesTypeField = 'file'; -export interface CreateWorkflowStartRequestBodyFilesField { - readonly type?: CreateWorkflowStartRequestBodyFilesTypeField; +export type StartWorkflowRequestBodyFilesTypeField = 'file'; +export interface StartWorkflowRequestBodyFilesField { + readonly type?: StartWorkflowRequestBodyFilesTypeField; readonly id?: string; } -export type CreateWorkflowStartRequestBodyFolderTypeField = 'folder'; -export interface CreateWorkflowStartRequestBodyFolderField { - readonly type?: CreateWorkflowStartRequestBodyFolderTypeField; +export type StartWorkflowRequestBodyFolderTypeField = 'folder'; +export interface StartWorkflowRequestBodyFolderField { + readonly type?: StartWorkflowRequestBodyFolderTypeField; readonly id?: string; } -export type CreateWorkflowStartRequestBodyOutcomesTypeField = 'outcome'; -export interface CreateWorkflowStartRequestBodyOutcomesField { +export type StartWorkflowRequestBodyOutcomesTypeField = 'outcome'; +export interface StartWorkflowRequestBodyOutcomesField { readonly id?: string; - readonly type?: CreateWorkflowStartRequestBodyOutcomesTypeField; + readonly type?: StartWorkflowRequestBodyOutcomesTypeField; readonly parameter?: string; } -export interface CreateWorkflowStartRequestBody { - readonly type?: CreateWorkflowStartRequestBodyTypeField; - readonly flow: CreateWorkflowStartRequestBodyFlowField; - readonly files: readonly CreateWorkflowStartRequestBodyFilesField[]; - readonly folder: CreateWorkflowStartRequestBodyFolderField; - readonly outcomes?: readonly CreateWorkflowStartRequestBodyOutcomesField[]; +export interface StartWorkflowRequestBody { + readonly type?: StartWorkflowRequestBodyTypeField; + readonly flow: StartWorkflowRequestBodyFlowField; + readonly files: readonly StartWorkflowRequestBodyFilesField[]; + readonly folder: StartWorkflowRequestBodyFolderField; + readonly outcomes?: readonly StartWorkflowRequestBodyOutcomesField[]; } -export class CreateWorkflowStartHeaders { +export class StartWorkflowHeaders { readonly extraHeaders?: { readonly [key: string]: undefined | string; } = {}; constructor( fields: - | Omit - | Partial> + | Omit + | Partial> ) { Object.assign(this, fields); } @@ -86,7 +86,7 @@ export class WorkflowsManager { fields: | Omit< WorkflowsManager, - 'networkSession' | 'getWorkflows' | 'createWorkflowStart' + 'networkSession' | 'getWorkflows' | 'startWorkflow' > | Partial> ) { @@ -122,10 +122,10 @@ export class WorkflowsManager { )) as FetchResponse; return deserializeWorkflows(response.data); } - async createWorkflowStart( + async startWorkflow( workflowId: string, - requestBody: CreateWorkflowStartRequestBody, - headers: CreateWorkflowStartHeaders = new CreateWorkflowStartHeaders({}), + requestBody: StartWorkflowRequestBody, + headers: StartWorkflowHeaders = new StartWorkflowHeaders({}), cancellationToken?: CancellationToken ): Promise { const headersMap: { @@ -141,7 +141,7 @@ export class WorkflowsManager { { method: 'POST', headers: headersMap, - data: serializeCreateWorkflowStartRequestBody(requestBody), + data: serializeStartWorkflowRequestBody(requestBody), contentType: 'application/json', responseFormat: void 0, auth: this.auth, @@ -152,215 +152,204 @@ export class WorkflowsManager { return void 0; } } -export function serializeCreateWorkflowStartRequestBodyTypeField( - val: CreateWorkflowStartRequestBodyTypeField +export function serializeStartWorkflowRequestBodyTypeField( + val: StartWorkflowRequestBodyTypeField ): SerializedData { return val; } -export function deserializeCreateWorkflowStartRequestBodyTypeField( +export function deserializeStartWorkflowRequestBodyTypeField( val: any -): CreateWorkflowStartRequestBodyTypeField { +): StartWorkflowRequestBodyTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateWorkflowStartRequestBodyTypeField"'; + throw 'Expecting a string for "StartWorkflowRequestBodyTypeField"'; } if (val == 'workflow_parameters') { return 'workflow_parameters'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateWorkflowStartRequestBodyFlowField( - val: CreateWorkflowStartRequestBodyFlowField +export function serializeStartWorkflowRequestBodyFlowField( + val: StartWorkflowRequestBodyFlowField ): SerializedData { return { ['type']: val.type == void 0 ? void 0 : val.type, ['id']: val.id == void 0 ? void 0 : val.id, }; } -export function deserializeCreateWorkflowStartRequestBodyFlowField( +export function deserializeStartWorkflowRequestBodyFlowField( val: any -): CreateWorkflowStartRequestBodyFlowField { +): StartWorkflowRequestBodyFlowField { const type: undefined | string = val.type == void 0 ? void 0 : val.type; const id: undefined | string = val.id == void 0 ? void 0 : val.id; - return { - type: type, - id: id, - } satisfies CreateWorkflowStartRequestBodyFlowField; + return { type: type, id: id } satisfies StartWorkflowRequestBodyFlowField; } -export function serializeCreateWorkflowStartRequestBodyFilesTypeField( - val: CreateWorkflowStartRequestBodyFilesTypeField +export function serializeStartWorkflowRequestBodyFilesTypeField( + val: StartWorkflowRequestBodyFilesTypeField ): SerializedData { return val; } -export function deserializeCreateWorkflowStartRequestBodyFilesTypeField( +export function deserializeStartWorkflowRequestBodyFilesTypeField( val: any -): CreateWorkflowStartRequestBodyFilesTypeField { +): StartWorkflowRequestBodyFilesTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateWorkflowStartRequestBodyFilesTypeField"'; + throw 'Expecting a string for "StartWorkflowRequestBodyFilesTypeField"'; } if (val == 'file') { return 'file'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateWorkflowStartRequestBodyFilesField( - val: CreateWorkflowStartRequestBodyFilesField +export function serializeStartWorkflowRequestBodyFilesField( + val: StartWorkflowRequestBodyFilesField ): SerializedData { return { ['type']: val.type == void 0 ? void 0 - : serializeCreateWorkflowStartRequestBodyFilesTypeField(val.type), + : serializeStartWorkflowRequestBodyFilesTypeField(val.type), ['id']: val.id == void 0 ? void 0 : val.id, }; } -export function deserializeCreateWorkflowStartRequestBodyFilesField( +export function deserializeStartWorkflowRequestBodyFilesField( val: any -): CreateWorkflowStartRequestBodyFilesField { - const type: undefined | CreateWorkflowStartRequestBodyFilesTypeField = +): StartWorkflowRequestBodyFilesField { + const type: undefined | StartWorkflowRequestBodyFilesTypeField = val.type == void 0 ? void 0 - : deserializeCreateWorkflowStartRequestBodyFilesTypeField(val.type); + : deserializeStartWorkflowRequestBodyFilesTypeField(val.type); const id: undefined | string = val.id == void 0 ? void 0 : val.id; - return { - type: type, - id: id, - } satisfies CreateWorkflowStartRequestBodyFilesField; + return { type: type, id: id } satisfies StartWorkflowRequestBodyFilesField; } -export function serializeCreateWorkflowStartRequestBodyFolderTypeField( - val: CreateWorkflowStartRequestBodyFolderTypeField +export function serializeStartWorkflowRequestBodyFolderTypeField( + val: StartWorkflowRequestBodyFolderTypeField ): SerializedData { return val; } -export function deserializeCreateWorkflowStartRequestBodyFolderTypeField( +export function deserializeStartWorkflowRequestBodyFolderTypeField( val: any -): CreateWorkflowStartRequestBodyFolderTypeField { +): StartWorkflowRequestBodyFolderTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateWorkflowStartRequestBodyFolderTypeField"'; + throw 'Expecting a string for "StartWorkflowRequestBodyFolderTypeField"'; } if (val == 'folder') { return 'folder'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateWorkflowStartRequestBodyFolderField( - val: CreateWorkflowStartRequestBodyFolderField +export function serializeStartWorkflowRequestBodyFolderField( + val: StartWorkflowRequestBodyFolderField ): SerializedData { return { ['type']: val.type == void 0 ? void 0 - : serializeCreateWorkflowStartRequestBodyFolderTypeField(val.type), + : serializeStartWorkflowRequestBodyFolderTypeField(val.type), ['id']: val.id == void 0 ? void 0 : val.id, }; } -export function deserializeCreateWorkflowStartRequestBodyFolderField( +export function deserializeStartWorkflowRequestBodyFolderField( val: any -): CreateWorkflowStartRequestBodyFolderField { - const type: undefined | CreateWorkflowStartRequestBodyFolderTypeField = +): StartWorkflowRequestBodyFolderField { + const type: undefined | StartWorkflowRequestBodyFolderTypeField = val.type == void 0 ? void 0 - : deserializeCreateWorkflowStartRequestBodyFolderTypeField(val.type); + : deserializeStartWorkflowRequestBodyFolderTypeField(val.type); const id: undefined | string = val.id == void 0 ? void 0 : val.id; - return { - type: type, - id: id, - } satisfies CreateWorkflowStartRequestBodyFolderField; + return { type: type, id: id } satisfies StartWorkflowRequestBodyFolderField; } -export function serializeCreateWorkflowStartRequestBodyOutcomesTypeField( - val: CreateWorkflowStartRequestBodyOutcomesTypeField +export function serializeStartWorkflowRequestBodyOutcomesTypeField( + val: StartWorkflowRequestBodyOutcomesTypeField ): SerializedData { return val; } -export function deserializeCreateWorkflowStartRequestBodyOutcomesTypeField( +export function deserializeStartWorkflowRequestBodyOutcomesTypeField( val: any -): CreateWorkflowStartRequestBodyOutcomesTypeField { +): StartWorkflowRequestBodyOutcomesTypeField { if (!sdIsString(val)) { - throw 'Expecting a string for "CreateWorkflowStartRequestBodyOutcomesTypeField"'; + throw 'Expecting a string for "StartWorkflowRequestBodyOutcomesTypeField"'; } if (val == 'outcome') { return 'outcome'; } throw ''.concat('Invalid value: ', val) as string; } -export function serializeCreateWorkflowStartRequestBodyOutcomesField( - val: CreateWorkflowStartRequestBodyOutcomesField +export function serializeStartWorkflowRequestBodyOutcomesField( + val: StartWorkflowRequestBodyOutcomesField ): SerializedData { return { ['id']: val.id == void 0 ? void 0 : val.id, ['type']: val.type == void 0 ? void 0 - : serializeCreateWorkflowStartRequestBodyOutcomesTypeField(val.type), + : serializeStartWorkflowRequestBodyOutcomesTypeField(val.type), ['parameter']: val.parameter == void 0 ? void 0 : val.parameter, }; } -export function deserializeCreateWorkflowStartRequestBodyOutcomesField( +export function deserializeStartWorkflowRequestBodyOutcomesField( val: any -): CreateWorkflowStartRequestBodyOutcomesField { +): StartWorkflowRequestBodyOutcomesField { const id: undefined | string = val.id == void 0 ? void 0 : val.id; - const type: undefined | CreateWorkflowStartRequestBodyOutcomesTypeField = + const type: undefined | StartWorkflowRequestBodyOutcomesTypeField = val.type == void 0 ? void 0 - : deserializeCreateWorkflowStartRequestBodyOutcomesTypeField(val.type); + : deserializeStartWorkflowRequestBodyOutcomesTypeField(val.type); const parameter: undefined | string = val.parameter == void 0 ? void 0 : val.parameter; return { id: id, type: type, parameter: parameter, - } satisfies CreateWorkflowStartRequestBodyOutcomesField; + } satisfies StartWorkflowRequestBodyOutcomesField; } -export function serializeCreateWorkflowStartRequestBody( - val: CreateWorkflowStartRequestBody +export function serializeStartWorkflowRequestBody( + val: StartWorkflowRequestBody ): SerializedData { return { ['type']: val.type == void 0 ? void 0 - : serializeCreateWorkflowStartRequestBodyTypeField(val.type), - ['flow']: serializeCreateWorkflowStartRequestBodyFlowField(val.flow), + : serializeStartWorkflowRequestBodyTypeField(val.type), + ['flow']: serializeStartWorkflowRequestBodyFlowField(val.flow), ['files']: val.files.map(function ( - item: CreateWorkflowStartRequestBodyFilesField + item: StartWorkflowRequestBodyFilesField ): any { - return serializeCreateWorkflowStartRequestBodyFilesField(item); + return serializeStartWorkflowRequestBodyFilesField(item); }) as readonly any[], - ['folder']: serializeCreateWorkflowStartRequestBodyFolderField(val.folder), + ['folder']: serializeStartWorkflowRequestBodyFolderField(val.folder), ['outcomes']: val.outcomes == void 0 ? void 0 : (val.outcomes.map(function ( - item: CreateWorkflowStartRequestBodyOutcomesField + item: StartWorkflowRequestBodyOutcomesField ): any { - return serializeCreateWorkflowStartRequestBodyOutcomesField(item); + return serializeStartWorkflowRequestBodyOutcomesField(item); }) as readonly any[]), }; } -export function deserializeCreateWorkflowStartRequestBody( +export function deserializeStartWorkflowRequestBody( val: any -): CreateWorkflowStartRequestBody { - const type: undefined | CreateWorkflowStartRequestBodyTypeField = +): StartWorkflowRequestBody { + const type: undefined | StartWorkflowRequestBodyTypeField = val.type == void 0 ? void 0 - : deserializeCreateWorkflowStartRequestBodyTypeField(val.type); - const flow: CreateWorkflowStartRequestBodyFlowField = - deserializeCreateWorkflowStartRequestBodyFlowField(val.flow); - const files: readonly CreateWorkflowStartRequestBodyFilesField[] = sdIsList( + : deserializeStartWorkflowRequestBodyTypeField(val.type); + const flow: StartWorkflowRequestBodyFlowField = + deserializeStartWorkflowRequestBodyFlowField(val.flow); + const files: readonly StartWorkflowRequestBodyFilesField[] = sdIsList( val.files ) ? (val.files.map(function (itm: SerializedData): any { - return deserializeCreateWorkflowStartRequestBodyFilesField(itm); + return deserializeStartWorkflowRequestBodyFilesField(itm); }) as readonly any[]) : []; - const folder: CreateWorkflowStartRequestBodyFolderField = - deserializeCreateWorkflowStartRequestBodyFolderField(val.folder); - const outcomes: - | undefined - | readonly CreateWorkflowStartRequestBodyOutcomesField[] = + const folder: StartWorkflowRequestBodyFolderField = + deserializeStartWorkflowRequestBodyFolderField(val.folder); + const outcomes: undefined | readonly StartWorkflowRequestBodyOutcomesField[] = val.outcomes == void 0 ? void 0 : sdIsList(val.outcomes) ? (val.outcomes.map(function (itm: SerializedData): any { - return deserializeCreateWorkflowStartRequestBodyOutcomesField(itm); + return deserializeStartWorkflowRequestBodyOutcomesField(itm); }) as readonly any[]) : []; return { @@ -369,5 +358,5 @@ export function deserializeCreateWorkflowStartRequestBody( files: files, folder: folder, outcomes: outcomes, - } satisfies CreateWorkflowStartRequestBody; + } satisfies StartWorkflowRequestBody; } diff --git a/src/oauth.generated.ts b/src/oauth.generated.ts index 58a86ecc..a2edbe2c 100644 --- a/src/oauth.generated.ts +++ b/src/oauth.generated.ts @@ -81,7 +81,7 @@ export class BoxOAuth implements Authentication { const authManager: AuthorizationManager = !(networkSession == void 0) ? new AuthorizationManager({ networkSession: networkSession }) : new AuthorizationManager({}); - const token: AccessToken = await authManager.createOauth2Token({ + const token: AccessToken = await authManager.requestAccessToken({ grantType: 'authorization_code', code: authorizationCode, clientId: this.config.clientId, @@ -110,7 +110,7 @@ export class BoxOAuth implements Authentication { const authManager: AuthorizationManager = !(networkSession == void 0) ? new AuthorizationManager({ networkSession: networkSession }) : new AuthorizationManager({}); - const token: AccessToken = await authManager.createOauth2Token({ + const token: AccessToken = await authManager.requestAccessToken({ grantType: 'refresh_token', clientId: this.config.clientId, clientSecret: this.config.clientSecret, @@ -127,7 +127,7 @@ export class BoxOAuth implements Authentication { const authManager: AuthorizationManager = !(networkSession == void 0) ? new AuthorizationManager({ networkSession: networkSession }) : new AuthorizationManager({}); - await authManager.createOauth2Revoke({ + await authManager.revokeAccessToken({ clientId: this.config.clientId, clientSecret: this.config.clientSecret, token: token.accessToken, @@ -148,7 +148,7 @@ export class BoxOAuth implements Authentication { const authManager: AuthorizationManager = !(networkSession == void 0) ? new AuthorizationManager({ networkSession: networkSession }) : new AuthorizationManager({}); - const downscopedToken: AccessToken = await authManager.createOauth2Token({ + const downscopedToken: AccessToken = await authManager.requestAccessToken({ grantType: 'urn:ietf:params:oauth:grant-type:token-exchange', subjectToken: token.accessToken, subjectTokenType: 'urn:ietf:params:oauth:token-type:access_token', diff --git a/src/test/classifications.generated.test.ts b/src/test/classifications.generated.test.ts index ec897c7d..65ee4f86 100644 --- a/src/test/classifications.generated.test.ts +++ b/src/test/classifications.generated.test.ts @@ -1,3 +1,5 @@ +import { serializeClassificationTemplateFieldsOptionsField } from '../schemas.generated.js'; +import { deserializeClassificationTemplateFieldsOptionsField } from '../schemas.generated.js'; import { serializeUpdateClassificationRequestBody } from '../managers/classifications.generated.js'; import { deserializeUpdateClassificationRequestBody } from '../managers/classifications.generated.js'; import { serializeUpdateClassificationRequestBodyOpField } from '../managers/classifications.generated.js'; @@ -10,18 +12,16 @@ import { serializeUpdateClassificationRequestBodyDataStaticConfigField } from '. import { deserializeUpdateClassificationRequestBodyDataStaticConfigField } from '../managers/classifications.generated.js'; import { serializeUpdateClassificationRequestBodyDataStaticConfigClassificationField } from '../managers/classifications.generated.js'; import { deserializeUpdateClassificationRequestBodyDataStaticConfigClassificationField } from '../managers/classifications.generated.js'; -import { serializeClassificationTemplateFieldsOptionsField } from '../schemas.generated.js'; -import { deserializeClassificationTemplateFieldsOptionsField } from '../schemas.generated.js'; import { serializeClassificationTemplate } from '../schemas.generated.js'; import { deserializeClassificationTemplate } from '../schemas.generated.js'; import { BoxClient } from '../client.generated.js'; +import { ClassificationTemplateFieldsOptionsField } from '../schemas.generated.js'; import { UpdateClassificationRequestBody } from '../managers/classifications.generated.js'; import { UpdateClassificationRequestBodyOpField } from '../managers/classifications.generated.js'; import { UpdateClassificationRequestBodyFieldKeyField } from '../managers/classifications.generated.js'; import { UpdateClassificationRequestBodyDataField } from '../managers/classifications.generated.js'; import { UpdateClassificationRequestBodyDataStaticConfigField } from '../managers/classifications.generated.js'; import { UpdateClassificationRequestBodyDataStaticConfigClassificationField } from '../managers/classifications.generated.js'; -import { ClassificationTemplateFieldsOptionsField } from '../schemas.generated.js'; import { getUuid } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; import { getOrCreateClassificationTemplate } from './commons.generated.js'; @@ -38,9 +38,8 @@ const client: BoxClient = getDefaultClient(); test('testClassifications', async function testClassifications(): Promise { const classificationTemplate: ClassificationTemplate = await getOrCreateClassificationTemplate(); - const classification: any = await getOrCreateClassification( - classificationTemplate - ); + const classification: ClassificationTemplateFieldsOptionsField = + await getOrCreateClassification(classificationTemplate); if (!!(classification.key == '')) { throw 'Assertion failed'; } @@ -77,7 +76,8 @@ test('testClassifications', async function testClassifications(): Promise { ]); const updatedClassifications: readonly ClassificationTemplateFieldsOptionsField[] = classificationTemplateWithUpdatedClassification.fields[0].options; - const updatedClassification: any = updatedClassifications[0]; + const updatedClassification: ClassificationTemplateFieldsOptionsField = + updatedClassifications[0]; if (!(updatedClassification.key == updatedClassificationName)) { throw 'Assertion failed'; } diff --git a/src/test/commons.generated.ts b/src/test/commons.generated.ts index 0f7e3b29..549421d3 100644 --- a/src/test/commons.generated.ts +++ b/src/test/commons.generated.ts @@ -139,7 +139,7 @@ export async function uploadNewFile(): Promise { } export async function getOrCreateClassification( classificationTemplate: ClassificationTemplate -): Promise { +): Promise { const client: BoxClient = getDefaultClient(); const classifications: readonly ClassificationTemplateFieldsOptionsField[] = classificationTemplate.fields[0].options; diff --git a/src/test/fileClassifications.generated.test.ts b/src/test/fileClassifications.generated.test.ts index cd9a2e38..5187ad7a 100644 --- a/src/test/fileClassifications.generated.test.ts +++ b/src/test/fileClassifications.generated.test.ts @@ -56,7 +56,7 @@ import { sdIsMap } from '../json.js'; const client: BoxClient = getDefaultClient(); export async function getOrCreateSecondClassification( classificationTemplate: ClassificationTemplate -): Promise { +): Promise { const classifications: readonly ClassificationTemplateFieldsOptionsField[] = classificationTemplate.fields[0].options; const currentNumberOfClassifications: number = classifications.length; @@ -85,9 +85,8 @@ export async function getOrCreateSecondClassification( test('testFileClassifications', async function testFileClassifications(): Promise { const classificationTemplate: ClassificationTemplate = await getOrCreateClassificationTemplate(); - const classification: any = await getOrCreateClassification( - classificationTemplate - ); + const classification: ClassificationTemplateFieldsOptionsField = + await getOrCreateClassification(classificationTemplate); const file: FileFull = await uploadNewFile(); await expect(async () => { await client.fileClassifications.getClassificationOnFile(file.id); @@ -111,9 +110,8 @@ test('testFileClassifications', async function testFileClassifications(): Promis ) { throw 'Assertion failed'; } - const secondClassification: any = await getOrCreateSecondClassification( - classificationTemplate - ); + const secondClassification: ClassificationTemplateFieldsOptionsField = + await getOrCreateSecondClassification(classificationTemplate); const updatedFileClassification: Classification = await client.fileClassifications.updateClassificationOnFile(file.id, [ { diff --git a/src/test/files.generated.test.ts b/src/test/files.generated.test.ts index 3970846c..78fa7bf5 100644 --- a/src/test/files.generated.test.ts +++ b/src/test/files.generated.test.ts @@ -115,7 +115,7 @@ test('testCreateGetAndDeleteFile', async function testCreateGetAndDeleteFile(): throw 'Assertion failed'; } await client.files.deleteFileById(uploadedFile.id); - const trashedFile: TrashFile = await client.trashedFiles.getFileTrash( + const trashedFile: TrashFile = await client.trashedFiles.getTrashedFileById( uploadedFile.id ); if (!(file.id == trashedFile.id)) { diff --git a/src/test/folderClassifications.generated.test.ts b/src/test/folderClassifications.generated.test.ts index f80497f0..5506a363 100644 --- a/src/test/folderClassifications.generated.test.ts +++ b/src/test/folderClassifications.generated.test.ts @@ -56,7 +56,7 @@ import { sdIsMap } from '../json.js'; const client: BoxClient = getDefaultClient(); export async function getOrCreateSecondClassification( classificationTemplate: ClassificationTemplate -): Promise { +): Promise { const classifications: readonly ClassificationTemplateFieldsOptionsField[] = classificationTemplate.fields[0].options; const currentNumberOfClassifications: number = classifications.length; @@ -85,9 +85,8 @@ export async function getOrCreateSecondClassification( test('testFolderClassifications', async function testFolderClassifications(): Promise { const classificationTemplate: ClassificationTemplate = await getOrCreateClassificationTemplate(); - const classification: any = await getOrCreateClassification( - classificationTemplate - ); + const classification: ClassificationTemplateFieldsOptionsField = + await getOrCreateClassification(classificationTemplate); const folder: FolderFull = await createNewFolder(); await expect(async () => { await client.folderClassifications.getClassificationOnFolder(folder.id); @@ -111,9 +110,8 @@ test('testFolderClassifications', async function testFolderClassifications(): Pr ) { throw 'Assertion failed'; } - const secondClassification: any = await getOrCreateSecondClassification( - classificationTemplate - ); + const secondClassification: ClassificationTemplateFieldsOptionsField = + await getOrCreateSecondClassification(classificationTemplate); const updatedFolderClassification: Classification = await client.folderClassifications.updateClassificationOnFolder(folder.id, [ { diff --git a/src/test/metadataCascadePolicies.generated.test.ts b/src/test/metadataCascadePolicies.generated.test.ts index 54369768..8fbb4205 100644 --- a/src/test/metadataCascadePolicies.generated.test.ts +++ b/src/test/metadataCascadePolicies.generated.test.ts @@ -14,10 +14,10 @@ import { serializeCreateMetadataCascadePolicyRequestBodyScopeField } from '../ma import { deserializeCreateMetadataCascadePolicyRequestBodyScopeField } from '../managers/metadataCascadePolicies.generated.js'; import { serializeMetadataCascadePolicies } from '../schemas.generated.js'; import { deserializeMetadataCascadePolicies } from '../schemas.generated.js'; -import { serializeCreateMetadataCascadePolicyApplyRequestBody } from '../managers/metadataCascadePolicies.generated.js'; -import { deserializeCreateMetadataCascadePolicyApplyRequestBody } from '../managers/metadataCascadePolicies.generated.js'; -import { serializeCreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField } from '../managers/metadataCascadePolicies.generated.js'; -import { deserializeCreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField } from '../managers/metadataCascadePolicies.generated.js'; +import { serializeApplyMetadataCascadePolicyRequestBody } from '../managers/metadataCascadePolicies.generated.js'; +import { deserializeApplyMetadataCascadePolicyRequestBody } from '../managers/metadataCascadePolicies.generated.js'; +import { serializeApplyMetadataCascadePolicyRequestBodyConflictResolutionField } from '../managers/metadataCascadePolicies.generated.js'; +import { deserializeApplyMetadataCascadePolicyRequestBodyConflictResolutionField } from '../managers/metadataCascadePolicies.generated.js'; import { serializeCreateFolderMetadataByIdScope } from '../managers/folderMetadata.generated.js'; import { deserializeCreateFolderMetadataByIdScope } from '../managers/folderMetadata.generated.js'; import { BoxClient } from '../client.generated.js'; @@ -30,8 +30,8 @@ import { CreateMetadataCascadePolicyRequestBody } from '../managers/metadataCasc import { CreateMetadataCascadePolicyRequestBodyScopeField } from '../managers/metadataCascadePolicies.generated.js'; import { MetadataCascadePolicies } from '../schemas.generated.js'; import { GetMetadataCascadePoliciesQueryParams } from '../managers/metadataCascadePolicies.generated.js'; -import { CreateMetadataCascadePolicyApplyRequestBody } from '../managers/metadataCascadePolicies.generated.js'; -import { CreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField } from '../managers/metadataCascadePolicies.generated.js'; +import { ApplyMetadataCascadePolicyRequestBody } from '../managers/metadataCascadePolicies.generated.js'; +import { ApplyMetadataCascadePolicyRequestBodyConflictResolutionField } from '../managers/metadataCascadePolicies.generated.js'; import { CreateFolderMetadataByIdScope } from '../managers/folderMetadata.generated.js'; import { getUuid } from '../utils.js'; import { getEnvVar } from '../utils.js'; @@ -120,12 +120,12 @@ test('testMetadataCascadePolicies', async function testMetadataCascadePolicies() throw 'Assertion failed'; } await expect(async () => { - await client.metadataCascadePolicies.createMetadataCascadePolicyApply( + await client.metadataCascadePolicies.applyMetadataCascadePolicy( cascadePolicyId, { conflictResolution: - 'overwrite' as CreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField, - } satisfies CreateMetadataCascadePolicyApplyRequestBody + 'overwrite' as ApplyMetadataCascadePolicyRequestBodyConflictResolutionField, + } satisfies ApplyMetadataCascadePolicyRequestBody ); }).rejects.toThrow(); const data: { @@ -137,12 +137,12 @@ test('testMetadataCascadePolicies', async function testMetadataCascadePolicies() templateKey, data ); - await client.metadataCascadePolicies.createMetadataCascadePolicyApply( + await client.metadataCascadePolicies.applyMetadataCascadePolicy( cascadePolicyId, { conflictResolution: - 'overwrite' as CreateMetadataCascadePolicyApplyRequestBodyConflictResolutionField, - } satisfies CreateMetadataCascadePolicyApplyRequestBody + 'overwrite' as ApplyMetadataCascadePolicyRequestBodyConflictResolutionField, + } satisfies ApplyMetadataCascadePolicyRequestBody ); await client.metadataCascadePolicies.deleteMetadataCascadePolicyById( cascadePolicyId diff --git a/src/test/search.generated.test.ts b/src/test/search.generated.test.ts index 225ca338..4f21cfee 100644 --- a/src/test/search.generated.test.ts +++ b/src/test/search.generated.test.ts @@ -30,8 +30,8 @@ import { serializeGetMetadataQueryIndicesQueryParamsScopeField } from '../manage import { deserializeGetMetadataQueryIndicesQueryParamsScopeField } from '../managers/search.generated.js'; import { serializeSearchResultsOrSearchResultsWithSharedLinks } from '../schemas.generated.js'; import { deserializeSearchResultsOrSearchResultsWithSharedLinks } from '../schemas.generated.js'; -import { serializeGetSearchQueryParamsTrashContentField } from '../managers/search.generated.js'; -import { deserializeGetSearchQueryParamsTrashContentField } from '../managers/search.generated.js'; +import { serializeSearchForContentQueryParamsTrashContentField } from '../managers/search.generated.js'; +import { deserializeSearchForContentQueryParamsTrashContentField } from '../managers/search.generated.js'; import { BoxClient } from '../client.generated.js'; import { MetadataTemplate } from '../schemas.generated.js'; import { CreateMetadataTemplateRequestBody } from '../managers/metadataTemplates.generated.js'; @@ -51,8 +51,8 @@ import { MetadataQueryIndices } from '../schemas.generated.js'; import { GetMetadataQueryIndicesQueryParams } from '../managers/search.generated.js'; import { GetMetadataQueryIndicesQueryParamsScopeField } from '../managers/search.generated.js'; import { SearchResultsOrSearchResultsWithSharedLinks } from '../schemas.generated.js'; -import { GetSearchQueryParams } from '../managers/search.generated.js'; -import { GetSearchQueryParamsTrashContentField } from '../managers/search.generated.js'; +import { SearchForContentQueryParams } from '../managers/search.generated.js'; +import { SearchForContentQueryParamsTrashContentField } from '../managers/search.generated.js'; import { getUuid } from '../utils.js'; import { generateByteStream } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; @@ -108,7 +108,7 @@ test('testCreateMetaDataQueryExecuteRead', async function testCreateMetaDataQuer '.', template.templateKey ) as string; - const query: any = await client.search.createMetadataQueryExecuteRead({ + const query: any = await client.search.searchByMetadataQuery({ ancestorFolderId: '0', from: searchFrom, query: 'testName >= :value', @@ -154,23 +154,25 @@ test('testGetMetadataQueryIndices', async function testGetMetadataQueryIndices() }); test('testGetSearch', async function testGetSearch(): Promise { const keyword: any = 'test'; - const search: any = await client.search.getSearch({ + const search: any = await client.search.searchForContent({ ancestorFolderIds: ['0' as ''], query: keyword, - trashContent: 'non_trashed_only' as GetSearchQueryParamsTrashContentField, - } satisfies GetSearchQueryParams); + trashContent: + 'non_trashed_only' as SearchForContentQueryParamsTrashContentField, + } satisfies SearchForContentQueryParams); if (!(search.entries!.length >= 0)) { throw 'Assertion failed'; } if (!((toString(search.type) as string) == 'search_results_items')) { throw 'Assertion failed'; } - const searchWithSharedLink: any = await client.search.getSearch({ + const searchWithSharedLink: any = await client.search.searchForContent({ ancestorFolderIds: ['0' as ''], query: keyword, - trashContent: 'non_trashed_only' as GetSearchQueryParamsTrashContentField, + trashContent: + 'non_trashed_only' as SearchForContentQueryParamsTrashContentField, includeRecentSharedLinks: true, - } satisfies GetSearchQueryParams); + } satisfies SearchForContentQueryParams); if (!(searchWithSharedLink.entries!.length >= 0)) { throw 'Assertion failed'; } diff --git a/src/test/sessionTermination.generated.test.ts b/src/test/sessionTermination.generated.test.ts index 3e4e4b21..d2938579 100644 --- a/src/test/sessionTermination.generated.test.ts +++ b/src/test/sessionTermination.generated.test.ts @@ -2,21 +2,21 @@ import { serializeUserFull } from '../schemas.generated.js'; import { deserializeUserFull } from '../schemas.generated.js'; import { serializeSessionTerminationMessage } from '../schemas.generated.js'; import { deserializeSessionTerminationMessage } from '../schemas.generated.js'; -import { serializeCreateUserTerminateSessionRequestBody } from '../managers/sessionTermination.generated.js'; -import { deserializeCreateUserTerminateSessionRequestBody } from '../managers/sessionTermination.generated.js'; +import { serializeTerminateUsersSessionsRequestBody } from '../managers/sessionTermination.generated.js'; +import { deserializeTerminateUsersSessionsRequestBody } from '../managers/sessionTermination.generated.js'; import { serializeGroupFull } from '../schemas.generated.js'; import { deserializeGroupFull } from '../schemas.generated.js'; import { serializeCreateGroupRequestBody } from '../managers/groups.generated.js'; import { deserializeCreateGroupRequestBody } from '../managers/groups.generated.js'; -import { serializeCreateGroupTerminateSessionRequestBody } from '../managers/sessionTermination.generated.js'; -import { deserializeCreateGroupTerminateSessionRequestBody } from '../managers/sessionTermination.generated.js'; +import { serializeTerminateGroupsSessionsRequestBody } from '../managers/sessionTermination.generated.js'; +import { deserializeTerminateGroupsSessionsRequestBody } from '../managers/sessionTermination.generated.js'; import { BoxClient } from '../client.generated.js'; import { UserFull } from '../schemas.generated.js'; import { SessionTerminationMessage } from '../schemas.generated.js'; -import { CreateUserTerminateSessionRequestBody } from '../managers/sessionTermination.generated.js'; +import { TerminateUsersSessionsRequestBody } from '../managers/sessionTermination.generated.js'; import { GroupFull } from '../schemas.generated.js'; import { CreateGroupRequestBody } from '../managers/groups.generated.js'; -import { CreateGroupTerminateSessionRequestBody } from '../managers/sessionTermination.generated.js'; +import { TerminateGroupsSessionsRequestBody } from '../managers/sessionTermination.generated.js'; import { getUuid } from '../utils.js'; import { getEnvVar } from '../utils.js'; import { getDefaultClient } from './commons.generated.js'; @@ -35,10 +35,10 @@ test('testSessionTerminationUser', async function testSessionTerminationUser(): ); const user: UserFull = await adminClient.users.getUserMe(); const result: SessionTerminationMessage = - await client.sessionTermination.createUserTerminateSession({ + await client.sessionTermination.terminateUsersSessions({ userIds: [getEnvVar('USER_ID')], userLogins: [user.login!], - } satisfies CreateUserTerminateSessionRequestBody); + } satisfies TerminateUsersSessionsRequestBody); if ( !( result.message == @@ -54,9 +54,9 @@ test('testSessionTerminationGroup', async function testSessionTerminationGroup() name: groupName, } satisfies CreateGroupRequestBody); const result: SessionTerminationMessage = - await client.sessionTermination.createGroupTerminateSession({ + await client.sessionTermination.terminateGroupsSessions({ groupIds: [group.id], - } satisfies CreateGroupTerminateSessionRequestBody); + } satisfies TerminateGroupsSessionsRequestBody); if ( !( result.message == diff --git a/src/test/sharedLinksFiles.generated.test.ts b/src/test/sharedLinksFiles.generated.test.ts index 6b86f7ee..a9d8a1fd 100644 --- a/src/test/sharedLinksFiles.generated.test.ts +++ b/src/test/sharedLinksFiles.generated.test.ts @@ -4,37 +4,37 @@ import { serializeUploadFileRequestBodyAttributesField } from '../managers/uploa import { deserializeUploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; import { serializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; import { deserializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; -import { serializeUpdateFileAddSharedLinkRequestBody } from '../managers/sharedLinksFiles.generated.js'; -import { deserializeUpdateFileAddSharedLinkRequestBody } from '../managers/sharedLinksFiles.generated.js'; -import { serializeUpdateFileAddSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFiles.generated.js'; -import { deserializeUpdateFileAddSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFiles.generated.js'; -import { serializeUpdateFileAddSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFiles.generated.js'; -import { deserializeUpdateFileAddSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFiles.generated.js'; +import { serializeAddShareLinkToFileRequestBody } from '../managers/sharedLinksFiles.generated.js'; +import { deserializeAddShareLinkToFileRequestBody } from '../managers/sharedLinksFiles.generated.js'; +import { serializeAddShareLinkToFileRequestBodySharedLinkField } from '../managers/sharedLinksFiles.generated.js'; +import { deserializeAddShareLinkToFileRequestBodySharedLinkField } from '../managers/sharedLinksFiles.generated.js'; +import { serializeAddShareLinkToFileRequestBodySharedLinkAccessField } from '../managers/sharedLinksFiles.generated.js'; +import { deserializeAddShareLinkToFileRequestBodySharedLinkAccessField } from '../managers/sharedLinksFiles.generated.js'; import { serializeFileFull } from '../schemas.generated.js'; import { deserializeFileFull } from '../schemas.generated.js'; -import { serializeUpdateFileUpdateSharedLinkRequestBody } from '../managers/sharedLinksFiles.generated.js'; -import { deserializeUpdateFileUpdateSharedLinkRequestBody } from '../managers/sharedLinksFiles.generated.js'; -import { serializeUpdateFileUpdateSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFiles.generated.js'; -import { deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFiles.generated.js'; -import { serializeUpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFiles.generated.js'; -import { deserializeUpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFiles.generated.js'; +import { serializeUpdateSharedLinkOnFileRequestBody } from '../managers/sharedLinksFiles.generated.js'; +import { deserializeUpdateSharedLinkOnFileRequestBody } from '../managers/sharedLinksFiles.generated.js'; +import { serializeUpdateSharedLinkOnFileRequestBodySharedLinkField } from '../managers/sharedLinksFiles.generated.js'; +import { deserializeUpdateSharedLinkOnFileRequestBodySharedLinkField } from '../managers/sharedLinksFiles.generated.js'; +import { serializeUpdateSharedLinkOnFileRequestBodySharedLinkAccessField } from '../managers/sharedLinksFiles.generated.js'; +import { deserializeUpdateSharedLinkOnFileRequestBodySharedLinkAccessField } from '../managers/sharedLinksFiles.generated.js'; import { BoxClient } from '../client.generated.js'; import { Files } from '../schemas.generated.js'; import { UploadFileRequestBody } from '../managers/uploads.generated.js'; import { UploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js'; import { UploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js'; -import { UpdateFileAddSharedLinkRequestBody } from '../managers/sharedLinksFiles.generated.js'; -import { UpdateFileAddSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFiles.generated.js'; -import { UpdateFileAddSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFiles.generated.js'; -import { UpdateFileAddSharedLinkQueryParams } from '../managers/sharedLinksFiles.generated.js'; +import { AddShareLinkToFileRequestBody } from '../managers/sharedLinksFiles.generated.js'; +import { AddShareLinkToFileRequestBodySharedLinkField } from '../managers/sharedLinksFiles.generated.js'; +import { AddShareLinkToFileRequestBodySharedLinkAccessField } from '../managers/sharedLinksFiles.generated.js'; +import { AddShareLinkToFileQueryParams } from '../managers/sharedLinksFiles.generated.js'; import { FileFull } from '../schemas.generated.js'; -import { GetFileGetSharedLinkQueryParams } from '../managers/sharedLinksFiles.generated.js'; -import { GetSharedItemsQueryParams } from '../managers/sharedLinksFiles.generated.js'; -import { GetSharedItemsHeaders } from '../managers/sharedLinksFiles.generated.js'; -import { UpdateFileUpdateSharedLinkRequestBody } from '../managers/sharedLinksFiles.generated.js'; -import { UpdateFileUpdateSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFiles.generated.js'; -import { UpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFiles.generated.js'; -import { UpdateFileUpdateSharedLinkQueryParams } from '../managers/sharedLinksFiles.generated.js'; +import { GetSharedLinkForFileQueryParams } from '../managers/sharedLinksFiles.generated.js'; +import { FindFileForSharedLinkQueryParams } from '../managers/sharedLinksFiles.generated.js'; +import { FindFileForSharedLinkHeaders } from '../managers/sharedLinksFiles.generated.js'; +import { UpdateSharedLinkOnFileRequestBody } from '../managers/sharedLinksFiles.generated.js'; +import { UpdateSharedLinkOnFileRequestBodySharedLinkField } from '../managers/sharedLinksFiles.generated.js'; +import { UpdateSharedLinkOnFileRequestBodySharedLinkAccessField } from '../managers/sharedLinksFiles.generated.js'; +import { UpdateSharedLinkOnFileQueryParams } from '../managers/sharedLinksFiles.generated.js'; import { getUuid } from '../utils.js'; import { generateByteStream } from '../utils.js'; import { getEnvVar } from '../utils.js'; @@ -59,30 +59,29 @@ test('testSharedLinksFiles', async function testSharedLinksFiles(): Promise file: generateByteStream(10), } satisfies UploadFileRequestBody); const fileId: string = uploadedFiles.entries![0].id; - await client.sharedLinksFiles.updateFileAddSharedLink( + await client.sharedLinksFiles.addShareLinkToFile( fileId, { sharedLink: { - access: - 'open' as UpdateFileAddSharedLinkRequestBodySharedLinkAccessField, + access: 'open' as AddShareLinkToFileRequestBodySharedLinkAccessField, password: 'Secret123@', - } satisfies UpdateFileAddSharedLinkRequestBodySharedLinkField, - } satisfies UpdateFileAddSharedLinkRequestBody, - { fields: 'shared_link' } satisfies UpdateFileAddSharedLinkQueryParams + } satisfies AddShareLinkToFileRequestBodySharedLinkField, + } satisfies AddShareLinkToFileRequestBody, + { fields: 'shared_link' } satisfies AddShareLinkToFileQueryParams ); const fileFromApi: FileFull = - await client.sharedLinksFiles.getFileGetSharedLink(fileId, { + await client.sharedLinksFiles.getSharedLinkForFile(fileId, { fields: 'shared_link', - } satisfies GetFileGetSharedLinkQueryParams); + } satisfies GetSharedLinkForFileQueryParams); if (!((toString(fileFromApi.sharedLink!.access) as string) == 'open')) { throw 'Assertion failed'; } const userId: string = getEnvVar('USER_ID'); const userClient: BoxClient = await getDefaultClientAsUser(userId); const fileFromSharedLinkPassword: FileFull = - await userClient.sharedLinksFiles.getSharedItems( - {} satisfies GetSharedItemsQueryParams, - new GetSharedItemsHeaders({ + await userClient.sharedLinksFiles.findFileForSharedLink( + {} satisfies FindFileForSharedLinkQueryParams, + new FindFileForSharedLinkHeaders({ boxapi: ''.concat( 'shared_link=', fileFromApi.sharedLink!.url, @@ -94,9 +93,9 @@ test('testSharedLinksFiles', async function testSharedLinksFiles(): Promise throw 'Assertion failed'; } await expect(async () => { - await userClient.sharedLinksFiles.getSharedItems( - {} satisfies GetSharedItemsQueryParams, - new GetSharedItemsHeaders({ + await userClient.sharedLinksFiles.findFileForSharedLink( + {} satisfies FindFileForSharedLinkQueryParams, + new FindFileForSharedLinkHeaders({ boxapi: ''.concat( 'shared_link=', fileFromApi.sharedLink!.url, @@ -106,15 +105,15 @@ test('testSharedLinksFiles', async function testSharedLinksFiles(): Promise ); }).rejects.toThrow(); const updatedFile: FileFull = - await client.sharedLinksFiles.updateFileUpdateSharedLink( + await client.sharedLinksFiles.updateSharedLinkOnFile( fileId, { sharedLink: { access: - 'collaborators' as UpdateFileUpdateSharedLinkRequestBodySharedLinkAccessField, - } satisfies UpdateFileUpdateSharedLinkRequestBodySharedLinkField, - } satisfies UpdateFileUpdateSharedLinkRequestBody, - { fields: 'shared_link' } satisfies UpdateFileUpdateSharedLinkQueryParams + 'collaborators' as UpdateSharedLinkOnFileRequestBodySharedLinkAccessField, + } satisfies UpdateSharedLinkOnFileRequestBodySharedLinkField, + } satisfies UpdateSharedLinkOnFileRequestBody, + { fields: 'shared_link' } satisfies UpdateSharedLinkOnFileQueryParams ); if ( !((toString(updatedFile.sharedLink!.access) as string) == 'collaborators') diff --git a/src/test/sharedLinksFolders.generated.test.ts b/src/test/sharedLinksFolders.generated.test.ts index 00abc20d..dddc3887 100644 --- a/src/test/sharedLinksFolders.generated.test.ts +++ b/src/test/sharedLinksFolders.generated.test.ts @@ -4,33 +4,33 @@ import { serializeCreateFolderRequestBody } from '../managers/folders.generated. import { deserializeCreateFolderRequestBody } from '../managers/folders.generated.js'; import { serializeCreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; import { deserializeCreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; -import { serializeUpdateFolderAddSharedLinkRequestBody } from '../managers/sharedLinksFolders.generated.js'; -import { deserializeUpdateFolderAddSharedLinkRequestBody } from '../managers/sharedLinksFolders.generated.js'; -import { serializeUpdateFolderAddSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFolders.generated.js'; -import { deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFolders.generated.js'; -import { serializeUpdateFolderAddSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFolders.generated.js'; -import { deserializeUpdateFolderAddSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFolders.generated.js'; -import { serializeUpdateFolderUpdateSharedLinkRequestBody } from '../managers/sharedLinksFolders.generated.js'; -import { deserializeUpdateFolderUpdateSharedLinkRequestBody } from '../managers/sharedLinksFolders.generated.js'; -import { serializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFolders.generated.js'; -import { deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFolders.generated.js'; -import { serializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFolders.generated.js'; -import { deserializeUpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFolders.generated.js'; +import { serializeAddShareLinkToFolderRequestBody } from '../managers/sharedLinksFolders.generated.js'; +import { deserializeAddShareLinkToFolderRequestBody } from '../managers/sharedLinksFolders.generated.js'; +import { serializeAddShareLinkToFolderRequestBodySharedLinkField } from '../managers/sharedLinksFolders.generated.js'; +import { deserializeAddShareLinkToFolderRequestBodySharedLinkField } from '../managers/sharedLinksFolders.generated.js'; +import { serializeAddShareLinkToFolderRequestBodySharedLinkAccessField } from '../managers/sharedLinksFolders.generated.js'; +import { deserializeAddShareLinkToFolderRequestBodySharedLinkAccessField } from '../managers/sharedLinksFolders.generated.js'; +import { serializeUpdateSharedLinkOnFolderRequestBody } from '../managers/sharedLinksFolders.generated.js'; +import { deserializeUpdateSharedLinkOnFolderRequestBody } from '../managers/sharedLinksFolders.generated.js'; +import { serializeUpdateSharedLinkOnFolderRequestBodySharedLinkField } from '../managers/sharedLinksFolders.generated.js'; +import { deserializeUpdateSharedLinkOnFolderRequestBodySharedLinkField } from '../managers/sharedLinksFolders.generated.js'; +import { serializeUpdateSharedLinkOnFolderRequestBodySharedLinkAccessField } from '../managers/sharedLinksFolders.generated.js'; +import { deserializeUpdateSharedLinkOnFolderRequestBodySharedLinkAccessField } from '../managers/sharedLinksFolders.generated.js'; import { BoxClient } from '../client.generated.js'; import { FolderFull } from '../schemas.generated.js'; import { CreateFolderRequestBody } from '../managers/folders.generated.js'; import { CreateFolderRequestBodyParentField } from '../managers/folders.generated.js'; -import { UpdateFolderAddSharedLinkRequestBody } from '../managers/sharedLinksFolders.generated.js'; -import { UpdateFolderAddSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFolders.generated.js'; -import { UpdateFolderAddSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFolders.generated.js'; -import { UpdateFolderAddSharedLinkQueryParams } from '../managers/sharedLinksFolders.generated.js'; -import { GetFolderGetSharedLinkQueryParams } from '../managers/sharedLinksFolders.generated.js'; -import { GetSharedItemFoldersQueryParams } from '../managers/sharedLinksFolders.generated.js'; -import { GetSharedItemFoldersHeaders } from '../managers/sharedLinksFolders.generated.js'; -import { UpdateFolderUpdateSharedLinkRequestBody } from '../managers/sharedLinksFolders.generated.js'; -import { UpdateFolderUpdateSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksFolders.generated.js'; -import { UpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksFolders.generated.js'; -import { UpdateFolderUpdateSharedLinkQueryParams } from '../managers/sharedLinksFolders.generated.js'; +import { AddShareLinkToFolderRequestBody } from '../managers/sharedLinksFolders.generated.js'; +import { AddShareLinkToFolderRequestBodySharedLinkField } from '../managers/sharedLinksFolders.generated.js'; +import { AddShareLinkToFolderRequestBodySharedLinkAccessField } from '../managers/sharedLinksFolders.generated.js'; +import { AddShareLinkToFolderQueryParams } from '../managers/sharedLinksFolders.generated.js'; +import { GetSharedLinkForFolderQueryParams } from '../managers/sharedLinksFolders.generated.js'; +import { FindFolderForSharedLinkQueryParams } from '../managers/sharedLinksFolders.generated.js'; +import { FindFolderForSharedLinkHeaders } from '../managers/sharedLinksFolders.generated.js'; +import { UpdateSharedLinkOnFolderRequestBody } from '../managers/sharedLinksFolders.generated.js'; +import { UpdateSharedLinkOnFolderRequestBodySharedLinkField } from '../managers/sharedLinksFolders.generated.js'; +import { UpdateSharedLinkOnFolderRequestBodySharedLinkAccessField } from '../managers/sharedLinksFolders.generated.js'; +import { UpdateSharedLinkOnFolderQueryParams } from '../managers/sharedLinksFolders.generated.js'; import { getUuid } from '../utils.js'; import { generateByteStream } from '../utils.js'; import { getEnvVar } from '../utils.js'; @@ -51,30 +51,29 @@ test('testSharedLinksFolders', async function testSharedLinksFolders(): Promise< name: getUuid(), parent: { id: '0' } satisfies CreateFolderRequestBodyParentField, } satisfies CreateFolderRequestBody); - await client.sharedLinksFolders.updateFolderAddSharedLink( + await client.sharedLinksFolders.addShareLinkToFolder( folder.id, { sharedLink: { - access: - 'open' as UpdateFolderAddSharedLinkRequestBodySharedLinkAccessField, + access: 'open' as AddShareLinkToFolderRequestBodySharedLinkAccessField, password: 'Secret123@', - } satisfies UpdateFolderAddSharedLinkRequestBodySharedLinkField, - } satisfies UpdateFolderAddSharedLinkRequestBody, - { fields: 'shared_link' } satisfies UpdateFolderAddSharedLinkQueryParams + } satisfies AddShareLinkToFolderRequestBodySharedLinkField, + } satisfies AddShareLinkToFolderRequestBody, + { fields: 'shared_link' } satisfies AddShareLinkToFolderQueryParams ); const folderFromApi: FolderFull = - await client.sharedLinksFolders.getFolderGetSharedLink(folder.id, { + await client.sharedLinksFolders.getSharedLinkForFolder(folder.id, { fields: 'shared_link', - } satisfies GetFolderGetSharedLinkQueryParams); + } satisfies GetSharedLinkForFolderQueryParams); if (!((toString(folderFromApi.sharedLink!.access) as string) == 'open')) { throw 'Assertion failed'; } const userId: string = getEnvVar('USER_ID'); const userClient: BoxClient = await getDefaultClientAsUser(userId); const folderFromSharedLinkPassword: FolderFull = - await userClient.sharedLinksFolders.getSharedItemFolders( - {} satisfies GetSharedItemFoldersQueryParams, - new GetSharedItemFoldersHeaders({ + await userClient.sharedLinksFolders.findFolderForSharedLink( + {} satisfies FindFolderForSharedLinkQueryParams, + new FindFolderForSharedLinkHeaders({ boxapi: ''.concat( 'shared_link=', folderFromApi.sharedLink!.url, @@ -86,9 +85,9 @@ test('testSharedLinksFolders', async function testSharedLinksFolders(): Promise< throw 'Assertion failed'; } await expect(async () => { - await userClient.sharedLinksFolders.getSharedItemFolders( - {} satisfies GetSharedItemFoldersQueryParams, - new GetSharedItemFoldersHeaders({ + await userClient.sharedLinksFolders.findFolderForSharedLink( + {} satisfies FindFolderForSharedLinkQueryParams, + new FindFolderForSharedLinkHeaders({ boxapi: ''.concat( 'shared_link=', folderFromApi.sharedLink!.url, @@ -98,17 +97,15 @@ test('testSharedLinksFolders', async function testSharedLinksFolders(): Promise< ); }).rejects.toThrow(); const updatedFolder: FolderFull = - await client.sharedLinksFolders.updateFolderUpdateSharedLink( + await client.sharedLinksFolders.updateSharedLinkOnFolder( folder.id, { sharedLink: { access: - 'collaborators' as UpdateFolderUpdateSharedLinkRequestBodySharedLinkAccessField, - } satisfies UpdateFolderUpdateSharedLinkRequestBodySharedLinkField, - } satisfies UpdateFolderUpdateSharedLinkRequestBody, - { - fields: 'shared_link', - } satisfies UpdateFolderUpdateSharedLinkQueryParams + 'collaborators' as UpdateSharedLinkOnFolderRequestBodySharedLinkAccessField, + } satisfies UpdateSharedLinkOnFolderRequestBodySharedLinkField, + } satisfies UpdateSharedLinkOnFolderRequestBody, + { fields: 'shared_link' } satisfies UpdateSharedLinkOnFolderQueryParams ); if ( !((toString(updatedFolder.sharedLink!.access) as string) == 'collaborators') diff --git a/src/test/sharedLinksWebLinks.generated.test.ts b/src/test/sharedLinksWebLinks.generated.test.ts index 8e5472f2..6592f9f3 100644 --- a/src/test/sharedLinksWebLinks.generated.test.ts +++ b/src/test/sharedLinksWebLinks.generated.test.ts @@ -6,34 +6,34 @@ import { serializeCreateWebLinkRequestBody } from '../managers/webLinks.generate import { deserializeCreateWebLinkRequestBody } from '../managers/webLinks.generated.js'; import { serializeCreateWebLinkRequestBodyParentField } from '../managers/webLinks.generated.js'; import { deserializeCreateWebLinkRequestBodyParentField } from '../managers/webLinks.generated.js'; -import { serializeUpdateWebLinkAddSharedLinkRequestBody } from '../managers/sharedLinksWebLinks.generated.js'; -import { deserializeUpdateWebLinkAddSharedLinkRequestBody } from '../managers/sharedLinksWebLinks.generated.js'; -import { serializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; -import { deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; -import { serializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksWebLinks.generated.js'; -import { deserializeUpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksWebLinks.generated.js'; -import { serializeUpdateWebLinkUpdateSharedLinkRequestBody } from '../managers/sharedLinksWebLinks.generated.js'; -import { deserializeUpdateWebLinkUpdateSharedLinkRequestBody } from '../managers/sharedLinksWebLinks.generated.js'; -import { serializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; -import { deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; -import { serializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksWebLinks.generated.js'; -import { deserializeUpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksWebLinks.generated.js'; +import { serializeAddShareLinkToWebLinkRequestBody } from '../managers/sharedLinksWebLinks.generated.js'; +import { deserializeAddShareLinkToWebLinkRequestBody } from '../managers/sharedLinksWebLinks.generated.js'; +import { serializeAddShareLinkToWebLinkRequestBodySharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; +import { deserializeAddShareLinkToWebLinkRequestBodySharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; +import { serializeAddShareLinkToWebLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksWebLinks.generated.js'; +import { deserializeAddShareLinkToWebLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksWebLinks.generated.js'; +import { serializeUpdateSharedLinkOnWebLinkRequestBody } from '../managers/sharedLinksWebLinks.generated.js'; +import { deserializeUpdateSharedLinkOnWebLinkRequestBody } from '../managers/sharedLinksWebLinks.generated.js'; +import { serializeUpdateSharedLinkOnWebLinkRequestBodySharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; +import { deserializeUpdateSharedLinkOnWebLinkRequestBodySharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; +import { serializeUpdateSharedLinkOnWebLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksWebLinks.generated.js'; +import { deserializeUpdateSharedLinkOnWebLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksWebLinks.generated.js'; import { BoxClient } from '../client.generated.js'; import { FolderFull } from '../schemas.generated.js'; import { WebLink } from '../schemas.generated.js'; import { CreateWebLinkRequestBody } from '../managers/webLinks.generated.js'; import { CreateWebLinkRequestBodyParentField } from '../managers/webLinks.generated.js'; -import { UpdateWebLinkAddSharedLinkRequestBody } from '../managers/sharedLinksWebLinks.generated.js'; -import { UpdateWebLinkAddSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; -import { UpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksWebLinks.generated.js'; -import { UpdateWebLinkAddSharedLinkQueryParams } from '../managers/sharedLinksWebLinks.generated.js'; -import { GetWebLinkGetSharedLinkQueryParams } from '../managers/sharedLinksWebLinks.generated.js'; -import { GetSharedItemWebLinksQueryParams } from '../managers/sharedLinksWebLinks.generated.js'; -import { GetSharedItemWebLinksHeaders } from '../managers/sharedLinksWebLinks.generated.js'; -import { UpdateWebLinkUpdateSharedLinkRequestBody } from '../managers/sharedLinksWebLinks.generated.js'; -import { UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; -import { UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksWebLinks.generated.js'; -import { UpdateWebLinkUpdateSharedLinkQueryParams } from '../managers/sharedLinksWebLinks.generated.js'; +import { AddShareLinkToWebLinkRequestBody } from '../managers/sharedLinksWebLinks.generated.js'; +import { AddShareLinkToWebLinkRequestBodySharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; +import { AddShareLinkToWebLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksWebLinks.generated.js'; +import { AddShareLinkToWebLinkQueryParams } from '../managers/sharedLinksWebLinks.generated.js'; +import { GetSharedLinkForWebLinkQueryParams } from '../managers/sharedLinksWebLinks.generated.js'; +import { FindWebLinkForSharedLinkQueryParams } from '../managers/sharedLinksWebLinks.generated.js'; +import { FindWebLinkForSharedLinkHeaders } from '../managers/sharedLinksWebLinks.generated.js'; +import { UpdateSharedLinkOnWebLinkRequestBody } from '../managers/sharedLinksWebLinks.generated.js'; +import { UpdateSharedLinkOnWebLinkRequestBodySharedLinkField } from '../managers/sharedLinksWebLinks.generated.js'; +import { UpdateSharedLinkOnWebLinkRequestBodySharedLinkAccessField } from '../managers/sharedLinksWebLinks.generated.js'; +import { UpdateSharedLinkOnWebLinkQueryParams } from '../managers/sharedLinksWebLinks.generated.js'; import { getUuid } from '../utils.js'; import { generateByteStream } from '../utils.js'; import { getEnvVar } from '../utils.js'; @@ -58,30 +58,29 @@ test('testSharedLinksWebLinks', async function testSharedLinksWebLinks(): Promis description: 'Weblink description', } satisfies CreateWebLinkRequestBody); const webLinkId: string = webLink.id; - await client.sharedLinksWebLinks.updateWebLinkAddSharedLink( + await client.sharedLinksWebLinks.addShareLinkToWebLink( webLinkId, { sharedLink: { - access: - 'open' as UpdateWebLinkAddSharedLinkRequestBodySharedLinkAccessField, + access: 'open' as AddShareLinkToWebLinkRequestBodySharedLinkAccessField, password: 'Secret123@', - } satisfies UpdateWebLinkAddSharedLinkRequestBodySharedLinkField, - } satisfies UpdateWebLinkAddSharedLinkRequestBody, - { fields: 'shared_link' } satisfies UpdateWebLinkAddSharedLinkQueryParams + } satisfies AddShareLinkToWebLinkRequestBodySharedLinkField, + } satisfies AddShareLinkToWebLinkRequestBody, + { fields: 'shared_link' } satisfies AddShareLinkToWebLinkQueryParams ); const webLinkFromApi: WebLink = - await client.sharedLinksWebLinks.getWebLinkGetSharedLink(webLinkId, { + await client.sharedLinksWebLinks.getSharedLinkForWebLink(webLinkId, { fields: 'shared_link', - } satisfies GetWebLinkGetSharedLinkQueryParams); + } satisfies GetSharedLinkForWebLinkQueryParams); if (!((toString(webLinkFromApi.sharedLink!.access) as string) == 'open')) { throw 'Assertion failed'; } const userId: string = getEnvVar('USER_ID'); const userClient: BoxClient = await getDefaultClientAsUser(userId); const webLinkFromSharedLinkPassword: WebLink = - await userClient.sharedLinksWebLinks.getSharedItemWebLinks( - {} satisfies GetSharedItemWebLinksQueryParams, - new GetSharedItemWebLinksHeaders({ + await userClient.sharedLinksWebLinks.findWebLinkForSharedLink( + {} satisfies FindWebLinkForSharedLinkQueryParams, + new FindWebLinkForSharedLinkHeaders({ boxapi: ''.concat( 'shared_link=', webLinkFromApi.sharedLink!.url, @@ -93,9 +92,9 @@ test('testSharedLinksWebLinks', async function testSharedLinksWebLinks(): Promis throw 'Assertion failed'; } await expect(async () => { - await userClient.sharedLinksWebLinks.getSharedItemWebLinks( - {} satisfies GetSharedItemWebLinksQueryParams, - new GetSharedItemWebLinksHeaders({ + await userClient.sharedLinksWebLinks.findWebLinkForSharedLink( + {} satisfies FindWebLinkForSharedLinkQueryParams, + new FindWebLinkForSharedLinkHeaders({ boxapi: ''.concat( 'shared_link=', webLinkFromApi.sharedLink!.url, @@ -105,17 +104,15 @@ test('testSharedLinksWebLinks', async function testSharedLinksWebLinks(): Promis ); }).rejects.toThrow(); const updatedWebLink: WebLink = - await client.sharedLinksWebLinks.updateWebLinkUpdateSharedLink( + await client.sharedLinksWebLinks.updateSharedLinkOnWebLink( webLinkId, { sharedLink: { access: - 'collaborators' as UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkAccessField, - } satisfies UpdateWebLinkUpdateSharedLinkRequestBodySharedLinkField, - } satisfies UpdateWebLinkUpdateSharedLinkRequestBody, - { - fields: 'shared_link', - } satisfies UpdateWebLinkUpdateSharedLinkQueryParams + 'collaborators' as UpdateSharedLinkOnWebLinkRequestBodySharedLinkAccessField, + } satisfies UpdateSharedLinkOnWebLinkRequestBodySharedLinkField, + } satisfies UpdateSharedLinkOnWebLinkRequestBody, + { fields: 'shared_link' } satisfies UpdateSharedLinkOnWebLinkQueryParams ); if ( !( diff --git a/src/test/shieldInformationBarriers.generated.test.ts b/src/test/shieldInformationBarriers.generated.test.ts index 20fa42c2..0bd251fa 100644 --- a/src/test/shieldInformationBarriers.generated.test.ts +++ b/src/test/shieldInformationBarriers.generated.test.ts @@ -2,15 +2,15 @@ import { serializeShieldInformationBarrier } from '../schemas.generated.js'; import { deserializeShieldInformationBarrier } from '../schemas.generated.js'; import { serializeShieldInformationBarriers } from '../schemas.generated.js'; import { deserializeShieldInformationBarriers } from '../schemas.generated.js'; -import { serializeCreateShieldInformationBarrierChangeStatusRequestBody } from '../managers/shieldInformationBarriers.generated.js'; -import { deserializeCreateShieldInformationBarrierChangeStatusRequestBody } from '../managers/shieldInformationBarriers.generated.js'; -import { serializeCreateShieldInformationBarrierChangeStatusRequestBodyStatusField } from '../managers/shieldInformationBarriers.generated.js'; -import { deserializeCreateShieldInformationBarrierChangeStatusRequestBodyStatusField } from '../managers/shieldInformationBarriers.generated.js'; +import { serializeUpdateShieldInformationBarrierStatusRequestBody } from '../managers/shieldInformationBarriers.generated.js'; +import { deserializeUpdateShieldInformationBarrierStatusRequestBody } from '../managers/shieldInformationBarriers.generated.js'; +import { serializeUpdateShieldInformationBarrierStatusRequestBodyStatusField } from '../managers/shieldInformationBarriers.generated.js'; +import { deserializeUpdateShieldInformationBarrierStatusRequestBodyStatusField } from '../managers/shieldInformationBarriers.generated.js'; import { BoxClient } from '../client.generated.js'; import { ShieldInformationBarrier } from '../schemas.generated.js'; import { ShieldInformationBarriers } from '../schemas.generated.js'; -import { CreateShieldInformationBarrierChangeStatusRequestBody } from '../managers/shieldInformationBarriers.generated.js'; -import { CreateShieldInformationBarrierChangeStatusRequestBodyStatusField } from '../managers/shieldInformationBarriers.generated.js'; +import { UpdateShieldInformationBarrierStatusRequestBody } from '../managers/shieldInformationBarriers.generated.js'; +import { UpdateShieldInformationBarrierStatusRequestBodyStatusField } from '../managers/shieldInformationBarriers.generated.js'; import { getEnvVar } from '../utils.js'; import { getDefaultClientAsUser } from './commons.generated.js'; import { getOrCreateShieldInformationBarrier } from './commons.generated.js'; @@ -54,12 +54,12 @@ test('testShieldInformationBarriers', async function testShieldInformationBarrie throw 'Assertion failed'; } await expect(async () => { - await client.shieldInformationBarriers.createShieldInformationBarrierChangeStatus( + await client.shieldInformationBarriers.updateShieldInformationBarrierStatus( { id: barrierId, status: - 'disabled' as CreateShieldInformationBarrierChangeStatusRequestBodyStatusField, - } satisfies CreateShieldInformationBarrierChangeStatusRequestBody + 'disabled' as UpdateShieldInformationBarrierStatusRequestBodyStatusField, + } satisfies UpdateShieldInformationBarrierStatusRequestBody ); }).rejects.toThrow(); }); diff --git a/src/test/trashedFiles.generated.test.ts b/src/test/trashedFiles.generated.test.ts index 0dd4e18a..987ec1a6 100644 --- a/src/test/trashedFiles.generated.test.ts +++ b/src/test/trashedFiles.generated.test.ts @@ -45,7 +45,9 @@ test('testTrashedFiles', async function testTrashedFiles(): Promise { } satisfies UploadFileRequestBody); const file: FileFull = files.entries![0]; await client.files.deleteFileById(file.id); - const fromTrash: TrashFile = await client.trashedFiles.getFileTrash(file.id); + const fromTrash: TrashFile = await client.trashedFiles.getTrashedFileById( + file.id + ); if (!(fromTrash.id == file.id)) { throw 'Assertion failed'; } @@ -69,9 +71,9 @@ test('testTrashedFiles', async function testTrashedFiles(): Promise { throw 'Assertion failed'; } await client.files.deleteFileById(file.id); - await client.trashedFiles.deleteFileTrash(file.id); + await client.trashedFiles.deleteTrashedFileById(file.id); await expect(async () => { - await client.trashedFiles.getFileTrash(file.id); + await client.trashedFiles.getTrashedFileById(file.id); }).rejects.toThrow(); }); export {}; diff --git a/src/test/trashedFolders.generated.test.ts b/src/test/trashedFolders.generated.test.ts index a049bce1..9e9dec48 100644 --- a/src/test/trashedFolders.generated.test.ts +++ b/src/test/trashedFolders.generated.test.ts @@ -30,9 +30,8 @@ test('testTrashedFolders', async function testTrashedFolders(): Promise { parent: { id: '0' } satisfies CreateFolderRequestBodyParentField, } satisfies CreateFolderRequestBody); await client.folders.deleteFolderById(folder.id); - const fromTrash: TrashFolder = await client.trashedFolders.getFolderTrash( - folder.id - ); + const fromTrash: TrashFolder = + await client.trashedFolders.getTrashedFolderById(folder.id); if (!(fromTrash.id == folder.id)) { throw 'Assertion failed'; } @@ -52,9 +51,9 @@ test('testTrashedFolders', async function testTrashedFolders(): Promise { throw 'Assertion failed'; } await client.folders.deleteFolderById(folder.id); - await client.trashedFolders.deleteFolderTrash(folder.id); + await client.trashedFolders.deleteTrashedFolderById(folder.id); await expect(async () => { - await client.trashedFolders.getFolderTrash(folder.id); + await client.trashedFolders.getTrashedFolderById(folder.id); }).rejects.toThrow(); }); export {}; diff --git a/src/test/trashedItems.generated.test.ts b/src/test/trashedItems.generated.test.ts index b5ed2f88..92f1b549 100644 --- a/src/test/trashedItems.generated.test.ts +++ b/src/test/trashedItems.generated.test.ts @@ -18,7 +18,7 @@ const client: BoxClient = getDefaultClient(); test('testListTrashedItems', async function testListTrashedItems(): Promise { const file: FileFull = await uploadNewFile(); await client.files.deleteFileById(file.id); - const trashedItems: Items = await client.trashedItems.getFolderTrashItems(); + const trashedItems: Items = await client.trashedItems.getTrashedItems(); if (!(trashedItems.entries!.length > 0)) { throw 'Assertion failed'; } diff --git a/src/test/trashedWebLinks.generated.test.ts b/src/test/trashedWebLinks.generated.test.ts index 241355df..a12728a3 100644 --- a/src/test/trashedWebLinks.generated.test.ts +++ b/src/test/trashedWebLinks.generated.test.ts @@ -41,9 +41,8 @@ test('testTrashedWebLinks', async function testTrashedWebLinks(): Promise { description: description, } satisfies CreateWebLinkRequestBody); await client.webLinks.deleteWebLinkById(weblink.id); - const fromTrash: TrashWebLink = await client.trashedWebLinks.getWebLinkTrash( - weblink.id - ); + const fromTrash: TrashWebLink = + await client.trashedWebLinks.getTrashedWebLinkById(weblink.id); if (!(fromTrash.id == weblink.id)) { throw 'Assertion failed'; } @@ -66,9 +65,9 @@ test('testTrashedWebLinks', async function testTrashedWebLinks(): Promise { throw 'Assertion failed'; } await client.webLinks.deleteWebLinkById(weblink.id); - await client.trashedWebLinks.deleteWebLinkTrash(weblink.id); + await client.trashedWebLinks.deleteTrashedWebLinkById(weblink.id); await expect(async () => { - await client.trashedWebLinks.getWebLinkTrash(weblink.id); + await client.trashedWebLinks.getTrashedWebLinkById(weblink.id); }).rejects.toThrow(); }); export {}; From 56a5db1fbfb9cf9124e26f8ed0f5ce81cc8bdb36 Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Thu, 21 Dec 2023 04:21:43 -0800 Subject: [PATCH 8/8] generated with codegen at box/box-codegen@7a2cf3d and spec at box/box-openapi@fc21828 --- docs/authorization.md | 112 ++++++- docs/avatars.md | 108 ++++++ docs/chunkedUploads.md | 267 +++++++++++++++ docs/classifications.md | 180 ++++++++++ docs/collaborationAllowlistEntries.md | 138 ++++++++ docs/collaborationAllowlistExemptTargets.md | 141 ++++++++ docs/collections.md | 70 ++++ docs/comments.md | 182 +++++++++++ docs/devicePinners.md | 88 +++++ docs/emailAliases.md | 102 ++++++ docs/events.md | 101 ++++++ docs/fileClassifications.md | 161 +++++++++ docs/fileMetadata.md | 221 +++++++++++++ docs/fileRequests.md | 141 ++++++++ docs/fileVersionLegalHolds.md | 77 +++++ docs/fileVersionRetentions.md | 56 ++++ docs/fileVersions.md | 208 ++++++++++++ docs/fileWatermarks.md | 104 ++++++ docs/folderClassifications.md | 161 +++++++++ docs/folderLocks.md | 118 +++++++ docs/folderMetadata.md | 226 +++++++++++++ docs/folderWatermarks.md | 105 ++++++ docs/groups.md | 178 ++++++++++ docs/integrationMappings.md | 126 +++++++ docs/invites.md | 83 +++++ docs/legalHoldPolicies.md | 170 ++++++++++ docs/legalHoldPolicyAssignments.md | 204 ++++++++++++ docs/listCollaborations.md | 156 +++++++++ docs/memberships.md | 219 +++++++++++++ docs/metadataCascadePolicies.md | 191 +++++++++++ docs/metadataTemplates.md | 307 ++++++++++++++++++ docs/recentItems.md | 35 ++ docs/retentionPolicies.md | 174 ++++++++++ docs/retentionPolicyAssignments.md | 179 ++++++++++ docs/search.md | 116 +++++++ docs/sessionTermination.md | 75 +++++ docs/sharedLinksFiles.md | 209 ++++++++++++ docs/sharedLinksFolders.md | 206 ++++++++++++ docs/sharedLinksWebLinks.md | 207 ++++++++++++ docs/shieldInformationBarrierReports.md | 108 ++++++ .../shieldInformationBarrierSegmentMembers.md | 150 +++++++++ ...ldInformationBarrierSegmentRestrictions.md | 153 +++++++++ docs/shieldInformationBarrierSegments.md | 183 +++++++++++ docs/shieldInformationBarriers.md | 142 ++++++++ docs/signTemplates.md | 66 ++++ docs/skills.md | 150 +++++++++ docs/storagePolicies.md | 56 ++++ docs/storagePolicyAssignments.md | 148 +++++++++ docs/taskAssignments.md | 146 +++++++++ docs/tasks.md | 176 ++++++++++ docs/termsOfServiceUserStatuses.md | 87 +++++ docs/termsOfServices.md | 115 +++++++ docs/transfer.md | 78 +++++ docs/trashedFiles.md | 118 +++++++ docs/trashedFolders.md | 127 ++++++++ docs/trashedItems.md | 41 +++ docs/trashedWebLinks.md | 108 ++++++ docs/userCollaborations.md | 163 ++++++++++ docs/users.md | 240 ++++++++++++++ docs/webLinks.md | 140 ++++++++ docs/webhooks.md | 174 ++++++++++ docs/workflows.md | 65 ++++ docs/zipDownloads.md | 195 +++++++++++ 63 files changed, 9021 insertions(+), 10 deletions(-) create mode 100644 docs/avatars.md create mode 100644 docs/chunkedUploads.md create mode 100644 docs/classifications.md create mode 100644 docs/collaborationAllowlistEntries.md create mode 100644 docs/collaborationAllowlistExemptTargets.md create mode 100644 docs/collections.md create mode 100644 docs/comments.md create mode 100644 docs/devicePinners.md create mode 100644 docs/emailAliases.md create mode 100644 docs/events.md create mode 100644 docs/fileClassifications.md create mode 100644 docs/fileMetadata.md create mode 100644 docs/fileRequests.md create mode 100644 docs/fileVersionLegalHolds.md create mode 100644 docs/fileVersionRetentions.md create mode 100644 docs/fileVersions.md create mode 100644 docs/fileWatermarks.md create mode 100644 docs/folderClassifications.md create mode 100644 docs/folderLocks.md create mode 100644 docs/folderMetadata.md create mode 100644 docs/folderWatermarks.md create mode 100644 docs/groups.md create mode 100644 docs/integrationMappings.md create mode 100644 docs/invites.md create mode 100644 docs/legalHoldPolicies.md create mode 100644 docs/legalHoldPolicyAssignments.md create mode 100644 docs/listCollaborations.md create mode 100644 docs/memberships.md create mode 100644 docs/metadataCascadePolicies.md create mode 100644 docs/metadataTemplates.md create mode 100644 docs/recentItems.md create mode 100644 docs/retentionPolicies.md create mode 100644 docs/retentionPolicyAssignments.md create mode 100644 docs/search.md create mode 100644 docs/sessionTermination.md create mode 100644 docs/sharedLinksFiles.md create mode 100644 docs/sharedLinksFolders.md create mode 100644 docs/sharedLinksWebLinks.md create mode 100644 docs/shieldInformationBarrierReports.md create mode 100644 docs/shieldInformationBarrierSegmentMembers.md create mode 100644 docs/shieldInformationBarrierSegmentRestrictions.md create mode 100644 docs/shieldInformationBarrierSegments.md create mode 100644 docs/shieldInformationBarriers.md create mode 100644 docs/signTemplates.md create mode 100644 docs/skills.md create mode 100644 docs/storagePolicies.md create mode 100644 docs/storagePolicyAssignments.md create mode 100644 docs/taskAssignments.md create mode 100644 docs/tasks.md create mode 100644 docs/termsOfServiceUserStatuses.md create mode 100644 docs/termsOfServices.md create mode 100644 docs/transfer.md create mode 100644 docs/trashedFiles.md create mode 100644 docs/trashedFolders.md create mode 100644 docs/trashedItems.md create mode 100644 docs/trashedWebLinks.md create mode 100644 docs/userCollaborations.md create mode 100644 docs/users.md create mode 100644 docs/webLinks.md create mode 100644 docs/webhooks.md create mode 100644 docs/workflows.md create mode 100644 docs/zipDownloads.md diff --git a/docs/authorization.md b/docs/authorization.md index 546bea11..5e98dd9a 100644 --- a/docs/authorization.md +++ b/docs/authorization.md @@ -1,40 +1,132 @@ # AuthorizationManager -- [](#) -- [](#) +- [Authorize user](#authorize-user) +- [Request access token](#request-access-token) +- [Refresh access token](#refresh-access-token) +- [Revoke access token](#revoke-access-token) -## +## Authorize user + +Authorize a user by sending them through the [Box](https://box.com) +website and request their permission to act on their behalf. + +This is the first step when authenticating a user using +OAuth 2.0. To request a user's authorization to use the Box APIs +on their behalf you will need to send a user to the URL with this +format. + +This operation is performed by calling function `authorizeUser`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-authorize/). + +_Currently we don't have an example for calling `authorizeUser` in integration tests_ + +### Arguments + +- queryParams `AuthorizeUserQueryParams` + - Query parameters of authorizeUser method +- headers `AuthorizeUserHeaders` + - Headers of authorizeUser method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Does not return any data, but rather should be used in the browser. + +## Request access token + +Request an Access Token using either a client-side obtained OAuth 2.0 +authorization code or a server-side JWT assertion. + +An Access Token is a string that enables Box to verify that a +request belongs to an authorized session. In the normal order of +operations you will begin by requesting authentication from the +[authorize](#get-authorize) endpoint and Box will send you an +authorization code. + +You will then send this code to this endpoint to exchange it for +an Access Token. The returned Access Token can then be used to to make +Box API calls. This operation is performed by calling function `requestAccessToken`. See the endpoint docs at -[API Reference](https://developer.box.com/reference//). +[API Reference](https://developer.box.com/reference/post-oauth-2-token/). _Currently we don't have an example for calling `requestAccessToken` in integration tests_ ### Arguments -- requestBody `` - - +- requestBody `PostOAuth2Token` + - Request body of requestAccessToken method +- headers `RequestAccessTokenHeaders` + - Headers of requestAccessToken method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. ### Returns This function returns a value of type `AccessToken`. -## +Returns a new Access Token that can be used to make authenticated +API calls by passing along the token in a authorization header as +follows `Authorization: Bearer `. + +## Refresh access token + +Refresh an Access Token using its client ID, secret, and refresh token. + +This operation is performed by calling function `refreshAccessToken`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-oauth-2-token-refresh/). + +_Currently we don't have an example for calling `refreshAccessToken` in integration tests_ + +### Arguments + +- requestBody `PostOAuth2TokenRefreshAccessToken` + - Request body of refreshAccessToken method +- headers `RefreshAccessTokenHeaders` + - Headers of refreshAccessToken method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `AccessToken`. + +Returns a new Access Token that can be used to make authenticated +API calls by passing along the token in a authorization header as +follows `Authorization: Bearer `. + +## Revoke access token + +Revoke an active Access Token, effectively logging a user out +that has been previously authenticated. This operation is performed by calling function `revokeAccessToken`. See the endpoint docs at -[API Reference](https://developer.box.com/reference//). +[API Reference](https://developer.box.com/reference/post-oauth-2-revoke/). _Currently we don't have an example for calling `revokeAccessToken` in integration tests_ ### Arguments -- requestBody `` - - +- requestBody `PostOAuth2Revoke` + - Request body of revokeAccessToken method +- headers `RevokeAccessTokenHeaders` + - Headers of revokeAccessToken method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. ### Returns This function returns a value of type `undefined`. + +Returns an empty response when the token was successfully revoked. diff --git a/docs/avatars.md b/docs/avatars.md new file mode 100644 index 00000000..66bf5c65 --- /dev/null +++ b/docs/avatars.md @@ -0,0 +1,108 @@ +# AvatarsManager + +- [Get user avatar](#get-user-avatar) +- [Add or update user avatar](#add-or-update-user-avatar) +- [Delete user avatar](#delete-user-avatar) + +## Get user avatar + +Retrieves an image of a the user's avatar. + +This operation is performed by calling function `getUserAvatar`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-users-id-avatar/). + + + +```ts +await client.avatars.getUserAvatar(user.id); +``` + +### Arguments + +- userId `string` + - The ID of the user. Example: "12345" +- headers `GetUserAvatarHeaders` + - Headers of getUserAvatar method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ByteStream`. + +When an avatar can be found for the user the +image data will be returned in the body of the +response. + +## Add or update user avatar + +Adds or updates a user avatar. + +This operation is performed by calling function `createUserAvatar`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-users-id-avatar/). + + + +```ts +await client.avatars.createUserAvatar(user.id, { + pic: decodeBase64ByteStream( + 'iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDolAAAAA1BMVEW10NBjBBbqAAAAH0lEQVRoge3BAQ0AAADCoPdPbQ43oAAAAAAAAAAAvg0hAAABmmDh1QAAAABJRU5ErkJggg==' + ), + picContentType: 'image/png', + picFileName: 'avatar.png', +} satisfies CreateUserAvatarRequestBody); +``` + +### Arguments + +- userId `string` + - The ID of the user. Example: "12345" +- requestBody `CreateUserAvatarRequestBody` + - Request body of createUserAvatar method +- headers `CreateUserAvatarHeaders` + - Headers of createUserAvatar method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `UserAvatar`. + +- `ok`: Returns the `pic_urls` object with URLs to existing + user avatars that were updated.\* `created`: Returns the `pic_urls` object with URLS to user avatars + uploaded to Box with the request. + +## Delete user avatar + +Removes an existing user avatar. +You cannot reverse this operation. + +This operation is performed by calling function `deleteUserAvatar`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-users-id-avatar/). + + + +```ts +await client.avatars.deleteUserAvatar(user.id); +``` + +### Arguments + +- userId `string` + - The ID of the user. Example: "12345" +- headers `DeleteUserAvatarHeaders` + - Headers of deleteUserAvatar method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +- `no_content`: Removes the avatar and returns an empty response. diff --git a/docs/chunkedUploads.md b/docs/chunkedUploads.md new file mode 100644 index 00000000..42327825 --- /dev/null +++ b/docs/chunkedUploads.md @@ -0,0 +1,267 @@ +# ChunkedUploadsManager + +This is a manager for chunked uploads (allowed for files at least 20MB). + +- [Create upload session](#create-upload-session) +- [Create upload session for existing file](#create-upload-session-for-existing-file) +- [Get upload session](#get-upload-session) +- [Upload part of file](#upload-part-of-file) +- [Remove upload session](#remove-upload-session) +- [List parts](#list-parts) +- [Commit upload session](#commit-upload-session) +- [](#) +- [](#) + +## Create upload session + +Creates an upload session for a new file. + +This operation is performed by calling function `createFileUploadSession`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-files-upload-sessions/). + +_Currently we don't have an example for calling `createFileUploadSession` in integration tests_ + +### Arguments + +- requestBody `CreateFileUploadSessionRequestBody` + - Request body of createFileUploadSession method +- headers `CreateFileUploadSessionHeaders` + - Headers of createFileUploadSession method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `UploadSession`. + +Returns a new upload session. + +## Create upload session for existing file + +Creates an upload session for an existing file. + +This operation is performed by calling function `createFileUploadSessionForExistingFile`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-files-id-upload-sessions/). + +_Currently we don't have an example for calling `createFileUploadSessionForExistingFile` in integration tests_ + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- requestBody `CreateFileUploadSessionForExistingFileRequestBody` + - Request body of createFileUploadSessionForExistingFile method +- headers `CreateFileUploadSessionForExistingFileHeaders` + - Headers of createFileUploadSessionForExistingFile method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `UploadSession`. + +Returns a new upload session. + +## Get upload session + +Return information about an upload session. + +This operation is performed by calling function `getFileUploadSessionById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-files-upload-sessions-id/). + +_Currently we don't have an example for calling `getFileUploadSessionById` in integration tests_ + +### Arguments + +- uploadSessionId `string` + - The ID of the upload session. Example: "D5E3F7A" +- headers `GetFileUploadSessionByIdHeaders` + - Headers of getFileUploadSessionById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `UploadSession`. + +Returns an upload session object. + +## Upload part of file + +Updates a chunk of an upload session for a file. + +This operation is performed by calling function `uploadFilePart`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-files-upload-sessions-id/). + +_Currently we don't have an example for calling `uploadFilePart` in integration tests_ + +### Arguments + +- uploadSessionId `string` + - The ID of the upload session. Example: "D5E3F7A" +- requestBody `ByteStream` + - Request body of uploadFilePart method +- headers `UploadFilePartHeaders` + - Headers of uploadFilePart method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `UploadedPart`. + +Chunk has been uploaded successfully. + +## Remove upload session + +Abort an upload session and discard all data uploaded. + +This cannot be reversed. + +This operation is performed by calling function `deleteFileUploadSessionById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-files-upload-sessions-id/). + +_Currently we don't have an example for calling `deleteFileUploadSessionById` in integration tests_ + +### Arguments + +- uploadSessionId `string` + - The ID of the upload session. Example: "D5E3F7A" +- headers `DeleteFileUploadSessionByIdHeaders` + - Headers of deleteFileUploadSessionById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +A blank response is returned if the session was +successfully aborted. + +## List parts + +Return a list of the chunks uploaded to the upload +session so far. + +This operation is performed by calling function `getFileUploadSessionParts`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-files-upload-sessions-id-parts/). + +_Currently we don't have an example for calling `getFileUploadSessionParts` in integration tests_ + +### Arguments + +- uploadSessionId `string` + - The ID of the upload session. Example: "D5E3F7A" +- queryParams `GetFileUploadSessionPartsQueryParams` + - Query parameters of getFileUploadSessionParts method +- headers `GetFileUploadSessionPartsHeaders` + - Headers of getFileUploadSessionParts method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `UploadParts`. + +Returns a list of parts that have been uploaded. + +## Commit upload session + +Close an upload session and create a file from the +uploaded chunks. + +This operation is performed by calling function `createFileUploadSessionCommit`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-files-upload-sessions-id-commit/). + +_Currently we don't have an example for calling `createFileUploadSessionCommit` in integration tests_ + +### Arguments + +- uploadSessionId `string` + - The ID of the upload session. Example: "D5E3F7A" +- requestBody `CreateFileUploadSessionCommitRequestBody` + - Request body of createFileUploadSessionCommit method +- headers `CreateFileUploadSessionCommitHeaders` + - Headers of createFileUploadSessionCommit method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Files`. + +Returns the file object in a list.Returns when all chunks have been uploaded but not yet processed. + +Inspect the upload session to get more information about the +progress of processing the chunks, then retry committing the file +when all chunks have processed. + +## + +This operation is performed by calling function `reducer`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference//). + +_Currently we don't have an example for calling `reducer` in integration tests_ + +### Arguments + +- acc `PartAccumulator` + - +- chunk `ByteStream` + - + +### Returns + +This function returns a value of type `PartAccumulator`. + +## + +This operation is performed by calling function `uploadBigFile`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference//). + + + +```ts +await client.chunkedUploads.uploadBigFile( + fileByteStream, + fileName, + fileSize, + parentFolderId +); +``` + +### Arguments + +- file `ByteStream` + - The stream of the file to upload. +- fileName `string` + - The name of the file, which will be used for storage in Box. +- fileSize `number` + - The total size of the file for the chunked upload in bytes. +- parentFolderId `string` + - The ID of the folder where the file should be uploaded. +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FileFull`. diff --git a/docs/classifications.md b/docs/classifications.md new file mode 100644 index 00000000..9df0bdd9 --- /dev/null +++ b/docs/classifications.md @@ -0,0 +1,180 @@ +# ClassificationsManager + +- [List all classifications](#list-all-classifications) +- [Add classification](#add-classification) +- [Update classification](#update-classification) +- [Add initial classifications](#add-initial-classifications) + +## List all classifications + +Retrieves the classification metadata template and lists all the +classifications available to this enterprise. + +This API can also be called by including the enterprise ID in the +URL explicitly, for example +`/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`. + +This operation is performed by calling function `getClassificationTemplate`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-metadata-templates-enterprise-security-classification-6-vm-vochw-u-wo-schema/). + + + +```ts +await client.classifications.getClassificationTemplate(); +``` + +### Arguments + +- headers `GetClassificationTemplateHeaders` + - Headers of getClassificationTemplate method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ClassificationTemplate`. + +Returns the `securityClassification` metadata template, which contains +a `Box__Security__Classification__Key` field that lists all the +classifications available to this enterprise. + +## Add classification + +Adds one or more new classifications to the list of classifications +available to the enterprise. + +This API can also be called by including the enterprise ID in the +URL explicitly, for example +`/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`. + +This operation is performed by calling function `addClassification`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-metadata-templates-enterprise-security-classification-6-vm-vochw-u-wo-schema-add/). + + + +```ts +await client.classifications.addClassification([ + { + op: 'addEnumOption' as AddClassificationRequestBodyOpField, + fieldKey: + 'Box__Security__Classification__Key' as AddClassificationRequestBodyFieldKeyField, + data: { + key: getUuid(), + staticConfig: { + classification: { + colorId: 4, + classificationDefinition: 'Other description', + } satisfies AddClassificationRequestBodyDataStaticConfigClassificationField, + } satisfies AddClassificationRequestBodyDataStaticConfigField, + } satisfies AddClassificationRequestBodyDataField, + } satisfies AddClassificationRequestBody, +]); +``` + +### Arguments + +- requestBody `readonly AddClassificationRequestBody[]` + - Request body of addClassification method +- headers `AddClassificationHeaders` + - Headers of addClassification method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ClassificationTemplate`. + +Returns the updated `securityClassification` metadata template, which +contains a `Box__Security__Classification__Key` field that lists all +the classifications available to this enterprise. + +## Update classification + +Updates the labels and descriptions of one or more classifications +available to the enterprise. + +This API can also be called by including the enterprise ID in the +URL explicitly, for example +`/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`. + +This operation is performed by calling function `updateClassification`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-metadata-templates-enterprise-security-classification-6-vm-vochw-u-wo-schema-update/). + + + +```ts +await client.classifications.updateClassification([ + { + op: 'editEnumOption' as UpdateClassificationRequestBodyOpField, + fieldKey: + 'Box__Security__Classification__Key' as UpdateClassificationRequestBodyFieldKeyField, + enumOptionKey: classification.key, + data: { + key: updatedClassificationName, + staticConfig: { + classification: { + colorId: 2, + classificationDefinition: updatedClassificationDescription, + } satisfies UpdateClassificationRequestBodyDataStaticConfigClassificationField, + } satisfies UpdateClassificationRequestBodyDataStaticConfigField, + } satisfies UpdateClassificationRequestBodyDataField, + } satisfies UpdateClassificationRequestBody, +]); +``` + +### Arguments + +- requestBody `readonly UpdateClassificationRequestBody[]` + - Request body of updateClassification method +- headers `UpdateClassificationHeaders` + - Headers of updateClassification method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ClassificationTemplate`. + +Returns the updated `securityClassification` metadata template, which +contains a `Box__Security__Classification__Key` field that lists all +the classifications available to this enterprise. + +## Add initial classifications + +When an enterprise does not yet have any classifications, this API call +initializes the classification template with an initial set of +classifications. + +If an enterprise already has a classification, the template will already +exist and instead an API call should be made to add additional +classifications. + +This operation is performed by calling function `createClassificationTemplate`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-metadata-templates-schema-classifications/). + +_Currently we don't have an example for calling `createClassificationTemplate` in integration tests_ + +### Arguments + +- requestBody `CreateClassificationTemplateRequestBody` + - Request body of createClassificationTemplate method +- headers `CreateClassificationTemplateHeaders` + - Headers of createClassificationTemplate method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ClassificationTemplate`. + +Returns a new `securityClassification` metadata template, which +contains a `Box__Security__Classification__Key` field that lists all +the classifications available to this enterprise. diff --git a/docs/collaborationAllowlistEntries.md b/docs/collaborationAllowlistEntries.md new file mode 100644 index 00000000..9eeea4a9 --- /dev/null +++ b/docs/collaborationAllowlistEntries.md @@ -0,0 +1,138 @@ +# CollaborationAllowlistEntriesManager + +- [List allowed collaboration domains](#list-allowed-collaboration-domains) +- [Add domain to list of allowed collaboration domains](#add-domain-to-list-of-allowed-collaboration-domains) +- [Get allowed collaboration domain](#get-allowed-collaboration-domain) +- [Remove domain from list of allowed collaboration domains](#remove-domain-from-list-of-allowed-collaboration-domains) + +## List allowed collaboration domains + +Returns the list domains that have been deemed safe to create collaborations +for within the current enterprise. + +This operation is performed by calling function `getCollaborationWhitelistEntries`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-collaboration-whitelist-entries/). + + + +```ts +await client.collaborationAllowlistEntries.getCollaborationWhitelistEntries(); +``` + +### Arguments + +- queryParams `GetCollaborationWhitelistEntriesQueryParams` + - Query parameters of getCollaborationWhitelistEntries method +- headers `GetCollaborationWhitelistEntriesHeaders` + - Headers of getCollaborationWhitelistEntries method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `CollaborationAllowlistEntries`. + +Returns a collection of domains that are allowed for collaboration. + +## Add domain to list of allowed collaboration domains + +Creates a new entry in the list of allowed domains to allow +collaboration for. + +This operation is performed by calling function `createCollaborationWhitelistEntry`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-collaboration-whitelist-entries/). + + + +```ts +await client.collaborationAllowlistEntries.createCollaborationWhitelistEntry({ + direction: direction, + domain: domain, +} satisfies CreateCollaborationWhitelistEntryRequestBody); +``` + +### Arguments + +- requestBody `CreateCollaborationWhitelistEntryRequestBody` + - Request body of createCollaborationWhitelistEntry method +- headers `CreateCollaborationWhitelistEntryHeaders` + - Headers of createCollaborationWhitelistEntry method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `CollaborationAllowlistEntry`. + +Returns a new entry on the list of allowed domains. + +## Get allowed collaboration domain + +Returns a domain that has been deemed safe to create collaborations +for within the current enterprise. + +This operation is performed by calling function `getCollaborationWhitelistEntryById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-collaboration-whitelist-entries-id/). + + + +```ts +await client.collaborationAllowlistEntries.getCollaborationWhitelistEntryById( + entry.id! +); +``` + +### Arguments + +- collaborationWhitelistEntryId `string` + - The ID of the entry in the list. Example: "213123" +- headers `GetCollaborationWhitelistEntryByIdHeaders` + - Headers of getCollaborationWhitelistEntryById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `CollaborationAllowlistEntry`. + +Returns an entry on the list of allowed domains. + +## Remove domain from list of allowed collaboration domains + +Removes a domain from the list of domains that have been deemed safe to create +collaborations for within the current enterprise. + +This operation is performed by calling function `deleteCollaborationWhitelistEntryById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-collaboration-whitelist-entries-id/). + + + +```ts +await client.collaborationAllowlistEntries.deleteCollaborationWhitelistEntryById( + entry.id! +); +``` + +### Arguments + +- collaborationWhitelistEntryId `string` + - The ID of the entry in the list. Example: "213123" +- headers `DeleteCollaborationWhitelistEntryByIdHeaders` + - Headers of deleteCollaborationWhitelistEntryById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +A blank response is returned if the entry was +successfully deleted. diff --git a/docs/collaborationAllowlistExemptTargets.md b/docs/collaborationAllowlistExemptTargets.md new file mode 100644 index 00000000..e7967855 --- /dev/null +++ b/docs/collaborationAllowlistExemptTargets.md @@ -0,0 +1,141 @@ +# CollaborationAllowlistExemptTargetsManager + +- [List users exempt from collaboration domain restrictions](#list-users-exempt-from-collaboration-domain-restrictions) +- [Create user exemption from collaboration domain restrictions](#create-user-exemption-from-collaboration-domain-restrictions) +- [Get user exempt from collaboration domain restrictions](#get-user-exempt-from-collaboration-domain-restrictions) +- [Remove user from list of users exempt from domain restrictions](#remove-user-from-list-of-users-exempt-from-domain-restrictions) + +## List users exempt from collaboration domain restrictions + +Returns a list of users who have been exempt from the collaboration +domain restrictions. + +This operation is performed by calling function `getCollaborationWhitelistExemptTargets`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-collaboration-whitelist-exempt-targets/). + + + +```ts +await client.collaborationAllowlistExemptTargets.getCollaborationWhitelistExemptTargets(); +``` + +### Arguments + +- queryParams `GetCollaborationWhitelistExemptTargetsQueryParams` + - Query parameters of getCollaborationWhitelistExemptTargets method +- headers `GetCollaborationWhitelistExemptTargetsHeaders` + - Headers of getCollaborationWhitelistExemptTargets method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `CollaborationAllowlistExemptTargets`. + +Returns a collection of user exemptions. + +## Create user exemption from collaboration domain restrictions + +Exempts a user from the restrictions set out by the allowed list of domains +for collaborations. + +This operation is performed by calling function `createCollaborationWhitelistExemptTarget`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-collaboration-whitelist-exempt-targets/). + + + +```ts +await client.collaborationAllowlistExemptTargets.createCollaborationWhitelistExemptTarget( + { + user: { + id: user.id, + } satisfies CreateCollaborationWhitelistExemptTargetRequestBodyUserField, + } satisfies CreateCollaborationWhitelistExemptTargetRequestBody +); +``` + +### Arguments + +- requestBody `CreateCollaborationWhitelistExemptTargetRequestBody` + - Request body of createCollaborationWhitelistExemptTarget method +- headers `CreateCollaborationWhitelistExemptTargetHeaders` + - Headers of createCollaborationWhitelistExemptTarget method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `CollaborationAllowlistExemptTarget`. + +Returns a new exemption entry. + +## Get user exempt from collaboration domain restrictions + +Returns a users who has been exempt from the collaboration +domain restrictions. + +This operation is performed by calling function `getCollaborationWhitelistExemptTargetById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-collaboration-whitelist-exempt-targets-id/). + + + +```ts +await client.collaborationAllowlistExemptTargets.getCollaborationWhitelistExemptTargetById( + exemptTarget.id! +); +``` + +### Arguments + +- collaborationWhitelistExemptTargetId `string` + - The ID of the exemption to the list. Example: "984923" +- headers `GetCollaborationWhitelistExemptTargetByIdHeaders` + - Headers of getCollaborationWhitelistExemptTargetById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `CollaborationAllowlistExemptTarget`. + +Returns the user's exempted from the list of collaboration domains. + +## Remove user from list of users exempt from domain restrictions + +Removes a user's exemption from the restrictions set out by the allowed list +of domains for collaborations. + +This operation is performed by calling function `deleteCollaborationWhitelistExemptTargetById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-collaboration-whitelist-exempt-targets-id/). + + + +```ts +await client.collaborationAllowlistExemptTargets.deleteCollaborationWhitelistExemptTargetById( + exemptTarget.id! +); +``` + +### Arguments + +- collaborationWhitelistExemptTargetId `string` + - The ID of the exemption to the list. Example: "984923" +- headers `DeleteCollaborationWhitelistExemptTargetByIdHeaders` + - Headers of deleteCollaborationWhitelistExemptTargetById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +A blank response is returned if the exemption was +successfully deleted. diff --git a/docs/collections.md b/docs/collections.md new file mode 100644 index 00000000..500ee597 --- /dev/null +++ b/docs/collections.md @@ -0,0 +1,70 @@ +# CollectionsManager + +- [List all collections](#list-all-collections) +- [List collection items](#list-collection-items) + +## List all collections + +Retrieves all collections for a given user. + +Currently, only the `favorites` collection +is supported. + +This operation is performed by calling function `getCollections`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-collections/). + + + +```ts +await client.collections.getCollections(); +``` + +### Arguments + +- queryParams `GetCollectionsQueryParams` + - Query parameters of getCollections method +- headers `GetCollectionsHeaders` + - Headers of getCollections method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Collections`. + +Returns all collections for the given user + +## List collection items + +Retrieves the files and/or folders contained within +this collection. + +This operation is performed by calling function `getCollectionItems`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-collections-id-items/). + + + +```ts +await client.collections.getCollectionItems(favouriteCollection.id!); +``` + +### Arguments + +- collectionId `string` + - The ID of the collection. Example: "926489" +- queryParams `GetCollectionItemsQueryParams` + - Query parameters of getCollectionItems method +- headers `GetCollectionItemsHeaders` + - Headers of getCollectionItems method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Items`. + +Returns an array of items in the collection. diff --git a/docs/comments.md b/docs/comments.md new file mode 100644 index 00000000..e6f9d791 --- /dev/null +++ b/docs/comments.md @@ -0,0 +1,182 @@ +# CommentsManager + +- [List file comments](#list-file-comments) +- [Get comment](#get-comment) +- [Update comment](#update-comment) +- [Remove comment](#remove-comment) +- [Create comment](#create-comment) + +## List file comments + +Retrieves a list of comments for a file. + +This operation is performed by calling function `getFileComments`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-files-id-comments/). + + + +```ts +await client.comments.getFileComments(fileId); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- queryParams `GetFileCommentsQueryParams` + - Query parameters of getFileComments method +- headers `GetFileCommentsHeaders` + - Headers of getFileComments method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Comments`. + +Returns a collection of comment objects. If there are no +comments on this file an empty collection will be returned. + +## Get comment + +Retrieves the message and metadata for a specific comment, as well +as information on the user who created the comment. + +This operation is performed by calling function `getCommentById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-comments-id/). + + + +```ts +await client.comments.getCommentById(newComment.id!); +``` + +### Arguments + +- commentId `string` + - The ID of the comment. Example: "12345" +- queryParams `GetCommentByIdQueryParams` + - Query parameters of getCommentById method +- headers `GetCommentByIdHeaders` + - Headers of getCommentById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `CommentFull`. + +Returns a full comment object. + +## Update comment + +Update the message of a comment. + +This operation is performed by calling function `updateCommentById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-comments-id/). + + + +```ts +await client.comments.updateCommentById(newReplyComment.id!, { + message: newMessage, +} satisfies UpdateCommentByIdRequestBody); +``` + +### Arguments + +- commentId `string` + - The ID of the comment. Example: "12345" +- requestBody `UpdateCommentByIdRequestBody` + - Request body of updateCommentById method +- queryParams `UpdateCommentByIdQueryParams` + - Query parameters of updateCommentById method +- headers `UpdateCommentByIdHeaders` + - Headers of updateCommentById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `CommentFull`. + +Returns the updated comment object. + +## Remove comment + +Permanently deletes a comment. + +This operation is performed by calling function `deleteCommentById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-comments-id/). + + + +```ts +await client.comments.deleteCommentById(newComment.id!); +``` + +### Arguments + +- commentId `string` + - The ID of the comment. Example: "12345" +- headers `DeleteCommentByIdHeaders` + - Headers of deleteCommentById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the comment has been deleted. + +## Create comment + +Adds a comment by the user to a specific file, or +as a reply to an other comment. + +This operation is performed by calling function `createComment`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-comments/). + + + +```ts +await client.comments.createComment({ + message: message, + item: { + id: newComment.id!, + type: 'comment' as CreateCommentRequestBodyItemTypeField, + } satisfies CreateCommentRequestBodyItemField, +} satisfies CreateCommentRequestBody); +``` + +### Arguments + +- requestBody `CreateCommentRequestBody` + - Request body of createComment method +- queryParams `CreateCommentQueryParams` + - Query parameters of createComment method +- headers `CreateCommentHeaders` + - Headers of createComment method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `CommentFull`. + +Returns the newly created comment object. + +Not all available fields are returned by default. Use the +[fields](#param-fields) query parameter to explicitly request +any specific fields. diff --git a/docs/devicePinners.md b/docs/devicePinners.md new file mode 100644 index 00000000..3705a80d --- /dev/null +++ b/docs/devicePinners.md @@ -0,0 +1,88 @@ +# DevicePinnersManager + +- [Get device pin](#get-device-pin) +- [Remove device pin](#remove-device-pin) +- [List enterprise device pins](#list-enterprise-device-pins) + +## Get device pin + +Retrieves information about an individual device pin. + +This operation is performed by calling function `getDevicePinnerById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-device-pinners-id/). + +_Currently we don't have an example for calling `getDevicePinnerById` in integration tests_ + +### Arguments + +- devicePinnerId `string` + - The ID of the device pin Example: "2324234" +- headers `GetDevicePinnerByIdHeaders` + - Headers of getDevicePinnerById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `DevicePinner`. + +Returns information about a single device pin. + +## Remove device pin + +Deletes an individual device pin. + +This operation is performed by calling function `deleteDevicePinnerById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-device-pinners-id/). + +_Currently we don't have an example for calling `deleteDevicePinnerById` in integration tests_ + +### Arguments + +- devicePinnerId `string` + - The ID of the device pin Example: "2324234" +- headers `DeleteDevicePinnerByIdHeaders` + - Headers of deleteDevicePinnerById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the pin has been deleted. + +## List enterprise device pins + +Retrieves all the device pins within an enterprise. + +The user must have admin privileges, and the application +needs the "manage enterprise" scope to make this call. + +This operation is performed by calling function `getEnterpriseDevicePinners`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-enterprises-id-device-pinners/). + +_Currently we don't have an example for calling `getEnterpriseDevicePinners` in integration tests_ + +### Arguments + +- enterpriseId `string` + - The ID of the enterprise Example: "3442311" +- queryParams `GetEnterpriseDevicePinnersQueryParams` + - Query parameters of getEnterpriseDevicePinners method +- headers `GetEnterpriseDevicePinnersHeaders` + - Headers of getEnterpriseDevicePinners method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `DevicePinners`. + +Returns a list of device pins for a given enterprise. diff --git a/docs/emailAliases.md b/docs/emailAliases.md new file mode 100644 index 00000000..5c0893bd --- /dev/null +++ b/docs/emailAliases.md @@ -0,0 +1,102 @@ +# EmailAliasesManager + +- [List user's email aliases](#list-users-email-aliases) +- [Create email alias](#create-email-alias) +- [Remove email alias](#remove-email-alias) + +## List user's email aliases + +Retrieves all email aliases for a user. The collection +does not include the primary login for the user. + +This operation is performed by calling function `getUserEmailAliases`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-users-id-email-aliases/). + + + +```ts +await client.emailAliases.getUserEmailAliases(newUser.id); +``` + +### Arguments + +- userId `string` + - The ID of the user. Example: "12345" +- headers `GetUserEmailAliasesHeaders` + - Headers of getUserEmailAliases method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `EmailAliases`. + +Returns a collection of email aliases. + +## Create email alias + +Adds a new email alias to a user account.. + +This operation is performed by calling function `createUserEmailAlias`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-users-id-email-aliases/). + + + +```ts +await client.emailAliases.createUserEmailAlias(newUser.id, { + email: newAliasEmail, +} satisfies CreateUserEmailAliasRequestBody); +``` + +### Arguments + +- userId `string` + - The ID of the user. Example: "12345" +- requestBody `CreateUserEmailAliasRequestBody` + - Request body of createUserEmailAlias method +- headers `CreateUserEmailAliasHeaders` + - Headers of createUserEmailAlias method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `EmailAlias`. + +Returns the newly created email alias object. + +## Remove email alias + +Removes an email alias from a user. + +This operation is performed by calling function `deleteUserEmailAliasById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-users-id-email-aliases-id/). + + + +```ts +await client.emailAliases.deleteUserEmailAliasById(newUser.id, newAlias.id!); +``` + +### Arguments + +- userId `string` + - The ID of the user. Example: "12345" +- emailAliasId `string` + - The ID of the email alias. Example: "23432" +- headers `DeleteUserEmailAliasByIdHeaders` + - Headers of deleteUserEmailAliasById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Removes the alias and returns an empty response. diff --git a/docs/events.md b/docs/events.md new file mode 100644 index 00000000..7fd9eef6 --- /dev/null +++ b/docs/events.md @@ -0,0 +1,101 @@ +# EventsManager + +- [List user and enterprise events](#list-user-and-enterprise-events) +- [Get events long poll endpoint](#get-events-long-poll-endpoint) + +## List user and enterprise events + +Returns up to a year of past events for a given user +or for the entire enterprise. + +By default this returns events for the authenticated user. To retrieve events +for the entire enterprise, set the `stream_type` to `admin_logs_streaming` +for live monitoring of new events, or `admin_logs` for querying across +historical events. The user making the API call will +need to have admin privileges, and the application will need to have the +scope `manage enterprise properties` checked. + +This operation is performed by calling function `getEvents`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-events/). + +_Currently we don't have an example for calling `getEvents` in integration tests_ + +### Arguments + +- queryParams `GetEventsQueryParams` + - Query parameters of getEvents method +- headers `GetEventsHeaders` + - Headers of getEvents method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Events`. + +Returns a list of event objects. + +Events objects are returned in pages, with each page (chunk) +including a list of event objects. The response includes a +`chunk_size` parameter indicating how many events were returned in this +chunk, as well as the next `stream_position` that can be +queried. + +## Get events long poll endpoint + +Returns a list of real-time servers that can be used for long-polling updates +to the [event stream](#get-events). + +Long polling is the concept where a HTTP request is kept open until the +server sends a response, then repeating the process over and over to receive +updated responses. + +Long polling the event stream can only be used for user events, not for +enterprise events. + +To use long polling, first use this endpoint to retrieve a list of long poll +URLs. Next, make a long poll request to any of the provided URLs. + +When an event occurs in monitored account a response with the value +`new_change` will be sent. The response contains no other details as +it only serves as a prompt to take further action such as sending a +request to the [events endpoint](#get-events) with the last known +`stream_position`. + +After the server sends this response it closes the connection. You must now +repeat the long poll process to begin listening for events again. + +If no events occur for a while and the connection times out you will +receive a response with the value `reconnect`. When you receive this response +you’ll make another call to this endpoint to restart the process. + +If you receive no events in `retry_timeout` seconds then you will need to +make another request to the real-time server (one of the URLs in the response +for this endpoint). This might be necessary due to network errors. + +Finally, if you receive a `max_retries` error when making a request to the +real-time server, you should start over by making a call to this endpoint +first. + +This operation is performed by calling function `getEventsWithLongPolling`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/options-events/). + +_Currently we don't have an example for calling `getEventsWithLongPolling` in integration tests_ + +### Arguments + +- headers `GetEventsWithLongPollingHeaders` + - Headers of getEventsWithLongPolling method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `RealtimeServers`. + +Returns a paginated array of servers that can be used +instead of the regular endpoints for long-polling events. diff --git a/docs/fileClassifications.md b/docs/fileClassifications.md new file mode 100644 index 00000000..c91f6c22 --- /dev/null +++ b/docs/fileClassifications.md @@ -0,0 +1,161 @@ +# FileClassificationsManager + +- [Get classification on file](#get-classification-on-file) +- [Add classification to file](#add-classification-to-file) +- [Update classification on file](#update-classification-on-file) +- [Remove classification from file](#remove-classification-from-file) + +## Get classification on file + +Retrieves the classification metadata instance that +has been applied to a file. + +This API can also be called by including the enterprise ID in the +URL explicitly, for example +`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`. + +This operation is performed by calling function `getClassificationOnFile`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-files-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/). + + + +```ts +await client.fileClassifications.getClassificationOnFile(file.id); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- headers `GetClassificationOnFileHeaders` + - Headers of getClassificationOnFile method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Classification`. + +Returns an instance of the `securityClassification` metadata +template, which contains a `Box__Security__Classification__Key` +field that lists all the classifications available to this +enterprise. + +## Add classification to file + +Adds a classification to a file by specifying the label of the +classification to add. + +This API can also be called by including the enterprise ID in the +URL explicitly, for example +`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`. + +This operation is performed by calling function `addClassificationToFile`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-files-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/). + + + +```ts +await client.fileClassifications.addClassificationToFile(file.id, { + boxSecurityClassificationKey: classification.key, +} satisfies AddClassificationToFileRequestBody); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- requestBody `AddClassificationToFileRequestBody` + - Request body of addClassificationToFile method +- headers `AddClassificationToFileHeaders` + - Headers of addClassificationToFile method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Classification`. + +Returns the classification template instance +that was applied to the file. + +## Update classification on file + +Updates a classification on a file. + +The classification can only be updated if a classification has already been +applied to the file before. When editing classifications, only values are +defined for the enterprise will be accepted. + +This operation is performed by calling function `updateClassificationOnFile`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-files-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/). + + + +```ts +await client.fileClassifications.updateClassificationOnFile(file.id, [ + { + op: 'replace' as UpdateClassificationOnFileRequestBodyOpField, + path: '/Box__Security__Classification__Key' as UpdateClassificationOnFileRequestBodyPathField, + value: secondClassification.key, + } satisfies UpdateClassificationOnFileRequestBody, +]); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- requestBody `readonly UpdateClassificationOnFileRequestBody[]` + - Request body of updateClassificationOnFile method +- headers `UpdateClassificationOnFileHeaders` + - Headers of updateClassificationOnFile method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Classification`. + +Returns the updated classification metadata template instance. + +## Remove classification from file + +Removes any classifications from a file. + +This API can also be called by including the enterprise ID in the +URL explicitly, for example +`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`. + +This operation is performed by calling function `deleteClassificationFromFile`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-files-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/). + + + +```ts +await client.fileClassifications.deleteClassificationFromFile(file.id); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- headers `DeleteClassificationFromFileHeaders` + - Headers of deleteClassificationFromFile method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the classification is +successfully deleted. diff --git a/docs/fileMetadata.md b/docs/fileMetadata.md new file mode 100644 index 00000000..244b2852 --- /dev/null +++ b/docs/fileMetadata.md @@ -0,0 +1,221 @@ +# FileMetadataManager + +- [List metadata instances on file](#list-metadata-instances-on-file) +- [Get metadata instance on file](#get-metadata-instance-on-file) +- [Create metadata instance on file](#create-metadata-instance-on-file) +- [Update metadata instance on file](#update-metadata-instance-on-file) +- [Remove metadata instance from file](#remove-metadata-instance-from-file) + +## List metadata instances on file + +Retrieves all metadata for a given file. + +This operation is performed by calling function `getFileMetadata`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-files-id-metadata/). + + + +```ts +await client.fileMetadata.getFileMetadata(file.id); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- headers `GetFileMetadataHeaders` + - Headers of getFileMetadata method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Metadatas`. + +Returns all the metadata associated with a file. + +This API does not support pagination and will therefore always return +all of the metadata associated to the file. + +## Get metadata instance on file + +Retrieves the instance of a metadata template that has been applied to a +file. + +This operation is performed by calling function `getFileMetadataById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-files-id-metadata-id-id/). + + + +```ts +await client.fileMetadata.getFileMetadataById( + file.id, + 'global' as GetFileMetadataByIdScope, + 'properties' +); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- scope `GetFileMetadataByIdScope` + - The scope of the metadata template Example: "global" +- templateKey `string` + - The name of the metadata template Example: "properties" +- headers `GetFileMetadataByIdHeaders` + - Headers of getFileMetadataById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `MetadataFull`. + +An instance of the metadata template that includes +additional "key:value" pairs defined by the user or +an application. + +## Create metadata instance on file + +Applies an instance of a metadata template to a file. + +In most cases only values that are present in the metadata template +will be accepted, except for the `global.properties` template which accepts +any key-value pair. + +This operation is performed by calling function `createFileMetadataById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-files-id-metadata-id-id/). + + + +```ts +await client.fileMetadata.createFileMetadataById( + file.id, + 'enterprise' as CreateFileMetadataByIdScope, + templateKey, + { ['testName']: 1 } +); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- scope `CreateFileMetadataByIdScope` + - The scope of the metadata template Example: "global" +- templateKey `string` + - The name of the metadata template Example: "properties" +- requestBody `CreateFileMetadataByIdRequestBody` + - Request body of createFileMetadataById method +- headers `CreateFileMetadataByIdHeaders` + - Headers of createFileMetadataById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `MetadataFull`. + +Returns the instance of the template that was applied to the file, +including the data that was applied to the template. + +## Update metadata instance on file + +Updates a piece of metadata on a file. + +The metadata instance can only be updated if the template has already been +applied to the file before. When editing metadata, only values that match +the metadata template schema will be accepted. + +The update is applied atomically. If any errors occur during the +application of the operations, the metadata instance will not be changed. + +This operation is performed by calling function `updateFileMetadataById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-files-id-metadata-id-id/). + + + +```ts +await client.fileMetadata.updateFileMetadataById( + file.id, + 'global' as UpdateFileMetadataByIdScope, + 'properties', + [ + { + op: 'replace' as UpdateFileMetadataByIdRequestBodyOpField, + path: '/abc', + value: newValue, + } satisfies UpdateFileMetadataByIdRequestBody, + ] +); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- scope `UpdateFileMetadataByIdScope` + - The scope of the metadata template Example: "global" +- templateKey `string` + - The name of the metadata template Example: "properties" +- requestBody `readonly UpdateFileMetadataByIdRequestBody[]` + - Request body of updateFileMetadataById method +- headers `UpdateFileMetadataByIdHeaders` + - Headers of updateFileMetadataById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `MetadataFull`. + +Returns the updated metadata template instance, with the +custom template data included. + +## Remove metadata instance from file + +Deletes a piece of file metadata. + +This operation is performed by calling function `deleteFileMetadataById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-files-id-metadata-id-id/). + + + +```ts +await client.fileMetadata.deleteFileMetadataById( + file.id, + 'enterprise' as DeleteFileMetadataByIdScope, + templateKey +); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- scope `DeleteFileMetadataByIdScope` + - The scope of the metadata template Example: "global" +- templateKey `string` + - The name of the metadata template Example: "properties" +- headers `DeleteFileMetadataByIdHeaders` + - Headers of deleteFileMetadataById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the metadata is +successfully deleted. diff --git a/docs/fileRequests.md b/docs/fileRequests.md new file mode 100644 index 00000000..6231c247 --- /dev/null +++ b/docs/fileRequests.md @@ -0,0 +1,141 @@ +# FileRequestsManager + +- [Get file request](#get-file-request) +- [Update file request](#update-file-request) +- [Delete file request](#delete-file-request) +- [Copy file request](#copy-file-request) + +## Get file request + +Retrieves the information about a file request. + +This operation is performed by calling function `getFileRequestById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-file-requests-id/). + + + +```ts +await client.fileRequests.getFileRequestById(updatedFileRequest.id); +``` + +### Arguments + +- fileRequestId `string` + - The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`. Example: "123" +- headers `GetFileRequestByIdHeaders` + - Headers of getFileRequestById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FileRequest`. + +Returns a file request object. + +## Update file request + +Updates a file request. This can be used to activate or +deactivate a file request. + +This operation is performed by calling function `updateFileRequestById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-file-requests-id/). + + + +```ts +await client.fileRequests.updateFileRequestById(copiedFileRequest.id, { + title: 'updated title', + description: 'updated description', +} satisfies FileRequestUpdateRequest); +``` + +### Arguments + +- fileRequestId `string` + - The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`. Example: "123" +- requestBody `FileRequestUpdateRequest` + - Request body of updateFileRequestById method +- headers `UpdateFileRequestByIdHeaders` + - Headers of updateFileRequestById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FileRequest`. + +Returns the updated file request object. + +## Delete file request + +Deletes a file request permanently. + +This operation is performed by calling function `deleteFileRequestById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-file-requests-id/). + + + +```ts +await client.fileRequests.deleteFileRequestById(updatedFileRequest.id); +``` + +### Arguments + +- fileRequestId `string` + - The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`. Example: "123" +- headers `DeleteFileRequestByIdHeaders` + - Headers of deleteFileRequestById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the file request has been successfully +deleted. + +## Copy file request + +Copies an existing file request that is already present on one folder, +and applies it to another folder. + +This operation is performed by calling function `createFileRequestCopy`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-file-requests-id-copy/). + + + +```ts +await client.fileRequests.createFileRequestCopy(fileRequestId, { + folder: { + id: fileRequest.folder.id, + type: 'folder' as FileRequestCopyRequestFolderTypeField, + } satisfies FileRequestCopyRequestFolderField, +} satisfies FileRequestCopyRequest); +``` + +### Arguments + +- fileRequestId `string` + - The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`. Example: "123" +- requestBody `FileRequestCopyRequest` + - Request body of createFileRequestCopy method +- headers `CreateFileRequestCopyHeaders` + - Headers of createFileRequestCopy method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FileRequest`. + +Returns updated file request object. diff --git a/docs/fileVersionLegalHolds.md b/docs/fileVersionLegalHolds.md new file mode 100644 index 00000000..c546bf62 --- /dev/null +++ b/docs/fileVersionLegalHolds.md @@ -0,0 +1,77 @@ +# FileVersionLegalHoldsManager + +- [Get file version legal hold](#get-file-version-legal-hold) +- [List file version legal holds](#list-file-version-legal-holds) + +## Get file version legal hold + +Retrieves information about the legal hold policies +assigned to a file version. + +This operation is performed by calling function `getFileVersionLegalHoldById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-file-version-legal-holds-id/). + +_Currently we don't have an example for calling `getFileVersionLegalHoldById` in integration tests_ + +### Arguments + +- fileVersionLegalHoldId `string` + - The ID of the file version legal hold Example: "2348213" +- headers `GetFileVersionLegalHoldByIdHeaders` + - Headers of getFileVersionLegalHoldById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FileVersionLegalHold`. + +Returns the legal hold policy assignments for the file version. + +## List file version legal holds + +Get a list of file versions on legal hold for a legal hold +assignment. + +Due to ongoing re-architecture efforts this API might not return all file +versions for this policy ID. + +Instead, this API will only return file versions held in the legacy +architecture. Two new endpoints will available to request any file versions +held in the new architecture. + +For file versions held in the new architecture, the `GET +/legal_hold_policy_assignments/:id/file_versions_on_hold` API can be used to +return all past file versions available for this policy assignment, and the +`GET /legal_hold_policy_assignments/:id/files_on_hold` API can be used to +return any current (latest) versions of a file under legal hold. + +The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to +find a list of policy assignments for a given policy ID. + +Once the re-architecture is completed this API will be deprecated. + +This operation is performed by calling function `getFileVersionLegalHolds`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-file-version-legal-holds/). + +_Currently we don't have an example for calling `getFileVersionLegalHolds` in integration tests_ + +### Arguments + +- queryParams `GetFileVersionLegalHoldsQueryParams` + - Query parameters of getFileVersionLegalHolds method +- headers `GetFileVersionLegalHoldsHeaders` + - Headers of getFileVersionLegalHolds method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FileVersionLegalHolds`. + +Returns the list of file version legal holds for a specific legal +hold policy. diff --git a/docs/fileVersionRetentions.md b/docs/fileVersionRetentions.md new file mode 100644 index 00000000..09c6c00b --- /dev/null +++ b/docs/fileVersionRetentions.md @@ -0,0 +1,56 @@ +# FileVersionRetentionsManager + +- [List file version retentions](#list-file-version-retentions) +- [Get retention on file](#get-retention-on-file) + +## List file version retentions + +Retrieves all file version retentions for the given enterprise. + +This operation is performed by calling function `getFileVersionRetentions`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-file-version-retentions/). + +_Currently we don't have an example for calling `getFileVersionRetentions` in integration tests_ + +### Arguments + +- queryParams `GetFileVersionRetentionsQueryParams` + - Query parameters of getFileVersionRetentions method +- headers `GetFileVersionRetentionsHeaders` + - Headers of getFileVersionRetentions method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FileVersionRetentions`. + +Returns a list of all file version retentions for the enterprise. + +## Get retention on file + +Returns information about a file version retention. + +This operation is performed by calling function `getFileVersionRetentionById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-file-version-retentions-id/). + +_Currently we don't have an example for calling `getFileVersionRetentionById` in integration tests_ + +### Arguments + +- fileVersionRetentionId `string` + - The ID of the file version retention Example: "3424234" +- headers `GetFileVersionRetentionByIdHeaders` + - Headers of getFileVersionRetentionById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FileVersionRetention`. + +Returns a file version retention object. diff --git a/docs/fileVersions.md b/docs/fileVersions.md new file mode 100644 index 00000000..1beb7efa --- /dev/null +++ b/docs/fileVersions.md @@ -0,0 +1,208 @@ +# FileVersionsManager + +- [List all file versions](#list-all-file-versions) +- [Get file version](#get-file-version) +- [Restore file version](#restore-file-version) +- [Remove file version](#remove-file-version) +- [Promote file version](#promote-file-version) + +## List all file versions + +Retrieve a list of the past versions for a file. + +Versions are only tracked by Box users with premium accounts. To fetch the ID +of the current version of a file, use the `GET /file/:id` API. + +This operation is performed by calling function `getFileVersions`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-files-id-versions/). + + + +```ts +await client.fileVersions.getFileVersions(file.id); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- queryParams `GetFileVersionsQueryParams` + - Query parameters of getFileVersions method +- headers `GetFileVersionsHeaders` + - Headers of getFileVersions method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FileVersions`. + +Returns an array of past versions for this file. + +## Get file version + +Retrieve a specific version of a file. + +Versions are only tracked for Box users with premium accounts. + +This operation is performed by calling function `getFileVersionById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-files-id-versions-id/). + + + +```ts +await client.fileVersions.getFileVersionById( + file.id, + fileVersions.entries![0].id +); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- fileVersionId `string` + - The ID of the file version Example: "1234" +- queryParams `GetFileVersionByIdQueryParams` + - Query parameters of getFileVersionById method +- headers `GetFileVersionByIdHeaders` + - Headers of getFileVersionById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FileVersionFull`. + +Returns a specific version of a file. + +Not all available fields are returned by default. Use the +[fields](#param-fields) query parameter to explicitly request +any specific fields. + +## Restore file version + +Restores a specific version of a file after it was deleted. +Don't use this endpoint to restore Box Notes, +as it works with file formats such as PDF, DOC, +PPTX or similar. + +This operation is performed by calling function `updateFileVersionById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-files-id-versions-id/). + +_Currently we don't have an example for calling `updateFileVersionById` in integration tests_ + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- fileVersionId `string` + - The ID of the file version Example: "1234" +- requestBody `UpdateFileVersionByIdRequestBody` + - Request body of updateFileVersionById method +- headers `UpdateFileVersionByIdHeaders` + - Headers of updateFileVersionById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FileVersionFull`. + +Returns a restored file version object. + +## Remove file version + +Move a file version to the trash. + +Versions are only tracked for Box users with premium accounts. + +This operation is performed by calling function `deleteFileVersionById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-files-id-versions-id/). + + + +```ts +await client.fileVersions.deleteFileVersionById( + file.id, + fileVersionsRestored.entries![0].id +); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- fileVersionId `string` + - The ID of the file version Example: "1234" +- headers `DeleteFileVersionByIdHeaders` + - Headers of deleteFileVersionById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the file has been successfully +deleted. + +## Promote file version + +Promote a specific version of a file. + +If previous versions exist, this method can be used to +promote one of the older versions to the top of the version history. + +This creates a new copy of the old version and puts it at the +top of the versions history. The file will have the exact same contents +as the older version, with the the same hash digest, `etag`, and +name as the original. + +Other properties such as comments do not get updated to their +former values. + +Don't use this endpoint to restore Box Notes, +as it works with file formats such as PDF, DOC, +PPTX or similar. + +This operation is performed by calling function `promoteFileVersion`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-files-id-versions-current/). + + + +```ts +await client.fileVersions.promoteFileVersion(file.id, { + id: fileVersions.entries![0].id, + type: 'file_version' as PromoteFileVersionRequestBodyTypeField, +} satisfies PromoteFileVersionRequestBody); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- requestBody `PromoteFileVersionRequestBody` + - Request body of promoteFileVersion method +- queryParams `PromoteFileVersionQueryParams` + - Query parameters of promoteFileVersion method +- headers `PromoteFileVersionHeaders` + - Headers of promoteFileVersion method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FileVersionFull`. + +Returns a newly created file version object. diff --git a/docs/fileWatermarks.md b/docs/fileWatermarks.md new file mode 100644 index 00000000..da127287 --- /dev/null +++ b/docs/fileWatermarks.md @@ -0,0 +1,104 @@ +# FileWatermarksManager + +- [Get watermark on file](#get-watermark-on-file) +- [Apply watermark to file](#apply-watermark-to-file) +- [Remove watermark from file](#remove-watermark-from-file) + +## Get watermark on file + +Retrieve the watermark for a file. + +This operation is performed by calling function `getFileWatermark`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-files-id-watermark/). + + + +```ts +await client.fileWatermarks.getFileWatermark(file.id); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- headers `GetFileWatermarkHeaders` + - Headers of getFileWatermark method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Watermark`. + +Returns an object containing information about the +watermark associated for to this file. + +## Apply watermark to file + +Applies or update a watermark on a file. + +This operation is performed by calling function `updateFileWatermark`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-files-id-watermark/). + + + +```ts +await client.fileWatermarks.updateFileWatermark(file.id, { + watermark: { + imprint: 'default' as UpdateFileWatermarkRequestBodyWatermarkImprintField, + } satisfies UpdateFileWatermarkRequestBodyWatermarkField, +} satisfies UpdateFileWatermarkRequestBody); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- requestBody `UpdateFileWatermarkRequestBody` + - Request body of updateFileWatermark method +- headers `UpdateFileWatermarkHeaders` + - Headers of updateFileWatermark method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Watermark`. + +Returns an updated watermark if a watermark already +existed on this file.Returns a new watermark if no watermark existed on +this file yet. + +## Remove watermark from file + +Removes the watermark from a file. + +This operation is performed by calling function `deleteFileWatermark`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-files-id-watermark/). + + + +```ts +await client.fileWatermarks.deleteFileWatermark(file.id); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- headers `DeleteFileWatermarkHeaders` + - Headers of deleteFileWatermark method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Removes the watermark and returns an empty response. diff --git a/docs/folderClassifications.md b/docs/folderClassifications.md new file mode 100644 index 00000000..43f88c10 --- /dev/null +++ b/docs/folderClassifications.md @@ -0,0 +1,161 @@ +# FolderClassificationsManager + +- [Get classification on folder](#get-classification-on-folder) +- [Add classification to folder](#add-classification-to-folder) +- [Update classification on folder](#update-classification-on-folder) +- [Remove classification from folder](#remove-classification-from-folder) + +## Get classification on folder + +Retrieves the classification metadata instance that +has been applied to a folder. + +This API can also be called by including the enterprise ID in the +URL explicitly, for example +`/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo`. + +This operation is performed by calling function `getClassificationOnFolder`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-folders-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/). + + + +```ts +await client.folderClassifications.getClassificationOnFolder(folder.id); +``` + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" +- headers `GetClassificationOnFolderHeaders` + - Headers of getClassificationOnFolder method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Classification`. + +Returns an instance of the `securityClassification` metadata +template, which contains a `Box__Security__Classification__Key` +field that lists all the classifications available to this +enterprise. + +## Add classification to folder + +Adds a classification to a folder by specifying the label of the +classification to add. + +This API can also be called by including the enterprise ID in the +URL explicitly, for example +`/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo`. + +This operation is performed by calling function `addClassificationToFolder`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-folders-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/). + + + +```ts +await client.folderClassifications.addClassificationToFolder(folder.id, { + boxSecurityClassificationKey: classification.key, +} satisfies AddClassificationToFolderRequestBody); +``` + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" +- requestBody `AddClassificationToFolderRequestBody` + - Request body of addClassificationToFolder method +- headers `AddClassificationToFolderHeaders` + - Headers of addClassificationToFolder method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Classification`. + +Returns the classification template instance +that was applied to the folder. + +## Update classification on folder + +Updates a classification on a folder. + +The classification can only be updated if a classification has already been +applied to the folder before. When editing classifications, only values are +defined for the enterprise will be accepted. + +This operation is performed by calling function `updateClassificationOnFolder`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-folders-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/). + + + +```ts +await client.folderClassifications.updateClassificationOnFolder(folder.id, [ + { + op: 'replace' as UpdateClassificationOnFolderRequestBodyOpField, + path: '/Box__Security__Classification__Key' as UpdateClassificationOnFolderRequestBodyPathField, + value: secondClassification.key, + } satisfies UpdateClassificationOnFolderRequestBody, +]); +``` + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" +- requestBody `readonly UpdateClassificationOnFolderRequestBody[]` + - Request body of updateClassificationOnFolder method +- headers `UpdateClassificationOnFolderHeaders` + - Headers of updateClassificationOnFolder method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Classification`. + +Returns the updated classification metadata template instance. + +## Remove classification from folder + +Removes any classifications from a folder. + +This API can also be called by including the enterprise ID in the +URL explicitly, for example +`/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo`. + +This operation is performed by calling function `deleteClassificationFromFolder`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-folders-id-metadata-enterprise-security-classification-6-vm-vochw-u-wo/). + + + +```ts +await client.folderClassifications.deleteClassificationFromFolder(folder.id); +``` + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" +- headers `DeleteClassificationFromFolderHeaders` + - Headers of deleteClassificationFromFolder method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the classification is +successfully deleted. diff --git a/docs/folderLocks.md b/docs/folderLocks.md new file mode 100644 index 00000000..fc35f02d --- /dev/null +++ b/docs/folderLocks.md @@ -0,0 +1,118 @@ +# FolderLocksManager + +- [List folder locks](#list-folder-locks) +- [Create folder lock](#create-folder-lock) +- [Delete folder lock](#delete-folder-lock) + +## List folder locks + +Retrieves folder lock details for a given folder. + +You must be authenticated as the owner or co-owner of the folder to +use this endpoint. + +This operation is performed by calling function `getFolderLocks`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-folder-locks/). + + + +```ts +await client.folderLocks.getFolderLocks({ + folderId: folder.id, +} satisfies GetFolderLocksQueryParams); +``` + +### Arguments + +- queryParams `GetFolderLocksQueryParams` + - Query parameters of getFolderLocks method +- headers `GetFolderLocksHeaders` + - Headers of getFolderLocks method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FolderLocks`. + +Returns details for all folder locks applied to the folder, including the +lock type and user that applied the lock. + +## Create folder lock + +Creates a folder lock on a folder, preventing it from being moved and/or +deleted. + +You must be authenticated as the owner or co-owner of the folder to +use this endpoint. + +This operation is performed by calling function `createFolderLock`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-folder-locks/). + + + +```ts +await client.folderLocks.createFolderLock({ + folder: { + id: folder.id, + type: 'folder', + } satisfies CreateFolderLockRequestBodyFolderField, + lockedOperations: { + move: true, + delete: true, + } satisfies CreateFolderLockRequestBodyLockedOperationsField, +} satisfies CreateFolderLockRequestBody); +``` + +### Arguments + +- requestBody `CreateFolderLockRequestBody` + - Request body of createFolderLock method +- headers `CreateFolderLockHeaders` + - Headers of createFolderLock method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FolderLock`. + +Returns the instance of the folder lock that was applied to the folder, +including the user that applied the lock and the operations set. + +## Delete folder lock + +Deletes a folder lock on a given folder. + +You must be authenticated as the owner or co-owner of the folder to +use this endpoint. + +This operation is performed by calling function `deleteFolderLockById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-folder-locks-id/). + + + +```ts +await client.folderLocks.deleteFolderLockById(folderLock.id!); +``` + +### Arguments + +- folderLockId `string` + - The ID of the folder lock. Example: "12345" +- headers `DeleteFolderLockByIdHeaders` + - Headers of deleteFolderLockById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the folder lock is successfully deleted. diff --git a/docs/folderMetadata.md b/docs/folderMetadata.md new file mode 100644 index 00000000..22854391 --- /dev/null +++ b/docs/folderMetadata.md @@ -0,0 +1,226 @@ +# FolderMetadataManager + +- [List metadata instances on folder](#list-metadata-instances-on-folder) +- [Get metadata instance on folder](#get-metadata-instance-on-folder) +- [Create metadata instance on folder](#create-metadata-instance-on-folder) +- [Update metadata instance on folder](#update-metadata-instance-on-folder) +- [Remove metadata instance from folder](#remove-metadata-instance-from-folder) + +## List metadata instances on folder + +Retrieves all metadata for a given folder. This can not be used on the root +folder with ID `0`. + +This operation is performed by calling function `getFolderMetadata`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-folders-id-metadata/). + + + +```ts +await client.folderMetadata.getFolderMetadata(folder.id); +``` + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" +- headers `GetFolderMetadataHeaders` + - Headers of getFolderMetadata method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Metadatas`. + +Returns all the metadata associated with a folder. + +This API does not support pagination and will therefore always return +all of the metadata associated to the folder. + +## Get metadata instance on folder + +Retrieves the instance of a metadata template that has been applied to a +folder. This can not be used on the root folder with ID `0`. + +This operation is performed by calling function `getFolderMetadataById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-folders-id-metadata-id-id/). + + + +```ts +await client.folderMetadata.getFolderMetadataById( + folder.id, + 'global' as GetFolderMetadataByIdScope, + 'properties' +); +``` + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" +- scope `GetFolderMetadataByIdScope` + - The scope of the metadata template Example: "global" +- templateKey `string` + - The name of the metadata template Example: "properties" +- headers `GetFolderMetadataByIdHeaders` + - Headers of getFolderMetadataById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `MetadataFull`. + +An instance of the metadata template that includes +additional "key:value" pairs defined by the user or +an application. + +## Create metadata instance on folder + +Applies an instance of a metadata template to a folder. + +In most cases only values that are present in the metadata template +will be accepted, except for the `global.properties` template which accepts +any key-value pair. + +To display the metadata template in the Box web app the enterprise needs to be +configured to enable **Cascading Folder Level Metadata** for the user in the +admin console. + +This operation is performed by calling function `createFolderMetadataById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-folders-id-metadata-id-id/). + + + +```ts +await client.folderMetadata.createFolderMetadataById( + folder.id, + 'enterprise' as CreateFolderMetadataByIdScope, + templateKey, + data +); +``` + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" +- scope `CreateFolderMetadataByIdScope` + - The scope of the metadata template Example: "global" +- templateKey `string` + - The name of the metadata template Example: "properties" +- requestBody `CreateFolderMetadataByIdRequestBody` + - Request body of createFolderMetadataById method +- headers `CreateFolderMetadataByIdHeaders` + - Headers of createFolderMetadataById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `MetadataFull`. + +Returns the instance of the template that was applied to the folder, +including the data that was applied to the template. + +## Update metadata instance on folder + +Updates a piece of metadata on a folder. + +The metadata instance can only be updated if the template has already been +applied to the folder before. When editing metadata, only values that match +the metadata template schema will be accepted. + +The update is applied atomically. If any errors occur during the +application of the operations, the metadata instance will not be changed. + +This operation is performed by calling function `updateFolderMetadataById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-folders-id-metadata-id-id/). + + + +```ts +await client.folderMetadata.updateFolderMetadataById( + folder.id, + 'global' as UpdateFolderMetadataByIdScope, + 'properties', + [ + { + op: 'replace' as UpdateFolderMetadataByIdRequestBodyOpField, + path: '/abc', + value: newValue, + } satisfies UpdateFolderMetadataByIdRequestBody, + ] +); +``` + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" +- scope `UpdateFolderMetadataByIdScope` + - The scope of the metadata template Example: "global" +- templateKey `string` + - The name of the metadata template Example: "properties" +- requestBody `readonly UpdateFolderMetadataByIdRequestBody[]` + - Request body of updateFolderMetadataById method +- headers `UpdateFolderMetadataByIdHeaders` + - Headers of updateFolderMetadataById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `MetadataFull`. + +Returns the updated metadata template instance, with the +custom template data included. + +## Remove metadata instance from folder + +Deletes a piece of folder metadata. + +This operation is performed by calling function `deleteFolderMetadataById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-folders-id-metadata-id-id/). + + + +```ts +await client.folderMetadata.deleteFolderMetadataById( + folder.id, + 'global' as DeleteFolderMetadataByIdScope, + 'properties' +); +``` + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" +- scope `DeleteFolderMetadataByIdScope` + - The scope of the metadata template Example: "global" +- templateKey `string` + - The name of the metadata template Example: "properties" +- headers `DeleteFolderMetadataByIdHeaders` + - Headers of deleteFolderMetadataById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the metadata is +successfully deleted. diff --git a/docs/folderWatermarks.md b/docs/folderWatermarks.md new file mode 100644 index 00000000..72c73896 --- /dev/null +++ b/docs/folderWatermarks.md @@ -0,0 +1,105 @@ +# FolderWatermarksManager + +- [Get watermark for folder](#get-watermark-for-folder) +- [Apply watermark to folder](#apply-watermark-to-folder) +- [Remove watermark from folder](#remove-watermark-from-folder) + +## Get watermark for folder + +Retrieve the watermark for a folder. + +This operation is performed by calling function `getFolderWatermark`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-folders-id-watermark/). + + + +```ts +await client.folderWatermarks.getFolderWatermark(folder.id); +``` + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" +- headers `GetFolderWatermarkHeaders` + - Headers of getFolderWatermark method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Watermark`. + +Returns an object containing information about the +watermark associated for to this folder. + +## Apply watermark to folder + +Applies or update a watermark on a folder. + +This operation is performed by calling function `updateFolderWatermark`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-folders-id-watermark/). + + + +```ts +await client.folderWatermarks.updateFolderWatermark(folder.id, { + watermark: { + imprint: 'default' as UpdateFolderWatermarkRequestBodyWatermarkImprintField, + } satisfies UpdateFolderWatermarkRequestBodyWatermarkField, +} satisfies UpdateFolderWatermarkRequestBody); +``` + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" +- requestBody `UpdateFolderWatermarkRequestBody` + - Request body of updateFolderWatermark method +- headers `UpdateFolderWatermarkHeaders` + - Headers of updateFolderWatermark method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Watermark`. + +Returns an updated watermark if a watermark already +existed on this folder.Returns a new watermark if no watermark existed on +this folder yet. + +## Remove watermark from folder + +Removes the watermark from a folder. + +This operation is performed by calling function `deleteFolderWatermark`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-folders-id-watermark/). + + + +```ts +await client.folderWatermarks.deleteFolderWatermark(folder.id); +``` + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" +- headers `DeleteFolderWatermarkHeaders` + - Headers of deleteFolderWatermark method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +An empty response will be returned when the watermark +was successfully deleted. diff --git a/docs/groups.md b/docs/groups.md new file mode 100644 index 00000000..666579db --- /dev/null +++ b/docs/groups.md @@ -0,0 +1,178 @@ +# GroupsManager + +- [List groups for enterprise](#list-groups-for-enterprise) +- [Create group](#create-group) +- [Get group](#get-group) +- [Update group](#update-group) +- [Remove group](#remove-group) + +## List groups for enterprise + +Retrieves all of the groups for a given enterprise. The user +must have admin permissions to inspect enterprise's groups. + +This operation is performed by calling function `getGroups`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-groups/). + + + +```ts +await client.groups.getGroups(); +``` + +### Arguments + +- queryParams `GetGroupsQueryParams` + - Query parameters of getGroups method +- headers `GetGroupsHeaders` + - Headers of getGroups method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Groups`. + +Returns a collection of group objects. If there are no groups, an +empty collection will be returned. + +## Create group + +Creates a new group of users in an enterprise. Only users with admin +permissions can create new groups. + +This operation is performed by calling function `createGroup`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-groups/). + + + +```ts +await client.groups.createGroup({ + name: groupName, +} satisfies CreateGroupRequestBody); +``` + +### Arguments + +- requestBody `CreateGroupRequestBody` + - Request body of createGroup method +- queryParams `CreateGroupQueryParams` + - Query parameters of createGroup method +- headers `CreateGroupHeaders` + - Headers of createGroup method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `GroupFull`. + +Returns the new group object. + +## Get group + +Retrieves information about a group. Only members of this +group or users with admin-level permissions will be able to +use this API. + +This operation is performed by calling function `getGroupById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-groups-id/). + + + +```ts +await client.groups.getGroupById(group.id); +``` + +### Arguments + +- groupId `string` + - The ID of the group. Example: "57645" +- queryParams `GetGroupByIdQueryParams` + - Query parameters of getGroupById method +- headers `GetGroupByIdHeaders` + - Headers of getGroupById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `GroupFull`. + +Returns the group object + +## Update group + +Updates a specific group. Only admins of this +group or users with admin-level permissions will be able to +use this API. + +This operation is performed by calling function `updateGroupById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-groups-id/). + + + +```ts +await client.groups.updateGroupById(group.id, { + name: updatedGroupName, +} satisfies UpdateGroupByIdRequestBody); +``` + +### Arguments + +- groupId `string` + - The ID of the group. Example: "57645" +- requestBody `UpdateGroupByIdRequestBody` + - Request body of updateGroupById method +- queryParams `UpdateGroupByIdQueryParams` + - Query parameters of updateGroupById method +- headers `UpdateGroupByIdHeaders` + - Headers of updateGroupById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `GroupFull`. + +Returns the updated group object. + +## Remove group + +Permanently deletes a group. Only users with +admin-level permissions will be able to use this API. + +This operation is performed by calling function `deleteGroupById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-groups-id/). + + + +```ts +await client.groups.deleteGroupById(group.id); +``` + +### Arguments + +- groupId `string` + - The ID of the group. Example: "57645" +- headers `DeleteGroupByIdHeaders` + - Headers of deleteGroupById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +A blank response is returned if the group was +successfully deleted. diff --git a/docs/integrationMappings.md b/docs/integrationMappings.md new file mode 100644 index 00000000..19433ebd --- /dev/null +++ b/docs/integrationMappings.md @@ -0,0 +1,126 @@ +# IntegrationMappingsManager + +- [List Slack integration mappings](#list-slack-integration-mappings) +- [Create Slack integration mapping](#create-slack-integration-mapping) +- [Update Slack integration mapping](#update-slack-integration-mapping) +- [Delete Slack integration mapping](#delete-slack-integration-mapping) + +## List Slack integration mappings + +Lists [Slack integration mappings](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) in a users' enterprise. + +You need Admin or Co-Admin role to +use this endpoint. + +This operation is performed by calling function `getSlackIntegrationMapping`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-integration-mappings-slack/). + +_Currently we don't have an example for calling `getSlackIntegrationMapping` in integration tests_ + +### Arguments + +- queryParams `GetSlackIntegrationMappingQueryParams` + - Query parameters of getSlackIntegrationMapping method +- headers `GetSlackIntegrationMappingHeaders` + - Headers of getSlackIntegrationMapping method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `IntegrationMappings`. + +Returns a collection of integration mappings + +## Create Slack integration mapping + +Creates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) +by mapping a Slack channel to a Box item. + +You need Admin or Co-Admin role to +use this endpoint. + +This operation is performed by calling function `createSlackIntegrationMapping`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-integration-mappings-slack/). + +_Currently we don't have an example for calling `createSlackIntegrationMapping` in integration tests_ + +### Arguments + +- requestBody `IntegrationMappingSlackCreateRequest` + - Request body of createSlackIntegrationMapping method +- headers `CreateSlackIntegrationMappingHeaders` + - Headers of createSlackIntegrationMapping method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `IntegrationMapping`. + +Returns the created integration mapping. + +## Update Slack integration mapping + +Updates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack). +Supports updating the Box folder ID and options. + +You need Admin or Co-Admin role to +use this endpoint. + +This operation is performed by calling function `updateSlackIntegrationMappingById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-integration-mappings-slack-id/). + +_Currently we don't have an example for calling `updateSlackIntegrationMappingById` in integration tests_ + +### Arguments + +- integrationMappingId `string` + - An ID of an integration mapping Example: "11235432" +- requestBody `UpdateSlackIntegrationMappingByIdRequestBody` + - Request body of updateSlackIntegrationMappingById method +- headers `UpdateSlackIntegrationMappingByIdHeaders` + - Headers of updateSlackIntegrationMappingById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `IntegrationMapping`. + +Returns the updated integration mapping object. + +## Delete Slack integration mapping + +Deletes a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack). + +You need Admin or Co-Admin role to +use this endpoint. + +This operation is performed by calling function `deleteSlackIntegrationMappingById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-integration-mappings-slack-id/). + +_Currently we don't have an example for calling `deleteSlackIntegrationMappingById` in integration tests_ + +### Arguments + +- integrationMappingId `string` + - An ID of an integration mapping Example: "11235432" +- headers `DeleteSlackIntegrationMappingByIdHeaders` + - Headers of deleteSlackIntegrationMappingById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Empty body in response diff --git a/docs/invites.md b/docs/invites.md new file mode 100644 index 00000000..fd6523f1 --- /dev/null +++ b/docs/invites.md @@ -0,0 +1,83 @@ +# InvitesManager + +- [Create user invite](#create-user-invite) +- [Get user invite status](#get-user-invite-status) + +## Create user invite + +Invites an existing external user to join an enterprise. + +The existing user can not be part of another enterprise and +must already have a Box account. Once invited, the user will receive an +email and are prompted to accept the invitation within the +Box web application. + +This method requires the "Manage An Enterprise" scope enabled for +the application, which can be enabled within the developer console. + +This operation is performed by calling function `createInvite`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-invites/). + + + +```ts +await client.invites.createInvite({ + enterprise: { + id: currentUser.enterprise!.id!, + } satisfies CreateInviteRequestBodyEnterpriseField, + actionableBy: { + login: email, + } satisfies CreateInviteRequestBodyActionableByField, +} satisfies CreateInviteRequestBody); +``` + +### Arguments + +- requestBody `CreateInviteRequestBody` + - Request body of createInvite method +- queryParams `CreateInviteQueryParams` + - Query parameters of createInvite method +- headers `CreateInviteHeaders` + - Headers of createInvite method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Invite`. + +Returns a new invite object. + +## Get user invite status + +Returns the status of a user invite. + +This operation is performed by calling function `getInviteById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-invites-id/). + + + +```ts +await client.invites.getInviteById(invitation.id); +``` + +### Arguments + +- inviteId `string` + - The ID of an invite. Example: "213723" +- queryParams `GetInviteByIdQueryParams` + - Query parameters of getInviteById method +- headers `GetInviteByIdHeaders` + - Headers of getInviteById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Invite`. + +Returns an invite object diff --git a/docs/legalHoldPolicies.md b/docs/legalHoldPolicies.md new file mode 100644 index 00000000..e3195e2d --- /dev/null +++ b/docs/legalHoldPolicies.md @@ -0,0 +1,170 @@ +# LegalHoldPoliciesManager + +- [List all legal hold policies](#list-all-legal-hold-policies) +- [Create legal hold policy](#create-legal-hold-policy) +- [Get legal hold policy](#get-legal-hold-policy) +- [Update legal hold policy](#update-legal-hold-policy) +- [Remove legal hold policy](#remove-legal-hold-policy) + +## List all legal hold policies + +Retrieves a list of legal hold policies that belong to +an enterprise. + +This operation is performed by calling function `getLegalHoldPolicies`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-legal-hold-policies/). + + + +```ts +await client.legalHoldPolicies.getLegalHoldPolicies(); +``` + +### Arguments + +- queryParams `GetLegalHoldPoliciesQueryParams` + - Query parameters of getLegalHoldPolicies method +- headers `GetLegalHoldPoliciesHeaders` + - Headers of getLegalHoldPolicies method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `LegalHoldPolicies`. + +Returns a list of legal hold policies. + +## Create legal hold policy + +Create a new legal hold policy. + +This operation is performed by calling function `createLegalHoldPolicy`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-legal-hold-policies/). + + + +```ts +await client.legalHoldPolicies.createLegalHoldPolicy({ + policyName: legalHoldPolicyName, + description: legalHoldDescription, + isOngoing: true, +} satisfies CreateLegalHoldPolicyRequestBody); +``` + +### Arguments + +- requestBody `CreateLegalHoldPolicyRequestBody` + - Request body of createLegalHoldPolicy method +- headers `CreateLegalHoldPolicyHeaders` + - Headers of createLegalHoldPolicy method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `LegalHoldPolicy`. + +Returns a new legal hold policy object. + +## Get legal hold policy + +Retrieve a legal hold policy. + +This operation is performed by calling function `getLegalHoldPolicyById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-legal-hold-policies-id/). + + + +```ts +await client.legalHoldPolicies.getLegalHoldPolicyById(legalHoldPolicyId); +``` + +### Arguments + +- legalHoldPolicyId `string` + - The ID of the legal hold policy Example: "324432" +- headers `GetLegalHoldPolicyByIdHeaders` + - Headers of getLegalHoldPolicyById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `LegalHoldPolicy`. + +Returns a legal hold policy object. + +## Update legal hold policy + +Update legal hold policy. + +This operation is performed by calling function `updateLegalHoldPolicyById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-legal-hold-policies-id/). + + + +```ts +await client.legalHoldPolicies.updateLegalHoldPolicyById(legalHoldPolicyId, { + policyName: updatedLegalHoldPolicyName, +} satisfies UpdateLegalHoldPolicyByIdRequestBody); +``` + +### Arguments + +- legalHoldPolicyId `string` + - The ID of the legal hold policy Example: "324432" +- requestBody `UpdateLegalHoldPolicyByIdRequestBody` + - Request body of updateLegalHoldPolicyById method +- headers `UpdateLegalHoldPolicyByIdHeaders` + - Headers of updateLegalHoldPolicyById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `LegalHoldPolicy`. + +Returns a new legal hold policy object. + +## Remove legal hold policy + +Delete an existing legal hold policy. + +This is an asynchronous process. The policy will not be +fully deleted yet when the response returns. + +This operation is performed by calling function `deleteLegalHoldPolicyById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-legal-hold-policies-id/). + + + +```ts +await client.legalHoldPolicies.deleteLegalHoldPolicyById(legalHoldPolicyId); +``` + +### Arguments + +- legalHoldPolicyId `string` + - The ID of the legal hold policy Example: "324432" +- headers `DeleteLegalHoldPolicyByIdHeaders` + - Headers of deleteLegalHoldPolicyById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +A blank response is returned if the policy was +successfully deleted. diff --git a/docs/legalHoldPolicyAssignments.md b/docs/legalHoldPolicyAssignments.md new file mode 100644 index 00000000..6225c3d2 --- /dev/null +++ b/docs/legalHoldPolicyAssignments.md @@ -0,0 +1,204 @@ +# LegalHoldPolicyAssignmentsManager + +- [List legal hold policy assignments](#list-legal-hold-policy-assignments) +- [Assign legal hold policy](#assign-legal-hold-policy) +- [Get legal hold policy assignment](#get-legal-hold-policy-assignment) +- [Unassign legal hold policy](#unassign-legal-hold-policy) +- [List current file versions for legal hold policy assignment](#list-current-file-versions-for-legal-hold-policy-assignment) +- [List previous file versions for legal hold policy assignment](#list-previous-file-versions-for-legal-hold-policy-assignment) + +## List legal hold policy assignments + +Retrieves a list of items a legal hold policy has been assigned to. + +This operation is performed by calling function `getLegalHoldPolicyAssignments`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-legal-hold-policy-assignments/). + +_Currently we don't have an example for calling `getLegalHoldPolicyAssignments` in integration tests_ + +### Arguments + +- queryParams `GetLegalHoldPolicyAssignmentsQueryParams` + - Query parameters of getLegalHoldPolicyAssignments method +- headers `GetLegalHoldPolicyAssignmentsHeaders` + - Headers of getLegalHoldPolicyAssignments method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `LegalHoldPolicyAssignments`. + +Returns a list of legal hold policy assignments. + +## Assign legal hold policy + +Assign a legal hold to a file, file version, folder, or user. + +This operation is performed by calling function `createLegalHoldPolicyAssignment`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-legal-hold-policy-assignments/). + +_Currently we don't have an example for calling `createLegalHoldPolicyAssignment` in integration tests_ + +### Arguments + +- requestBody `CreateLegalHoldPolicyAssignmentRequestBody` + - Request body of createLegalHoldPolicyAssignment method +- headers `CreateLegalHoldPolicyAssignmentHeaders` + - Headers of createLegalHoldPolicyAssignment method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `LegalHoldPolicyAssignment`. + +Returns a new legal hold policy assignment. + +## Get legal hold policy assignment + +Retrieve a legal hold policy assignment. + +This operation is performed by calling function `getLegalHoldPolicyAssignmentById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-legal-hold-policy-assignments-id/). + +_Currently we don't have an example for calling `getLegalHoldPolicyAssignmentById` in integration tests_ + +### Arguments + +- legalHoldPolicyAssignmentId `string` + - The ID of the legal hold policy assignment Example: "753465" +- headers `GetLegalHoldPolicyAssignmentByIdHeaders` + - Headers of getLegalHoldPolicyAssignmentById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `LegalHoldPolicyAssignment`. + +Returns a legal hold policy object. + +## Unassign legal hold policy + +Remove a legal hold from an item. + +This is an asynchronous process. The policy will not be +fully removed yet when the response returns. + +This operation is performed by calling function `deleteLegalHoldPolicyAssignmentById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-legal-hold-policy-assignments-id/). + +_Currently we don't have an example for calling `deleteLegalHoldPolicyAssignmentById` in integration tests_ + +### Arguments + +- legalHoldPolicyAssignmentId `string` + - The ID of the legal hold policy assignment Example: "753465" +- headers `DeleteLegalHoldPolicyAssignmentByIdHeaders` + - Headers of deleteLegalHoldPolicyAssignmentById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +A blank response is returned if the assignment was +successfully deleted. + +## List current file versions for legal hold policy assignment + +Get a list of current file versions for a legal hold +assignment. + +In some cases you may want to get previous file versions instead. In these +cases, use the `GET /legal_hold_policy_assignments/:id/file_versions_on_hold` +API instead to return any previous versions of a file for this legal hold +policy assignment. + +Due to ongoing re-architecture efforts this API might not return all file +versions held for this policy ID. Instead, this API will only return the +latest file version held in the newly developed architecture. The `GET +/file_version_legal_holds` API can be used to fetch current and past versions +of files held within the legacy architecture. + +The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to +find a list of policy assignments for a given policy ID. + +This operation is performed by calling function `getLegalHoldPolicyAssignmentFileOnHold`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-legal-hold-policy-assignments-id-files-on-hold/). + +_Currently we don't have an example for calling `getLegalHoldPolicyAssignmentFileOnHold` in integration tests_ + +### Arguments + +- legalHoldPolicyAssignmentId `string` + - The ID of the legal hold policy assignment Example: "753465" +- queryParams `GetLegalHoldPolicyAssignmentFileOnHoldQueryParams` + - Query parameters of getLegalHoldPolicyAssignmentFileOnHold method +- headers `GetLegalHoldPolicyAssignmentFileOnHoldHeaders` + - Headers of getLegalHoldPolicyAssignmentFileOnHold method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FileVersionLegalHolds`. + +Returns the list of current file versions held under legal hold for a +specific legal hold policy assignment. + +## List previous file versions for legal hold policy assignment + +Get a list of previous file versions for a legal hold +assignment. + +In some cases you may only need the latest file versions instead. In these +cases, use the `GET /legal_hold_policy_assignments/:id/files_on_hold` API +instead to return any current (latest) versions of a file for this legal hold +policy assignment. + +Due to ongoing re-architecture efforts this API might not return all files +held for this policy ID. Instead, this API will only return past file versions +held in the newly developed architecture. The `GET /file_version_legal_holds` +API can be used to fetch current and past versions of files held within the +legacy architecture. + +The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to +find a list of policy assignments for a given policy ID. + +This operation is performed by calling function `getLegalHoldPolicyAssignmentFileVersionOnHold`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-legal-hold-policy-assignments-id-file-versions-on-hold/). + +_Currently we don't have an example for calling `getLegalHoldPolicyAssignmentFileVersionOnHold` in integration tests_ + +### Arguments + +- legalHoldPolicyAssignmentId `string` + - The ID of the legal hold policy assignment Example: "753465" +- queryParams `GetLegalHoldPolicyAssignmentFileVersionOnHoldQueryParams` + - Query parameters of getLegalHoldPolicyAssignmentFileVersionOnHold method +- headers `GetLegalHoldPolicyAssignmentFileVersionOnHoldHeaders` + - Headers of getLegalHoldPolicyAssignmentFileVersionOnHold method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FileVersionLegalHolds`. + +Returns the list of previous file versions held under legal hold for a +specific legal hold policy assignment. diff --git a/docs/listCollaborations.md b/docs/listCollaborations.md new file mode 100644 index 00000000..a9f1e157 --- /dev/null +++ b/docs/listCollaborations.md @@ -0,0 +1,156 @@ +# ListCollaborationsManager + +- [List file collaborations](#list-file-collaborations) +- [List folder collaborations](#list-folder-collaborations) +- [List pending collaborations](#list-pending-collaborations) +- [List group collaborations](#list-group-collaborations) + +## List file collaborations + +Retrieves a list of pending and active collaborations for a +file. This returns all the users that have access to the file +or have been invited to the file. + +This operation is performed by calling function `getFileCollaborations`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-files-id-collaborations/). + + + +```ts +await client.listCollaborations.getFileCollaborations(file.id); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- queryParams `GetFileCollaborationsQueryParams` + - Query parameters of getFileCollaborations method +- headers `GetFileCollaborationsHeaders` + - Headers of getFileCollaborations method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Collaborations`. + +Returns a collection of collaboration objects. If there are no +collaborations on this file an empty collection will be returned. + +This list includes pending collaborations, for which the `status` +is set to `pending`, indicating invitations that have been sent but not +yet accepted. + +## List folder collaborations + +Retrieves a list of pending and active collaborations for a +folder. This returns all the users that have access to the folder +or have been invited to the folder. + +This operation is performed by calling function `getFolderCollaborations`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-folders-id-collaborations/). + + + +```ts +await client.listCollaborations.getFolderCollaborations(folder.id); +``` + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. Example: "12345" +- queryParams `GetFolderCollaborationsQueryParams` + - Query parameters of getFolderCollaborations method +- headers `GetFolderCollaborationsHeaders` + - Headers of getFolderCollaborations method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Collaborations`. + +Returns a collection of collaboration objects. If there are no +collaborations on this folder an empty collection will be returned. + +This list includes pending collaborations, for which the `status` +is set to `pending`, indicating invitations that have been sent but not +yet accepted. + +## List pending collaborations + +Retrieves all pending collaboration invites for this user. + +This operation is performed by calling function `getCollaborations`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-collaborations/). + + + +```ts +await client.listCollaborations.getCollaborations({ + status: 'pending' as GetCollaborationsQueryParamsStatusField, +} satisfies GetCollaborationsQueryParams); +``` + +### Arguments + +- queryParams `GetCollaborationsQueryParams` + - Query parameters of getCollaborations method +- headers `GetCollaborationsHeaders` + - Headers of getCollaborations method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Collaborations`. + +Returns a collection of pending collaboration objects. + +If the user has no pending collaborations, the collection +will be empty. + +## List group collaborations + +Retrieves all the collaborations for a group. The user +must have admin permissions to inspect enterprise's groups. + +Each collaboration object has details on which files or +folders the group has access to and with what role. + +This operation is performed by calling function `getGroupCollaborations`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-groups-id-collaborations/). + + + +```ts +await client.listCollaborations.getGroupCollaborations(group.id); +``` + +### Arguments + +- groupId `string` + - The ID of the group. Example: "57645" +- queryParams `GetGroupCollaborationsQueryParams` + - Query parameters of getGroupCollaborations method +- headers `GetGroupCollaborationsHeaders` + - Headers of getGroupCollaborations method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Collaborations`. + +Returns a collection of collaboration objects. If there are no +collaborations, an empty collection will be returned. diff --git a/docs/memberships.md b/docs/memberships.md new file mode 100644 index 00000000..4e784d16 --- /dev/null +++ b/docs/memberships.md @@ -0,0 +1,219 @@ +# MembershipsManager + +- [List user's groups](#list-users-groups) +- [List members of group](#list-members-of-group) +- [Add user to group](#add-user-to-group) +- [Get group membership](#get-group-membership) +- [Update group membership](#update-group-membership) +- [Remove user from group](#remove-user-from-group) + +## List user's groups + +Retrieves all the groups for a user. Only members of this +group or users with admin-level permissions will be able to +use this API. + +This operation is performed by calling function `getUserMemberships`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-users-id-memberships/). + + + +```ts +await client.memberships.getUserMemberships(user.id); +``` + +### Arguments + +- userId `string` + - The ID of the user. Example: "12345" +- queryParams `GetUserMembershipsQueryParams` + - Query parameters of getUserMemberships method +- headers `GetUserMembershipsHeaders` + - Headers of getUserMemberships method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `GroupMemberships`. + +Returns a collection of membership objects. If there are no +memberships, an empty collection will be returned. + +## List members of group + +Retrieves all the members for a group. Only members of this +group or users with admin-level permissions will be able to +use this API. + +This operation is performed by calling function `getGroupMemberships`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-groups-id-memberships/). + + + +```ts +await client.memberships.getGroupMemberships(group.id); +``` + +### Arguments + +- groupId `string` + - The ID of the group. Example: "57645" +- queryParams `GetGroupMembershipsQueryParams` + - Query parameters of getGroupMemberships method +- headers `GetGroupMembershipsHeaders` + - Headers of getGroupMemberships method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `GroupMemberships`. + +Returns a collection of membership objects. If there are no +memberships, an empty collection will be returned. + +## Add user to group + +Creates a group membership. Only users with +admin-level permissions will be able to use this API. + +This operation is performed by calling function `createGroupMembership`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-group-memberships/). + + + +```ts +await client.memberships.createGroupMembership({ + user: { id: user.id } satisfies CreateGroupMembershipRequestBodyUserField, + group: { id: group.id } satisfies CreateGroupMembershipRequestBodyGroupField, +} satisfies CreateGroupMembershipRequestBody); +``` + +### Arguments + +- requestBody `CreateGroupMembershipRequestBody` + - Request body of createGroupMembership method +- queryParams `CreateGroupMembershipQueryParams` + - Query parameters of createGroupMembership method +- headers `CreateGroupMembershipHeaders` + - Headers of createGroupMembership method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `GroupMembership`. + +Returns a new group membership object. + +## Get group membership + +Retrieves a specific group membership. Only admins of this +group or users with admin-level permissions will be able to +use this API. + +This operation is performed by calling function `getGroupMembershipById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-group-memberships-id/). + + + +```ts +await client.memberships.getGroupMembershipById(groupMembership.id!); +``` + +### Arguments + +- groupMembershipId `string` + - The ID of the group membership. Example: "434534" +- queryParams `GetGroupMembershipByIdQueryParams` + - Query parameters of getGroupMembershipById method +- headers `GetGroupMembershipByIdHeaders` + - Headers of getGroupMembershipById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `GroupMembership`. + +Returns the group membership object. + +## Update group membership + +Updates a user's group membership. Only admins of this +group or users with admin-level permissions will be able to +use this API. + +This operation is performed by calling function `updateGroupMembershipById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-group-memberships-id/). + + + +```ts +await client.memberships.updateGroupMembershipById(groupMembership.id!, { + role: 'admin' as UpdateGroupMembershipByIdRequestBodyRoleField, +} satisfies UpdateGroupMembershipByIdRequestBody); +``` + +### Arguments + +- groupMembershipId `string` + - The ID of the group membership. Example: "434534" +- requestBody `UpdateGroupMembershipByIdRequestBody` + - Request body of updateGroupMembershipById method +- queryParams `UpdateGroupMembershipByIdQueryParams` + - Query parameters of updateGroupMembershipById method +- headers `UpdateGroupMembershipByIdHeaders` + - Headers of updateGroupMembershipById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `GroupMembership`. + +Returns a new group membership object. + +## Remove user from group + +Deletes a specific group membership. Only admins of this +group or users with admin-level permissions will be able to +use this API. + +This operation is performed by calling function `deleteGroupMembershipById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-group-memberships-id/). + + + +```ts +await client.memberships.deleteGroupMembershipById(groupMembership.id!); +``` + +### Arguments + +- groupMembershipId `string` + - The ID of the group membership. Example: "434534" +- headers `DeleteGroupMembershipByIdHeaders` + - Headers of deleteGroupMembershipById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +A blank response is returned if the membership was +successfully deleted. diff --git a/docs/metadataCascadePolicies.md b/docs/metadataCascadePolicies.md new file mode 100644 index 00000000..a6f6d893 --- /dev/null +++ b/docs/metadataCascadePolicies.md @@ -0,0 +1,191 @@ +# MetadataCascadePoliciesManager + +- [List metadata cascade policies](#list-metadata-cascade-policies) +- [Create metadata cascade policy](#create-metadata-cascade-policy) +- [Get metadata cascade policy](#get-metadata-cascade-policy) +- [Remove metadata cascade policy](#remove-metadata-cascade-policy) +- [Force-apply metadata cascade policy to folder](#force-apply-metadata-cascade-policy-to-folder) + +## List metadata cascade policies + +Retrieves a list of all the metadata cascade policies +that are applied to a given folder. This can not be used on the root +folder with ID `0`. + +This operation is performed by calling function `getMetadataCascadePolicies`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-metadata-cascade-policies/). + + + +```ts +await client.metadataCascadePolicies.getMetadataCascadePolicies({ + folderId: folder.id, +} satisfies GetMetadataCascadePoliciesQueryParams); +``` + +### Arguments + +- queryParams `GetMetadataCascadePoliciesQueryParams` + - Query parameters of getMetadataCascadePolicies method +- headers `GetMetadataCascadePoliciesHeaders` + - Headers of getMetadataCascadePolicies method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `MetadataCascadePolicies`. + +Returns a list of metadata cascade policies + +## Create metadata cascade policy + +Creates a new metadata cascade policy that applies a given +metadata template to a given folder and automatically +cascades it down to any files within that folder. + +In order for the policy to be applied a metadata instance must first +be applied to the folder the policy is to be applied to. + +This operation is performed by calling function `createMetadataCascadePolicy`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-metadata-cascade-policies/). + + + +```ts +await client.metadataCascadePolicies.createMetadataCascadePolicy({ + folderId: folder.id, + scope: 'enterprise' as CreateMetadataCascadePolicyRequestBodyScopeField, + templateKey: templateKey, +} satisfies CreateMetadataCascadePolicyRequestBody); +``` + +### Arguments + +- requestBody `CreateMetadataCascadePolicyRequestBody` + - Request body of createMetadataCascadePolicy method +- headers `CreateMetadataCascadePolicyHeaders` + - Headers of createMetadataCascadePolicy method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `MetadataCascadePolicy`. + +Returns a new of metadata cascade policy + +## Get metadata cascade policy + +Retrieve a specific metadata cascade policy assigned to a folder. + +This operation is performed by calling function `getMetadataCascadePolicyById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-metadata-cascade-policies-id/). + + + +```ts +await client.metadataCascadePolicies.getMetadataCascadePolicyById( + cascadePolicyId +); +``` + +### Arguments + +- metadataCascadePolicyId `string` + - The ID of the metadata cascade policy. Example: "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7" +- headers `GetMetadataCascadePolicyByIdHeaders` + - Headers of getMetadataCascadePolicyById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `MetadataCascadePolicy`. + +Returns a metadata cascade policy + +## Remove metadata cascade policy + +Deletes a metadata cascade policy. + +This operation is performed by calling function `deleteMetadataCascadePolicyById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-metadata-cascade-policies-id/). + + + +```ts +await client.metadataCascadePolicies.deleteMetadataCascadePolicyById( + cascadePolicyId +); +``` + +### Arguments + +- metadataCascadePolicyId `string` + - The ID of the metadata cascade policy. Example: "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7" +- headers `DeleteMetadataCascadePolicyByIdHeaders` + - Headers of deleteMetadataCascadePolicyById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the policy +is successfully deleted. + +## Force-apply metadata cascade policy to folder + +Force the metadata on a folder with a metadata cascade policy to be applied to +all of its children. This can be used after creating a new cascade policy to +enforce the metadata to be cascaded down to all existing files within that +folder. + +This operation is performed by calling function `applyMetadataCascadePolicy`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-metadata-cascade-policies-id-apply/). + + + +```ts +await client.metadataCascadePolicies.applyMetadataCascadePolicy( + cascadePolicyId, + { + conflictResolution: + 'overwrite' as ApplyMetadataCascadePolicyRequestBodyConflictResolutionField, + } satisfies ApplyMetadataCascadePolicyRequestBody +); +``` + +### Arguments + +- metadataCascadePolicyId `string` + - The ID of the cascade policy to force-apply. Example: "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7" +- requestBody `ApplyMetadataCascadePolicyRequestBody` + - Request body of applyMetadataCascadePolicy method +- headers `ApplyMetadataCascadePolicyHeaders` + - Headers of applyMetadataCascadePolicy method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the API call was successful. The metadata +cascade operation will be performed asynchronously. + +The API call will return directly, before the cascade operation +is complete. There is currently no API to check for the status of this +operation. diff --git a/docs/metadataTemplates.md b/docs/metadataTemplates.md new file mode 100644 index 00000000..dbceeef2 --- /dev/null +++ b/docs/metadataTemplates.md @@ -0,0 +1,307 @@ +# MetadataTemplatesManager + +- [Find metadata template by instance ID](#find-metadata-template-by-instance-id) +- [Get metadata template by name](#get-metadata-template-by-name) +- [Update metadata template](#update-metadata-template) +- [Remove metadata template](#remove-metadata-template) +- [Get metadata template by ID](#get-metadata-template-by-id) +- [List all global metadata templates](#list-all-global-metadata-templates) +- [List all metadata templates for enterprise](#list-all-metadata-templates-for-enterprise) +- [Create metadata template](#create-metadata-template) + +## Find metadata template by instance ID + +Finds a metadata template by searching for the ID of an instance of the +template. + +This operation is performed by calling function `getMetadataTemplatesByInstanceId`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-metadata-templates/). + + + +```ts +await client.metadataTemplates.getMetadataTemplatesByInstanceId({ + metadataInstanceId: createdMetadataInstance.id!, +} satisfies GetMetadataTemplatesByInstanceIdQueryParams); +``` + +### Arguments + +- queryParams `GetMetadataTemplatesByInstanceIdQueryParams` + - Query parameters of getMetadataTemplatesByInstanceId method +- headers `GetMetadataTemplatesByInstanceIdHeaders` + - Headers of getMetadataTemplatesByInstanceId method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `MetadataTemplates`. + +Returns a list containing the 1 metadata template that matches the +instance ID. + +## Get metadata template by name + +Retrieves a metadata template by its `scope` and `templateKey` values. + +To find the `scope` and `templateKey` for a template, list all templates for +an enterprise or globally, or list all templates applied to a file or folder. + +This operation is performed by calling function `getMetadataTemplate`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-metadata-templates-id-id-schema/). + + + +```ts +await client.metadataTemplates.getMetadataTemplate( + 'enterprise' as GetMetadataTemplateScope, + template.templateKey! +); +``` + +### Arguments + +- scope `GetMetadataTemplateScope` + - The scope of the metadata template Example: "global" +- templateKey `string` + - The name of the metadata template Example: "properties" +- headers `GetMetadataTemplateHeaders` + - Headers of getMetadataTemplate method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `MetadataTemplate`. + +Returns the metadata template matching the `scope` +and `template` name. + +## Update metadata template + +Updates a metadata template. + +The metadata template can only be updated if the template +already exists. + +The update is applied atomically. If any errors occur during the +application of the operations, the metadata template will not be changed. + +This operation is performed by calling function `updateMetadataTemplate`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-metadata-templates-id-id-schema/). + + + +```ts +await client.metadataTemplates.updateMetadataTemplate( + 'enterprise' as UpdateMetadataTemplateScope, + templateKey, + [ + { + op: 'addField' as UpdateMetadataTemplateRequestBodyOpField, + fieldKey: 'newfieldname', + data: { ['type']: 'string', ['displayName']: 'newFieldName' }, + } satisfies UpdateMetadataTemplateRequestBody, + ] +); +``` + +### Arguments + +- scope `UpdateMetadataTemplateScope` + - The scope of the metadata template Example: "global" +- templateKey `string` + - The name of the metadata template Example: "properties" +- requestBody `readonly UpdateMetadataTemplateRequestBody[]` + - Request body of updateMetadataTemplate method +- headers `UpdateMetadataTemplateHeaders` + - Headers of updateMetadataTemplate method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `MetadataTemplate`. + +Returns the updated metadata template, with the +custom template data included. + +## Remove metadata template + +Delete a metadata template and its instances. +This deletion is permanent and can not be reversed. + +This operation is performed by calling function `deleteMetadataTemplate`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-metadata-templates-id-id-schema/). + + + +```ts +await client.metadataTemplates.deleteMetadataTemplate( + 'enterprise' as DeleteMetadataTemplateScope, + template.templateKey +); +``` + +### Arguments + +- scope `DeleteMetadataTemplateScope` + - The scope of the metadata template Example: "global" +- templateKey `string` + - The name of the metadata template Example: "properties" +- headers `DeleteMetadataTemplateHeaders` + - Headers of deleteMetadataTemplate method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the metadata +template is successfully deleted. + +## Get metadata template by ID + +Retrieves a metadata template by its ID. + +This operation is performed by calling function `getMetadataTemplateById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-metadata-templates-id/). + + + +```ts +await client.metadataTemplates.getMetadataTemplateById(template.id); +``` + +### Arguments + +- templateId `string` + - The ID of the template Example: "f7a9891f" +- headers `GetMetadataTemplateByIdHeaders` + - Headers of getMetadataTemplateById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `MetadataTemplate`. + +Returns the metadata template that matches the ID. + +## List all global metadata templates + +Used to retrieve all generic, global metadata templates available to all +enterprises using Box. + +This operation is performed by calling function `getGlobalMetadataTemplates`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-metadata-templates-global/). + + + +```ts +await client.metadataTemplates.getGlobalMetadataTemplates(); +``` + +### Arguments + +- queryParams `GetGlobalMetadataTemplatesQueryParams` + - Query parameters of getGlobalMetadataTemplates method +- headers `GetGlobalMetadataTemplatesHeaders` + - Headers of getGlobalMetadataTemplates method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `MetadataTemplates`. + +Returns all of the metadata templates available to all enterprises +and their corresponding schema. + +## List all metadata templates for enterprise + +Used to retrieve all metadata templates created to be used specifically within +the user's enterprise + +This operation is performed by calling function `getEnterpriseMetadataTemplates`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-metadata-templates-enterprise/). + + + +```ts +await client.metadataTemplates.getEnterpriseMetadataTemplates(); +``` + +### Arguments + +- queryParams `GetEnterpriseMetadataTemplatesQueryParams` + - Query parameters of getEnterpriseMetadataTemplates method +- headers `GetEnterpriseMetadataTemplatesHeaders` + - Headers of getEnterpriseMetadataTemplates method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `MetadataTemplates`. + +Returns all of the metadata templates within an enterprise +and their corresponding schema. + +## Create metadata template + +Creates a new metadata template that can be applied to +files and folders. + +This operation is performed by calling function `createMetadataTemplate`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-metadata-templates-schema/). + + + +```ts +await client.metadataTemplates.createMetadataTemplate({ + scope: 'enterprise', + displayName: templateKey, + templateKey: templateKey, + fields: [ + { + type: 'string' as CreateMetadataTemplateRequestBodyFieldsTypeField, + key: 'testName', + displayName: 'testName', + } satisfies CreateMetadataTemplateRequestBodyFieldsField, + ], +} satisfies CreateMetadataTemplateRequestBody); +``` + +### Arguments + +- requestBody `CreateMetadataTemplateRequestBody` + - Request body of createMetadataTemplate method +- headers `CreateMetadataTemplateHeaders` + - Headers of createMetadataTemplate method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `MetadataTemplate`. + +The schema representing the metadata template created. diff --git a/docs/recentItems.md b/docs/recentItems.md new file mode 100644 index 00000000..397251c2 --- /dev/null +++ b/docs/recentItems.md @@ -0,0 +1,35 @@ +# RecentItemsManager + +- [List recently accessed items](#list-recently-accessed-items) + +## List recently accessed items + +Returns information about the recent items accessed +by a user, either in the last 90 days or up to the last +1000 items accessed. + +This operation is performed by calling function `getRecentItems`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-recent-items/). + + + +```ts +await client.recentItems.getRecentItems(); +``` + +### Arguments + +- queryParams `GetRecentItemsQueryParams` + - Query parameters of getRecentItems method +- headers `GetRecentItemsHeaders` + - Headers of getRecentItems method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `RecentItems`. + +Returns a list recent items access by a user. diff --git a/docs/retentionPolicies.md b/docs/retentionPolicies.md new file mode 100644 index 00000000..2f816788 --- /dev/null +++ b/docs/retentionPolicies.md @@ -0,0 +1,174 @@ +# RetentionPoliciesManager + +- [List retention policies](#list-retention-policies) +- [Create retention policy](#create-retention-policy) +- [Get retention policy](#get-retention-policy) +- [Update retention policy](#update-retention-policy) +- [Delete retention policy](#delete-retention-policy) + +## List retention policies + +Retrieves all of the retention policies for an enterprise. + +This operation is performed by calling function `getRetentionPolicies`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-retention-policies/). + + + +```ts +await client.retentionPolicies.getRetentionPolicies(); +``` + +### Arguments + +- queryParams `GetRetentionPoliciesQueryParams` + - Query parameters of getRetentionPolicies method +- headers `GetRetentionPoliciesHeaders` + - Headers of getRetentionPolicies method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `RetentionPolicies`. + +Returns a list retention policies in the enterprise. + +## Create retention policy + +Creates a retention policy. + +This operation is performed by calling function `createRetentionPolicy`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-retention-policies/). + + + +```ts +await client.retentionPolicies.createRetentionPolicy({ + policyName: retentionPolicyName, + policyType: 'finite' as CreateRetentionPolicyRequestBodyPolicyTypeField, + areOwnersNotified: true, + canOwnerExtendRetention: true, + description: retentionDescription, + dispositionAction: + 'remove_retention' as CreateRetentionPolicyRequestBodyDispositionActionField, + retentionLength: '1', + retentionType: + 'modifiable' as CreateRetentionPolicyRequestBodyRetentionTypeField, +} satisfies CreateRetentionPolicyRequestBody); +``` + +### Arguments + +- requestBody `CreateRetentionPolicyRequestBody` + - Request body of createRetentionPolicy method +- headers `CreateRetentionPolicyHeaders` + - Headers of createRetentionPolicy method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `RetentionPolicy`. + +Returns a new retention policy object. + +## Get retention policy + +Retrieves a retention policy. + +This operation is performed by calling function `getRetentionPolicyById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-retention-policies-id/). + + + +```ts +await client.retentionPolicies.getRetentionPolicyById(retentionPolicy.id); +``` + +### Arguments + +- retentionPolicyId `string` + - The ID of the retention policy. Example: "982312" +- queryParams `GetRetentionPolicyByIdQueryParams` + - Query parameters of getRetentionPolicyById method +- headers `GetRetentionPolicyByIdHeaders` + - Headers of getRetentionPolicyById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `RetentionPolicy`. + +Returns the retention policy object. + +## Update retention policy + +Updates a retention policy. + +This operation is performed by calling function `updateRetentionPolicyById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-retention-policies-id/). + + + +```ts +await client.retentionPolicies.updateRetentionPolicyById(retentionPolicy.id, { + policyName: updatedRetentionPolicyName, +} satisfies UpdateRetentionPolicyByIdRequestBody); +``` + +### Arguments + +- retentionPolicyId `string` + - The ID of the retention policy. Example: "982312" +- requestBody `UpdateRetentionPolicyByIdRequestBody` + - Request body of updateRetentionPolicyById method +- headers `UpdateRetentionPolicyByIdHeaders` + - Headers of updateRetentionPolicyById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `RetentionPolicy`. + +Returns the updated retention policy object. + +## Delete retention policy + +Permanently deletes a retention policy. + +This operation is performed by calling function `deleteRetentionPolicyById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-retention-policies-id/). + + + +```ts +await client.retentionPolicies.deleteRetentionPolicyById(retentionPolicy.id); +``` + +### Arguments + +- retentionPolicyId `string` + - The ID of the retention policy. Example: "982312" +- headers `DeleteRetentionPolicyByIdHeaders` + - Headers of deleteRetentionPolicyById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the policy has been deleted. diff --git a/docs/retentionPolicyAssignments.md b/docs/retentionPolicyAssignments.md new file mode 100644 index 00000000..cdd3f8d5 --- /dev/null +++ b/docs/retentionPolicyAssignments.md @@ -0,0 +1,179 @@ +# RetentionPolicyAssignmentsManager + +- [List retention policy assignments](#list-retention-policy-assignments) +- [Assign retention policy](#assign-retention-policy) +- [Get retention policy assignment](#get-retention-policy-assignment) +- [Remove retention policy assignment](#remove-retention-policy-assignment) +- [Get files under retention](#get-files-under-retention) +- [Get file versions under retention](#get-file-versions-under-retention) + +## List retention policy assignments + +Returns a list of all retention policy assignments associated with a specified +retention policy. + +This operation is performed by calling function `getRetentionPolicyAssignments`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-retention-policies-id-assignments/). + +_Currently we don't have an example for calling `getRetentionPolicyAssignments` in integration tests_ + +### Arguments + +- retentionPolicyId `string` + - The ID of the retention policy. Example: "982312" +- queryParams `GetRetentionPolicyAssignmentsQueryParams` + - Query parameters of getRetentionPolicyAssignments method +- headers `GetRetentionPolicyAssignmentsHeaders` + - Headers of getRetentionPolicyAssignments method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `RetentionPolicyAssignments`. + +Returns a list of the retention policy assignments associated with the +specified retention policy. + +## Assign retention policy + +Assigns a retention policy to an item. + +This operation is performed by calling function `createRetentionPolicyAssignment`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-retention-policy-assignments/). + +_Currently we don't have an example for calling `createRetentionPolicyAssignment` in integration tests_ + +### Arguments + +- requestBody `CreateRetentionPolicyAssignmentRequestBody` + - Request body of createRetentionPolicyAssignment method +- headers `CreateRetentionPolicyAssignmentHeaders` + - Headers of createRetentionPolicyAssignment method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `RetentionPolicyAssignment`. + +Returns a new retention policy assignment object. + +## Get retention policy assignment + +Retrieves a retention policy assignment + +This operation is performed by calling function `getRetentionPolicyAssignmentById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-retention-policy-assignments-id/). + +_Currently we don't have an example for calling `getRetentionPolicyAssignmentById` in integration tests_ + +### Arguments + +- retentionPolicyAssignmentId `string` + - The ID of the retention policy assignment. Example: "1233123" +- queryParams `GetRetentionPolicyAssignmentByIdQueryParams` + - Query parameters of getRetentionPolicyAssignmentById method +- headers `GetRetentionPolicyAssignmentByIdHeaders` + - Headers of getRetentionPolicyAssignmentById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `RetentionPolicyAssignment`. + +Returns the retention policy assignment object. + +## Remove retention policy assignment + +Removes a retention policy assignment +applied to content. + +This operation is performed by calling function `deleteRetentionPolicyAssignmentById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-retention-policy-assignments-id/). + +_Currently we don't have an example for calling `deleteRetentionPolicyAssignmentById` in integration tests_ + +### Arguments + +- retentionPolicyAssignmentId `string` + - The ID of the retention policy assignment. Example: "1233123" +- headers `DeleteRetentionPolicyAssignmentByIdHeaders` + - Headers of deleteRetentionPolicyAssignmentById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the policy assignment +is successfully deleted. + +## Get files under retention + +Returns a list of files under retention for a retention policy assignment. + +This operation is performed by calling function `getFilesUnderRetentionPolicyAssignment`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention/). + +_Currently we don't have an example for calling `getFilesUnderRetentionPolicyAssignment` in integration tests_ + +### Arguments + +- retentionPolicyAssignmentId `string` + - The ID of the retention policy assignment. Example: "1233123" +- queryParams `GetFilesUnderRetentionPolicyAssignmentQueryParams` + - Query parameters of getFilesUnderRetentionPolicyAssignment method +- headers `GetFilesUnderRetentionPolicyAssignmentHeaders` + - Headers of getFilesUnderRetentionPolicyAssignment method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FilesUnderRetention`. + +Returns a list of files under retention that are associated with the +specified retention policy assignment. + +## Get file versions under retention + +Returns a list of file versions under retention for a retention policy +assignment. + +This operation is performed by calling function `getFileVersionsUnderRetentionPolicyAssignment`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention/). + +_Currently we don't have an example for calling `getFileVersionsUnderRetentionPolicyAssignment` in integration tests_ + +### Arguments + +- retentionPolicyAssignmentId `string` + - The ID of the retention policy assignment. Example: "1233123" +- queryParams `GetFileVersionsUnderRetentionPolicyAssignmentQueryParams` + - Query parameters of getFileVersionsUnderRetentionPolicyAssignment method +- headers `GetFileVersionsUnderRetentionPolicyAssignmentHeaders` + - Headers of getFileVersionsUnderRetentionPolicyAssignment method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FilesUnderRetention`. + +Returns a list of file versions under retention that are associated with +the specified retention policy assignment. diff --git a/docs/search.md b/docs/search.md new file mode 100644 index 00000000..a430cbee --- /dev/null +++ b/docs/search.md @@ -0,0 +1,116 @@ +# SearchManager + +- [Query files/folders by metadata](#query-files-folders-by-metadata) +- [List metadata query indices](#list-metadata-query-indices) +- [Search for content](#search-for-content) + +## Query files/folders by metadata + +Create a search using SQL-like syntax to return items that match specific +metadata. + +By default, this endpoint returns only the most basic info about the items for +which the query matches. To get additional fields for each item, including any +of the metadata, use the `fields` attribute in the query. + +This operation is performed by calling function `searchByMetadataQuery`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-metadata-queries-execute-read/). + + + +```ts +await client.search.searchByMetadataQuery({ + ancestorFolderId: '0', + from: searchFrom, + query: 'testName >= :value', + queryParams: { ['value']: '0.0' }, +} satisfies MetadataQuery); +``` + +### Arguments + +- requestBody `MetadataQuery` + - Request body of searchByMetadataQuery method +- headers `SearchByMetadataQueryHeaders` + - Headers of searchByMetadataQuery method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `MetadataQueryResults`. + +Returns a list of files and folders that match this metadata query. + +## List metadata query indices + +Retrieves the metadata query indices for a given scope and template key. + +This operation is performed by calling function `getMetadataQueryIndices`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-metadata-query-indices/). + + + +```ts +await client.search.getMetadataQueryIndices({ + scope: 'enterprise' as GetMetadataQueryIndicesQueryParamsScopeField, + templateKey: templateKey, +} satisfies GetMetadataQueryIndicesQueryParams); +``` + +### Arguments + +- queryParams `GetMetadataQueryIndicesQueryParams` + - Query parameters of getMetadataQueryIndices method +- headers `GetMetadataQueryIndicesHeaders` + - Headers of getMetadataQueryIndices method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `MetadataQueryIndices`. + +Returns a collection of metadata query indices for scope and template key. + +## Search for content + +Searches for files, folders, web links, and shared files across the +users content or across the entire enterprise. + +This operation is performed by calling function `searchForContent`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-search/). + + + +```ts +await client.search.searchForContent({ + ancestorFolderIds: ['0' as ''], + query: keyword, + trashContent: + 'non_trashed_only' as SearchForContentQueryParamsTrashContentField, + includeRecentSharedLinks: true, +} satisfies SearchForContentQueryParams); +``` + +### Arguments + +- queryParams `SearchForContentQueryParams` + - Query parameters of searchForContent method +- headers `SearchForContentHeaders` + - Headers of searchForContent method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `SearchResultsOrSearchResultsWithSharedLinks`. + +Returns a collection of search results. If there are no matching +search results, the `entries` array will be empty. diff --git a/docs/sessionTermination.md b/docs/sessionTermination.md new file mode 100644 index 00000000..2732a9aa --- /dev/null +++ b/docs/sessionTermination.md @@ -0,0 +1,75 @@ +# SessionTerminationManager + +- [Create jobs to terminate users session](#create-jobs-to-terminate-users-session) +- [Create jobs to terminate user group session](#create-jobs-to-terminate-user-group-session) + +## Create jobs to terminate users session + +Validates the roles and permissions of the user, +and creates asynchronous jobs +to terminate the user's sessions. +Returns the status for the POST request. + +This operation is performed by calling function `terminateUsersSessions`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-users-terminate-sessions/). + + + +```ts +await client.sessionTermination.terminateUsersSessions({ + userIds: [getEnvVar('USER_ID')], + userLogins: [user.login!], +} satisfies TerminateUsersSessionsRequestBody); +``` + +### Arguments + +- requestBody `TerminateUsersSessionsRequestBody` + - Request body of terminateUsersSessions method +- headers `TerminateUsersSessionsHeaders` + - Headers of terminateUsersSessions method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `SessionTerminationMessage`. + +Returns a message about the request status. + +## Create jobs to terminate user group session + +Validates the roles and permissions of the group, +and creates asynchronous jobs +to terminate the group's sessions. +Returns the status for the POST request. + +This operation is performed by calling function `terminateGroupsSessions`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-groups-terminate-sessions/). + + + +```ts +await client.sessionTermination.terminateGroupsSessions({ + groupIds: [group.id], +} satisfies TerminateGroupsSessionsRequestBody); +``` + +### Arguments + +- requestBody `TerminateGroupsSessionsRequestBody` + - Request body of terminateGroupsSessions method +- headers `TerminateGroupsSessionsHeaders` + - Headers of terminateGroupsSessions method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `SessionTerminationMessage`. + +Returns a message about the request status. diff --git a/docs/sharedLinksFiles.md b/docs/sharedLinksFiles.md new file mode 100644 index 00000000..15562c54 --- /dev/null +++ b/docs/sharedLinksFiles.md @@ -0,0 +1,209 @@ +# SharedLinksFilesManager + +- [Find file for shared link](#find-file-for-shared-link) +- [Get shared link for file](#get-shared-link-for-file) +- [Add shared link to file](#add-shared-link-to-file) +- [Update shared link on file](#update-shared-link-on-file) +- [Remove shared link from file](#remove-shared-link-from-file) + +## Find file for shared link + +Returns the file represented by a shared link. + +A shared file can be represented by a shared link, +which can originate within the current enterprise or within another. + +This endpoint allows an application to retrieve information about a +shared file when only given a shared link. + +The `shared_link_permission_options` array field can be returned +by requesting it in the `fields` query parameter. + +This operation is performed by calling function `findFileForSharedLink`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-shared-items/). + + + +```ts +await userClient.sharedLinksFiles.findFileForSharedLink( + {} satisfies FindFileForSharedLinkQueryParams, + new FindFileForSharedLinkHeaders({ + boxapi: ''.concat( + 'shared_link=', + fileFromApi.sharedLink!.url, + '&shared_link_password=incorrectPassword' + ) as string, + }) +); +``` + +### Arguments + +- queryParams `FindFileForSharedLinkQueryParams` + - Query parameters of findFileForSharedLink method +- headers `FindFileForSharedLinkHeaders` + - Headers of findFileForSharedLink method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FileFull`. + +Returns a full file resource if the shared link is valid and +the user has access to it. + +## Get shared link for file + +Gets the information for a shared link on a file. + +This operation is performed by calling function `getSharedLinkForFile`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-files-id-get-shared-link/). + + + +```ts +await client.sharedLinksFiles.getSharedLinkForFile(fileId, { + fields: 'shared_link', +} satisfies GetSharedLinkForFileQueryParams); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- queryParams `GetSharedLinkForFileQueryParams` + - Query parameters of getSharedLinkForFile method +- headers `GetSharedLinkForFileHeaders` + - Headers of getSharedLinkForFile method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FileFull`. + +Returns the base representation of a file with the +additional shared link information. + +## Add shared link to file + +Adds a shared link to a file. + +This operation is performed by calling function `addShareLinkToFile`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-files-id-add-shared-link/). + + + +```ts +await client.sharedLinksFiles.addShareLinkToFile( + fileId, + { + sharedLink: { + access: 'open' as AddShareLinkToFileRequestBodySharedLinkAccessField, + password: 'Secret123@', + } satisfies AddShareLinkToFileRequestBodySharedLinkField, + } satisfies AddShareLinkToFileRequestBody, + { fields: 'shared_link' } satisfies AddShareLinkToFileQueryParams +); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- requestBody `AddShareLinkToFileRequestBody` + - Request body of addShareLinkToFile method +- queryParams `AddShareLinkToFileQueryParams` + - Query parameters of addShareLinkToFile method +- headers `AddShareLinkToFileHeaders` + - Headers of addShareLinkToFile method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FileFull`. + +Returns the base representation of a file with a new shared +link attached. + +## Update shared link on file + +Updates a shared link on a file. + +This operation is performed by calling function `updateSharedLinkOnFile`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-files-id-update-shared-link/). + + + +```ts +await client.sharedLinksFiles.updateSharedLinkOnFile( + fileId, + { + sharedLink: { + access: + 'collaborators' as UpdateSharedLinkOnFileRequestBodySharedLinkAccessField, + } satisfies UpdateSharedLinkOnFileRequestBodySharedLinkField, + } satisfies UpdateSharedLinkOnFileRequestBody, + { fields: 'shared_link' } satisfies UpdateSharedLinkOnFileQueryParams +); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- requestBody `UpdateSharedLinkOnFileRequestBody` + - Request body of updateSharedLinkOnFile method +- queryParams `UpdateSharedLinkOnFileQueryParams` + - Query parameters of updateSharedLinkOnFile method +- headers `UpdateSharedLinkOnFileHeaders` + - Headers of updateSharedLinkOnFile method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FileFull`. + +Returns a basic representation of the file, with the updated shared +link attached. + +## Remove shared link from file + +Removes a shared link from a file. + +This operation is performed by calling function `removeSharedLinkFromFile`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-files-id-remove-shared-link/). + +_Currently we don't have an example for calling `removeSharedLinkFromFile` in integration tests_ + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- requestBody `RemoveSharedLinkFromFileRequestBody` + - Request body of removeSharedLinkFromFile method +- queryParams `RemoveSharedLinkFromFileQueryParams` + - Query parameters of removeSharedLinkFromFile method +- headers `RemoveSharedLinkFromFileHeaders` + - Headers of removeSharedLinkFromFile method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FileFull`. + +Returns a basic representation of a file, with the shared link removed. diff --git a/docs/sharedLinksFolders.md b/docs/sharedLinksFolders.md new file mode 100644 index 00000000..0446c290 --- /dev/null +++ b/docs/sharedLinksFolders.md @@ -0,0 +1,206 @@ +# SharedLinksFoldersManager + +- [Find folder for shared link](#find-folder-for-shared-link) +- [Get shared link for folder](#get-shared-link-for-folder) +- [Add shared link to folder](#add-shared-link-to-folder) +- [Update shared link on folder](#update-shared-link-on-folder) +- [Remove shared link from folder](#remove-shared-link-from-folder) + +## Find folder for shared link + +Return the folder represented by a shared link. + +A shared folder can be represented by a shared link, +which can originate within the current enterprise or within another. + +This endpoint allows an application to retrieve information about a +shared folder when only given a shared link. + +This operation is performed by calling function `findFolderForSharedLink`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-shared-items-folders/). + + + +```ts +await userClient.sharedLinksFolders.findFolderForSharedLink( + {} satisfies FindFolderForSharedLinkQueryParams, + new FindFolderForSharedLinkHeaders({ + boxapi: ''.concat( + 'shared_link=', + folderFromApi.sharedLink!.url, + '&shared_link_password=incorrectPassword' + ) as string, + }) +); +``` + +### Arguments + +- queryParams `FindFolderForSharedLinkQueryParams` + - Query parameters of findFolderForSharedLink method +- headers `FindFolderForSharedLinkHeaders` + - Headers of findFolderForSharedLink method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FolderFull`. + +Returns a full folder resource if the shared link is valid and +the user has access to it. + +## Get shared link for folder + +Gets the information for a shared link on a folder. + +This operation is performed by calling function `getSharedLinkForFolder`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-folders-id-get-shared-link/). + + + +```ts +await client.sharedLinksFolders.getSharedLinkForFolder(folder.id, { + fields: 'shared_link', +} satisfies GetSharedLinkForFolderQueryParams); +``` + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" +- queryParams `GetSharedLinkForFolderQueryParams` + - Query parameters of getSharedLinkForFolder method +- headers `GetSharedLinkForFolderHeaders` + - Headers of getSharedLinkForFolder method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FolderFull`. + +Returns the base representation of a folder with the +additional shared link information. + +## Add shared link to folder + +Adds a shared link to a folder. + +This operation is performed by calling function `addShareLinkToFolder`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-folders-id-add-shared-link/). + + + +```ts +await client.sharedLinksFolders.addShareLinkToFolder( + folder.id, + { + sharedLink: { + access: 'open' as AddShareLinkToFolderRequestBodySharedLinkAccessField, + password: 'Secret123@', + } satisfies AddShareLinkToFolderRequestBodySharedLinkField, + } satisfies AddShareLinkToFolderRequestBody, + { fields: 'shared_link' } satisfies AddShareLinkToFolderQueryParams +); +``` + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" +- requestBody `AddShareLinkToFolderRequestBody` + - Request body of addShareLinkToFolder method +- queryParams `AddShareLinkToFolderQueryParams` + - Query parameters of addShareLinkToFolder method +- headers `AddShareLinkToFolderHeaders` + - Headers of addShareLinkToFolder method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FolderFull`. + +Returns the base representation of a folder with a new shared +link attached. + +## Update shared link on folder + +Updates a shared link on a folder. + +This operation is performed by calling function `updateSharedLinkOnFolder`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-folders-id-update-shared-link/). + + + +```ts +await client.sharedLinksFolders.updateSharedLinkOnFolder( + folder.id, + { + sharedLink: { + access: + 'collaborators' as UpdateSharedLinkOnFolderRequestBodySharedLinkAccessField, + } satisfies UpdateSharedLinkOnFolderRequestBodySharedLinkField, + } satisfies UpdateSharedLinkOnFolderRequestBody, + { fields: 'shared_link' } satisfies UpdateSharedLinkOnFolderQueryParams +); +``` + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" +- requestBody `UpdateSharedLinkOnFolderRequestBody` + - Request body of updateSharedLinkOnFolder method +- queryParams `UpdateSharedLinkOnFolderQueryParams` + - Query parameters of updateSharedLinkOnFolder method +- headers `UpdateSharedLinkOnFolderHeaders` + - Headers of updateSharedLinkOnFolder method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FolderFull`. + +Returns a basic representation of the folder, with the updated shared +link attached. + +## Remove shared link from folder + +Removes a shared link from a folder. + +This operation is performed by calling function `removeSharedLinkFromFolder`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-folders-id-remove-shared-link/). + +_Currently we don't have an example for calling `removeSharedLinkFromFolder` in integration tests_ + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" +- requestBody `RemoveSharedLinkFromFolderRequestBody` + - Request body of removeSharedLinkFromFolder method +- queryParams `RemoveSharedLinkFromFolderQueryParams` + - Query parameters of removeSharedLinkFromFolder method +- headers `RemoveSharedLinkFromFolderHeaders` + - Headers of removeSharedLinkFromFolder method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FolderFull`. + +Returns a basic representation of a folder, with the shared link removed. diff --git a/docs/sharedLinksWebLinks.md b/docs/sharedLinksWebLinks.md new file mode 100644 index 00000000..96d31252 --- /dev/null +++ b/docs/sharedLinksWebLinks.md @@ -0,0 +1,207 @@ +# SharedLinksWebLinksManager + +- [Find web link for shared link](#find-web-link-for-shared-link) +- [Get shared link for web link](#get-shared-link-for-web-link) +- [Add shared link to web link](#add-shared-link-to-web-link) +- [Update shared link on web link](#update-shared-link-on-web-link) +- [Remove shared link from web link](#remove-shared-link-from-web-link) + +## Find web link for shared link + +Returns the web link represented by a shared link. + +A shared web link can be represented by a shared link, +which can originate within the current enterprise or within another. + +This endpoint allows an application to retrieve information about a +shared web link when only given a shared link. + +This operation is performed by calling function `findWebLinkForSharedLink`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-shared-items-web-links/). + + + +```ts +await userClient.sharedLinksWebLinks.findWebLinkForSharedLink( + {} satisfies FindWebLinkForSharedLinkQueryParams, + new FindWebLinkForSharedLinkHeaders({ + boxapi: ''.concat( + 'shared_link=', + webLinkFromApi.sharedLink!.url, + '&shared_link_password=incorrectPassword' + ) as string, + }) +); +``` + +### Arguments + +- queryParams `FindWebLinkForSharedLinkQueryParams` + - Query parameters of findWebLinkForSharedLink method +- headers `FindWebLinkForSharedLinkHeaders` + - Headers of findWebLinkForSharedLink method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `WebLink`. + +Returns a full file resource if the shared link is valid and +the user has access to it. + +## Get shared link for web link + +Gets the information for a shared link on a web link. + +This operation is performed by calling function `getSharedLinkForWebLink`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-web-links-id-get-shared-link/). + + + +```ts +await client.sharedLinksWebLinks.getSharedLinkForWebLink(webLinkId, { + fields: 'shared_link', +} satisfies GetSharedLinkForWebLinkQueryParams); +``` + +### Arguments + +- webLinkId `string` + - The ID of the web link. Example: "12345" +- queryParams `GetSharedLinkForWebLinkQueryParams` + - Query parameters of getSharedLinkForWebLink method +- headers `GetSharedLinkForWebLinkHeaders` + - Headers of getSharedLinkForWebLink method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `WebLink`. + +Returns the base representation of a web link with the +additional shared link information. + +## Add shared link to web link + +Adds a shared link to a web link. + +This operation is performed by calling function `addShareLinkToWebLink`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-web-links-id-add-shared-link/). + + + +```ts +await client.sharedLinksWebLinks.addShareLinkToWebLink( + webLinkId, + { + sharedLink: { + access: 'open' as AddShareLinkToWebLinkRequestBodySharedLinkAccessField, + password: 'Secret123@', + } satisfies AddShareLinkToWebLinkRequestBodySharedLinkField, + } satisfies AddShareLinkToWebLinkRequestBody, + { fields: 'shared_link' } satisfies AddShareLinkToWebLinkQueryParams +); +``` + +### Arguments + +- webLinkId `string` + - The ID of the web link. Example: "12345" +- requestBody `AddShareLinkToWebLinkRequestBody` + - Request body of addShareLinkToWebLink method +- queryParams `AddShareLinkToWebLinkQueryParams` + - Query parameters of addShareLinkToWebLink method +- headers `AddShareLinkToWebLinkHeaders` + - Headers of addShareLinkToWebLink method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `WebLink`. + +Returns the base representation of a web link with a new shared +link attached. + +## Update shared link on web link + +Updates a shared link on a web link. + +This operation is performed by calling function `updateSharedLinkOnWebLink`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-web-links-id-update-shared-link/). + + + +```ts +await client.sharedLinksWebLinks.updateSharedLinkOnWebLink( + webLinkId, + { + sharedLink: { + access: + 'collaborators' as UpdateSharedLinkOnWebLinkRequestBodySharedLinkAccessField, + } satisfies UpdateSharedLinkOnWebLinkRequestBodySharedLinkField, + } satisfies UpdateSharedLinkOnWebLinkRequestBody, + { fields: 'shared_link' } satisfies UpdateSharedLinkOnWebLinkQueryParams +); +``` + +### Arguments + +- webLinkId `string` + - The ID of the web link. Example: "12345" +- requestBody `UpdateSharedLinkOnWebLinkRequestBody` + - Request body of updateSharedLinkOnWebLink method +- queryParams `UpdateSharedLinkOnWebLinkQueryParams` + - Query parameters of updateSharedLinkOnWebLink method +- headers `UpdateSharedLinkOnWebLinkHeaders` + - Headers of updateSharedLinkOnWebLink method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `WebLink`. + +Returns a basic representation of the web link, with the updated shared +link attached. + +## Remove shared link from web link + +Removes a shared link from a web link. + +This operation is performed by calling function `removeSharedLinkFromWebLink`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-web-links-id-remove-shared-link/). + +_Currently we don't have an example for calling `removeSharedLinkFromWebLink` in integration tests_ + +### Arguments + +- webLinkId `string` + - The ID of the web link. Example: "12345" +- requestBody `RemoveSharedLinkFromWebLinkRequestBody` + - Request body of removeSharedLinkFromWebLink method +- queryParams `RemoveSharedLinkFromWebLinkQueryParams` + - Query parameters of removeSharedLinkFromWebLink method +- headers `RemoveSharedLinkFromWebLinkHeaders` + - Headers of removeSharedLinkFromWebLink method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `WebLink`. + +Returns a basic representation of a web link, with the +shared link removed. diff --git a/docs/shieldInformationBarrierReports.md b/docs/shieldInformationBarrierReports.md new file mode 100644 index 00000000..2d1bc4f9 --- /dev/null +++ b/docs/shieldInformationBarrierReports.md @@ -0,0 +1,108 @@ +# ShieldInformationBarrierReportsManager + +- [List shield information barrier reports](#list-shield-information-barrier-reports) +- [Create shield information barrier report](#create-shield-information-barrier-report) +- [Get shield information barrier report by ID](#get-shield-information-barrier-report-by-id) + +## List shield information barrier reports + +Lists shield information barrier reports. + +This operation is performed by calling function `getShieldInformationBarrierReports`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-shield-information-barrier-reports/). + + + +```ts +await client.shieldInformationBarrierReports.getShieldInformationBarrierReports( + { + shieldInformationBarrierId: barrierId, + } satisfies GetShieldInformationBarrierReportsQueryParams +); +``` + +### Arguments + +- queryParams `GetShieldInformationBarrierReportsQueryParams` + - Query parameters of getShieldInformationBarrierReports method +- headers `GetShieldInformationBarrierReportsHeaders` + - Headers of getShieldInformationBarrierReports method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ShieldInformationBarrierReports`. + +Returns a paginated list of shield information barrier report objects. + +## Create shield information barrier report + +Creates a shield information barrier report for a given barrier. + +This operation is performed by calling function `createShieldInformationBarrierReport`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-shield-information-barrier-reports/). + + + +```ts +await client.shieldInformationBarrierReports.createShieldInformationBarrierReport( + { + shieldInformationBarrier: { + id: barrierId, + type: 'shield_information_barrier' as ShieldInformationBarrierBaseTypeField, + } satisfies ShieldInformationBarrierBase, + } satisfies ShieldInformationBarrierReference +); +``` + +### Arguments + +- requestBody `ShieldInformationBarrierReference` + - Request body of createShieldInformationBarrierReport method +- headers `CreateShieldInformationBarrierReportHeaders` + - Headers of createShieldInformationBarrierReport method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ShieldInformationBarrierReport`. + +Returns the shield information barrier report information object. + +## Get shield information barrier report by ID + +Retrieves a shield information barrier report by its ID. + +This operation is performed by calling function `getShieldInformationBarrierReportById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-shield-information-barrier-reports-id/). + + + +```ts +await client.shieldInformationBarrierReports.getShieldInformationBarrierReportById( + createdReport.id! +); +``` + +### Arguments + +- shieldInformationBarrierReportId `string` + - The ID of the shield information barrier Report. Example: "3423" +- headers `GetShieldInformationBarrierReportByIdHeaders` + - Headers of getShieldInformationBarrierReportById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ShieldInformationBarrierReport`. + +Returns the shield information barrier report object. diff --git a/docs/shieldInformationBarrierSegmentMembers.md b/docs/shieldInformationBarrierSegmentMembers.md new file mode 100644 index 00000000..ae189920 --- /dev/null +++ b/docs/shieldInformationBarrierSegmentMembers.md @@ -0,0 +1,150 @@ +# ShieldInformationBarrierSegmentMembersManager + +- [Get shield information barrier segment member by ID](#get-shield-information-barrier-segment-member-by-id) +- [Delete shield information barrier segment member by ID](#delete-shield-information-barrier-segment-member-by-id) +- [List shield information barrier segment members](#list-shield-information-barrier-segment-members) +- [Create shield information barrier segment member](#create-shield-information-barrier-segment-member) + +## Get shield information barrier segment member by ID + +Retrieves a shield information barrier +segment member by its ID. + +This operation is performed by calling function `getShieldInformationBarrierSegmentMemberById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-shield-information-barrier-segment-members-id/). + + + +```ts +await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMemberById( + segmentMember.id! +); +``` + +### Arguments + +- shieldInformationBarrierSegmentMemberId `string` + - The ID of the shield information barrier segment Member. Example: "7815" +- headers `GetShieldInformationBarrierSegmentMemberByIdHeaders` + - Headers of getShieldInformationBarrierSegmentMemberById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ShieldInformationBarrierSegmentMember`. + +Returns the shield information barrier segment member object. + +## Delete shield information barrier segment member by ID + +Deletes a shield information barrier +segment member based on provided ID. + +This operation is performed by calling function `deleteShieldInformationBarrierSegmentMemberById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-shield-information-barrier-segment-members-id/). + + + +```ts +await client.shieldInformationBarrierSegmentMembers.deleteShieldInformationBarrierSegmentMemberById( + segmentMember.id! +); +``` + +### Arguments + +- shieldInformationBarrierSegmentMemberId `string` + - The ID of the shield information barrier segment Member. Example: "7815" +- headers `DeleteShieldInformationBarrierSegmentMemberByIdHeaders` + - Headers of deleteShieldInformationBarrierSegmentMemberById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response if the +segment member was deleted successfully. + +## List shield information barrier segment members + +Lists shield information barrier segment members +based on provided segment IDs. + +This operation is performed by calling function `getShieldInformationBarrierSegmentMembers`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-shield-information-barrier-segment-members/). + + + +```ts +await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMembers( + { + shieldInformationBarrierSegmentId: segment.id!, + } satisfies GetShieldInformationBarrierSegmentMembersQueryParams +); +``` + +### Arguments + +- queryParams `GetShieldInformationBarrierSegmentMembersQueryParams` + - Query parameters of getShieldInformationBarrierSegmentMembers method +- headers `GetShieldInformationBarrierSegmentMembersHeaders` + - Headers of getShieldInformationBarrierSegmentMembers method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ShieldInformationBarrierSegmentMembers`. + +Returns a paginated list of +shield information barrier segment member objects. + +## Create shield information barrier segment member + +Creates a new shield information barrier segment member. + +This operation is performed by calling function `createShieldInformationBarrierSegmentMember`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-shield-information-barrier-segment-members/). + + + +```ts +await client.shieldInformationBarrierSegmentMembers.createShieldInformationBarrierSegmentMember( + { + shieldInformationBarrierSegment: { + id: segment.id!, + type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentTypeField, + } satisfies CreateShieldInformationBarrierSegmentMemberRequestBodyShieldInformationBarrierSegmentField, + user: { + id: getEnvVar('USER_ID'), + type: 'user' as UserBaseTypeField, + } satisfies UserBase, + } satisfies CreateShieldInformationBarrierSegmentMemberRequestBody +); +``` + +### Arguments + +- requestBody `CreateShieldInformationBarrierSegmentMemberRequestBody` + - Request body of createShieldInformationBarrierSegmentMember method +- headers `CreateShieldInformationBarrierSegmentMemberHeaders` + - Headers of createShieldInformationBarrierSegmentMember method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ShieldInformationBarrierSegmentMember`. + +Returns a new shield information barrier segment member object. diff --git a/docs/shieldInformationBarrierSegmentRestrictions.md b/docs/shieldInformationBarrierSegmentRestrictions.md new file mode 100644 index 00000000..7af53a8e --- /dev/null +++ b/docs/shieldInformationBarrierSegmentRestrictions.md @@ -0,0 +1,153 @@ +# ShieldInformationBarrierSegmentRestrictionsManager + +- [Get shield information barrier segment restriction by ID](#get-shield-information-barrier-segment-restriction-by-id) +- [Delete shield information barrier segment restriction by ID](#delete-shield-information-barrier-segment-restriction-by-id) +- [List shield information barrier segment restrictions](#list-shield-information-barrier-segment-restrictions) +- [Create shield information barrier segment restriction](#create-shield-information-barrier-segment-restriction) + +## Get shield information barrier segment restriction by ID + +Retrieves a shield information barrier segment +restriction based on provided ID. + +This operation is performed by calling function `getShieldInformationBarrierSegmentRestrictionById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-shield-information-barrier-segment-restrictions-id/). + + + +```ts +await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictionById( + segmentRestrictionId +); +``` + +### Arguments + +- shieldInformationBarrierSegmentRestrictionId `string` + - The ID of the shield information barrier segment Restriction. Example: "4563" +- headers `GetShieldInformationBarrierSegmentRestrictionByIdHeaders` + - Headers of getShieldInformationBarrierSegmentRestrictionById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ShieldInformationBarrierSegmentRestriction`. + +Returns the shield information barrier segment +restriction object. + +## Delete shield information barrier segment restriction by ID + +Delete shield information barrier segment restriction +based on provided ID. + +This operation is performed by calling function `deleteShieldInformationBarrierSegmentRestrictionById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-shield-information-barrier-segment-restrictions-id/). + + + +```ts +await client.shieldInformationBarrierSegmentRestrictions.deleteShieldInformationBarrierSegmentRestrictionById( + segmentRestrictionId +); +``` + +### Arguments + +- shieldInformationBarrierSegmentRestrictionId `string` + - The ID of the shield information barrier segment Restriction. Example: "4563" +- headers `DeleteShieldInformationBarrierSegmentRestrictionByIdHeaders` + - Headers of deleteShieldInformationBarrierSegmentRestrictionById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Empty body in response + +## List shield information barrier segment restrictions + +Lists shield information barrier segment restrictions +based on provided segment ID. + +This operation is performed by calling function `getShieldInformationBarrierSegmentRestrictions`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-shield-information-barrier-segment-restrictions/). + + + +```ts +await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictions( + { + shieldInformationBarrierSegmentId: segmentId, + } satisfies GetShieldInformationBarrierSegmentRestrictionsQueryParams +); +``` + +### Arguments + +- queryParams `GetShieldInformationBarrierSegmentRestrictionsQueryParams` + - Query parameters of getShieldInformationBarrierSegmentRestrictions method +- headers `GetShieldInformationBarrierSegmentRestrictionsHeaders` + - Headers of getShieldInformationBarrierSegmentRestrictions method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ShieldInformationBarrierSegmentRestrictions`. + +Returns a paginated list of +shield information barrier segment restriction objects. + +## Create shield information barrier segment restriction + +Creates a shield information barrier +segment restriction object. + +This operation is performed by calling function `createShieldInformationBarrierSegmentRestriction`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-shield-information-barrier-segment-restrictions/). + + + +```ts +await client.shieldInformationBarrierSegmentRestrictions.createShieldInformationBarrierSegmentRestriction( + { + restrictedSegment: { + id: segmentToRestrictId, + type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentTypeField, + } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyRestrictedSegmentField, + shieldInformationBarrierSegment: { + id: segmentId, + type: 'shield_information_barrier_segment' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentTypeField, + } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBodyShieldInformationBarrierSegmentField, + type: 'shield_information_barrier_segment_restriction' as CreateShieldInformationBarrierSegmentRestrictionRequestBodyTypeField, + } satisfies CreateShieldInformationBarrierSegmentRestrictionRequestBody +); +``` + +### Arguments + +- requestBody `CreateShieldInformationBarrierSegmentRestrictionRequestBody` + - Request body of createShieldInformationBarrierSegmentRestriction method +- headers `CreateShieldInformationBarrierSegmentRestrictionHeaders` + - Headers of createShieldInformationBarrierSegmentRestriction method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ShieldInformationBarrierSegmentRestriction`. + +Returns the newly created Shield +Information Barrier Segment Restriction object. diff --git a/docs/shieldInformationBarrierSegments.md b/docs/shieldInformationBarrierSegments.md new file mode 100644 index 00000000..eb7aa249 --- /dev/null +++ b/docs/shieldInformationBarrierSegments.md @@ -0,0 +1,183 @@ +# ShieldInformationBarrierSegmentsManager + +- [Get shield information barrier segment with specified ID](#get-shield-information-barrier-segment-with-specified-id) +- [Update shield information barrier segment with specified ID](#update-shield-information-barrier-segment-with-specified-id) +- [Delete shield information barrier segment](#delete-shield-information-barrier-segment) +- [List shield information barrier segments](#list-shield-information-barrier-segments) +- [Create shield information barrier segment](#create-shield-information-barrier-segment) + +## Get shield information barrier segment with specified ID + +Retrieves shield information barrier segment based on provided ID.. + +This operation is performed by calling function `getShieldInformationBarrierSegmentById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-shield-information-barrier-segments-id/). + + + +```ts +await client.shieldInformationBarrierSegments.getShieldInformationBarrierSegmentById( + segmentId +); +``` + +### Arguments + +- shieldInformationBarrierSegmentId `string` + - The ID of the shield information barrier segment. Example: "3423" +- headers `GetShieldInformationBarrierSegmentByIdHeaders` + - Headers of getShieldInformationBarrierSegmentById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ShieldInformationBarrierSegment`. + +Returns the shield information barrier segment object. + +## Update shield information barrier segment with specified ID + +Updates the shield information barrier segment based on provided ID.. + +This operation is performed by calling function `updateShieldInformationBarrierSegmentById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-shield-information-barrier-segments-id/). + + + +```ts +await client.shieldInformationBarrierSegments.updateShieldInformationBarrierSegmentById( + segmentId, + { + description: updatedSegmentDescription, + } satisfies UpdateShieldInformationBarrierSegmentByIdRequestBody +); +``` + +### Arguments + +- shieldInformationBarrierSegmentId `string` + - The ID of the shield information barrier segment. Example: "3423" +- requestBody `UpdateShieldInformationBarrierSegmentByIdRequestBody` + - Request body of updateShieldInformationBarrierSegmentById method +- headers `UpdateShieldInformationBarrierSegmentByIdHeaders` + - Headers of updateShieldInformationBarrierSegmentById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ShieldInformationBarrierSegment`. + +Returns the updated shield information barrier segment object. + +## Delete shield information barrier segment + +Deletes the shield information barrier segment +based on provided ID. + +This operation is performed by calling function `deleteShieldInformationBarrierSegmentById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-shield-information-barrier-segments-id/). + + + +```ts +await client.shieldInformationBarrierSegments.deleteShieldInformationBarrierSegmentById( + segmentId +); +``` + +### Arguments + +- shieldInformationBarrierSegmentId `string` + - The ID of the shield information barrier segment. Example: "3423" +- headers `DeleteShieldInformationBarrierSegmentByIdHeaders` + - Headers of deleteShieldInformationBarrierSegmentById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Empty body in response + +## List shield information barrier segments + +Retrieves a list of shield information barrier segment objects +for the specified Information Barrier ID. + +This operation is performed by calling function `getShieldInformationBarrierSegments`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-shield-information-barrier-segments/). + + + +```ts +await client.shieldInformationBarrierSegments.getShieldInformationBarrierSegments( + { + shieldInformationBarrierId: barrierId, + } satisfies GetShieldInformationBarrierSegmentsQueryParams +); +``` + +### Arguments + +- queryParams `GetShieldInformationBarrierSegmentsQueryParams` + - Query parameters of getShieldInformationBarrierSegments method +- headers `GetShieldInformationBarrierSegmentsHeaders` + - Headers of getShieldInformationBarrierSegments method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ShieldInformationBarrierSegments`. + +Returns a paginated list of shield information barrier segment objects. + +## Create shield information barrier segment + +Creates a shield information barrier segment. + +This operation is performed by calling function `createShieldInformationBarrierSegment`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-shield-information-barrier-segments/). + + + +```ts +await client.shieldInformationBarrierSegments.createShieldInformationBarrierSegment( + { + shieldInformationBarrier: { + id: barrierId, + type: 'shield_information_barrier' as ShieldInformationBarrierBaseTypeField, + } satisfies ShieldInformationBarrierBase, + name: segmentName, + description: segmentDescription, + } satisfies CreateShieldInformationBarrierSegmentRequestBody +); +``` + +### Arguments + +- requestBody `CreateShieldInformationBarrierSegmentRequestBody` + - Request body of createShieldInformationBarrierSegment method +- headers `CreateShieldInformationBarrierSegmentHeaders` + - Headers of createShieldInformationBarrierSegment method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ShieldInformationBarrierSegment`. + +Returns a new shield information barrier segment object. diff --git a/docs/shieldInformationBarriers.md b/docs/shieldInformationBarriers.md new file mode 100644 index 00000000..62a79c0d --- /dev/null +++ b/docs/shieldInformationBarriers.md @@ -0,0 +1,142 @@ +# ShieldInformationBarriersManager + +- [Get shield information barrier with specified ID](#get-shield-information-barrier-with-specified-id) +- [Add changed status of shield information barrier with specified ID](#add-changed-status-of-shield-information-barrier-with-specified-id) +- [List shield information barriers](#list-shield-information-barriers) +- [Create shield information barrier](#create-shield-information-barrier) + +## Get shield information barrier with specified ID + +Get shield information barrier based on provided ID. + +This operation is performed by calling function `getShieldInformationBarrierById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-shield-information-barriers-id/). + + + +```ts +await client.shieldInformationBarriers.getShieldInformationBarrierById( + barrierId +); +``` + +### Arguments + +- shieldInformationBarrierId `string` + - The ID of the shield information barrier. Example: "1910967" +- headers `GetShieldInformationBarrierByIdHeaders` + - Headers of getShieldInformationBarrierById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ShieldInformationBarrier`. + +Returns the shield information barrier object. + +## Add changed status of shield information barrier with specified ID + +Change status of shield information barrier with the specified ID. + +This operation is performed by calling function `updateShieldInformationBarrierStatus`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-shield-information-barriers-change-status/). + + + +```ts +await client.shieldInformationBarriers.updateShieldInformationBarrierStatus({ + id: barrierId, + status: + 'disabled' as UpdateShieldInformationBarrierStatusRequestBodyStatusField, +} satisfies UpdateShieldInformationBarrierStatusRequestBody); +``` + +### Arguments + +- requestBody `UpdateShieldInformationBarrierStatusRequestBody` + - Request body of updateShieldInformationBarrierStatus method +- headers `UpdateShieldInformationBarrierStatusHeaders` + - Headers of updateShieldInformationBarrierStatus method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ShieldInformationBarrier`. + +Returns the updated shield information barrier object. + +## List shield information barriers + +Retrieves a list of shield information barrier objects +for the enterprise of JWT. + +This operation is performed by calling function `getShieldInformationBarriers`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-shield-information-barriers/). + + + +```ts +await client.shieldInformationBarriers.getShieldInformationBarriers(); +``` + +### Arguments + +- queryParams `GetShieldInformationBarriersQueryParams` + - Query parameters of getShieldInformationBarriers method +- headers `GetShieldInformationBarriersHeaders` + - Headers of getShieldInformationBarriers method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ShieldInformationBarriers`. + +Returns a paginated list of +shield information barrier objects, +empty list if currently no barrier. + +## Create shield information barrier + +Creates a shield information barrier to +separate individuals/groups within the same +firm and prevents confidential information passing between them. + +This operation is performed by calling function `createShieldInformationBarrier`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-shield-information-barriers/). + + + +```ts +await client.shieldInformationBarriers.createShieldInformationBarrier({ + enterprise: { + id: enterpriseId, + type: 'enterprise' as EnterpriseBaseTypeField, + } satisfies EnterpriseBase, +} satisfies CreateShieldInformationBarrierRequestBody); +``` + +### Arguments + +- requestBody `CreateShieldInformationBarrierRequestBody` + - Request body of createShieldInformationBarrier method +- headers `CreateShieldInformationBarrierHeaders` + - Headers of createShieldInformationBarrier method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ShieldInformationBarrier`. + +Returns a new shield information barrier object. diff --git a/docs/signTemplates.md b/docs/signTemplates.md new file mode 100644 index 00000000..f598aa55 --- /dev/null +++ b/docs/signTemplates.md @@ -0,0 +1,66 @@ +# SignTemplatesManager + +- [List Box Sign templates](#list-box-sign-templates) +- [Get Box Sign template by ID](#get-box-sign-template-by-id) + +## List Box Sign templates + +Gets Box Sign templates created by a user. + +This operation is performed by calling function `getSignTemplates`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-sign-templates/). + + + +```ts +await client.signTemplates.getSignTemplates({ + limit: 2, +} satisfies GetSignTemplatesQueryParams); +``` + +### Arguments + +- queryParams `GetSignTemplatesQueryParams` + - Query parameters of getSignTemplates method +- headers `GetSignTemplatesHeaders` + - Headers of getSignTemplates method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `SignTemplates`. + +Returns a collection of templates. + +## Get Box Sign template by ID + +Fetches details of a specific Box Sign template. + +This operation is performed by calling function `getSignTemplateById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-sign-templates-id/). + + + +```ts +await client.signTemplates.getSignTemplateById(signTemplates.entries![0].id!); +``` + +### Arguments + +- templateId `string` + - The ID of a Box Sign template. Example: "123075213-7d117509-8f05-42e4-a5ef-5190a319d41d" +- headers `GetSignTemplateByIdHeaders` + - Headers of getSignTemplateById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `SignTemplate`. + +Returns details of a template. diff --git a/docs/skills.md b/docs/skills.md new file mode 100644 index 00000000..55227f09 --- /dev/null +++ b/docs/skills.md @@ -0,0 +1,150 @@ +# SkillsManager + +- [List Box Skill cards on file](#list-box-skill-cards-on-file) +- [Create Box Skill cards on file](#create-box-skill-cards-on-file) +- [Update Box Skill cards on file](#update-box-skill-cards-on-file) +- [Remove Box Skill cards from file](#remove-box-skill-cards-from-file) +- [Update all Box Skill cards on file](#update-all-box-skill-cards-on-file) + +## List Box Skill cards on file + +List the Box Skills metadata cards that are attached to a file. + +This operation is performed by calling function `getBoxSkillCardsOnFile`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-files-id-metadata-global-box-skills-cards/). + +_Currently we don't have an example for calling `getBoxSkillCardsOnFile` in integration tests_ + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- headers `GetBoxSkillCardsOnFileHeaders` + - Headers of getBoxSkillCardsOnFile method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `SkillCardsMetadata`. + +Returns all the metadata associated with a file. + +This API does not support pagination and will therefore always return +all of the metadata associated to the file. + +## Create Box Skill cards on file + +Applies one or more Box Skills metadata cards to a file. + +This operation is performed by calling function `createBoxSkillCardsOnFile`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-files-id-metadata-global-box-skills-cards/). + +_Currently we don't have an example for calling `createBoxSkillCardsOnFile` in integration tests_ + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- requestBody `CreateBoxSkillCardsOnFileRequestBody` + - Request body of createBoxSkillCardsOnFile method +- headers `CreateBoxSkillCardsOnFileHeaders` + - Headers of createBoxSkillCardsOnFile method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `SkillCardsMetadata`. + +Returns the instance of the template that was applied to the file, +including the data that was applied to the template. + +## Update Box Skill cards on file + +Updates one or more Box Skills metadata cards to a file. + +This operation is performed by calling function `updateBoxSkillCardsOnFile`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-files-id-metadata-global-box-skills-cards/). + +_Currently we don't have an example for calling `updateBoxSkillCardsOnFile` in integration tests_ + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- requestBody `readonly UpdateBoxSkillCardsOnFileRequestBody[]` + - Request body of updateBoxSkillCardsOnFile method +- headers `UpdateBoxSkillCardsOnFileHeaders` + - Headers of updateBoxSkillCardsOnFile method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `SkillCardsMetadata`. + +Returns the updated metadata template, with the +custom template data included. + +## Remove Box Skill cards from file + +Removes any Box Skills cards metadata from a file. + +This operation is performed by calling function `deleteBoxSkillCardsFromFile`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-files-id-metadata-global-box-skills-cards/). + +_Currently we don't have an example for calling `deleteBoxSkillCardsFromFile` in integration tests_ + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- headers `DeleteBoxSkillCardsFromFileHeaders` + - Headers of deleteBoxSkillCardsFromFile method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the cards are +successfully deleted. + +## Update all Box Skill cards on file + +An alternative method that can be used to overwrite and update all Box Skill +metadata cards on a file. + +This operation is performed by calling function `updateAllSkillCardsOnFile`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-skill-invocations-id/). + +_Currently we don't have an example for calling `updateAllSkillCardsOnFile` in integration tests_ + +### Arguments + +- skillId `string` + - The ID of the skill to apply this metadata for. Example: "33243242" +- requestBody `UpdateAllSkillCardsOnFileRequestBody` + - Request body of updateAllSkillCardsOnFile method +- headers `UpdateAllSkillCardsOnFileHeaders` + - Headers of updateAllSkillCardsOnFile method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the card has been successfully updated. diff --git a/docs/storagePolicies.md b/docs/storagePolicies.md new file mode 100644 index 00000000..fa45d227 --- /dev/null +++ b/docs/storagePolicies.md @@ -0,0 +1,56 @@ +# StoragePoliciesManager + +- [List storage policies](#list-storage-policies) +- [Get storage policy](#get-storage-policy) + +## List storage policies + +Fetches all the storage policies in the enterprise. + +This operation is performed by calling function `getStoragePolicies`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-storage-policies/). + +_Currently we don't have an example for calling `getStoragePolicies` in integration tests_ + +### Arguments + +- queryParams `GetStoragePoliciesQueryParams` + - Query parameters of getStoragePolicies method +- headers `GetStoragePoliciesHeaders` + - Headers of getStoragePolicies method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `StoragePolicies`. + +Returns a collection of storage policies. + +## Get storage policy + +Fetches a specific storage policy. + +This operation is performed by calling function `getStoragePolicyById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-storage-policies-id/). + +_Currently we don't have an example for calling `getStoragePolicyById` in integration tests_ + +### Arguments + +- storagePolicyId `string` + - The ID of the storage policy. Example: "34342" +- headers `GetStoragePolicyByIdHeaders` + - Headers of getStoragePolicyById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `StoragePolicy`. + +Returns a storage policy object. diff --git a/docs/storagePolicyAssignments.md b/docs/storagePolicyAssignments.md new file mode 100644 index 00000000..4fd1680f --- /dev/null +++ b/docs/storagePolicyAssignments.md @@ -0,0 +1,148 @@ +# StoragePolicyAssignmentsManager + +- [List storage policy assignments](#list-storage-policy-assignments) +- [Assign storage policy](#assign-storage-policy) +- [Get storage policy assignment](#get-storage-policy-assignment) +- [Update storage policy assignment](#update-storage-policy-assignment) +- [Unassign storage policy](#unassign-storage-policy) + +## List storage policy assignments + +Fetches all the storage policy assignment for an enterprise or user. + +This operation is performed by calling function `getStoragePolicyAssignments`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-storage-policy-assignments/). + +_Currently we don't have an example for calling `getStoragePolicyAssignments` in integration tests_ + +### Arguments + +- queryParams `GetStoragePolicyAssignmentsQueryParams` + - Query parameters of getStoragePolicyAssignments method +- headers `GetStoragePolicyAssignmentsHeaders` + - Headers of getStoragePolicyAssignments method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `StoragePolicyAssignments`. + +Returns a collection of storage policies for +the enterprise or user. + +## Assign storage policy + +Creates a storage policy assignment for an enterprise or user. + +This operation is performed by calling function `createStoragePolicyAssignment`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-storage-policy-assignments/). + +_Currently we don't have an example for calling `createStoragePolicyAssignment` in integration tests_ + +### Arguments + +- requestBody `CreateStoragePolicyAssignmentRequestBody` + - Request body of createStoragePolicyAssignment method +- headers `CreateStoragePolicyAssignmentHeaders` + - Headers of createStoragePolicyAssignment method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `StoragePolicyAssignment`. + +Returns the new storage policy assignment created. + +## Get storage policy assignment + +Fetches a specific storage policy assignment. + +This operation is performed by calling function `getStoragePolicyAssignmentById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-storage-policy-assignments-id/). + +_Currently we don't have an example for calling `getStoragePolicyAssignmentById` in integration tests_ + +### Arguments + +- storagePolicyAssignmentId `string` + - The ID of the storage policy assignment. Example: "932483" +- headers `GetStoragePolicyAssignmentByIdHeaders` + - Headers of getStoragePolicyAssignmentById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `StoragePolicyAssignment`. + +Returns a storage policy assignment object. + +## Update storage policy assignment + +Updates a specific storage policy assignment. + +This operation is performed by calling function `updateStoragePolicyAssignmentById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-storage-policy-assignments-id/). + +_Currently we don't have an example for calling `updateStoragePolicyAssignmentById` in integration tests_ + +### Arguments + +- storagePolicyAssignmentId `string` + - The ID of the storage policy assignment. Example: "932483" +- requestBody `UpdateStoragePolicyAssignmentByIdRequestBody` + - Request body of updateStoragePolicyAssignmentById method +- headers `UpdateStoragePolicyAssignmentByIdHeaders` + - Headers of updateStoragePolicyAssignmentById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `StoragePolicyAssignment`. + +Returns an updated storage policy assignment object. + +## Unassign storage policy + +Delete a storage policy assignment. + +Deleting a storage policy assignment on a user +will have the user inherit the enterprise's default +storage policy. + +There is a rate limit for calling this endpoint of only +twice per user in a 24 hour time frame. + +This operation is performed by calling function `deleteStoragePolicyAssignmentById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-storage-policy-assignments-id/). + +_Currently we don't have an example for calling `deleteStoragePolicyAssignmentById` in integration tests_ + +### Arguments + +- storagePolicyAssignmentId `string` + - The ID of the storage policy assignment. Example: "932483" +- headers `DeleteStoragePolicyAssignmentByIdHeaders` + - Headers of deleteStoragePolicyAssignmentById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the storage policy +assignment is successfully deleted. diff --git a/docs/taskAssignments.md b/docs/taskAssignments.md new file mode 100644 index 00000000..64bfe7c8 --- /dev/null +++ b/docs/taskAssignments.md @@ -0,0 +1,146 @@ +# TaskAssignmentsManager + +- [List task assignments](#list-task-assignments) +- [Assign task](#assign-task) +- [Get task assignment](#get-task-assignment) +- [Update task assignment](#update-task-assignment) +- [Unassign task](#unassign-task) + +## List task assignments + +Lists all of the assignments for a given task. + +This operation is performed by calling function `getTaskAssignments`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-tasks-id-assignments/). + +_Currently we don't have an example for calling `getTaskAssignments` in integration tests_ + +### Arguments + +- taskId `string` + - The ID of the task. Example: "12345" +- headers `GetTaskAssignmentsHeaders` + - Headers of getTaskAssignments method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `TaskAssignments`. + +Returns a collection of task assignment defining what task on +a file has been assigned to which users and by who. + +## Assign task + +Assigns a task to a user. + +A task can be assigned to more than one user by creating multiple +assignments. + +This operation is performed by calling function `createTaskAssignment`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-task-assignments/). + +_Currently we don't have an example for calling `createTaskAssignment` in integration tests_ + +### Arguments + +- requestBody `CreateTaskAssignmentRequestBody` + - Request body of createTaskAssignment method +- headers `CreateTaskAssignmentHeaders` + - Headers of createTaskAssignment method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `TaskAssignment`. + +Returns a new task assignment object. + +## Get task assignment + +Retrieves information about a task assignment. + +This operation is performed by calling function `getTaskAssignmentById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-task-assignments-id/). + +_Currently we don't have an example for calling `getTaskAssignmentById` in integration tests_ + +### Arguments + +- taskAssignmentId `string` + - The ID of the task assignment. Example: "12345" +- headers `GetTaskAssignmentByIdHeaders` + - Headers of getTaskAssignmentById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `TaskAssignment`. + +Returns a task assignment, specifying who the task has been assigned to +and by whom. + +## Update task assignment + +Updates a task assignment. This endpoint can be +used to update the state of a task assigned to a user. + +This operation is performed by calling function `updateTaskAssignmentById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-task-assignments-id/). + +_Currently we don't have an example for calling `updateTaskAssignmentById` in integration tests_ + +### Arguments + +- taskAssignmentId `string` + - The ID of the task assignment. Example: "12345" +- requestBody `UpdateTaskAssignmentByIdRequestBody` + - Request body of updateTaskAssignmentById method +- headers `UpdateTaskAssignmentByIdHeaders` + - Headers of updateTaskAssignmentById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `TaskAssignment`. + +Returns the updated task assignment object. + +## Unassign task + +Deletes a specific task assignment. + +This operation is performed by calling function `deleteTaskAssignmentById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-task-assignments-id/). + +_Currently we don't have an example for calling `deleteTaskAssignmentById` in integration tests_ + +### Arguments + +- taskAssignmentId `string` + - The ID of the task assignment. Example: "12345" +- headers `DeleteTaskAssignmentByIdHeaders` + - Headers of deleteTaskAssignmentById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the task +assignment was successfully deleted. diff --git a/docs/tasks.md b/docs/tasks.md new file mode 100644 index 00000000..528e46d7 --- /dev/null +++ b/docs/tasks.md @@ -0,0 +1,176 @@ +# TasksManager + +- [List tasks on file](#list-tasks-on-file) +- [Create task](#create-task) +- [Get task](#get-task) +- [Update task](#update-task) +- [Remove task](#remove-task) + +## List tasks on file + +Retrieves a list of all the tasks for a file. This +endpoint does not support pagination. + +This operation is performed by calling function `getFileTasks`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-files-id-tasks/). + + + +```ts +await client.tasks.getFileTasks(file.id); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- headers `GetFileTasksHeaders` + - Headers of getFileTasks method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Tasks`. + +Returns a list of tasks on a file. + +If there are no tasks on this file an empty collection is returned +instead. + +## Create task + +Creates a single task on a file. This task is not assigned to any user and +will need to be assigned separately. + +This operation is performed by calling function `createTask`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-tasks/). + + + +```ts +await client.tasks.createTask({ + item: { + type: 'file' as CreateTaskRequestBodyItemTypeField, + id: file.id, + } satisfies CreateTaskRequestBodyItemField, + message: 'test message', + dueAt: '2035-01-01T00:00:00Z', + action: 'review' as CreateTaskRequestBodyActionField, + completionRule: 'all_assignees' as CreateTaskRequestBodyCompletionRuleField, +} satisfies CreateTaskRequestBody); +``` + +### Arguments + +- requestBody `CreateTaskRequestBody` + - Request body of createTask method +- headers `CreateTaskHeaders` + - Headers of createTask method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Task`. + +Returns the newly created task. + +## Get task + +Retrieves information about a specific task. + +This operation is performed by calling function `getTaskById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-tasks-id/). + + + +```ts +await client.tasks.getTaskById(task.id!); +``` + +### Arguments + +- taskId `string` + - The ID of the task. Example: "12345" +- headers `GetTaskByIdHeaders` + - Headers of getTaskById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Task`. + +Returns a task object. + +## Update task + +Updates a task. This can be used to update a task's configuration, or to +update its completion state. + +This operation is performed by calling function `updateTaskById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-tasks-id/). + + + +```ts +await client.tasks.updateTaskById(task.id!, { + message: 'updated message', +} satisfies UpdateTaskByIdRequestBody); +``` + +### Arguments + +- taskId `string` + - The ID of the task. Example: "12345" +- requestBody `UpdateTaskByIdRequestBody` + - Request body of updateTaskById method +- headers `UpdateTaskByIdHeaders` + - Headers of updateTaskById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Task`. + +Returns the updated task object + +## Remove task + +Removes a task from a file. + +This operation is performed by calling function `deleteTaskById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-tasks-id/). + + + +```ts +await client.tasks.deleteTaskById(task.id!); +``` + +### Arguments + +- taskId `string` + - The ID of the task. Example: "12345" +- headers `DeleteTaskByIdHeaders` + - Headers of deleteTaskById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the task was successfully deleted. diff --git a/docs/termsOfServiceUserStatuses.md b/docs/termsOfServiceUserStatuses.md new file mode 100644 index 00000000..a40ebe28 --- /dev/null +++ b/docs/termsOfServiceUserStatuses.md @@ -0,0 +1,87 @@ +# TermsOfServiceUserStatusesManager + +- [List terms of service user statuses](#list-terms-of-service-user-statuses) +- [Create terms of service status for new user](#create-terms-of-service-status-for-new-user) +- [Update terms of service status for existing user](#update-terms-of-service-status-for-existing-user) + +## List terms of service user statuses + +Retrieves an overview of users and their status for a +terms of service, including Whether they have accepted +the terms and when. + +This operation is performed by calling function `getTermsOfServiceUserStatuses`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-terms-of-service-user-statuses/). + +_Currently we don't have an example for calling `getTermsOfServiceUserStatuses` in integration tests_ + +### Arguments + +- queryParams `GetTermsOfServiceUserStatusesQueryParams` + - Query parameters of getTermsOfServiceUserStatuses method +- headers `GetTermsOfServiceUserStatusesHeaders` + - Headers of getTermsOfServiceUserStatuses method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `TermsOfServiceUserStatuses`. + +Returns a list of terms of service statuses. + +## Create terms of service status for new user + +Sets the status for a terms of service for a user. + +This operation is performed by calling function `createTermsOfServiceStatusForUser`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-terms-of-service-user-statuses/). + +_Currently we don't have an example for calling `createTermsOfServiceStatusForUser` in integration tests_ + +### Arguments + +- requestBody `CreateTermsOfServiceStatusForUserRequestBody` + - Request body of createTermsOfServiceStatusForUser method +- headers `CreateTermsOfServiceStatusForUserHeaders` + - Headers of createTermsOfServiceStatusForUser method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `TermsOfServiceUserStatus`. + +Returns a terms of service status object. + +## Update terms of service status for existing user + +Updates the status for a terms of service for a user. + +This operation is performed by calling function `updateTermsOfServiceStatusForUserById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-terms-of-service-user-statuses-id/). + +_Currently we don't have an example for calling `updateTermsOfServiceStatusForUserById` in integration tests_ + +### Arguments + +- termsOfServiceUserStatusId `string` + - The ID of the terms of service status. Example: "324234" +- requestBody `UpdateTermsOfServiceStatusForUserByIdRequestBody` + - Request body of updateTermsOfServiceStatusForUserById method +- headers `UpdateTermsOfServiceStatusForUserByIdHeaders` + - Headers of updateTermsOfServiceStatusForUserById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `TermsOfServiceUserStatus`. + +Returns the updated terms of service status object. diff --git a/docs/termsOfServices.md b/docs/termsOfServices.md new file mode 100644 index 00000000..d68e07d9 --- /dev/null +++ b/docs/termsOfServices.md @@ -0,0 +1,115 @@ +# TermsOfServicesManager + +- [List terms of services](#list-terms-of-services) +- [Create terms of service](#create-terms-of-service) +- [Get terms of service](#get-terms-of-service) +- [Update terms of service](#update-terms-of-service) + +## List terms of services + +Returns the current terms of service text and settings +for the enterprise. + +This operation is performed by calling function `getTermsOfService`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-terms-of-services/). + +_Currently we don't have an example for calling `getTermsOfService` in integration tests_ + +### Arguments + +- queryParams `GetTermsOfServiceQueryParams` + - Query parameters of getTermsOfService method +- headers `GetTermsOfServiceHeaders` + - Headers of getTermsOfService method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `TermsOfServices`. + +Returns a collection of terms of service text and settings for the +enterprise. + +## Create terms of service + +Creates a terms of service for a given enterprise +and type of user. + +This operation is performed by calling function `createTermsOfService`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-terms-of-services/). + +_Currently we don't have an example for calling `createTermsOfService` in integration tests_ + +### Arguments + +- requestBody `CreateTermsOfServiceRequestBody` + - Request body of createTermsOfService method +- headers `CreateTermsOfServiceHeaders` + - Headers of createTermsOfService method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Task`. + +Returns a new task object + +## Get terms of service + +Fetches a specific terms of service. + +This operation is performed by calling function `getTermsOfServiceById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-terms-of-services-id/). + +_Currently we don't have an example for calling `getTermsOfServiceById` in integration tests_ + +### Arguments + +- termsOfServiceId `string` + - The ID of the terms of service. Example: "324234" +- headers `GetTermsOfServiceByIdHeaders` + - Headers of getTermsOfServiceById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `TermsOfService`. + +Returns a terms of service object. + +## Update terms of service + +Updates a specific terms of service. + +This operation is performed by calling function `updateTermsOfServiceById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-terms-of-services-id/). + +_Currently we don't have an example for calling `updateTermsOfServiceById` in integration tests_ + +### Arguments + +- termsOfServiceId `string` + - The ID of the terms of service. Example: "324234" +- requestBody `UpdateTermsOfServiceByIdRequestBody` + - Request body of updateTermsOfServiceById method +- headers `UpdateTermsOfServiceByIdHeaders` + - Headers of updateTermsOfServiceById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `TermsOfService`. + +Returns an updated terms of service object. diff --git a/docs/transfer.md b/docs/transfer.md new file mode 100644 index 00000000..aa6106b3 --- /dev/null +++ b/docs/transfer.md @@ -0,0 +1,78 @@ +# TransferManager + +- [Transfer owned folders](#transfer-owned-folders) + +## Transfer owned folders + +Move all of the items (files, folders and workflows) owned by a user into +another user's account + +Only the root folder (`0`) can be transferred. + +Folders can only be moved across users by users with administrative +permissions. + +All existing shared links and folder-level collaborations are transferred +during the operation. Please note that while collaborations at the individual +file-level are transferred during the operation, the collaborations are +deleted when the original user is deleted. + +This call will be performed synchronously which might lead to a slow response +when the source user has a large number of items in all of its folders. + +If the destination path has a metadata cascade policy attached to any of +the parent folders, a metadata cascade operation will be kicked off +asynchronously. + +There is currently no way to check for when this operation is finished. + +The destination folder's name will be in the format `{User}'s Files and +Folders`, where `{User}` is the display name of the user. + +To make this API call your application will need to have the "Read and write +all files and folders stored in Box" scope enabled. + +Please make sure the destination user has access to `Relay` or `Relay Lite`, +and has access to the files and folders involved in the workflows being +transferred. + +Admins will receive an email when the operation is completed. + +This operation is performed by calling function `transferOwnedFolder`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-users-id-folders-0/). + + + +```ts +await client.transfer.transferOwnedFolder( + newUser.id, + { + ownedBy: { + id: currentUser.id, + } satisfies TransferOwnedFolderRequestBodyOwnedByField, + } satisfies TransferOwnedFolderRequestBody, + { notify: false } satisfies TransferOwnedFolderQueryParams +); +``` + +### Arguments + +- userId `string` + - The ID of the user. Example: "12345" +- requestBody `TransferOwnedFolderRequestBody` + - Request body of transferOwnedFolder method +- queryParams `TransferOwnedFolderQueryParams` + - Query parameters of transferOwnedFolder method +- headers `TransferOwnedFolderHeaders` + - Headers of transferOwnedFolder method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `FolderFull`. + +Returns the information for the newly created +destination folder. diff --git a/docs/trashedFiles.md b/docs/trashedFiles.md new file mode 100644 index 00000000..7c889275 --- /dev/null +++ b/docs/trashedFiles.md @@ -0,0 +1,118 @@ +# TrashedFilesManager + +- [Restore file](#restore-file) +- [Get trashed file](#get-trashed-file) +- [Permanently remove file](#permanently-remove-file) + +## Restore file + +Restores a file that has been moved to the trash. + +An optional new parent ID can be provided to restore the file to in case the +original folder has been deleted. + +This operation is performed by calling function `restoreFileFromTrash`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-files-id/). + + + +```ts +await client.trashedFiles.restoreFileFromTrash(file.id); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- requestBody `RestoreFileFromTrashRequestBody` + - Request body of restoreFileFromTrash method +- queryParams `RestoreFileFromTrashQueryParams` + - Query parameters of restoreFileFromTrash method +- headers `RestoreFileFromTrashHeaders` + - Headers of restoreFileFromTrash method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `TrashFileRestored`. + +Returns a file object when the file has been restored. + +## Get trashed file + +Retrieves a file that has been moved to the trash. + +Please note that only if the file itself has been moved to the +trash can it be retrieved with this API call. If instead one of +its parent folders was moved to the trash, only that folder +can be inspected using the +[`GET /folders/:id/trash`](e://get_folders_id_trash) API. + +To list all items that have been moved to the trash, please +use the [`GET /folders/trash/items`](e://get-folders-trash-items/) +API. + +This operation is performed by calling function `getTrashedFileById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-files-id-trash/). + + + +```ts +await client.trashedFiles.getTrashedFileById(file.id); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- queryParams `GetTrashedFileByIdQueryParams` + - Query parameters of getTrashedFileById method +- headers `GetTrashedFileByIdHeaders` + - Headers of getTrashedFileById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `TrashFile`. + +Returns the file that was trashed, +including information about when the it +was moved to the trash. + +## Permanently remove file + +Permanently deletes a file that is in the trash. +This action cannot be undone. + +This operation is performed by calling function `deleteTrashedFileById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-files-id-trash/). + + + +```ts +await client.trashedFiles.deleteTrashedFileById(file.id); +``` + +### Arguments + +- fileId `string` + - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345" +- headers `DeleteTrashedFileByIdHeaders` + - Headers of deleteTrashedFileById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the file was +permanently deleted. diff --git a/docs/trashedFolders.md b/docs/trashedFolders.md new file mode 100644 index 00000000..091fbfed --- /dev/null +++ b/docs/trashedFolders.md @@ -0,0 +1,127 @@ +# TrashedFoldersManager + +- [Restore folder](#restore-folder) +- [Get trashed folder](#get-trashed-folder) +- [Permanently remove folder](#permanently-remove-folder) + +## Restore folder + +Restores a folder that has been moved to the trash. + +An optional new parent ID can be provided to restore the folder to in case the +original folder has been deleted. + +# Folder locking + +During this operation, part of the file tree will be locked, mainly +the source folder and all of its descendants, as well as the destination +folder. + +For the duration of the operation, no other move, copy, delete, or restore +operation can performed on any of the locked folders. + +This operation is performed by calling function `restoreFolderFromTrash`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-folders-id/). + + + +```ts +await client.trashedFolders.restoreFolderFromTrash(folder.id); +``` + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" +- requestBody `RestoreFolderFromTrashRequestBody` + - Request body of restoreFolderFromTrash method +- queryParams `RestoreFolderFromTrashQueryParams` + - Query parameters of restoreFolderFromTrash method +- headers `RestoreFolderFromTrashHeaders` + - Headers of restoreFolderFromTrash method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `TrashFolderRestored`. + +Returns a folder object when the folder has been restored. + +## Get trashed folder + +Retrieves a folder that has been moved to the trash. + +Please note that only if the folder itself has been moved to the +trash can it be retrieved with this API call. If instead one of +its parent folders was moved to the trash, only that folder +can be inspected using the +[`GET /folders/:id/trash`](e://get_folders_id_trash) API. + +To list all items that have been moved to the trash, please +use the [`GET /folders/trash/items`](e://get-folders-trash-items/) +API. + +This operation is performed by calling function `getTrashedFolderById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-folders-id-trash/). + + + +```ts +await client.trashedFolders.getTrashedFolderById(folder.id); +``` + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" +- queryParams `GetTrashedFolderByIdQueryParams` + - Query parameters of getTrashedFolderById method +- headers `GetTrashedFolderByIdHeaders` + - Headers of getTrashedFolderById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `TrashFolder`. + +Returns the folder that was trashed, +including information about when the it +was moved to the trash. + +## Permanently remove folder + +Permanently deletes a folder that is in the trash. +This action cannot be undone. + +This operation is performed by calling function `deleteTrashedFolderById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-folders-id-trash/). + + + +```ts +await client.trashedFolders.deleteTrashedFolderById(folder.id); +``` + +### Arguments + +- folderId `string` + - The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345" +- headers `DeleteTrashedFolderByIdHeaders` + - Headers of deleteTrashedFolderById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the folder was +permanently deleted. diff --git a/docs/trashedItems.md b/docs/trashedItems.md new file mode 100644 index 00000000..360e6718 --- /dev/null +++ b/docs/trashedItems.md @@ -0,0 +1,41 @@ +# TrashedItemsManager + +- [List trashed items](#list-trashed-items) + +## List trashed items + +Retrieves the files and folders that have been moved +to the trash. + +Any attribute in the full files or folders objects can be passed +in with the `fields` parameter to retrieve those specific +attributes that are not returned by default. + +This endpoint defaults to use offset-based pagination, yet also supports +marker-based pagination using the `marker` parameter. + +This operation is performed by calling function `getTrashedItems`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-folders-trash-items/). + + + +```ts +await client.trashedItems.getTrashedItems(); +``` + +### Arguments + +- queryParams `GetTrashedItemsQueryParams` + - Query parameters of getTrashedItems method +- headers `GetTrashedItemsHeaders` + - Headers of getTrashedItems method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Items`. + +Returns a list of items that have been deleted diff --git a/docs/trashedWebLinks.md b/docs/trashedWebLinks.md new file mode 100644 index 00000000..7f78ca66 --- /dev/null +++ b/docs/trashedWebLinks.md @@ -0,0 +1,108 @@ +# TrashedWebLinksManager + +- [Restore web link](#restore-web-link) +- [Get trashed web link](#get-trashed-web-link) +- [Permanently remove web link](#permanently-remove-web-link) + +## Restore web link + +Restores a web link that has been moved to the trash. + +An optional new parent ID can be provided to restore the web link to in case +the original folder has been deleted. + +This operation is performed by calling function `restoreWeblinkFromTrash`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-web-links-id/). + + + +```ts +await client.trashedWebLinks.restoreWeblinkFromTrash(weblink.id); +``` + +### Arguments + +- webLinkId `string` + - The ID of the web link. Example: "12345" +- requestBody `RestoreWeblinkFromTrashRequestBody` + - Request body of restoreWeblinkFromTrash method +- queryParams `RestoreWeblinkFromTrashQueryParams` + - Query parameters of restoreWeblinkFromTrash method +- headers `RestoreWeblinkFromTrashHeaders` + - Headers of restoreWeblinkFromTrash method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `TrashWebLinkRestored`. + +Returns a web link object when it has been restored. + +## Get trashed web link + +Retrieves a web link that has been moved to the trash. + +This operation is performed by calling function `getTrashedWebLinkById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-web-links-id-trash/). + + + +```ts +await client.trashedWebLinks.getTrashedWebLinkById(weblink.id); +``` + +### Arguments + +- webLinkId `string` + - The ID of the web link. Example: "12345" +- queryParams `GetTrashedWebLinkByIdQueryParams` + - Query parameters of getTrashedWebLinkById method +- headers `GetTrashedWebLinkByIdHeaders` + - Headers of getTrashedWebLinkById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `TrashWebLink`. + +Returns the web link that was trashed, +including information about when the it +was moved to the trash. + +## Permanently remove web link + +Permanently deletes a web link that is in the trash. +This action cannot be undone. + +This operation is performed by calling function `deleteTrashedWebLinkById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-web-links-id-trash/). + + + +```ts +await client.trashedWebLinks.deleteTrashedWebLinkById(weblink.id); +``` + +### Arguments + +- webLinkId `string` + - The ID of the web link. Example: "12345" +- headers `DeleteTrashedWebLinkByIdHeaders` + - Headers of deleteTrashedWebLinkById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Returns an empty response when the web link was +permanently deleted. diff --git a/docs/userCollaborations.md b/docs/userCollaborations.md new file mode 100644 index 00000000..f00c4eac --- /dev/null +++ b/docs/userCollaborations.md @@ -0,0 +1,163 @@ +# UserCollaborationsManager + +- [Get collaboration](#get-collaboration) +- [Update collaboration](#update-collaboration) +- [Remove collaboration](#remove-collaboration) +- [Create collaboration](#create-collaboration) + +## Get collaboration + +Retrieves a single collaboration. + +This operation is performed by calling function `getCollaborationById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-collaborations-id/). + + + +```ts +await client.userCollaborations.getCollaborationById(collaborationId); +``` + +### Arguments + +- collaborationId `string` + - The ID of the collaboration Example: "1234" +- queryParams `GetCollaborationByIdQueryParams` + - Query parameters of getCollaborationById method +- headers `GetCollaborationByIdHeaders` + - Headers of getCollaborationById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Collaboration`. + +Returns a collaboration object. + +## Update collaboration + +Updates a collaboration. +Can be used to change the owner of an item, or to +accept collaboration invites. + +This operation is performed by calling function `updateCollaborationById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-collaborations-id/). + + + +```ts +await client.userCollaborations.updateCollaborationById(collaborationId, { + role: 'viewer' as UpdateCollaborationByIdRequestBodyRoleField, +} satisfies UpdateCollaborationByIdRequestBody); +``` + +### Arguments + +- collaborationId `string` + - The ID of the collaboration Example: "1234" +- requestBody `UpdateCollaborationByIdRequestBody` + - Request body of updateCollaborationById method +- headers `UpdateCollaborationByIdHeaders` + - Headers of updateCollaborationById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Collaboration`. + +Returns an updated collaboration object unless the owner has changed.If the role is changed to `owner`, the collaboration is deleted +and a new collaboration is created. The previous `owner` of +the old collaboration will be a `co-owner` on the new collaboration. + +## Remove collaboration + +Deletes a single collaboration. + +This operation is performed by calling function `deleteCollaborationById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-collaborations-id/). + + + +```ts +await client.userCollaborations.deleteCollaborationById(collaborationId); +``` + +### Arguments + +- collaborationId `string` + - The ID of the collaboration Example: "1234" +- headers `DeleteCollaborationByIdHeaders` + - Headers of deleteCollaborationById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +A blank response is returned if the collaboration was +successfully deleted. + +## Create collaboration + +Adds a collaboration for a single user or a single group to a file +or folder. + +Collaborations can be created using email address, user IDs, or a +group IDs. + +If a collaboration is being created with a group, access to +this endpoint is dependent on the group's ability to be invited. + +If collaboration is in `pending` status, the following fields +are redacted: + +- `login` and `name` are hidden if a collaboration was created + using `user_id`, +- `name` is hidden if a collaboration was created using `login`. + +This operation is performed by calling function `createCollaboration`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-collaborations/). + + + +```ts +await client.userCollaborations.createCollaboration({ + item: { + type: 'folder' as CreateCollaborationRequestBodyItemTypeField, + id: folder.id, + } satisfies CreateCollaborationRequestBodyItemField, + accessibleBy: { + type: 'user' as CreateCollaborationRequestBodyAccessibleByTypeField, + login: userLogin, + } satisfies CreateCollaborationRequestBodyAccessibleByField, + role: 'editor' as CreateCollaborationRequestBodyRoleField, +} satisfies CreateCollaborationRequestBody); +``` + +### Arguments + +- requestBody `CreateCollaborationRequestBody` + - Request body of createCollaboration method +- queryParams `CreateCollaborationQueryParams` + - Query parameters of createCollaboration method +- headers `CreateCollaborationHeaders` + - Headers of createCollaboration method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Collaboration`. + +Returns a new collaboration object. diff --git a/docs/users.md b/docs/users.md new file mode 100644 index 00000000..00d17ed2 --- /dev/null +++ b/docs/users.md @@ -0,0 +1,240 @@ +# UsersManager + +- [List enterprise users](#list-enterprise-users) +- [Create user](#create-user) +- [Get current user](#get-current-user) +- [Get user](#get-user) +- [Update user](#update-user) +- [Delete user](#delete-user) + +## List enterprise users + +Returns a list of all users for the Enterprise along with their `user_id`, +`public_name`, and `login`. + +The application and the authenticated user need to +have the permission to look up users in the entire +enterprise. + +This operation is performed by calling function `getUsers`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-users/). + + + +```ts +await client.users.getUsers(); +``` + +### Arguments + +- queryParams `GetUsersQueryParams` + - Query parameters of getUsers method +- headers `GetUsersHeaders` + - Headers of getUsers method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Users`. + +Returns all of the users in the enterprise. + +## Create user + +Creates a new managed user in an enterprise. This endpoint +is only available to users and applications with the right +admin permissions. + +This operation is performed by calling function `createUser`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-users/). + + + +```ts +await client.users.createUser({ + name: userName, + login: userLogin, + isPlatformAccessOnly: true, +} satisfies CreateUserRequestBody); +``` + +### Arguments + +- requestBody `CreateUserRequestBody` + - Request body of createUser method +- queryParams `CreateUserQueryParams` + - Query parameters of createUser method +- headers `CreateUserHeaders` + - Headers of createUser method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `UserFull`. + +Returns a user object for the newly created user. + +## Get current user + +Retrieves information about the user who is currently authenticated. + +In the case of a client-side authenticated OAuth 2.0 application +this will be the user who authorized the app. + +In the case of a JWT, server-side authenticated application +this will be the service account that belongs to the application +by default. + +Use the `As-User` header to change who this API call is made on behalf of. + +This operation is performed by calling function `getUserMe`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-users-me/). + + + +```ts +await client.users.getUserMe(); +``` + +### Arguments + +- queryParams `GetUserMeQueryParams` + - Query parameters of getUserMe method +- headers `GetUserMeHeaders` + - Headers of getUserMe method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `UserFull`. + +Returns a single user object. + +## Get user + +Retrieves information about a user in the enterprise. + +The application and the authenticated user need to +have the permission to look up users in the entire +enterprise. + +This endpoint also returns a limited set of information +for external users who are collaborated on content +owned by the enterprise for authenticated users with the +right scopes. In this case, disallowed fields will return +null instead. + +This operation is performed by calling function `getUserById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-users-id/). + + + +```ts +await client.users.getUserById(user.id); +``` + +### Arguments + +- userId `string` + - The ID of the user. Example: "12345" +- queryParams `GetUserByIdQueryParams` + - Query parameters of getUserById method +- headers `GetUserByIdHeaders` + - Headers of getUserById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `UserFull`. + +Returns a single user object. + +Not all available fields are returned by default. Use the +[fields](#param-fields) query parameter to explicitly request +any specific fields using the [fields](#get-users-id--request--fields) +parameter. + +## Update user + +Updates a managed or app user in an enterprise. This endpoint +is only available to users and applications with the right +admin permissions. + +This operation is performed by calling function `updateUserById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-users-id/). + + + +```ts +await client.users.updateUserById(user.id, { + name: updatedUserName, +} satisfies UpdateUserByIdRequestBody); +``` + +### Arguments + +- userId `string` + - The ID of the user. Example: "12345" +- requestBody `UpdateUserByIdRequestBody` + - Request body of updateUserById method +- queryParams `UpdateUserByIdQueryParams` + - Query parameters of updateUserById method +- headers `UpdateUserByIdHeaders` + - Headers of updateUserById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `UserFull`. + +Returns the updated user object. + +## Delete user + +Deletes a user. By default this will fail if the user +still owns any content. Move their owned content first +before proceeding, or use the `force` field to delete +the user and their files. + +This operation is performed by calling function `deleteUserById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-users-id/). + + + +```ts +await client.users.deleteUserById(user.id); +``` + +### Arguments + +- userId `string` + - The ID of the user. Example: "12345" +- queryParams `DeleteUserByIdQueryParams` + - Query parameters of deleteUserById method +- headers `DeleteUserByIdHeaders` + - Headers of deleteUserById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Removes the user and returns an empty response. diff --git a/docs/webLinks.md b/docs/webLinks.md new file mode 100644 index 00000000..c87ee8bc --- /dev/null +++ b/docs/webLinks.md @@ -0,0 +1,140 @@ +# WebLinksManager + +- [Create web link](#create-web-link) +- [Get web link](#get-web-link) +- [Update web link](#update-web-link) +- [Remove web link](#remove-web-link) + +## Create web link + +Creates a web link object within a folder. + +This operation is performed by calling function `createWebLink`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-web-links/). + + + +```ts +await client.webLinks.createWebLink({ + url: url, + parent: { id: parent.id } satisfies CreateWebLinkRequestBodyParentField, + name: name, + description: description, +} satisfies CreateWebLinkRequestBody); +``` + +### Arguments + +- requestBody `CreateWebLinkRequestBody` + - Request body of createWebLink method +- headers `CreateWebLinkHeaders` + - Headers of createWebLink method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `WebLink`. + +Returns the newly created web link object. + +## Get web link + +Retrieve information about a web link. + +This operation is performed by calling function `getWebLinkById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-web-links-id/). + + + +```ts +await client.webLinks.getWebLinkById(weblink.id); +``` + +### Arguments + +- webLinkId `string` + - The ID of the web link. Example: "12345" +- headers `GetWebLinkByIdHeaders` + - Headers of getWebLinkById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `WebLink`. + +Returns the web link object. + +## Update web link + +Updates a web link object. + +This operation is performed by calling function `updateWebLinkById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-web-links-id/). + + + +```ts +await client.webLinks.updateWebLinkById(weblink.id, { + name: updatedName, + sharedLink: { + access: sharedAccess, + password: password, + } satisfies UpdateWebLinkByIdRequestBodySharedLinkField, +} satisfies UpdateWebLinkByIdRequestBody); +``` + +### Arguments + +- webLinkId `string` + - The ID of the web link. Example: "12345" +- requestBody `UpdateWebLinkByIdRequestBody` + - Request body of updateWebLinkById method +- headers `UpdateWebLinkByIdHeaders` + - Headers of updateWebLinkById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `WebLink`. + +Returns the updated web link object. + +## Remove web link + +Deletes a web link. + +This operation is performed by calling function `deleteWebLinkById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-web-links-id/). + + + +```ts +await client.webLinks.deleteWebLinkById(weblink.id); +``` + +### Arguments + +- webLinkId `string` + - The ID of the web link. Example: "12345" +- headers `DeleteWebLinkByIdHeaders` + - Headers of deleteWebLinkById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +An empty response will be returned when the web link +was successfully deleted. diff --git a/docs/webhooks.md b/docs/webhooks.md new file mode 100644 index 00000000..b02dea30 --- /dev/null +++ b/docs/webhooks.md @@ -0,0 +1,174 @@ +# WebhooksManager + +- [List all webhooks](#list-all-webhooks) +- [Create webhook](#create-webhook) +- [Get webhook](#get-webhook) +- [Update webhook](#update-webhook) +- [Remove webhook](#remove-webhook) + +## List all webhooks + +Returns all defined webhooks for the requesting application. + +This API only returns webhooks that are applied to files or folders that are +owned by the authenticated user. This means that an admin can not see webhooks +created by a service account unless the admin has access to those folders, and +vice versa. + +This operation is performed by calling function `getWebhooks`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-webhooks/). + + + +```ts +await client.webhooks.getWebhooks(); +``` + +### Arguments + +- queryParams `GetWebhooksQueryParams` + - Query parameters of getWebhooks method +- headers `GetWebhooksHeaders` + - Headers of getWebhooks method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Webhooks`. + +Returns a list of webhooks. + +## Create webhook + +Creates a webhook. + +This operation is performed by calling function `createWebhook`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-webhooks/). + + + +```ts +await client.webhooks.createWebhook({ + target: { + id: folder.id, + type: 'folder' as CreateWebhookRequestBodyTargetTypeField, + } satisfies CreateWebhookRequestBodyTargetField, + address: 'https://example.com/new-webhook', + triggers: ['FILE.UPLOADED' as CreateWebhookRequestBodyTriggersField], +} satisfies CreateWebhookRequestBody); +``` + +### Arguments + +- requestBody `CreateWebhookRequestBody` + - Request body of createWebhook method +- headers `CreateWebhookHeaders` + - Headers of createWebhook method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Webhook`. + +Returns the new webhook object. + +## Get webhook + +Retrieves a specific webhook + +This operation is performed by calling function `getWebhookById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-webhooks-id/). + + + +```ts +await client.webhooks.getWebhookById(webhook.id!); +``` + +### Arguments + +- webhookId `string` + - The ID of the webhook. Example: "3321123" +- headers `GetWebhookByIdHeaders` + - Headers of getWebhookById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Webhook`. + +Returns a webhook object + +## Update webhook + +Updates a webhook. + +This operation is performed by calling function `updateWebhookById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/put-webhooks-id/). + + + +```ts +await client.webhooks.updateWebhookById(webhook.id!, { + address: 'https://example.com/updated-webhook', +} satisfies UpdateWebhookByIdRequestBody); +``` + +### Arguments + +- webhookId `string` + - The ID of the webhook. Example: "3321123" +- requestBody `UpdateWebhookByIdRequestBody` + - Request body of updateWebhookById method +- headers `UpdateWebhookByIdHeaders` + - Headers of updateWebhookById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Webhook`. + +Returns the new webhook object. + +## Remove webhook + +Deletes a webhook. + +This operation is performed by calling function `deleteWebhookById`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/delete-webhooks-id/). + + + +```ts +await client.webhooks.deleteWebhookById(webhook.id!); +``` + +### Arguments + +- webhookId `string` + - The ID of the webhook. Example: "3321123" +- headers `DeleteWebhookByIdHeaders` + - Headers of deleteWebhookById method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +An empty response will be returned when the webhook +was successfully deleted. diff --git a/docs/workflows.md b/docs/workflows.md new file mode 100644 index 00000000..5a1dbbed --- /dev/null +++ b/docs/workflows.md @@ -0,0 +1,65 @@ +# WorkflowsManager + +- [List workflows](#list-workflows) +- [Starts workflow based on request body](#starts-workflow-based-on-request-body) + +## List workflows + +Returns list of workflows that act on a given `folder ID`, and +have a flow with a trigger type of `WORKFLOW_MANUAL_START`. + +You application must be authorized to use the `Manage Box Relay` application +scope within the developer console in to use this endpoint. + +This operation is performed by calling function `getWorkflows`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-workflows/). + +_Currently we don't have an example for calling `getWorkflows` in integration tests_ + +### Arguments + +- queryParams `GetWorkflowsQueryParams` + - Query parameters of getWorkflows method +- headers `GetWorkflowsHeaders` + - Headers of getWorkflows method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `Workflows`. + +Returns the workflow. + +## Starts workflow based on request body + +Initiates a flow with a trigger type of `WORKFLOW_MANUAL_START`. + +You application must be authorized to use the `Manage Box Relay` application +scope within the developer console. + +This operation is performed by calling function `startWorkflow`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-workflows-id-start/). + +_Currently we don't have an example for calling `startWorkflow` in integration tests_ + +### Arguments + +- workflowId `string` + - The ID of the workflow. Example: "12345" +- requestBody `StartWorkflowRequestBody` + - Request body of startWorkflow method +- headers `StartWorkflowHeaders` + - Headers of startWorkflow method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `undefined`. + +Starts the workflow. diff --git a/docs/zipDownloads.md b/docs/zipDownloads.md new file mode 100644 index 00000000..765db961 --- /dev/null +++ b/docs/zipDownloads.md @@ -0,0 +1,195 @@ +# ZipDownloadsManager + +- [Create zip download](#create-zip-download) +- [Download zip archive](#download-zip-archive) +- [Get zip download status](#get-zip-download-status) +- [](#) + +## Create zip download + +Creates a request to download multiple files and folders as a single `zip` +archive file. This API does not return the archive but instead performs all +the checks to ensure that the user has access to all the items, and then +returns a `download_url` and a `status_url` that can be used to download the +archive. + +The limit for an archive is either the Account's upload limit or +10,000 files, whichever is met first. + +**Note**: Downloading a large file can be +affected by various +factors such as distance, network latency, +bandwidth, and congestion, as well as packet loss +ratio and current server load. +For these reasons we recommend that a maximum ZIP archive +total size does not exceed 25GB. + +This operation is performed by calling function `createZipDownload`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/post-zip-downloads/). + + + +```ts +await client.zipDownloads.createZipDownload({ + items: [ + { + id: file1.id, + type: 'file' as ZipDownloadRequestItemsTypeField, + } satisfies ZipDownloadRequestItemsField, + { + id: file2.id, + type: 'file' as ZipDownloadRequestItemsTypeField, + } satisfies ZipDownloadRequestItemsField, + { + id: folder1.id, + type: 'folder' as ZipDownloadRequestItemsTypeField, + } satisfies ZipDownloadRequestItemsField, + ], + downloadFileName: 'zip', +} satisfies ZipDownloadRequest); +``` + +### Arguments + +- requestBody `ZipDownloadRequest` + - Request body of createZipDownload method +- headers `CreateZipDownloadHeaders` + - Headers of createZipDownload method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ZipDownload`. + +If the `zip` archive is ready to be downloaded, the API will return a +response that will include a `download_url`, a `status_url`, as well as +any conflicts that might have occurred when creating the request. + +## Download zip archive + +Returns the contents of a `zip` archive in binary format. This URL does not +require any form of authentication and could be used in a user's browser to +download the archive to a user's device. + +By default, this URL is only valid for a few seconds from the creation of +the request for this archive. Once a download has started it can not be +stopped and resumed, instead a new request for a zip archive would need to +be created. + +The URL of this endpoint should not be considered as fixed. Instead, use +the [Create zip download](e://post_zip_downloads) API to request to create a +`zip` archive, and then follow the `download_url` field in the response to +this endpoint. + +This operation is performed by calling function `getZipDownloadContent`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-zip-downloads-id-content/). + + + +```ts +await client.zipDownloads.getZipDownloadContent(zipDownload.downloadUrl!); +``` + +### Arguments + +- downloadUrl `string` + - The URL that can be used to download created `zip` archive. Example: `https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/content` +- headers `GetZipDownloadContentHeaders` + - Headers of getZipDownloadContent method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ByteStream`. + +Returns the content of the items requested for this download, formatted as +a stream of files and folders in a `zip` archive. + +## Get zip download status + +Returns the download status of a `zip` archive, allowing an application to +inspect the progress of the download as well as the number of items that +might have been skipped. + +This endpoint can only be accessed once the download has started. +Subsequently this endpoint is valid for 12 hours from the start of the +download. + +The URL of this endpoint should not be considered as fixed. Instead, use +the [Create zip download](e://post_zip_downloads) API to request to create a +`zip` archive, and then follow the `status_url` field in the response to +this endpoint. + +This operation is performed by calling function `getZipDownloadStatus`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference/get-zip-downloads-id-status/). + + + +```ts +await client.zipDownloads.getZipDownloadStatus(zipDownload.statusUrl!); +``` + +### Arguments + +- statusUrl `string` + - The URL that can be used to get the status of the `zip` archive being downloaded. Example: `https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/status` +- headers `GetZipDownloadStatusHeaders` + - Headers of getZipDownloadStatus method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ZipDownloadStatus`. + +Returns the status of the `zip` archive that is being downloaded. + +## + +This operation is performed by calling function `downloadZip`. + +See the endpoint docs at +[API Reference](https://developer.box.com/reference//). + + + +```ts +await client.zipDownloads.downloadZip({ + items: [ + { + id: file1.id, + type: 'file' as ZipDownloadRequestItemsTypeField, + } satisfies ZipDownloadRequestItemsField, + { + id: file2.id, + type: 'file' as ZipDownloadRequestItemsTypeField, + } satisfies ZipDownloadRequestItemsField, + { + id: folder1.id, + type: 'folder' as ZipDownloadRequestItemsTypeField, + } satisfies ZipDownloadRequestItemsField, + ], + downloadFileName: 'zip', +} satisfies ZipDownloadRequest); +``` + +### Arguments + +- requestBody `ZipDownloadRequest` + - Zip download request body +- headers `DownloadZipHeaders` + - Headers of zip download method +- cancellationToken `undefined | CancellationToken` + - Token used for request cancellation. + +### Returns + +This function returns a value of type `ByteStream`.