flatfile_api 0.1.0

data/scripts/spec_2022-12-02.yaml

@@ -0,0 +1,372 @@
+---
+- :method: POST
+  :description: Exchange access key for JWT
+  :path: "/auth/access-key-exchange"
+  :body_params:
+  - Name: accessKeyId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: Access Key generated in app
+  - Name: expiresIn
+    Required: ''
+    Type: number
+    Value: 43200 (default)
+    Description: Sets an expiration (in seconds)
+  - Name: secretAccessKey
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: Secret Access Key generated in app
+- :method: GET
+  :description: Download an upload
+  :path: "/batch/:batchId/export.csv"
+  :path_params:
+  - Name: batchId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: A valid UUID
+  :query_params:
+  - Name: type
+    Required: 'true'
+    Type: string
+    Value: 'Enum: original, processed'
+    Description: File to download
+- :method: DELETE
+  :description: Delete an upload
+  :path: "/batch/:batchId"
+  :path_params:
+  - Name: batchId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: A valid UUID
+- :method: GET
+  :description: Bulk delete uploads
+  :path: "/delete/batches"
+  :query_params:
+  - Name: olderThanQuantity
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: ''
+  - Name: olderThanUnit
+    Required: 'true'
+    Type: string
+    Value: 'Enum: minute, hour, day, week, month'
+    Description: ''
+  - Name: sendEmail
+    Required: 'true'
+    Type: string
+    Value: 'Enum: true, false'
+    Description: ''
+  - Name: teamId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: ''
+- :method: GET
+  :description: List Workspace uploads
+  :path: "/rest/batches"
+  :query_params:
+  - Name: endUserId
+    Required: ''
+    Type: string
+    Value: ''
+    Description: Valid endUserId for the Workspace
+  - Name: environmentId
+    Required: ''
+    Type: string
+    Value: ''
+    Description: Valid environmentId for the Workspace
+  - Name: licenseKey
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: A valid licenseKey for the Workspace
+  - Name: search
+    Required: ''
+    Type: string
+    Value: ''
+    Description: Searches fileName, originalFile, memo
+  - Name: skip
+    Required: ''
+    Type: number
+    Value: 0 (default)
+    Description: The rows to skip before listing
+  - Name: take
+    Required: ''
+    Type: number
+    Value: 50 (default)
+    Description: The maximum number of rows to return
+  - Name: workspaceId
+    Required: ''
+    Type: string
+    Value: ''
+    Description: Valid workspaceId for the Workspace
+- :method: GET
+  :description: File upload meta data
+  :path: "/rest/batch/:batchId"
+  :path_params:
+  - Name: batchId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: A valid UUID
+- :method: GET
+  :description: Sheet name for file upload
+  :path: "/upload/:uploadId/dataSources"
+  :path_params:
+  - Name: uploadId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: A valid UUID
+  :query_params:
+  - Name: licenseKey
+    Required: ''
+    Type: string
+    Value: ''
+    Description: A valid licenseKey for the Workspace
+- :method: GET
+  :description: Records for file upload
+  :path: "/rest/batch/:batchId/rows"
+  :path_params:
+  - Name: batchId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: A valid UUID
+  :query_params:
+  - Name: createdAtEndDate
+    Required: ''
+    Type: string
+    Value: ISO 8601
+    Description: The maximum createdAt date to return
+  - Name: createdAtStartDate
+    Required: ''
+    Type: string
+    Value: ISO 8601
+    Description: The minimum createdAt date to return
+  - Name: deleted
+    Required: ''
+    Type: string
+    Value: 'Enum: true, t, y, false, f, n'
+    Description: Return only deleted rows
+  - Name: skip
+    Required: ''
+    Type: number
+    Value: 0 (default)
+    Description: The rows to skip before listing
+  - Name: take
+    Required: ''
+    Type: number
+    Value: 50 (default)
+    Description: The maximum number of rows to return
+  - Name: updatedAtEndDate
+    Required: ''
+    Type: string
+    Value: ISO 8601
+    Description: The maximum updatedAt date to return
+  - Name: updatedAtStartDate
+    Required: ''
+    Type: string
+    Value: ISO 8601
+    Description: The minimum updatedAt date to return
+  - Name: valid
+    Required: ''
+    Type: string
+    Value: 'Enum: true, t, y, false, f, n'
+    Description: Return only valid rows
+- :method: POST
+  :description: Upload to Workspace sheet
+  :path: "/workspace/:workspaceId/sheet/:sheetId/data"
+  :path_params:
+  - Name: sheetId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: A valid UUID
+  - Name: workspaceId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: A valid UUID
+- :method: GET
+  :description: Fetch Workspace sheet records
+  :path: "/workspace/:workspaceId/sheet/:sheetId/records"
+  :path_params:
+  - Name: sheetId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: A valid UUID
+  - Name: workspaceId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: A valid UUID
+  :query_params:
+  - Name: filter
+    Required: ''
+    Type: string
+    Value: 'Enum: review, dismissed, accepted'
+    Description: Return only the filtered rows
+  - Name: mergeId
+    Required: ''
+    Type: string
+    Value: ''
+    Description: ''
+  - Name: nested
+    Required: ''
+    Type: boolean
+    Value: ''
+    Description: ''
+  - Name: recordIds
+    Required: ''
+    Type: string[]
+    Value: ''
+    Description: ''
+  - Name: skip
+    Required: ''
+    Type: number
+    Value: 0 (default)
+    Description: The rows to skip before listing
+  - Name: take
+    Required: ''
+    Type: number
+    Value: 50 (default)
+    Description: The maximum number of rows to return
+  - Name: valid
+    Required: ''
+    Type: string
+    Value: 'Enum: true, t, y, false, f, n'
+    Description: Return only valid rows
+- :method: GET
+  :description: List team Workspaces
+  :path: "/rest/teams/:teamId/workspaces"
+  :path_params:
+  - Name: teamId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: ''
+  :query_params:
+  - Name: environmentId
+    Required: ''
+    Type: string
+    Value: ''
+    Description: Valid environmentId for the Workspace
+  - Name: skip
+    Required: ''
+    Type: number
+    Value: 0 (default)
+    Description: The rows to skip before listing
+  - Name: take
+    Required: ''
+    Type: number
+    Value: 50 (default)
+    Description: The maximum number of rows to return
+- :method: GET
+  :description: Detail Workspace
+  :path: "/rest/workspace/:workspaceId"
+  :path_params:
+  - Name: workspaceId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: A valid UUID
+- :method: POST
+  :description: Invite Workspace collaborator
+  :path: "/rest/teams/:teamId/workspaces/:workspaceId/invitations"
+  :path_params:
+  - Name: teamId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: ''
+  - Name: workspaceId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: A valid UUID
+  :body_params:
+  - Name: email
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: Email address of invited collaborator
+- :method: GET
+  :description: List Workspace invitations
+  :path: "/rest/teams/:teamId/workspaces/:workspaceId/invitations"
+  :path_params:
+  - Name: teamId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: ''
+  - Name: workspaceId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: A valid UUID
+- :method: GET
+  :description: List Workspace collaborators
+  :path: "/rest/teams/:teamId/workspaces/:workspaceId/collaborators"
+  :path_params:
+  - Name: teamId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: ''
+  - Name: workspaceId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: A valid UUID
+- :method: DELETE
+  :description: Revoke Workspace invitation
+  :path: "/rest/teams/:teamId/workspaces/:workspaceId/invitations"
+  :path_params:
+  - Name: teamId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: ''
+  - Name: workspaceId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: A valid UUID
+  :body_params:
+  - Name: email
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: Email address of invited collaborator
+- :method: DELETE
+  :description: Remove Workspace collaborator
+  :path: "/rest/teams/:teamId/workspaces/:workspaceId/collaborators/:userId"
+  :path_params:
+  - Name: teamId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: ''
+  - Name: userId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: ''
+  - Name: workspaceId
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: A valid UUID
+  :body_params:
+  - Name: email
+    Required: 'true'
+    Type: string
+    Value: ''
+    Description: Email address of collaborator

