Skip to content

README.md

Latest commit

 

History

History
528 lines (414 loc) · 35.9 KB

README.md

File metadata and controls

528 lines (414 loc) · 35.9 KB

Documents

Overview

Available Operations

download_file

Download File

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::DocumentsDownloadFileRequest.new(
  export_format: 'text/plain',
  format: 'base64',
  id: '<id>',
  x_account_id: '<id>'
)
res = s.documents.download_file(request: req)

unless res.body.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Operations::DocumentsDownloadFileRequest ✔️ The request object to use for the request.

Response

T.nilable(Models::Operations::DocumentsDownloadFileResponse)

Errors

Error Type Status Code Content Type
Models::Errors::BadRequestResponse 400 application/json
Models::Errors::UnauthorizedResponse 401 application/json
Models::Errors::ForbiddenResponse 403 application/json
Models::Errors::NotFoundResponse 404 application/json
Models::Errors::RequestTimedOutResponse 408 application/json
Models::Errors::ConflictResponse 409 application/json
Models::Errors::PreconditionFailedResponse 412 application/json
Models::Errors::UnprocessableEntityResponse 422 application/json
Models::Errors::TooManyRequestsResponse 429 application/json
Models::Errors::InternalServerErrorResponse 500 application/json
Models::Errors::NotImplementedResponse 501 application/json
Models::Errors::BadGatewayResponse 502 application/json
Errors::APIError 4XX, 5XX */*

get_drive

Get Drive

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::DocumentsGetDriveRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,description,url,created_at,updated_at,unified_custom_fields',
  id: '<id>',
  x_account_id: '<id>'
)
res = s.documents.get_drive(request: req)

unless res.drive_result.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Operations::DocumentsGetDriveRequest ✔️ The request object to use for the request.

Response

T.nilable(Models::Operations::DocumentsGetDriveResponse)

Errors

Error Type Status Code Content Type
Models::Errors::BadRequestResponse 400 application/json
Models::Errors::UnauthorizedResponse 401 application/json
Models::Errors::ForbiddenResponse 403 application/json
Models::Errors::NotFoundResponse 404 application/json
Models::Errors::RequestTimedOutResponse 408 application/json
Models::Errors::ConflictResponse 409 application/json
Models::Errors::PreconditionFailedResponse 412 application/json
Models::Errors::UnprocessableEntityResponse 422 application/json
Models::Errors::TooManyRequestsResponse 429 application/json
Models::Errors::InternalServerErrorResponse 500 application/json
Models::Errors::NotImplementedResponse 501 application/json
Models::Errors::BadGatewayResponse 502 application/json
Errors::APIError 4XX, 5XX */*

get_file

Get File

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::DocumentsGetFileRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,description,url,size,file_format,path,owner_id,remote_owner_id,folder_id,remote_folder_id,drive_id,remote_drive_id,export_formats,default_download_format,created_at,updated_at,has_content,has_children,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields',
  id: '<id>',
  include: 'all_parent_folder_ids',
  x_account_id: '<id>'
)
res = s.documents.get_file(request: req)

unless res.file_result.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Operations::DocumentsGetFileRequest ✔️ The request object to use for the request.

Response

T.nilable(Models::Operations::DocumentsGetFileResponse)

Errors

