Class: StarkBank::Workspace

Inherits:
StarkCore::Utils::Resource
  • Object
show all
Defined in:
lib/workspace/workspace.rb

Overview

# Workspace object

Workspaces are bank accounts. They have independent balances, statements, operations and permissions. The only property that is shared between your workspaces is that they are linked to your organization, which carries your basic informations, such as tax ID, name, etc..

## Parameters (required):

  • username [string]: Simplified name to define the workspace URL. This name must be unique across all Stark Bank Workspaces. Ex: ‘starkbankworkspace’

  • name [string]: Full name that identifies the Workspace. This name will appear when people access the Workspace on our platform, for example. Ex: ‘Stark Bank Workspace’

## Parameters (optional):

  • allowed_tax_ids [list of strings]: list of tax IDs that will be allowed to send Deposits to this Workspace. ex: [‘012.345.678-90’, ‘20.018.183/0001-80’]

## Attributes (return-only):

  • id [string]: unique id returned when the workspace is created. ex: ‘5656565656565656’

  • status [string]: current Workspace status. Options: ‘active’, ‘closed’, ‘frozen’ or ‘blocked’

  • organization_id [string]: unique organization id returned when the organization is created. ex: ‘5656565656565656’

  • picture_url [string]: public workspace image (png) URL. ex: ‘storage.googleapis.com/api-ms-workspace-sbx.appspot.com/pictures/workspace/6284441752174592.png?20230208220551’

  • created [DateTime]: creation datetime for the Workspace. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(username:, name:, allowed_tax_ids: nil, id: nil, status: nil, organization_id: nil, picture_url: nil, created: nil) ⇒ Workspace

Returns a new instance of Workspace.



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/workspace/workspace.rb', line 30

def initialize(username:, name:, allowed_tax_ids: nil, id: nil, status: nil, organization_id: nil, picture_url: nil, created: nil)
  super(id)
  @username = username
  @name = name
  @allowed_tax_ids = allowed_tax_ids
  @status = status
  @organization_id = organization_id
  @picture_url = picture_url
  @created = StarkCore::Utils::Checks.check_datetime(created)
end

Instance Attribute Details

#allowed_tax_ids ⇒ Object (readonly)

Returns the value of attribute allowed_tax_ids.



29
30
31
 
# File 'lib/workspace/workspace.rb', line 29

def allowed_tax_ids
  @allowed_tax_ids
end

#created ⇒ Object (readonly)

Returns the value of attribute created.



29
30
31
 
# File 'lib/workspace/workspace.rb', line 29

def created
  @created
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



29
30
31
 
# File 'lib/workspace/workspace.rb', line 29

def id
  @id
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



29
30
31
 
# File 'lib/workspace/workspace.rb', line 29

def name
  @name
end

#organization_id ⇒ Object (readonly)

Returns the value of attribute organization_id.



29
30
31
 
# File 'lib/workspace/workspace.rb', line 29

def organization_id
  @organization_id
end

#picture_url ⇒ Object (readonly)

Returns the value of attribute picture_url.



29
30
31
 
# File 'lib/workspace/workspace.rb', line 29

def picture_url
  @picture_url
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



29
30
31
 
# File 'lib/workspace/workspace.rb', line 29

def status
  @status
end

#username ⇒ Object (readonly)

Returns the value of attribute username.



29
30
31
 
# File 'lib/workspace/workspace.rb', line 29

def username
  @username
end

Class Method Details

.create(username:, name:, user: nil, allowed_tax_ids: nil) ⇒ Object

# Create Workspace

Send a Workspace for creation in the Stark Bank API

## Parameters (required):

  • username [string]: Simplified name to define the workspace URL. This name must be unique across all Stark Bank Workspaces. Ex: ‘starkbankworkspace’

  • name [string]: Full name that identifies the Workspace. This name will appear when people access the Workspace on our platform, for example. Ex: ‘Stark Bank Workspace’

## Parameters (optional):

  • user [Organization object]: Organization object. Not necessary if StarkBank.user was set before function call

## Return:

  • Workspace object with updated attributes



54
55
56
 
# File 'lib/workspace/workspace.rb', line 54

def self.create(username:, name:, user: nil, allowed_tax_ids: nil)
  StarkBank::Utils::Rest.post_single(entity: Workspace.new(username: username, name: name, allowed_tax_ids: allowed_tax_ids), user: user, **resource)
end

.get(id, user: nil) ⇒ Object

# Retrieve a specific Workspace

Receive a single Workspace object previously created in the Stark Bank API by passing its id

