{"id":18299864,"url":"https://github.com/containersolutions/avazacli","last_synced_at":"2025-04-09T09:24:52.719Z","repository":{"id":87117882,"uuid":"196406206","full_name":"ContainerSolutions/avazacli","owner":"ContainerSolutions","description":"Generated avaza API client","archived":false,"fork":false,"pushed_at":"2019-07-11T14:23:18.000Z","size":184,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-15T03:29:22.762Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ContainerSolutions.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-11T14:03:31.000Z","updated_at":"2020-11-19T09:16:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"26360875-833b-4a68-8870-7a6bae733d78","html_url":"https://github.com/ContainerSolutions/avazacli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ContainerSolutions%2Favazacli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ContainerSolutions%2Favazacli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ContainerSolutions%2Favazacli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ContainerSolutions%2Favazacli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ContainerSolutions","download_url":"https://codeload.github.com/ContainerSolutions/avazacli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248009978,"owners_count":21032832,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T15:10:34.330Z","updated_at":"2025-04-09T09:24:52.694Z","avatar_url":"https://github.com/ContainerSolutions.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# avazacli\nWelcome to the autogenerated documentation \u0026 test tool for Avaza's API. \u003cbr/\u003e\u003cbr/\u003e\u003cstrong\u003eAPI Security \u0026 Authentication\u003c/strong\u003e\u003cbr/\u003eAuthentication options include OAuth2 Implicit and Authorization Code flows, and Personal Access Token. All connections should be encrypted over SSL/TLS \u003cbr/\u003e\u003cbr/\u003eYou can set up and manage your api authentication credentials from within your Avaza account. (requires Administrator permissions on your Avaza account).\u003cbr/\u003e\u003cbr/\u003e OAuth2 Authorization endpoint: https://any.avaza.com/oauth2/authorize  \u003cbr/\u003eOAuth2 Token endpoint: https://any.avaza.com/oauth2/token\u003cbr/\u003eBase URL for subsequent API Requests: https://api.avaza.com/ \u003cbr/\u003e\u003cbr/\u003eBlogpost about authenticating with Avaza's API:  https://www.avaza.com/avaza-api-oauth2-authentication/ \u003cbr/\u003eBlogpost on using Avaza's webhooks: https://www.avaza.com/avaza-api-webhook-notifications/\u003cbr/\u003eThe OAuth flow currently issues Access Tokens that last 1 day, and Refresh tokens that last 180 days\u003cbr/\u003eThe Api respects the security Roles assigned to the authenticating Avaza user and filters the data return appropriately. \u003cbr/\u003e\u003cbr\u003e\u003cstrong\u003eSupport\u003c/strong\u003e\u003cbr/\u003eFor API Support, and to request access please contact Avaza Support Team via our support chat. \u003cbr/\u003e\u003cbr/\u003e\u003cstrong\u003eUser Contributed Libraries:\u003c/strong\u003e\u003cbr/\u003eGraciously contributed by 3rd party users like you. \u003cbr/\u003eNote these are not tested or endorsesd by Avaza. We encourage you to review before use, and use at own risk.\u003cbr/\u003e \u003cul\u003e\u003cli\u003e - \u003ca target='blank' href='https://packagist.org/packages/debiprasad/oauth2-avaza'\u003ePHP OAuth Client Package for Azava API (by Debiprasad Sahoo)\u003c/a\u003e\u003c/li\u003e\u003c/ul\u003e\n\nThis Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:\n\n- API version: v1\n- Package version: 1.0.0\n- Build package: io.swagger.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation \u0026 Usage\n### pip install\n\nIf the python package is hosted on Github, you can install directly from Github\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport avazacli \n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport avazacli\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\nimport time\nimport avazacli\nfrom avazacli.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: oauth2\navazacli.configuration.access_token = 'YOUR_ACCESS_TOKEN'\n# create an instance of the API class\napi_instance = avazacli.AccountApi()\n\ntry:\n    # Account Details\n    api_response = api_instance.account_get()\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling AccountApi-\u003eaccount_get: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.avaza.com*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AccountApi* | [**account_get**](docs/AccountApi.md#account_get) | **GET** /api/Account | Account Details\n*CompanyApi* | [**company_get**](docs/CompanyApi.md#company_get) | **GET** /api/Company | Gets list of Companies\n*CompanyApi* | [**company_get_by_id**](docs/CompanyApi.md#company_get_by_id) | **GET** /api/Company/{id} | Gets Company by Company ID\n*CompanyApi* | [**company_post**](docs/CompanyApi.md#company_post) | **POST** /api/Company | Create a Company\n*CompanyApi* | [**company_put**](docs/CompanyApi.md#company_put) | **PUT** /api/Company | Update a Task.\n*ContactApi* | [**contact_get**](docs/ContactApi.md#contact_get) | **GET** /api/Contact | Gets list of Contacts\n*ContactApi* | [**contact_get_by_id**](docs/ContactApi.md#contact_get_by_id) | **GET** /api/Contact/{id} | Gets Contact by Contact ID\n*ContactApi* | [**contact_post**](docs/ContactApi.md#contact_post) | **POST** /api/Contact | Create a Contact\n*CreditNoteApi* | [**credit_note_get**](docs/CreditNoteApi.md#credit_note_get) | **GET** /api/CreditNote | Gets list of CreditNotes\n*CreditNoteApi* | [**credit_note_get_by_id**](docs/CreditNoteApi.md#credit_note_get_by_id) | **GET** /api/CreditNote/{id} | Gets Credit Note by CreditNoteID\n*CurrencyApi* | [**currency_get**](docs/CurrencyApi.md#currency_get) | **GET** /api/Currency | Gets list of Currencies\n*EstimateApi* | [**estimate_get**](docs/EstimateApi.md#estimate_get) | **GET** /api/Estimate | Gets list of Estimates\n*EstimateApi* | [**estimate_get_by_id**](docs/EstimateApi.md#estimate_get_by_id) | **GET** /api/Estimate/{id} | Gets Estimate by Estimate ID\n*ExpenseApi* | [**expense_get**](docs/ExpenseApi.md#expense_get) | **GET** /api/Expense | Gets list of Expenses\n*ExpenseApi* | [**expense_get_by_id**](docs/ExpenseApi.md#expense_get_by_id) | **GET** /api/Expense/{id} | Gets an Expense Entry by Expense ID\n*ExpenseApi* | [**expense_post**](docs/ExpenseApi.md#expense_post) | **POST** /api/Expense | Create an Expense\n*InventoryApi* | [**inventory_get**](docs/InventoryApi.md#inventory_get) | **GET** /api/Inventory | Gets list of Inventory\n*InventoryApi* | [**inventory_get_by_id**](docs/InventoryApi.md#inventory_get_by_id) | **GET** /api/Inventory/{id} | Gets InventoryItem by InventoryItem ID\n*InvoiceApi* | [**invoice_get**](docs/InvoiceApi.md#invoice_get) | **GET** /api/Invoice | Gets list of Invoices\n*InvoiceApi* | [**invoice_get_by_id**](docs/InvoiceApi.md#invoice_get_by_id) | **GET** /api/Invoice/{id} | Gets Invoice by Invoice ID\n*InvoiceApi* | [**invoice_post**](docs/InvoiceApi.md#invoice_post) | **POST** /api/Invoice | Create a new draft invoice\n*PaymentApi* | [**payment_get**](docs/PaymentApi.md#payment_get) | **GET** /api/Payment | Gets list of Payments\n*PaymentApi* | [**payment_get_by_id**](docs/PaymentApi.md#payment_get_by_id) | **GET** /api/Payment/{id} | Gets Payment by Payment Transaction ID\n*PaymentApi* | [**payment_post**](docs/PaymentApi.md#payment_post) | **POST** /api/Payment | Create new Payment and optionally assign payment allocations to Invoices\n*ProjectApi* | [**project_get**](docs/ProjectApi.md#project_get) | **GET** /api/Project | Gets list of Projects\n*ProjectApi* | [**project_get_by_id**](docs/ProjectApi.md#project_get_by_id) | **GET** /api/Project/{id} | Gets Project by Project ID\n*ProjectApi* | [**project_post**](docs/ProjectApi.md#project_post) | **POST** /api/Project | Create a Project\n*ProjectTimesheetCategoryApi* | [**project_timesheet_category_get**](docs/ProjectTimesheetCategoryApi.md#project_timesheet_category_get) | **GET** /api/ProjectTimesheetCategory | Gets list of Project Timesheet Categories\n*ScheduleAssignmentApi* | [**schedule_assignment_get**](docs/ScheduleAssignmentApi.md#schedule_assignment_get) | **GET** /api/ScheduleAssignment | Gets list of Schedule Assignments.\n*ScheduleSeriesApi* | [**schedule_series_get**](docs/ScheduleSeriesApi.md#schedule_series_get) | **GET** /api/ScheduleSeries | Gets list of Schedule Series\n*SectionApi* | [**section_get**](docs/SectionApi.md#section_get) | **GET** /api/Section | Gets list of Sections\n*SectionApi* | [**section_post**](docs/SectionApi.md#section_post) | **POST** /api/Section | Create a Section\n*TaskApi* | [**task_get**](docs/TaskApi.md#task_get) | **GET** /api/Task | Gets list of Tasks\n*TaskApi* | [**task_get_by_id**](docs/TaskApi.md#task_get_by_id) | **GET** /api/Task/{id} | Gets Task by Task ID\n*TaskApi* | [**task_post**](docs/TaskApi.md#task_post) | **POST** /api/Task | Create a Task\n*TaskApi* | [**task_put**](docs/TaskApi.md#task_put) | **PUT** /api/Task | Update a Task.\n*TaxApi* | [**tax_get**](docs/TaxApi.md#tax_get) | **GET** /api/Tax | Get List of Taxes configured in the Avaza account.\n*TimesheetApi* | [**timesheet_delete**](docs/TimesheetApi.md#timesheet_delete) | **DELETE** /api/Timesheet/{id} | Delete a Timesheet Entry\n*TimesheetApi* | [**timesheet_get**](docs/TimesheetApi.md#timesheet_get) | **GET** /api/Timesheet | Gets list of Timsheets\n*TimesheetApi* | [**timesheet_get_by_id**](docs/TimesheetApi.md#timesheet_get_by_id) | **GET** /api/Timesheet/{id} | Gets a Timesheet Entry by Timesheet ID\n*TimesheetApi* | [**timesheet_post**](docs/TimesheetApi.md#timesheet_post) | **POST** /api/Timesheet | Create a new Timesheet Entry\n*TimesheetApi* | [**timesheet_put**](docs/TimesheetApi.md#timesheet_put) | **PUT** /api/Timesheet | Update a Timesheet\n*TimesheetSubmissionApi* | [**timesheet_submission_post**](docs/TimesheetSubmissionApi.md#timesheet_submission_post) | **POST** /api/TimesheetSubmission | Submit Timesheets for Approval.\n*TimesheetTimerApi* | [**timesheet_timer_get_running_timer**](docs/TimesheetTimerApi.md#timesheet_timer_get_running_timer) | **GET** /api/TimesheetTimer | Gets the  Running Timer if there is one for a user.\n*TimesheetTimerApi* | [**timesheet_timer_start_timer**](docs/TimesheetTimerApi.md#timesheet_timer_start_timer) | **POST** /api/TimesheetTimer/{id} | Starts a Timer running on an existing Timesheet Entry\n*TimesheetTimerApi* | [**timesheet_timer_stop_timer**](docs/TimesheetTimerApi.md#timesheet_timer_stop_timer) | **DELETE** /api/TimesheetTimer/{id} | Stop the timer running on an existing Timesheet Entry\n*UserProfileApi* | [**user_profile_get**](docs/UserProfileApi.md#user_profile_get) | **GET** /api/UserProfile | Get Collection of Users who have roles in the current Avaza account.\n*WebhookApi* | [**webhook_delete**](docs/WebhookApi.md#webhook_delete) | **DELETE** /api/Webhook/{id} | Delete Webhook Subscription by ID\n*WebhookApi* | [**webhook_delete_by_url**](docs/WebhookApi.md#webhook_delete_by_url) | **DELETE** /api/Webhook | Delete webhook subscription by URL\n*WebhookApi* | [**webhook_get**](docs/WebhookApi.md#webhook_get) | **GET** /api/Webhook | Get list of Webhook Subscriptions\n*WebhookApi* | [**webhook_post**](docs/WebhookApi.md#webhook_post) | **POST** /api/Webhook | Subscribe to Webhook. On success, returns ID of webhook subscription.\n\n\n## Documentation For Models\n\n - [AccountDetails](docs/AccountDetails.md)\n - [Company](docs/Company.md)\n - [CompanyContact](docs/CompanyContact.md)\n - [CompanyList](docs/CompanyList.md)\n - [ContactList](docs/ContactList.md)\n - [CreateSubscription](docs/CreateSubscription.md)\n - [CreditNote](docs/CreditNote.md)\n - [CreditNoteAllocation](docs/CreditNoteAllocation.md)\n - [CreditNoteLineItem](docs/CreditNoteLineItem.md)\n - [CreditNoteList](docs/CreditNoteList.md)\n - [Currency](docs/Currency.md)\n - [CurrencyList](docs/CurrencyList.md)\n - [EstimateDetails](docs/EstimateDetails.md)\n - [EstimateLineItemDetails](docs/EstimateLineItemDetails.md)\n - [EstimateLinks](docs/EstimateLinks.md)\n - [EstimateList](docs/EstimateList.md)\n - [ExpenseDetails](docs/ExpenseDetails.md)\n - [ExpenseList](docs/ExpenseList.md)\n - [InventoryItem](docs/InventoryItem.md)\n - [InventoryList](docs/InventoryList.md)\n - [Invoice](docs/Invoice.md)\n - [InvoiceLineItem](docs/InvoiceLineItem.md)\n - [InvoiceLinks](docs/InvoiceLinks.md)\n - [InvoiceList](docs/InvoiceList.md)\n - [IssuerDetails](docs/IssuerDetails.md)\n - [NewCompany](docs/NewCompany.md)\n - [NewCompanyContact](docs/NewCompanyContact.md)\n - [NewExpense](docs/NewExpense.md)\n - [NewInvoice](docs/NewInvoice.md)\n - [NewInvoiceLineItem](docs/NewInvoiceLineItem.md)\n - [NewPayment](docs/NewPayment.md)\n - [NewPaymentAllocation](docs/NewPaymentAllocation.md)\n - [NewProjectModel](docs/NewProjectModel.md)\n - [NewSection](docs/NewSection.md)\n - [NewTag](docs/NewTag.md)\n - [NewTask](docs/NewTask.md)\n - [NewTimesheet](docs/NewTimesheet.md)\n - [Payment](docs/Payment.md)\n - [PaymentAllocation](docs/PaymentAllocation.md)\n - [PaymentList](docs/PaymentList.md)\n - [ProjectDetails](docs/ProjectDetails.md)\n - [ProjectList](docs/ProjectList.md)\n - [ProjectListDetails](docs/ProjectListDetails.md)\n - [ProjectMemberDetails](docs/ProjectMemberDetails.md)\n - [ProjectSectionDetails](docs/ProjectSectionDetails.md)\n - [ProjectTagItem](docs/ProjectTagItem.md)\n - [ProjectTimesheetCategoryDetails](docs/ProjectTimesheetCategoryDetails.md)\n - [ProjectTimesheetCategoryList](docs/ProjectTimesheetCategoryList.md)\n - [RecipientDetails](docs/RecipientDetails.md)\n - [RoleDetails](docs/RoleDetails.md)\n - [ScheduleAssignmentDetails](docs/ScheduleAssignmentDetails.md)\n - [ScheduleAssignmentList](docs/ScheduleAssignmentList.md)\n - [ScheduleSeriesDetails](docs/ScheduleSeriesDetails.md)\n - [ScheduleSeriesList](docs/ScheduleSeriesList.md)\n - [SectionDetails](docs/SectionDetails.md)\n - [SectionList](docs/SectionList.md)\n - [SubscribeResult](docs/SubscribeResult.md)\n - [TagItem](docs/TagItem.md)\n - [TaskDetails](docs/TaskDetails.md)\n - [TaskList](docs/TaskList.md)\n - [TaxComponent](docs/TaxComponent.md)\n - [TaxItem](docs/TaxItem.md)\n - [TaxList](docs/TaxList.md)\n - [TimesheetDetails](docs/TimesheetDetails.md)\n - [TimesheetList](docs/TimesheetList.md)\n - [UpdateCompany](docs/UpdateCompany.md)\n - [UpdateTask](docs/UpdateTask.md)\n - [UpdateTimesheetModel](docs/UpdateTimesheetModel.md)\n - [UserDetails](docs/UserDetails.md)\n - [UserList](docs/UserList.md)\n - [UserTagDetails](docs/UserTagDetails.md)\n - [WebhookDetails](docs/WebhookDetails.md)\n - [WebhookList](docs/WebhookList.md)\n\n\n## Documentation For Authorization\n\n\n## oauth2\n\n- **Type**: OAuth\n- **Flow**: implicit\n- **Authorization URL**: https://any.avaza.com/oauth2/authorize\n- **Scopes**: \n - **read_contacts**: Read access to Customers, Contacts\n - **read_account**: Read access to Account metadata\n - **read_users**: Read access to User Profiles\n - **read_financials**: Read access to Estimates, Invoices, Payments, Credit Notes\n - **read_projects**: Read access to Projects, Project Settings, Tasks\n - **read_schedule**: Read access to Schedule Details\n - **read_timesheets**: Read access to Timesheet Details\n - **read_expenses**: Read access to Expense Details\n - **write_contacts**: Write access to Customers, Contacts\n - **write_account**: Write access to Account metadata\n - **write_users**: Write access to User Profiles\n - **write_financials**: Write access to Estimates, Invoices, Payments, Credit Notes\n - **write_projects**: Write access to Projects, Project Settings, Tasks\n - **write_schedule**: Write access to Schedule module\n - **write_timesheets**: Write access to Timesheets module\n - **write_expenses**: Write access to Expense module\n - **webhook_notifications**: Read access to webhook notification events\n\n\n## Author\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontainersolutions%2Favazacli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcontainersolutions%2Favazacli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontainersolutions%2Favazacli/lists"}