Documentation

Folders extends BaseResource
in package

Class Folders

Tags
see
https://beadev.net/autentique-v2/folders

Table of Contents

Properties

$autentiqueUrl  : string
Autentique API URL
$api  : Api
Autentique API
$resourcesEnum  : ResourcesEnum
Autentique Resources Enum
$sandbox  : string
Autentique Sandbox Mode
$token  : string
Autentique API Token
$query  : Query

Methods

__construct()  : mixed
Documents constructor.
create()  : array<string|int, mixed>
Create folder
deleteById()  : array<string|int, mixed>
Delete folder by id
getApi()  : Api
Get Autentique API
getSandbox()  : string
Get Autentique Sandbox Mode
getToken()  : string
Get Autentique API Token
listAll()  : array<string|int, mixed>
List all folders
listById()  : array<string|int, mixed>
List folder by id
listContentsById()  : array<string|int, mixed>
List folder by id
setApi()  : $this
Set Api instance customizing the Autentique API URL and Request Timeout
setSandbox()  : $this
Set Autentique Sandbox Mode but by default it will get from $_ENV["AUTENTIQUE_SANDBOX"]
setToken()  : $this
Set Autentique API Token but by default it will get from $_ENV["AUTENTIQUE_TOKEN"]

Properties

$autentiqueUrl

Autentique API URL

public string $autentiqueUrl = "https://api.autentique.com.br/v2/graphql"

$sandbox

Autentique Sandbox Mode

protected string $sandbox

"true"|"false"

Methods

__construct()

Documents constructor.

public __construct([string|null $token = null ][, int $timeout = 60 ]) : mixed
Parameters
$token : string|null = null

Autentique API Token

$timeout : int = 60

Request Timeout in seconds

create()

Create folder

public create(array<string|int, mixed> $variables) : array<string|int, mixed>
Parameters
$variables : array<string|int, mixed>
Return values
array<string|int, mixed>

deleteById()

Delete folder by id

public deleteById(string $folderId) : array<string|int, mixed>
Parameters
$folderId : string
Return values
array<string|int, mixed>

getApi()

Get Autentique API

public getApi() : Api
Tags
codeCoverageIgnore
Return values
Api

getSandbox()

Get Autentique Sandbox Mode

public getSandbox() : string
Tags
codeCoverageIgnore
Return values
string

getToken()

Get Autentique API Token

public getToken() : string
Tags
codeCoverageIgnore
Return values
string

listAll()

List all folders

public listAll([int $page = 1 ]) : array<string|int, mixed>
Parameters
$page : int = 1
Return values
array<string|int, mixed>

listById()

List folder by id

public listById(string $folderId) : array<string|int, mixed>
Parameters
$folderId : string
Return values
array<string|int, mixed>

listContentsById()

List folder by id

public listContentsById(string $folderId[, int $page = 1 ]) : array<string|int, mixed>
Parameters
$folderId : string
$page : int = 1
Return values
array<string|int, mixed>

setApi()

Set Api instance customizing the Autentique API URL and Request Timeout

public setApi(Api $api) : $this
Parameters
$api : Api
Return values
$this

setSandbox()

Set Autentique Sandbox Mode but by default it will get from $_ENV["AUTENTIQUE_SANDBOX"]

public setSandbox([string $sandbox = null ]) : $this
Parameters
$sandbox : string = null

"true"|"false"

Return values
$this

setToken()

Set Autentique API Token but by default it will get from $_ENV["AUTENTIQUE_TOKEN"]

public setToken(string $token) : $this
Parameters
$token : string

Autentique API Token

Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results