data/sig/flatfile_api.rbs

@@ -0,0 +1,115 @@
+class FlatfileApi
+  VERSION: String
+
+  def initialize: (?access_key_id: String, ?secret_access_key: String, ?debug: bool) -> void
+
+  def exchange_access_key_for_jwt(
+    access_key_id: String,
+    ?expires_in: Integer,
+    secret_access_key: String
+  ) -> Response
+
+  def download_an_upload(
+    batch_id:,
+    type:
+  ) -> Response
+
+  def delete_an_upload(
+    batch_id: String
+  ) -> Response
+
+  def bulk_delete_uploads(
+    older_than_quantity: String,
+    older_than_unit: String,
+    send_email: bool,
+    team_id:  String
+  ) -> Response
+
+  def list_workspace_uploads(
+    ?end_user_id: String,
+    ?environment_id: String,
+    license_key: String,
+    ?search: String,
+    ?skip: Integer,
+    ?take: Integer,
+    ?workspace_id: String
+  ) -> PaginatedResponse
+
+  def file_upload_meta_data(
+    batch_id: String
+  ) -> Response
+
+  def sheet_name_for_file_upload(
+    upload_id: String,
+    ?license_key: String
+  ) -> Response
+
+  def records_for_file_upload(
+    batch_id: String,
+    ?created_at_end_date: (String | Time | DateTime),
+    ?created_at_start_date: (String | Time | DateTime),
+    ?deleted: bool,
+    ?skip: Integer,
+    ?take: Integer,
+    ?updated_at_end_date: (String | Time | DateTime),
+    ?updated_at_start_date: (String | Time | DateTime),
+    ?valid: bool
+  ) -> PaginatedResponse
+
+  def upload_to_workspace_sheet(
+    sheet_id: String,
+    workspace_id: String,
+  ) -> Response
+
+  def fetch_workspace_sheet_records(
+    sheet_id: String,
+    workspace_id: String,
+    ?filter: String,
+    ?merge_id: String,
+    ?nested: bool,
+    ?record_ids: Array[String],
+    ?skip: Integer,
+    ?take: Integer,
+    ?valid: bool
+  ) -> PaginatedResponse
+
+  def list_team_workspaces(
+    team_id: String,
+    ?environment_id: String,
+    ?skip: Integer,
+    ?take: Integer
+  ) -> PaginatedResponse
+
+  def detail_workspace(
+    workspace_id: String
+  ) -> Response
+
+  def invite_workspace_collaborator(
+    team_id: String,
+    workspace_id: String,
+    email: String
+  ) -> Response
+
+  def list_workspace_invitations(
+    team_id: String,
+    workspace_id: String
+  ) -> Response
+
+  def list_workspace_collaborators(
+    team_id: String,
+    workspace_id: String
+  ) -> Response
+
+  def revoke_workspace_invitation(
+    team_id: String,
+    workspace_id: String,
+    email: String
+  ) -> Response
+
+  def remove_workspace_collaborator(
+    team_id: String,
+    user_id: String,
+    workspace_id: String,
+    email: String
+  ) -> Response
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: flatfile_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- cyclotron3k
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-12-07 00:00:00.000000000 Z
+dependencies: []
+description: A thin wrapper around the Flatfile RESTful API
+email:
+- aidan.samuel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/flatfile_api.rb
+- lib/flatfile_api/paginated_response.rb
+- lib/flatfile_api/response.rb
+- lib/flatfile_api/string_tools.rb
+- lib/flatfile_api/version.rb
+- scripts/code_gen.rb
+- scripts/doc_gen.rb
+- scripts/parse_docs.rb
+- scripts/spec_2022-12-02.yaml
+- sig/flatfile_api.rbs
+homepage: https://github.com/cyclotron3k/flatfile_api
+licenses: []
+metadata:
+  bug_tracker_uri: https://github.com/cyclotron3k/flatfile_api/issues
+  changelog_uri: https://github.com/cyclotron3k/flatfile_api/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/cyclotron3k/flatfile_api/blob/v0.1.0/README.md
+  homepage_uri: https://github.com/cyclotron3k/flatfile_api
+  source_code_uri: https://github.com/cyclotron3k/flatfile_api
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Flatfile API client
+test_files: []