Skip to main content

Pipefy manipulator

Project description

PipefyUts

Installation

pip install pipefyUts

GitHub

Usage

Auth

python code
from pipefyUts import Pipefy

ORG_ID =  "<your_org_id>"
TOKEN  = "<your_token>"

pfy = Pipefy(ORG_ID,TOKEN)

listMembers

pfy.listMembers()
output
[
    {"id":1,"name":"name_1","email":"email_1@email.com"},
    {"id":2,"name":"name_2","email":"email_2@email.com"},
    {"id":3,"name":"name_3","email":"email_3@email.com"},
    {"id":4,"name":"name_4","email":"email_4@email.com"}
]

listStartFormFields

pfy.listStartFormFields(pipe_id="<pipe_id>")
output
[
    {"id":"field_1","label":"field_label_1"},
    {"id":"field_2","label":"field_label_2"},
    {"id":"field_3","label":"field_label_3"},
    {"id":"field_4","label":"field_label_4"}
]

listCardsFromPhase

pfy.listCardsFromPhase(phase_id="<phase_id>")
output
[
    {"id":"card_id_1","fields":[{...},{...},{...},...]},
    {"id":"card_id_2","fields":[{...},{...},{...},...]},
    {"id":"card_id_3","fields":[{...},{...},{...},...]},
    {"id":"card_id_4","fields":[{...},{...},{...},...]}
]

createAttachment

path = pfy.createAttachment(file_path="<my_file>")
output
"orgs/123456-1234-1234-1234-123asd5as1ad5s1/uploads/123ad3-123ddas-123cs-123da-asdc21cas21/my_file.txt"

cardCreation

authentication first

from pipefyUts import Pipefy,NewCard,CardField

ORG_ID =  "<your_org_id>"
TOKEN  = "<your_token>"

pfy = Pipefy(ORG_ID,TOKEN)

create card schema

class MyCard(NewCard):
    #DEFAULT
    __pipeid__               = "<my_pipe_id>"
    __title__                = "<card_title>"

    #PIPEFY FIELDS
    description              = CardField(str)
    total_ammount            = CardField(float)
    files                    = CardField(list)
    files                    = CardField(list,is_file_path=True)

create card

#CREATE CARD OBJECT
myNewCard = MyCard(
    description   = "AdtPro",
    total_ammount = 123.46,
    files         = ["<owner_id>"],
    files         = [r".\Doc1.pdf",r".\Doc2.txt"]
)

#RUN CARD CREATION
pfy.createCard(card=myNewCard)
output
{"id":"card_id"}

deleteCard

pfy.deleteCard(card_id="<card_id>")

Change Log

1.0.0 (2023-04-26)

  • First Release

1.0.1 (2023-04-26)

  • Bug Fixed

1.0.2 (2023-04-26)

  • Upercase Bug Fixed

1.0.3 (2023-04-26)

  • Upercase Write Bug Fixed

1.0.4 (2023-04-28)

  • Update Class bug fixed

1.0.6 (2023-04-28)

  • empty_as_null

1.0.7 (2023-04-28)

  • changing enviornment

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pipefyUts-1.0.6.tar.gz (9.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page