Class: StarkBank::Request

Inherits:
Object
  • Object
show all
Defined in:
lib/request/request.rb

Class Method Summary collapse

Class Method Details

.delete(path:, query: nil, user: nil) ⇒ Object

# Delete any StarkBank resource

Send parameters of StarkBank resources and delete them

Parameters (required):

  • path [string]: StarkBank resource’s route. ex: “/transfer/5699165527090460”

Parameters (optional):

  • user [Organization/Project object, default None]: Organization or Project object. Not necessary if StarkBank.user

    was set before function call

Return:

  • json of the resource with updated attributes



141
142
143
144
145
146
147
148
149
 
# File 'lib/request/request.rb', line 141

def self.delete(path:, query: nil, user: nil)
    content = StarkBank::Utils::Rest.delete_raw(
        path: path,
        query: query,
        user: user,
        prefix: "Joker",
        raiseException: false
    )
end

.get(path:, query: nil, user: nil) ⇒ Object

# Retrieve any StarkBank resource

Receive a json of resources previously created in StarkBank’s API

Parameters (required):

  • path [string]: StarkBank resource’s route. ex: “/invoice/”

  • query [json, default None]: Query parameters. ex: 1, “status”: paid

Parameters (optional):

  • user [Organization/Project object, default None]: Organization or Project object. Not necessary if StarkBank.user

    was set before function call

Return:

  • json of StarkBank objects with updated attributes



28
29
30
31
32
33
34
35
36
 
# File 'lib/request/request.rb', line 28

def self.get(path:, query: nil, user: nil)
    content = StarkBank::Utils::Rest.get_raw(
        path: path,
        query: query,
        user: user,
        prefix: "Joker",
        raiseException: false
    )
end

.patch(path:, payload:, query: nil, user: nil) ⇒ Object

# Update any StarkBank resource

Send a json with parameters of StarkBank resources to update them

Parameters (required):

  • path [string]: StarkBank resource’s route. ex: “/invoice/5699165527090460”

  • body [json]: request parameters. ex: 100

Parameters (optional):

  • user [Organization/Project object, default None]: Organization or Project object. Not necessary if StarkBank.user

    was set before function call

Return:

  • json of the resource with updated attributes



85
86
87
88
89
90
91
92
93
94
 
# File 'lib/request/request.rb', line 85

def self.patch(path:, payload:, query: nil, user: nil)
    content = StarkBank::Utils::Rest.patch_raw(
        path: path,
        query: query,
        payload: payload,
        user: user,
        prefix: "Joker",
        raiseException: false
    )
end

.post(path:, payload:, query: nil, user: nil) ⇒ Object

# Create any StarkBank resource

Send a json to create StarkBank resources

Parameters (required):

  • path [string]: StarkBank resource’s route. ex: “/invoice/”

  • body [json]: request parameters. ex: [{“amount”: 100, “name”: “Iron Bank S.A.”, “taxId”: “20.018.183/0001-80”]}

Parameters (optional):

  • user [Organization/Project object, default None]: Organization or Project object. Not necessary if StarkBank.user

    was set before function call

  • query [json, default None]: Query parameters. ex: 1, “status”: paid

Return:

  • list of resources jsons with updated attributes



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/request/request.rb', line 57

def self.post(path:, payload:, query: nil, user: nil)
    content = StarkBank::Utils::Rest.post_raw(
        path: path,
        query: query,
        payload: payload,
        user: user,
        prefix: "Joker",
        raiseException: false
    )
end

.put(path:, payload:, query: nil, user: nil) ⇒ Object

# Put any StarkBank resource

Send a json with parameters of a StarkBank resources to create them. If the resource already exists, you will update it.

Parameters (required):

  • path [string]: StarkBank resource’s route. ex: “/split-profile”

  • body [json]: request parameters. ex: [{“interval”: day, “delay”: “1”]}

Parameters (optional):

  • user [Organization/Project object, default None]: Organization or Project object. Not necessary if StarkBank.user

    was set before function call

Return:

  • json of the resource with updated attributes



114
115
116
117
118
119
120
121
122
123
 
# File 'lib/request/request.rb', line 114

def self.put(path:, payload:, query: nil, user: nil)
    content = StarkBank::Utils::Rest.put_raw(
        path: path,
        query: query,
        payload: payload,
        user: user,
        prefix: "Joker",
        raiseException: false
    )
end