Class: GroupDocsAssemblyCloud::AssemblyApi

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_assembly_cloud/api/assembly_api.rb

Overview

GroupDocs.Assembly for Cloud API

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AssemblyApi

Returns a new instance of AssemblyApi.



35
36
37
38
39
 
# File 'lib/groupdocs_assembly_cloud/api/assembly_api.rb', line 35

def initialize(api_client = ApiClient.default)
  @api_client = api_client
  require_all '../models/requests'
  request_token
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



33
34
35
 
# File 'lib/groupdocs_assembly_cloud/api/assembly_api.rb', line 33

def api_client
  @api_client
end

Instance Method Details

#assemble_document(request) ⇒ File

Builds a document using document template and XML or JSON data passed in request.

Parameters:

  • request —

    AssembleDocumentRequest

Returns:

  • (File) 


45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/groupdocs_assembly_cloud/api/assembly_api.rb', line 45

def assemble_document(request)
  begin
    data, _status_code, _headers = assemble_document_with_http_info(request)
    rescue ApiError => e
      if e.code == 401
        request_token
        data, _status_code, _headers = assemble_document_with_http_info(request)
      else
        raise
      end
  end
  data
end

#copy_file(request) ⇒ nil

Copy file

Parameters:

  • request —

    CopyFileRequest

Returns:

  • (nil) 


120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/groupdocs_assembly_cloud/api/assembly_api.rb', line 120

def copy_file(request)
  begin
    data, _status_code, _headers = copy_file_with_http_info(request)
    rescue ApiError => e
      if e.code == 401
        request_token
        data, _status_code, _headers = copy_file_with_http_info(request)
      else
        raise
      end
  end
  nil
end

#copy_folder(request) ⇒ nil

Copy folder

Parameters:

  • request —

    CopyFolderRequest

Returns:

  • (nil) 


213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/groupdocs_assembly_cloud/api/assembly_api.rb', line 213

def copy_folder(request)
  begin
    data, _status_code, _headers = copy_folder_with_http_info(request)
    rescue ApiError => e
      if e.code == 401
        request_token
        data, _status_code, _headers = copy_folder_with_http_info(request)
      else
        raise
      end
  end
  nil
end

#create_folder(request) ⇒ nil

Create the folder

Parameters:

  • request —

    CreateFolderRequest

Returns:

  • (nil) 


301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/groupdocs_assembly_cloud/api/assembly_api.rb', line 301

def create_folder(request)
  begin
    data, _status_code, _headers = create_folder_with_http_info(request)
    rescue ApiError => e
      if e.code == 401
        request_token
        data, _status_code, _headers = create_folder_with_http_info(request)
      else
        raise
      end
  end
  nil
end

#delete_file(request) ⇒ nil

Delete file

Parameters:

  • request —

    DeleteFileRequest

Returns:

  • (nil) 


380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/groupdocs_assembly_cloud/api/assembly_api.rb', line 380

def delete_file(request)
  begin
    data, _status_code, _headers = delete_file_with_http_info(request)
    rescue ApiError => e
      if e.code == 401
        request_token
        data, _status_code, _headers = delete_file_with_http_info(request)
      else
        raise
      end
  end
  nil
end

#delete_folder(request) ⇒ nil

Delete folder

Parameters:

  • request —

    DeleteFolderRequest

Returns:

  • (nil) 


464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/groupdocs_assembly_cloud/api/assembly_api.rb', line 464

def delete_folder(request)
  begin
    data, _status_code, _headers = delete_folder_with_http_info(request)
    rescue ApiError => e
      if e.code == 401
        request_token
        data, _status_code, _headers = delete_folder_with_http_info(request)
      else
        raise
      end
  end
  nil
end

#download_file(request) ⇒ File

Download file

Parameters:

  • request —

    DownloadFileRequest

Returns:

  • (File) 


548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/groupdocs_assembly_cloud/api/assembly_api.rb', line 548

def download_file(request)
  begin
    data, _status_code, _headers = download_file_with_http_info(request)
    rescue ApiError => e
      if e.code == 401
        request_token
        data, _status_code, _headers = download_file_with_http_info(request)
      else
        raise
      end
  end
  data
end

#get_files_list(request) ⇒ FilesList

Get all files and folders within a folder

Parameters:

  • request —

    GetFilesListRequest

Returns:



634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'lib/groupdocs_assembly_cloud/api/assembly_api.rb', line 634

def get_files_list(request)
  begin
    data, _status_code, _headers = get_files_list_with_http_info(request)
    rescue ApiError => e
      if e.code == 401
        request_token
        data, _status_code, _headers = get_files_list_with_http_info(request)
      else
        raise
      end
  end
  data
end

#get_supported_file_formats(request) ⇒ FileFormatsResponse

Retrieves list of supported file formats.

Parameters:

  • request —

    GetSupportedFileFormatsRequest

Returns:



715
716
717
718
719
720
721
722
723
724
725
726
727
 
# File 'lib/groupdocs_assembly_cloud/api/assembly_api.rb', line 715

def get_supported_file_formats(request)
  begin
    data, _status_code, _headers = get_supported_file_formats_with_http_info(request)
    rescue ApiError => e
      if e.code == 401
        request_token
        data, _status_code, _headers = get_supported_file_formats_with_http_info(request)
      else
        raise
      end
  end
  data
end

#move_file(request) ⇒ nil

Move file

Parameters:

  • request —

    MoveFileRequest

Returns:

  • (nil) 


788
789
790
791
792
793
794
795
796
797
798
799
800
 
# File 'lib/groupdocs_assembly_cloud/api/assembly_api.rb', line 788

def move_file(request)
  begin
    data, _status_code, _headers = move_file_with_http_info(request)
    rescue ApiError => e
      if e.code == 401
        request_token
        data, _status_code, _headers = move_file_with_http_info(request)
      else
        raise
      end
  end
  nil
end

#move_folder(request) ⇒ nil

Move folder

Parameters:

  • request —

    MoveFolderRequest

Returns:

  • (nil) 


881
882
883
884
885
886
887
888
889
890
891
892
893
 
# File 'lib/groupdocs_assembly_cloud/api/assembly_api.rb', line 881

def move_folder(request)
  begin
    data, _status_code, _headers = move_folder_with_http_info(request)
    rescue ApiError => e
      if e.code == 401
        request_token
        data, _status_code, _headers = move_folder_with_http_info(request)
      else
        raise
      end
  end
  nil
end

#upload_file(request) ⇒ FilesUploadResult

Upload file

Parameters:

  • request —

    UploadFileRequest

Returns:



969
970
971
972
973
974
975
976
977
978
979
980
981
 
# File 'lib/groupdocs_assembly_cloud/api/assembly_api.rb', line 969

def upload_file(request)
  begin
    data, _status_code, _headers = upload_file_with_http_info(request)
    rescue ApiError => e
      if e.code == 401
        request_token
        data, _status_code, _headers = upload_file_with_http_info(request)
      else
        raise
      end
  end
  data
end