## Parameters (required):

  • id [string]: object unique id. ex: ‘5656565656565656’

## Parameters (optional):

  • user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call

## Return:

  • Workspace object with updated attributes



70
71
72
 
# File 'lib/workspace/workspace.rb', line 70

def self.get(id, user: nil)
  StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
end

.page(cursor: nil, limit: nil, username: nil, ids: nil, user: nil) ⇒ Object

# Retrieve paged Workspaces

Receive a list of up to 100 Workspace objects previously created in the Stark Bank API and the cursor to the next page. Use this function instead of query if you want to manually page your requests.

## Parameters (optional):

  • cursor [string, default nil]: cursor returned on the previous page function call

  • limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35

  • username [string]: query by the simplified name that defines the workspace URL. This name is always unique across all Stark Bank Workspaces. Ex: ‘starkbankworkspace’

  • ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: [‘5656565656565656’, ‘4545454545454545’]

  • user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call

## Return:

  • list of Workspace objects with updated attributes and cursor to retrieve the next page of Workspace objects



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/workspace/workspace.rb', line 106

def self.page(cursor: nil, limit: nil, username: nil, ids: nil, user: nil)
  return StarkBank::Utils::Rest.get_page(
    cursor: cursor,
    limit: limit, 
    username: username, 
    ids: ids, 
    user: user, 
    **resource
  )
end

.query(limit: nil, username: nil, ids: nil, user: nil) ⇒ Object

# Retrieve Workspaces

Receive a generator of Workspace objects previously created in the Stark Bank API. If no filters are passed and the user is an Organization, all of the Organization Workspaces will be retrieved.

## Parameters (optional):

  • limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35

  • username [string]: query by the simplified name that defines the workspace URL. This name is always unique across all Stark Bank Workspaces. Ex: ‘starkbankworkspace’

  • ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: [‘5656565656565656’, ‘4545454545454545’]

  • user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call

## Return:

  • generator of Workspace objects with updated attributes



88
89
90
 
# File 'lib/workspace/workspace.rb', line 88

def self.query(limit: nil, username: nil, ids: nil, user: nil)
  StarkBank::Utils::Rest.get_stream(limit: limit, username: username, ids: ids, user: user, **resource)
end

.resource ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/workspace/workspace.rb', line 151

def self.resource
  {
    resource_name: 'Workspace',
    resource_maker: proc { |json|
      Workspace.new(
        id: json['id'],
        username: json['username'],
        name: json['name'],
        allowed_tax_ids: json['allowed_tax_ids'],
        status: json['status'],
        organization_id: json['organization_id'],
        picture_url: json['picture_url'],
        created: json['created']
      )
    }
  }
end

.update(id, username: nil, name: nil, allowed_tax_ids: nil, status: nil, picture: nil, picture_type: nil, user: nil) ⇒ Object

# Update an Workspace entity

Update an Workspace entity previously created in the Stark Bank API

## Parameters (required):

  • id [string]: Workspace unique id. ex: ‘5656565656565656’

## Parameters (conditionally required):

  • picture_type [string]: picture MIME type. This parameter will be required if the picture parameter is informed ex: ‘image/png’ or ‘image/jpeg’

## Parameters (optional):

  • username [string, default nil]: query by the simplified name that defines the workspace URL. This name is always unique across all Stark Bank Workspaces. Ex: ‘starkbankworkspace’

  • name [string, default nil]: Full name that identifies the Workspace. This name will appear when people access the Workspace on our platform, for example. Ex: ‘Stark Bank Workspace’

  • allowed_tax_ids [list of strings, default nil]: list of tax IDs that will be allowed to send Deposits to this Workspace. If empty, all are allowed. ex: [‘012.345.678-90’, ‘20.018.183/0001-80’]

  • status [string, default nil]: current Workspace status. Options: ‘active’ or ‘blocked’

  • picture [bytes, default nil]: Binary buffer of the picture. ex: open(‘/path/to/file.png’, ‘rb’).read()

  • user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call

## Return:

  • updated Workspace object



137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/workspace/workspace.rb', line 137

def self.update(id, username: nil, name: nil, allowed_tax_ids: nil, status: nil, picture: nil, picture_type: nil, user: nil)

  payload = {
    'allowed_tax_ids': allowed_tax_ids,
    'status': status,
  }

  unless picture.nil?
    payload['picture'] = "data:#{picture_type};base64,#{Base64.encode64(picture)}"
  end

  StarkBank::Utils::Rest.patch_id(id: id, user: user, username: username, name: name, **payload, **resource)
end