Error Type Status Code Content Type
Models::Errors::BadRequestResponse 400 application/json
Models::Errors::UnauthorizedResponse 401 application/json
Models::Errors::ForbiddenResponse 403 application/json
Models::Errors::NotFoundResponse 404 application/json
Models::Errors::RequestTimedOutResponse 408 application/json
Models::Errors::ConflictResponse 409 application/json
Models::Errors::PreconditionFailedResponse 412 application/json
Models::Errors::UnprocessableEntityResponse 422 application/json
Models::Errors::TooManyRequestsResponse 429 application/json
Models::Errors::InternalServerErrorResponse 500 application/json
Models::Errors::NotImplementedResponse 501 application/json
Models::Errors::BadGatewayResponse 502 application/json
Errors::APIError 4XX, 5XX */*

get_folder

Get Folder

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::DocumentsGetFolderRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,description,url,size,path,owner_id,remote_owner_id,parent_folder_id,remote_parent_folder_id,drive_id,remote_drive_id,created_at,updated_at,has_content,has_children,is_root,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields',
  id: '<id>',
  include: 'all_parent_folder_ids',
  x_account_id: '<id>'
)
res = s.documents.get_folder(request: req)

unless res.folder_result.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Operations::DocumentsGetFolderRequest ✔️ The request object to use for the request.

Response

T.nilable(Models::Operations::DocumentsGetFolderResponse)

Errors

Error Type Status Code Content Type
Models::Errors::BadRequestResponse 400 application/json
Models::Errors::UnauthorizedResponse 401 application/json
Models::Errors::ForbiddenResponse 403 application/json
Models::Errors::NotFoundResponse 404 application/json
Models::Errors::RequestTimedOutResponse 408 application/json
Models::Errors::ConflictResponse 409 application/json
Models::Errors::PreconditionFailedResponse 412 application/json
Models::Errors::UnprocessableEntityResponse 422 application/json
Models::Errors::TooManyRequestsResponse 429 application/json
Models::Errors::InternalServerErrorResponse 500 application/json
Models::Errors::NotImplementedResponse 501 application/json
Models::Errors::BadGatewayResponse 502 application/json
Errors::APIError 4XX, 5XX */*

list_drives

List Drives

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::DocumentsListDrivesRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,description,url,created_at,updated_at,unified_custom_fields',
  filter: Models::Operations::DocumentsListDrivesQueryParamFilter.new(
    updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')
  ),
  x_account_id: '<id>'
)
res = s.documents.list_drives(request: req)

unless res.drives_paginated.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Operations::DocumentsListDrivesRequest ✔️ The request object to use for the request.

Response

T.nilable(Models::Operations::DocumentsListDrivesResponse)

Errors

Error Type Status Code Content Type
Models::Errors::BadRequestResponse 400 application/json
Models::Errors::UnauthorizedResponse 401 application/json
Models::Errors::ForbiddenResponse 403 application/json
Models::Errors::NotFoundResponse 404 application/json
Models::Errors::RequestTimedOutResponse 408 application/json
Models::Errors::ConflictResponse 409 application/json
Models::Errors::PreconditionFailedResponse 412 application/json
Models::Errors::UnprocessableEntityResponse 422 application/json
Models::Errors::TooManyRequestsResponse 429 application/json
Models::Errors::InternalServerErrorResponse 500 application/json
Models::Errors::NotImplementedResponse 501 application/json
Models::Errors::BadGatewayResponse 502 application/json
Errors::APIError 4XX, 5XX */*

list_files

List Files

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::DocumentsListFilesRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,description,url,size,file_format,path,owner_id,remote_owner_id,folder_id,remote_folder_id,drive_id,remote_drive_id,export_formats,default_download_format,created_at,updated_at,has_content,has_children,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields',
  filter: Models::Operations::DocumentsListFilesQueryParamFilter.new(
    content: 'FAQ of the project',
    created_after: DateTime.iso8601('2020-01-01T00:00:00.000Z'),
    drive_id: '1234567890',
    folder_id: '1234567890',
    name: 'john_doe_resume.pdf',
    updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')
  ),
  folder_id: '1234567890',
  include: 'all_parent_folder_ids',
  nested_items: 'true',
  x_account_id: '<id>'
)
res = s.documents.list_files(request: req)

unless res.files_paginated.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Operations::DocumentsListFilesRequest ✔️ The request object to use for the request.

Response

T.nilable(Models::Operations::DocumentsListFilesResponse)

Errors

Error Type Status Code Content Type
Models::Errors::BadRequestResponse 400 application/json
Models::Errors::UnauthorizedResponse 401 application/json
Models::Errors::ForbiddenResponse 403 application/json
Models::Errors::NotFoundResponse 404 application/json
Models::Errors::RequestTimedOutResponse 408 application/json
Models::Errors::ConflictResponse 409 application/json
Models::Errors::PreconditionFailedResponse 412 application/json
Models::Errors::UnprocessableEntityResponse 422 application/json
Models::Errors::TooManyRequestsResponse 429 application/json
Models::Errors::InternalServerErrorResponse 500 application/json
Models::Errors::NotImplementedResponse 501 application/json
Models::Errors::BadGatewayResponse 502 application/json
Errors::APIError 4XX, 5XX */*

list_folders

List Folders

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::DocumentsListFoldersRequest.new(
  prefer: 'heartbeat',
  fields_: 'id,remote_id,name,description,url,size,path,owner_id,remote_owner_id,parent_folder_id,remote_parent_folder_id,drive_id,remote_drive_id,created_at,updated_at,has_content,has_children,is_root,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields',
  filter: Models::Operations::DocumentsListFoldersQueryParamFilter.new(
    drive_id: '1234567890',
    folder_id: '1234567890',
    name: 'Engineering',
    updated_after: DateTime.iso8601('2020-01-01T00:00:00.000Z')
  ),
  folder_id: '1234567890',
  include: 'all_parent_folder_ids',
  nested_items: 'true',
  x_account_id: '<id>'
)
res = s.documents.list_folders(request: req)

unless res.folders_paginated.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Operations::DocumentsListFoldersRequest ✔️ The request object to use for the request.

Response

T.nilable(Models::Operations::DocumentsListFoldersResponse)

Errors

Error Type Status Code Content Type
Models::Errors::BadRequestResponse 400 application/json
Models::Errors::UnauthorizedResponse 401 application/json
Models::Errors::ForbiddenResponse 403 application/json
Models::Errors::NotFoundResponse 404 application/json
Models::Errors::RequestTimedOutResponse 408 application/json
Models::Errors::ConflictResponse 409 application/json
Models::Errors::PreconditionFailedResponse 412 application/json
Models::Errors::UnprocessableEntityResponse 422 application/json
Models::Errors::TooManyRequestsResponse 429 application/json
Models::Errors::InternalServerErrorResponse 500 application/json
Models::Errors::NotImplementedResponse 501 application/json
Models::Errors::BadGatewayResponse 502 application/json
Errors::APIError 4XX, 5XX */*

upload_file

Upload File

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)
res = s.documents.upload_file(unified_upload_request_dto: Models::Shared::UnifiedUploadRequestDto.new(
  category: Models::Shared::UnifiedUploadRequestDtoCategory.new(
    source_value: '550e8400-e29b-41d4-a716-446655440000, CUSTOM_CATEGORY_NAME',
    value: 'reports, resumes'
  ),
  category_id: '6530',
  confidential: Models::Shared::UnifiedUploadRequestDtoConfidential.new(
    source_value: 'public',
    value: Models::Shared::UnifiedUploadRequestDtoValue::TRUE
  ),
  content: 'VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE',
  file_format: Models::Shared::UnifiedUploadRequestDtoFileFormat.new(
    source_value: 'application/pdf',
    value: Models::Shared::UnifiedUploadRequestDtoSchemasValue::PDF
  ),
  name: 'weather-forecast',
  path: '/path/to/file'
), x_account_id: '<id>')

unless res.write_result_api_model.nil?
  # handle response
end

Parameters

Parameter Type Required Description
unified_upload_request_dto Models::Shared::UnifiedUploadRequestDto ✔️ N/A
x_account_id ::String ✔️ The account identifier
x_stackone_api_session_token T.nilable(::String) ➖ The session token

Response

T.nilable(Models::Operations::DocumentsUploadFileResponse)

Errors

Error Type Status Code Content Type
Models::Errors::BadRequestResponse 400 application/json
Models::Errors::UnauthorizedResponse 401 application/json
Models::Errors::ForbiddenResponse 403 application/json
Models::Errors::NotFoundResponse 404 application/json
Models::Errors::RequestTimedOutResponse 408 application/json
Models::Errors::ConflictResponse 409 application/json
Models::Errors::PreconditionFailedResponse 412 application/json
Models::Errors::UnprocessableEntityResponse 422 application/json
Models::Errors::TooManyRequestsResponse 429 application/json
Models::Errors::InternalServerErrorResponse 500 application/json
Models::Errors::NotImplementedResponse 501 application/json
Models::Errors::BadGatewayResponse 502 application/json
Errors::APIError 4XX, 5XX */*