├── .gitignore
├── .travis.yml
├── docs
├── Model
│ ├── File.md
│ ├── PayloadOutboxModification.md
│ ├── PayloadNumberModification.md
│ ├── Error.md
│ ├── ResponseArchiveData.md
│ ├── ResponseNumberList.md
│ ├── ResponseOutboxList.md
│ ├── ResponseAccountList.md
│ ├── OutboxInitiatedFrom.md
│ ├── OutboxStatusChanges.md
│ ├── PayloadOutboxComment.md
│ ├── ResponseArchive.md
│ ├── FaxCostDetails.md
│ ├── PayloadOutboxOptionsRetry.md
│ ├── AccountSettingsSendFaxRetry.md
│ ├── PayloadFaxModification.md
│ ├── AccountSettingsSendFax.md
│ ├── OutboxFileChanges.md
│ ├── OutboxFiles.md
│ ├── NumberNotifications.md
│ ├── MemberDetail.md
│ ├── PayloadOutboxOptions.md
│ ├── AccountSettings.md
│ ├── AccountAccountData.md
│ ├── PayloadOutbox.md
│ ├── Number.md
│ ├── Fax.md
│ ├── Account.md
│ └── Outbox.md
└── Api
│ ├── FilesApi.md
│ ├── NumbersApi.md
│ └── ArchivesApi.md
├── .php_cs
├── composer.json
├── LICENSE.md
├── lib
├── model
│ ├── ModelInterface.php
│ ├── File.php
│ ├── ResponseArchiveData.php
│ ├── ResponseArchive.php
│ ├── AccountSettingsSendFax.php
│ ├── PayloadOutboxModification.php
│ ├── ResponseAccountList.php
│ ├── ResponseNumberList.php
│ ├── ResponseOutboxList.php
│ ├── PayloadNumberModification.php
│ ├── OutboxStatusChanges.php
│ ├── PayloadOutboxComment.php
│ ├── OutboxFileChanges.php
│ ├── MemberDetail.php
│ ├── PayloadOutboxOptionsRetry.php
│ ├── OutboxInitiatedFrom.php
│ ├── AccountSettingsSendFaxRetry.php
│ ├── Error.php
│ ├── PayloadFaxModification.php
│ └── PayloadOutboxOptions.php
├── ApiException.php
└── HeaderSelector.php
└── README.md
/.gitignore:
--------------------------------------------------------------------------------
1 | vendor
2 | composer.phar
3 | composer.lock
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: php
2 | sudo: false
3 | php:
4 | - 5.4
5 | - 5.5
6 | - 5.6
7 | - 7.0
8 | - hhvm
9 | before_install: "composer install"
10 | script: "vendor/bin/phpunit"
11 |
--------------------------------------------------------------------------------
/docs/Model/File.md:
--------------------------------------------------------------------------------
1 | # File
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **path** | **string** | Path of newly uploaded file | [optional]
7 |
8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/Model/PayloadOutboxModification.md:
--------------------------------------------------------------------------------
1 | # PayloadOutboxModification
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **comment** | **string** | | [optional]
7 |
8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/Model/PayloadNumberModification.md:
--------------------------------------------------------------------------------
1 | # PayloadNumberModification
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **assigned_to** | **string** | | [optional]
7 |
8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/Model/Error.md:
--------------------------------------------------------------------------------
1 | # Error
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **error** | **string** | | [optional]
7 | **description** | **string** | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/Model/ResponseArchiveData.md:
--------------------------------------------------------------------------------
1 | # ResponseArchiveData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **records** | [**\faxplus\model\Fax[]**](Fax.md) | | [optional]
7 |
8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/Model/ResponseNumberList.md:
--------------------------------------------------------------------------------
1 | # ResponseNumberList
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **numbers** | [**\faxplus\model\Number[]**](Number.md) | | [optional]
7 |
8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/Model/ResponseOutboxList.md:
--------------------------------------------------------------------------------
1 | # ResponseOutboxList
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **records** | [**\faxplus\model\Outbox[]**](Outbox.md) | | [optional]
7 |
8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/Model/ResponseAccountList.md:
--------------------------------------------------------------------------------
1 | # ResponseAccountList
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **members** | [**\faxplus\model\Account[]**](Account.md) | | [optional]
7 |
8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/Model/OutboxInitiatedFrom.md:
--------------------------------------------------------------------------------
1 | # OutboxInitiatedFrom
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **type** | **string** | | [optional]
7 | **from_id** | **string** | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/Model/OutboxStatusChanges.md:
--------------------------------------------------------------------------------
1 | # OutboxStatusChanges
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **string** | | [optional]
7 | **at** | **string** | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/Model/PayloadOutboxComment.md:
--------------------------------------------------------------------------------
1 | # PayloadOutboxComment
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **text** | **string** | | [optional]
7 | **tags** | **string[]** | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/Model/ResponseArchive.md:
--------------------------------------------------------------------------------
1 | # ResponseArchive
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **data** | [**\faxplus\model\ResponseArchiveData**](ResponseArchiveData.md) | | [optional]
7 |
8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/Model/FaxCostDetails.md:
--------------------------------------------------------------------------------
1 | # FaxCostDetails
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **notification_cost** | **float** | | [optional]
7 | **multiplier** | **float** | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/Model/PayloadOutboxOptionsRetry.md:
--------------------------------------------------------------------------------
1 | # PayloadOutboxOptionsRetry
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **delay** | **int** | | [optional]
7 | **count** | **int** | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/Model/AccountSettingsSendFaxRetry.md:
--------------------------------------------------------------------------------
1 | # AccountSettingsSendFaxRetry
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **count** | **int** | | [optional]
7 | **delay** | **int** | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/Model/PayloadFaxModification.md:
--------------------------------------------------------------------------------
1 | # PayloadFaxModification
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **is_read** | **bool** | | [optional]
7 | **comment** | **string** | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
12 |
--------------------------------------------------------------------------------
/.php_cs:
--------------------------------------------------------------------------------
1 | level(Symfony\CS\FixerInterface::PSR2_LEVEL)
5 | ->setUsingCache(true)
6 | ->fixers(
7 | [
8 | 'ordered_use',
9 | 'phpdoc_order',
10 | 'short_array_syntax',
11 | 'strict',
12 | 'strict_param'
13 | ]
14 | )
15 | ->finder(
16 | Symfony\CS\Finder\DefaultFinder::create()
17 | ->in(__DIR__)
18 | );
19 |
--------------------------------------------------------------------------------
/docs/Model/AccountSettingsSendFax.md:
--------------------------------------------------------------------------------
1 | # AccountSettingsSendFax
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **retry** | [**\faxplus\model\AccountSettingsSendFaxRetry**](AccountSettingsSendFaxRetry.md) | | [optional]
7 |
8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/Model/OutboxFileChanges.md:
--------------------------------------------------------------------------------
1 | # OutboxFileChanges
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **files** | [**\faxplus\model\OutboxFiles[]**](OutboxFiles.md) | | [optional]
7 | **at** | **string** | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/Model/OutboxFiles.md:
--------------------------------------------------------------------------------
1 | # OutboxFiles
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **file_name** | **string** | | [optional]
7 | **mime_type** | **string** | | [optional]
8 | **size** | **float** | | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/Model/NumberNotifications.md:
--------------------------------------------------------------------------------
1 | # NumberNotifications
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **type** | **string** | | [optional]
7 | **email** | **bool** | | [optional]
8 | **push_notification** | **bool** | | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/Model/MemberDetail.md:
--------------------------------------------------------------------------------
1 | # MemberDetail
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **quota** | **int** | quota of member (number of pages member can send per month) | [optional]
7 | **role** | **string** | Role of member in your company | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/Model/PayloadOutboxOptions.md:
--------------------------------------------------------------------------------
1 | # PayloadOutboxOptions
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **retry** | [**\faxplus\model\PayloadOutboxOptionsRetry**](PayloadOutboxOptionsRetry.md) | | [optional]
7 | **enhancement** | **bool** | | [optional]
8 |
9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/Model/AccountSettings.md:
--------------------------------------------------------------------------------
1 | # AccountSettings
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **caller_id_name** | **string** | Account caller id name | [optional]
7 | **send_fax** | [**\faxplus\model\AccountSettingsSendFax**](AccountSettingsSendFax.md) | | [optional]
8 | **should_enhance** | **bool** | | [optional]
9 | **options** | **object** | | [optional]
10 |
11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12 |
13 |
14 |
--------------------------------------------------------------------------------
/docs/Model/AccountAccountData.md:
--------------------------------------------------------------------------------
1 | # AccountAccountData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **default_file_type** | **string** | Default file type that fax server uses to send the fax | [optional]
7 | **save_history** | **bool** | Save fax CDRs in inbox status | [optional]
8 | **company_name** | **string** | Your company name in case you are corporate admin | [optional]
9 |
10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/Model/PayloadOutbox.md:
--------------------------------------------------------------------------------
1 | # PayloadOutbox
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **to** | **string[]** | | [optional]
7 | **from** | **string** | | [optional]
8 | **files** | **string[]** | | [optional]
9 | **options** | [**\faxplus\model\PayloadOutboxOptions**](PayloadOutboxOptions.md) | | [optional]
10 | **send_time** | **string** | | [optional]
11 | **comment** | [**\faxplus\model\PayloadOutboxComment**](PayloadOutboxComment.md) | | [optional]
12 |
13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14 |
15 |
16 |
--------------------------------------------------------------------------------
/docs/Model/Number.md:
--------------------------------------------------------------------------------
1 | # Number
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **id** | **string** | | [optional]
7 | **status** | **string** | Status of your fax phone number e.g. active, inactive. | [optional]
8 | **is_canceled** | **bool** | | [optional]
9 | **expiration_date** | **string** | | [optional]
10 | **number** | **string** | | [optional]
11 | **notifications** | [**\faxplus\model\NumberNotifications[]**](NumberNotifications.md) | | [optional]
12 | **acquired_date** | **string** | | [optional]
13 | **assigned_to** | **object** | | [optional]
14 | **owner_id** | **string** | | [optional]
15 |
16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "alohi/faxplus-api",
3 | "version": "0.1",
4 | "description": "",
5 | "keywords": [
6 | "php",
7 | "sdk",
8 | "api",
9 | "alohi"
10 | ],
11 | "homepage": "https://github.com/alohi/faxplus-php",
12 | "license": "MIT",
13 | "authors": [
14 | {
15 | "name": "alohi",
16 | "homepage": "https://github.com/alohi"
17 | }
18 | ],
19 | "require": {
20 | "php": ">=5.5",
21 | "ext-curl": "*",
22 | "ext-json": "*",
23 | "ext-mbstring": "*",
24 | "guzzlehttp/guzzle": "^6.2"
25 | },
26 | "require-dev": {
27 | "phpunit/phpunit": "^4.8",
28 | "squizlabs/php_codesniffer": "~2.6",
29 | "friendsofphp/php-cs-fixer": "~1.12"
30 | },
31 | "autoload": {
32 | "psr-4": { "faxplus\\" : "lib/" }
33 | }
34 | }
35 |
36 |
--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | Copyright 2018 Alohi Co.
2 |
3 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4 |
5 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6 |
7 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
--------------------------------------------------------------------------------
/docs/Model/Fax.md:
--------------------------------------------------------------------------------
1 | # Fax
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **id** | **string** | | [optional]
7 | **comment** | **string** | | [optional]
8 | **cost** | **int** | | [optional]
9 | **direction** | **string** | | [optional]
10 | **from** | **string** | | [optional]
11 | **status** | **string** | | [optional]
12 | **scheduled_time** | **string** | | [optional]
13 | **description** | **string** | | [optional]
14 | **is_spam** | **bool** | | [optional]
15 | **submit_time** | **string** | | [optional]
16 | **cost_details** | [**\faxplus\model\FaxCostDetails**](FaxCostDetails.md) | | [optional]
17 | **header** | **string** | | [optional]
18 | **file** | **string** | | [optional]
19 | **file_name** | **string** | | [optional]
20 | **retry_delay** | **int** | | [optional]
21 | **max_retry** | **int** | | [optional]
22 | **pages** | **int** | | [optional]
23 | **start_time** | **string** | | [optional]
24 | **to** | **string** | | [optional]
25 | **duration** | **int** | | [optional]
26 | **last_update** | **string** | | [optional]
27 | **is_read** | **bool** | | [optional]
28 | **owner_id** | **string** | | [optional]
29 |
30 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
31 |
32 |
33 |
--------------------------------------------------------------------------------
/docs/Model/Account.md:
--------------------------------------------------------------------------------
1 | # Account
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **string** | Your account status which could be active, inactive etc | [optional]
7 | **account_type** | **string** | Account type which could be corporate_admin, individual, etc | [optional]
8 | **lastname** | **string** | Your last name | [optional]
9 | **profile_image** | **string** | Profile image path | [optional]
10 | **creation_date** | **string** | creation date in UTC in the format of YYYY-MM-DD | [optional]
11 | **phone** | **string** | Your account phone number | [optional]
12 | **last_password_modification_date** | **string** | The date in which you have changed your password | [optional]
13 | **uid** | **string** | user id of current user | [optional]
14 | **account_data** | [**\faxplus\model\AccountAccountData**](AccountAccountData.md) | | [optional]
15 | **name** | **string** | your first name | [optional]
16 | **member_of** | **string[]** | list of user ids that you are member of. | [optional]
17 | **settings** | [**\faxplus\model\AccountSettings**](AccountSettings.md) | | [optional]
18 | **email** | **string** | Account email address | [optional]
19 | **notifications** | **object** | | [optional]
20 |
21 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
22 |
23 |
24 |
--------------------------------------------------------------------------------
/docs/Model/Outbox.md:
--------------------------------------------------------------------------------
1 | # Outbox
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **files** | **string[]** | | [optional]
7 | **src** | **string** | | [optional]
8 | **retry** | [**\faxplus\model\AccountSettingsSendFaxRetry**](AccountSettingsSendFaxRetry.md) | | [optional]
9 | **should_enhance** | **bool** | | [optional]
10 | **uid** | **string** | | [optional]
11 | **designated_src** | **string** | | [optional]
12 | **ip** | **string** | | [optional]
13 | **page_count** | **int** | | [optional]
14 | **comment** | [**\faxplus\model\PayloadOutboxComment**](PayloadOutboxComment.md) | | [optional]
15 | **id** | **string** | | [optional]
16 | **file_changes** | [**\faxplus\model\OutboxFileChanges[]**](OutboxFileChanges.md) | | [optional]
17 | **to** | **string[]** | | [optional]
18 | **status** | **string** | | [optional]
19 | **status_changes** | [**\faxplus\model\OutboxStatusChanges[]**](OutboxStatusChanges.md) | | [optional]
20 | **contact_name** | **string** | | [optional]
21 | **send_time** | **string** | | [optional]
22 | **initiated_from** | [**\faxplus\model\OutboxInitiatedFrom**](OutboxInitiatedFrom.md) | | [optional]
23 | **submit_time** | **string** | | [optional]
24 | **last_updated_status_time** | **string** | | [optional]
25 | **options** | **object** | | [optional]
26 | **extra_info** | **object** | | [optional]
27 |
28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
29 |
30 |
31 |
--------------------------------------------------------------------------------
/lib/model/ModelInterface.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | /**
33 | * Interface abstracting model access.
34 | *
35 | * @package faxplus\model
36 | * @author Swagger Codegen team
37 | */
38 | interface ModelInterface
39 | {
40 | /**
41 | * The original name of the model.
42 | *
43 | * @return string
44 | */
45 | public function getModelName();
46 |
47 | /**
48 | * Array of property to type mappings. Used for (de)serialization
49 | *
50 | * @return array
51 | */
52 | public static function swaggerTypes();
53 |
54 | /**
55 | * Array of property to format mappings. Used for (de)serialization
56 | *
57 | * @return array
58 | */
59 | public static function swaggerFormats();
60 |
61 | /**
62 | * Array of attributes where the key is the local name, and the value is the original name
63 | *
64 | * @return array
65 | */
66 | public static function attributeMap();
67 |
68 | /**
69 | * Array of attributes to setter functions (for deserialization of responses)
70 | *
71 | * @return array
72 | */
73 | public static function setters();
74 |
75 | /**
76 | * Array of attributes to getter functions (for serialization of requests)
77 | *
78 | * @return array
79 | */
80 | public static function getters();
81 |
82 | /**
83 | * Show all the invalid properties with reasons.
84 | *
85 | * @return array
86 | */
87 | public function listInvalidProperties();
88 |
89 | /**
90 | * Validate all the properties in the model
91 | * return true if all passed
92 | *
93 | * @return bool
94 | */
95 | public function valid();
96 | }
97 |
--------------------------------------------------------------------------------
/lib/ApiException.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
16 | *
17 | * OpenAPI spec version: 1.1.0
18 | *
19 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
20 | * Swagger Codegen version: 2.4.0-SNAPSHOT
21 | */
22 |
23 | /**
24 | * NOTE: This class is auto generated by the swagger code generator program.
25 | * https://github.com/swagger-api/swagger-codegen
26 | * Do not edit the class manually.
27 | */
28 |
29 | namespace faxplus;
30 |
31 | use \Exception;
32 |
33 | /**
34 | * ApiException Class Doc Comment
35 | *
36 | * @category Class
37 | * @package faxplus
38 | * @author Swagger Codegen team
39 | * @link https://github.com/swagger-api/swagger-codegen
40 | */
41 | class ApiException extends Exception
42 | {
43 |
44 | /**
45 | * The HTTP body of the server response either as Json or string.
46 | *
47 | * @var mixed
48 | */
49 | protected $responseBody;
50 |
51 | /**
52 | * The HTTP header of the server response.
53 | *
54 | * @var string[]|null
55 | */
56 | protected $responseHeaders;
57 |
58 | /**
59 | * The deserialized response object
60 | *
61 | * @var $responseObject;
62 | */
63 | protected $responseObject;
64 |
65 | /**
66 | * Constructor
67 | *
68 | * @param string $message Error message
69 | * @param int $code HTTP status code
70 | * @param string[]|null $responseHeaders HTTP response header
71 | * @param mixed $responseBody HTTP decoded body of the server response either as \stdClass or string
72 | */
73 | public function __construct($message = "", $code = 0, $responseHeaders = [], $responseBody = null)
74 | {
75 | parent::__construct($message, $code);
76 | $this->responseHeaders = $responseHeaders;
77 | $this->responseBody = $responseBody;
78 | }
79 |
80 | /**
81 | * Gets the HTTP response header
82 | *
83 | * @return string[]|null HTTP response header
84 | */
85 | public function getResponseHeaders()
86 | {
87 | return $this->responseHeaders;
88 | }
89 |
90 | /**
91 | * Gets the HTTP body of the server response either as Json or string
92 | *
93 | * @return mixed HTTP body of the server response either as \stdClass or string
94 | */
95 | public function getResponseBody()
96 | {
97 | return $this->responseBody;
98 | }
99 |
100 | /**
101 | * Sets the deseralized response object (during deserialization)
102 | *
103 | * @param mixed $obj Deserialized response object
104 | *
105 | * @return void
106 | */
107 | public function setResponseObject($obj)
108 | {
109 | $this->responseObject = $obj;
110 | }
111 |
112 | /**
113 | * Gets the deseralized response object (during deserialization)
114 | *
115 | * @return mixed the deserialized response object
116 | */
117 | public function getResponseObject()
118 | {
119 | return $this->responseObject;
120 | }
121 | }
122 |
--------------------------------------------------------------------------------
/docs/Api/FilesApi.md:
--------------------------------------------------------------------------------
1 | # faxplus\FilesApi
2 |
3 | All URIs are relative to *https://restapi.fax.plus/v1*
4 |
5 | Method | HTTP request | Description
6 | ------------- | ------------- | -------------
7 | [**getFile**](FilesApi.md#getFile) | **GET** /accounts/self/files/{fax_id} | get a file
8 | [**uploadFile**](FilesApi.md#uploadFile) | **POST** /accounts/self/files | upload a file
9 |
10 |
11 | # **getFile**
12 | > \SplFileObject getFile($fax_id, $format)
13 |
14 | get a file
15 |
16 | Get your fax archive file using it's id.
17 |
18 | ### Example
19 | ```php
20 | setAccessToken('YOUR_ACCESS_TOKEN');
25 |
26 | $apiInstance = new faxplus\Api\FilesApi(
27 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
28 | // This is optional, `GuzzleHttp\Client` will be used as default.
29 | new GuzzleHttp\Client(),
30 | $config
31 | );
32 | $fax_id = "fax_id_example"; // string |
33 | $format = "format_example"; // string | can be 'pdf' or 'tiff'
34 |
35 | try {
36 | $result = $apiInstance->getFile($fax_id, $format);
37 | print_r($result);
38 | } catch (Exception $e) {
39 | echo 'Exception when calling FilesApi->getFile: ', $e->getMessage(), PHP_EOL;
40 | }
41 | ?>
42 | ```
43 |
44 | ### Parameters
45 |
46 | Name | Type | Description | Notes
47 | ------------- | ------------- | ------------- | -------------
48 | **fax_id** | **string**| |
49 | **format** | **string**| can be 'pdf' or 'tiff' | [optional]
50 |
51 | ### Return type
52 |
53 | [**\SplFileObject**](../Model/\SplFileObject.md)
54 |
55 | ### Authorization
56 |
57 | [fax_oauth](../../README.md#fax_oauth)
58 |
59 | ### HTTP request headers
60 |
61 | - **Content-Type**: application/json
62 | - **Accept**: application/pdf, image/tiff
63 |
64 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
65 |
66 | # **uploadFile**
67 | > \faxplus\model\File uploadFile($fax_file, $format)
68 |
69 | upload a file
70 |
71 | Before sending a fax you need to upload your files using this API. In order to upload your fax file, you have to send a `multipart/form-data` request with your file. If the upload was successful you would receive a `file_path` which you can use to send your fax.
72 |
73 | ### Example
74 | ```php
75 | setAccessToken('YOUR_ACCESS_TOKEN');
80 |
81 | $apiInstance = new faxplus\Api\FilesApi(
82 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
83 | // This is optional, `GuzzleHttp\Client` will be used as default.
84 | new GuzzleHttp\Client(),
85 | $config
86 | );
87 | $fax_file = "/path/to/file.txt"; // \SplFileObject |
88 | $format = "format_example"; // string | can be 'pdf' or 'tiff'
89 |
90 | try {
91 | $result = $apiInstance->uploadFile($fax_file, $format);
92 | print_r($result);
93 | } catch (Exception $e) {
94 | echo 'Exception when calling FilesApi->uploadFile: ', $e->getMessage(), PHP_EOL;
95 | }
96 | ?>
97 | ```
98 |
99 | ### Parameters
100 |
101 | Name | Type | Description | Notes
102 | ------------- | ------------- | ------------- | -------------
103 | **fax_file** | **\SplFileObject**| |
104 | **format** | **string**| can be 'pdf' or 'tiff' | [optional]
105 |
106 | ### Return type
107 |
108 | [**\faxplus\model\File**](../Model/File.md)
109 |
110 | ### Authorization
111 |
112 | [fax_oauth](../../README.md#fax_oauth)
113 |
114 | ### HTTP request headers
115 |
116 | - **Content-Type**: multipart/form-data
117 | - **Accept**: application/json
118 |
119 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
120 |
121 |
--------------------------------------------------------------------------------
/lib/HeaderSelector.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
16 | *
17 | * OpenAPI spec version: 1.1.0
18 | *
19 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
20 | * Swagger Codegen version: 2.4.0-SNAPSHOT
21 | */
22 |
23 | /**
24 | * NOTE: This class is auto generated by the swagger code generator program.
25 | * https://github.com/swagger-api/swagger-codegen
26 | * Do not edit the class manually.
27 | */
28 |
29 | namespace faxplus;
30 |
31 | use \Exception;
32 |
33 | /**
34 | * ApiException Class Doc Comment
35 | *
36 | * @category Class
37 | * @package faxplus
38 | * @author Swagger Codegen team
39 | * @link https://github.com/swagger-api/swagger-codegen
40 | */
41 | class HeaderSelector
42 | {
43 | protected $extra_headers = array();
44 |
45 | public function __construct(array $extra_headers = null) {
46 | $this->extra_headers = $extra_headers ?: array();
47 | }
48 |
49 | /**
50 | * @param string[] $accept
51 | * @param string[] $contentTypes
52 | * @return array
53 | */
54 | public function selectHeaders($accept, $contentTypes)
55 | {
56 | $headers = [];
57 | foreach ($this->extra_headers as $k => $v){
58 | $headers[$k] = $v;
59 | }
60 |
61 | $accept = $this->selectAcceptHeader($accept);
62 | if ($accept !== null) {
63 | $headers['Accept'] = $accept;
64 | }
65 |
66 | $headers['Content-Type'] = $this->selectContentTypeHeader($contentTypes);
67 | return $headers;
68 | }
69 |
70 | /**
71 | * @param string[] $accept
72 | * @return array
73 | */
74 | public function selectHeadersForMultipart($accept)
75 | {
76 | $headers = $this->selectHeaders($accept, []);
77 |
78 | unset($headers['Content-Type']);
79 | return $headers;
80 | }
81 |
82 | /**
83 | * Return the header 'Accept' based on an array of Accept provided
84 | *
85 | * @param string[] $accept Array of header
86 | *
87 | * @return string Accept (e.g. application/json)
88 | */
89 | private function selectAcceptHeader($accept)
90 | {
91 | if (count($accept) === 0 || (count($accept) === 1 && $accept[0] === '')) {
92 | return null;
93 | } elseif (preg_grep("/application\/json/i", $accept)) {
94 | return 'application/json';
95 | } else {
96 | return implode(',', $accept);
97 | }
98 | }
99 |
100 | /**
101 | * Return the content type based on an array of content-type provided
102 | *
103 | * @param string[] $contentType Array fo content-type
104 | *
105 | * @return string Content-Type (e.g. application/json)
106 | */
107 | private function selectContentTypeHeader($contentType)
108 | {
109 | if (count($contentType) === 0 || (count($contentType) === 1 && $contentType[0] === '')) {
110 | return 'application/json';
111 | } elseif (preg_grep("/application\/json/i", $contentType)) {
112 | return 'application/json';
113 | } else {
114 | return implode(',', $contentType);
115 | }
116 | }
117 | }
118 |
119 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # FAX.PLUS PHP SDK
2 | This is the FAX.PLUS API v1 developed for third party developers and organizations. In order to have a better coding experience with this API, let's quickly go through some points:
3 | - This API assumes **/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
4 | - This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
5 | - Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
6 |
7 | ## Requirements
8 |
9 | PHP 5.5 and later
10 |
11 | ## Installation & Usage
12 | ### Composer
13 |
14 | You can simply run `composer require faxplus/faxplus-api` to add faxplus-api to your composer.json and install it (faxplus-api is published to packagist).
15 |
16 | Alternatively, to install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json` or your local composer config:
17 |
18 | ```
19 | {
20 | "repositories": [
21 | {
22 | "type": "git",
23 | "url": "https://github.com/alohi/faxplus-php.git"
24 | }
25 | ],
26 | "require": {
27 | "faxplus/faxplus-api": "*@dev"
28 | }
29 | }
30 | ```
31 |
32 | Then run `composer install`
33 |
34 | ## Getting Started
35 |
36 | There's a [sample application](https://github.com/alohi/faxplus-sample-php) which is intended to get you started using this SDK. Follow sample app instructions to run your first app.
37 |
38 | ## Documentation for API Endpoints
39 |
40 | All URIs are relative to *https://restapi.fax.plus/v1*
41 |
42 | Class | Method | HTTP request | Description
43 | ------------ | ------------- | ------------- | -------------
44 | *AccountsApi* | [**getAccounts**](docs/Api/AccountsApi.md#getaccounts) | **GET** /accounts | Get account information of all members of your corporate account
45 | *AccountsApi* | [**getMemberDetails**](docs/Api/AccountsApi.md#getmemberdetails) | **GET** /accounts/self/member-details/{member_id} | Get member details
46 | *AccountsApi* | [**getUser**](docs/Api/AccountsApi.md#getuser) | **GET** /accounts/{user_id} | Get account information for admin or member
47 | *AccountsApi* | [**updateMemberDetails**](docs/Api/AccountsApi.md#updatememberdetails) | **PUT** /accounts/self/member-details/{member_id} | Modify member details
48 | *AccountsApi* | [**updateUser**](docs/Api/AccountsApi.md#updateuser) | **PUT** /accounts/self | Modify account information
49 | *ArchivesApi* | [**deleteFax**](docs/Api/ArchivesApi.md#deletefax) | **DELETE** /accounts/self/archives/{fax_id} | Delete a fax
50 | *ArchivesApi* | [**getFax**](docs/Api/ArchivesApi.md#getfax) | **GET** /accounts/self/archives/{fax_id} | Get a fax record
51 | *ArchivesApi* | [**listFaxes**](docs/Api/ArchivesApi.md#listfaxes) | **GET** /accounts/{user_id}/archives | Get fax records
52 | *ArchivesApi* | [**updateFax**](docs/Api/ArchivesApi.md#updatefax) | **PUT** /accounts/self/archives/{fax_id} | Modify fax record
53 | *FilesApi* | [**getFile**](docs/Api/FilesApi.md#getfile) | **GET** /accounts/self/files/{fax_id} | get a file
54 | *FilesApi* | [**uploadFile**](docs/Api/FilesApi.md#uploadfile) | **POST** /accounts/self/files | upload a file
55 | *NumbersApi* | [**getNumber**](docs/Api/NumbersApi.md#getnumber) | **GET** /accounts/self/numbers/{number} | Get number information
56 | *NumbersApi* | [**listNumbers**](docs/Api/NumbersApi.md#listnumbers) | **GET** /accounts/self/numbers | Get your numbers
57 | *NumbersApi* | [**revokeNumber**](docs/Api/NumbersApi.md#revokenumber) | **DELETE** /accounts/self/numbers/{number} | Revoke number
58 | *NumbersApi* | [**updateNumber**](docs/Api/NumbersApi.md#updatenumber) | **PUT** /accounts/self/numbers/{number} | Assign number
59 | *OutboxApi* | [**deleteOutboxFax**](docs/Api/OutboxApi.md#deleteoutboxfax) | **DELETE** /accounts/self/outbox/{outbox_fax_id} | Delete a fax from outbox
60 | *OutboxApi* | [**getOutboxFax**](docs/Api/OutboxApi.md#getoutboxfax) | **GET** /accounts/self/outbox/{outbox_fax_id} | Get an outbox record
61 | *OutboxApi* | [**listOutboxFaxes**](docs/Api/OutboxApi.md#listoutboxfaxes) | **GET** /accounts/self/outbox | Get outbox records
62 | *OutboxApi* | [**sendFax**](docs/Api/OutboxApi.md#sendfax) | **POST** /accounts/self/outbox | Send a fax
63 | *OutboxApi* | [**updateOutboxFax**](docs/Api/OutboxApi.md#updateoutboxfax) | **PUT** /accounts/self/outbox/{outbox_fax_id} | Modify a fax record in outbox
64 |
65 |
66 | ## Documentation For Models
67 |
68 | - [Account](docs/Model/Account.md)
69 | - [AccountAccountData](docs/Model/AccountAccountData.md)
70 | - [AccountSettings](docs/Model/AccountSettings.md)
71 | - [AccountSettingsSendFax](docs/Model/AccountSettingsSendFax.md)
72 | - [AccountSettingsSendFaxRetry](docs/Model/AccountSettingsSendFaxRetry.md)
73 | - [Error](docs/Model/Error.md)
74 | - [Fax](docs/Model/Fax.md)
75 | - [FaxCostDetails](docs/Model/FaxCostDetails.md)
76 | - [File](docs/Model/File.md)
77 | - [MemberDetail](docs/Model/MemberDetail.md)
78 | - [Number](docs/Model/Number.md)
79 | - [NumberNotifications](docs/Model/NumberNotifications.md)
80 | - [Outbox](docs/Model/Outbox.md)
81 | - [OutboxComment](docs/Model/OutboxComment.md)
82 | - [OutboxFileChanges](docs/Model/OutboxFileChanges.md)
83 | - [OutboxFiles](docs/Model/OutboxFiles.md)
84 | - [OutboxInitiatedFrom](docs/Model/OutboxInitiatedFrom.md)
85 | - [OutboxStatusChanges](docs/Model/OutboxStatusChanges.md)
86 | - [PayloadFaxModification](docs/Model/PayloadFaxModification.md)
87 | - [PayloadNumberModification](docs/Model/PayloadNumberModification.md)
88 | - [PayloadOutbox](docs/Model/PayloadOutbox.md)
89 | - [PayloadOutboxComment](docs/Model/PayloadOutboxComment.md)
90 | - [PayloadOutboxModification](docs/Model/PayloadOutboxModification.md)
91 | - [PayloadOutboxOptions](docs/Model/PayloadOutboxOptions.md)
92 | - [PayloadOutboxOptionsRetry](docs/Model/PayloadOutboxOptionsRetry.md)
93 | - [ResponseAccountList](docs/Model/ResponseAccountList.md)
94 | - [ResponseArchive](docs/Model/ResponseArchive.md)
95 | - [ResponseArchiveData](docs/Model/ResponseArchiveData.md)
96 | - [ResponseNumberList](docs/Model/ResponseNumberList.md)
97 | - [ResponseOutboxList](docs/Model/ResponseOutboxList.md)
98 |
99 |
100 | ## Documentation For Authorization
101 |
102 |
103 | ## fax_oauth
104 |
105 | - **Type**: OAuth
106 | - **Flow**: accessCode
107 | - **Authorization URL**: https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=all
108 | - **Scopes**:
109 | - **all**: for now when a user grant permission, all grants will be permitted
110 |
111 |
112 |
113 |
--------------------------------------------------------------------------------
/docs/Api/NumbersApi.md:
--------------------------------------------------------------------------------
1 | # faxplus\NumbersApi
2 |
3 | All URIs are relative to *https://restapi.fax.plus/v1*
4 |
5 | Method | HTTP request | Description
6 | ------------- | ------------- | -------------
7 | [**getNumber**](NumbersApi.md#getNumber) | **GET** /accounts/self/numbers/{number} | Get number information
8 | [**listNumbers**](NumbersApi.md#listNumbers) | **GET** /accounts/self/numbers | Get your numbers
9 | [**revokeNumber**](NumbersApi.md#revokeNumber) | **DELETE** /accounts/self/numbers/{number} | Revoke number
10 | [**updateNumber**](NumbersApi.md#updateNumber) | **PUT** /accounts/self/numbers/{number} | Assign number
11 |
12 |
13 | # **getNumber**
14 | > \faxplus\model\Number getNumber($number)
15 |
16 | Get number information
17 |
18 | Get info of a single number
19 |
20 | ### Example
21 | ```php
22 | setAccessToken('YOUR_ACCESS_TOKEN');
27 |
28 | $apiInstance = new faxplus\Api\NumbersApi(
29 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
30 | // This is optional, `GuzzleHttp\Client` will be used as default.
31 | new GuzzleHttp\Client(),
32 | $config
33 | );
34 | $number = "number_example"; // string |
35 |
36 | try {
37 | $result = $apiInstance->getNumber($number);
38 | print_r($result);
39 | } catch (Exception $e) {
40 | echo 'Exception when calling NumbersApi->getNumber: ', $e->getMessage(), PHP_EOL;
41 | }
42 | ?>
43 | ```
44 |
45 | ### Parameters
46 |
47 | Name | Type | Description | Notes
48 | ------------- | ------------- | ------------- | -------------
49 | **number** | **string**| |
50 |
51 | ### Return type
52 |
53 | [**\faxplus\model\Number**](../Model/Number.md)
54 |
55 | ### Authorization
56 |
57 | [fax_oauth](../../README.md#fax_oauth)
58 |
59 | ### HTTP request headers
60 |
61 | - **Content-Type**: application/json
62 | - **Accept**: application/json
63 |
64 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
65 |
66 | # **listNumbers**
67 | > \faxplus\model\ResponseNumberList listNumbers()
68 |
69 | Get your numbers
70 |
71 | List all your purchased numbers
72 |
73 | ### Example
74 | ```php
75 | setAccessToken('YOUR_ACCESS_TOKEN');
80 |
81 | $apiInstance = new faxplus\Api\NumbersApi(
82 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
83 | // This is optional, `GuzzleHttp\Client` will be used as default.
84 | new GuzzleHttp\Client(),
85 | $config
86 | );
87 |
88 | try {
89 | $result = $apiInstance->listNumbers();
90 | print_r($result);
91 | } catch (Exception $e) {
92 | echo 'Exception when calling NumbersApi->listNumbers: ', $e->getMessage(), PHP_EOL;
93 | }
94 | ?>
95 | ```
96 |
97 | ### Parameters
98 | This endpoint does not need any parameter.
99 |
100 | ### Return type
101 |
102 | [**\faxplus\model\ResponseNumberList**](../Model/ResponseNumberList.md)
103 |
104 | ### Authorization
105 |
106 | [fax_oauth](../../README.md#fax_oauth)
107 |
108 | ### HTTP request headers
109 |
110 | - **Content-Type**: application/json
111 | - **Accept**: application/json
112 |
113 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
114 |
115 | # **revokeNumber**
116 | > revokeNumber($number)
117 |
118 | Revoke number
119 |
120 | Revoke a specific number from your corporate member
121 |
122 | ### Example
123 | ```php
124 | setAccessToken('YOUR_ACCESS_TOKEN');
129 |
130 | $apiInstance = new faxplus\Api\NumbersApi(
131 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
132 | // This is optional, `GuzzleHttp\Client` will be used as default.
133 | new GuzzleHttp\Client(),
134 | $config
135 | );
136 | $number = "number_example"; // string |
137 |
138 | try {
139 | $apiInstance->revokeNumber($number);
140 | } catch (Exception $e) {
141 | echo 'Exception when calling NumbersApi->revokeNumber: ', $e->getMessage(), PHP_EOL;
142 | }
143 | ?>
144 | ```
145 |
146 | ### Parameters
147 |
148 | Name | Type | Description | Notes
149 | ------------- | ------------- | ------------- | -------------
150 | **number** | **string**| |
151 |
152 | ### Return type
153 |
154 | void (empty response body)
155 |
156 | ### Authorization
157 |
158 | [fax_oauth](../../README.md#fax_oauth)
159 |
160 | ### HTTP request headers
161 |
162 | - **Content-Type**: application/json
163 | - **Accept**: application/json
164 |
165 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
166 |
167 | # **updateNumber**
168 | > updateNumber($number, $payload_number_modification)
169 |
170 | Assign number
171 |
172 | With this API call you will be able to assign a specific number to a specific account (one of your members).
173 |
174 | ### Example
175 | ```php
176 | setAccessToken('YOUR_ACCESS_TOKEN');
181 |
182 | $apiInstance = new faxplus\Api\NumbersApi(
183 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
184 | // This is optional, `GuzzleHttp\Client` will be used as default.
185 | new GuzzleHttp\Client(),
186 | $config
187 | );
188 | $number = "number_example"; // string |
189 | $payload_number_modification = new \faxplus\model\PayloadNumberModification(); // \faxplus\model\PayloadNumberModification |
190 |
191 | try {
192 | $apiInstance->updateNumber($number, $payload_number_modification);
193 | } catch (Exception $e) {
194 | echo 'Exception when calling NumbersApi->updateNumber: ', $e->getMessage(), PHP_EOL;
195 | }
196 | ?>
197 | ```
198 |
199 | ### Parameters
200 |
201 | Name | Type | Description | Notes
202 | ------------- | ------------- | ------------- | -------------
203 | **number** | **string**| |
204 | **payload_number_modification** | [**\faxplus\model\PayloadNumberModification**](../Model/PayloadNumberModification.md)| |
205 |
206 | ### Return type
207 |
208 | void (empty response body)
209 |
210 | ### Authorization
211 |
212 | [fax_oauth](../../README.md#fax_oauth)
213 |
214 | ### HTTP request headers
215 |
216 | - **Content-Type**: application/json
217 | - **Accept**: application/json
218 |
219 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
220 |
221 |
--------------------------------------------------------------------------------
/lib/model/File.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | use \ArrayAccess;
33 | use \faxplus\ObjectSerializer;
34 |
35 | /**
36 | * File Class Doc Comment
37 | *
38 | * @category Class
39 | * @package faxplus
40 | * @author Swagger Codegen team
41 | * @link https://github.com/swagger-api/swagger-codegen
42 | */
43 | class File implements ModelInterface, ArrayAccess
44 | {
45 | const DISCRIMINATOR = null;
46 |
47 | /**
48 | * The original name of the model.
49 | *
50 | * @var string
51 | */
52 | protected static $swaggerModelName = 'File';
53 |
54 | /**
55 | * Array of property to type mappings. Used for (de)serialization
56 | *
57 | * @var string[]
58 | */
59 | protected static $swaggerTypes = [
60 | 'path' => 'string'
61 | ];
62 |
63 | /**
64 | * Array of property to format mappings. Used for (de)serialization
65 | *
66 | * @var string[]
67 | */
68 | protected static $swaggerFormats = [
69 | 'path' => null
70 | ];
71 |
72 | /**
73 | * Array of property to type mappings. Used for (de)serialization
74 | *
75 | * @return array
76 | */
77 | public static function swaggerTypes()
78 | {
79 | return self::$swaggerTypes;
80 | }
81 |
82 | /**
83 | * Array of property to format mappings. Used for (de)serialization
84 | *
85 | * @return array
86 | */
87 | public static function swaggerFormats()
88 | {
89 | return self::$swaggerFormats;
90 | }
91 |
92 | /**
93 | * Array of attributes where the key is the local name,
94 | * and the value is the original name
95 | *
96 | * @var string[]
97 | */
98 | protected static $attributeMap = [
99 | 'path' => 'path'
100 | ];
101 |
102 | /**
103 | * Array of attributes to setter functions (for deserialization of responses)
104 | *
105 | * @var string[]
106 | */
107 | protected static $setters = [
108 | 'path' => 'setPath'
109 | ];
110 |
111 | /**
112 | * Array of attributes to getter functions (for serialization of requests)
113 | *
114 | * @var string[]
115 | */
116 | protected static $getters = [
117 | 'path' => 'getPath'
118 | ];
119 |
120 | /**
121 | * Array of attributes where the key is the local name,
122 | * and the value is the original name
123 | *
124 | * @return array
125 | */
126 | public static function attributeMap()
127 | {
128 | return self::$attributeMap;
129 | }
130 |
131 | /**
132 | * Array of attributes to setter functions (for deserialization of responses)
133 | *
134 | * @return array
135 | */
136 | public static function setters()
137 | {
138 | return self::$setters;
139 | }
140 |
141 | /**
142 | * Array of attributes to getter functions (for serialization of requests)
143 | *
144 | * @return array
145 | */
146 | public static function getters()
147 | {
148 | return self::$getters;
149 | }
150 |
151 | /**
152 | * The original name of the model.
153 | *
154 | * @return string
155 | */
156 | public function getModelName()
157 | {
158 | return self::$swaggerModelName;
159 | }
160 |
161 |
162 |
163 |
164 |
165 | /**
166 | * Associative array for storing property values
167 | *
168 | * @var mixed[]
169 | */
170 | protected $container = [];
171 |
172 | /**
173 | * Constructor
174 | *
175 | * @param mixed[] $data Associated array of property values
176 | * initializing the model
177 | */
178 | public function __construct(array $data = null)
179 | {
180 | $this->container['path'] = isset($data['path']) ? $data['path'] : null;
181 | }
182 |
183 | /**
184 | * Show all the invalid properties with reasons.
185 | *
186 | * @return array invalid properties with reasons
187 | */
188 | public function listInvalidProperties()
189 | {
190 | $invalidProperties = [];
191 |
192 | return $invalidProperties;
193 | }
194 |
195 | /**
196 | * Validate all the properties in the model
197 | * return true if all passed
198 | *
199 | * @return bool True if all properties are valid
200 | */
201 | public function valid()
202 | {
203 |
204 | return true;
205 | }
206 |
207 |
208 | /**
209 | * Gets path
210 | *
211 | * @return string
212 | */
213 | public function getPath()
214 | {
215 | return $this->container['path'];
216 | }
217 |
218 | /**
219 | * Sets path
220 | *
221 | * @param string $path Path of newly uploaded file
222 | *
223 | * @return $this
224 | */
225 | public function setPath($path)
226 | {
227 | $this->container['path'] = $path;
228 |
229 | return $this;
230 | }
231 | /**
232 | * Returns true if offset exists. False otherwise.
233 | *
234 | * @param integer $offset Offset
235 | *
236 | * @return boolean
237 | */
238 | public function offsetExists($offset)
239 | {
240 | return isset($this->container[$offset]);
241 | }
242 |
243 | /**
244 | * Gets offset.
245 | *
246 | * @param integer $offset Offset
247 | *
248 | * @return mixed
249 | */
250 | public function offsetGet($offset)
251 | {
252 | return isset($this->container[$offset]) ? $this->container[$offset] : null;
253 | }
254 |
255 | /**
256 | * Sets value based on offset.
257 | *
258 | * @param integer $offset Offset
259 | * @param mixed $value Value to be set
260 | *
261 | * @return void
262 | */
263 | public function offsetSet($offset, $value)
264 | {
265 | if (is_null($offset)) {
266 | $this->container[] = $value;
267 | } else {
268 | $this->container[$offset] = $value;
269 | }
270 | }
271 |
272 | /**
273 | * Unsets offset.
274 | *
275 | * @param integer $offset Offset
276 | *
277 | * @return void
278 | */
279 | public function offsetUnset($offset)
280 | {
281 | unset($this->container[$offset]);
282 | }
283 |
284 | /**
285 | * Gets the string presentation of the object
286 | *
287 | * @return string
288 | */
289 | public function __toString()
290 | {
291 | if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
292 | return json_encode(
293 | ObjectSerializer::sanitizeForSerialization($this),
294 | JSON_PRETTY_PRINT
295 | );
296 | }
297 |
298 | return json_encode(ObjectSerializer::sanitizeForSerialization($this));
299 | }
300 | }
301 |
302 |
303 |
--------------------------------------------------------------------------------
/docs/Api/ArchivesApi.md:
--------------------------------------------------------------------------------
1 | # faxplus\ArchivesApi
2 |
3 | All URIs are relative to *https://restapi.fax.plus/v1*
4 |
5 | Method | HTTP request | Description
6 | ------------- | ------------- | -------------
7 | [**deleteFax**](ArchivesApi.md#deleteFax) | **DELETE** /accounts/self/archives/{fax_id} | Delete a fax
8 | [**getFax**](ArchivesApi.md#getFax) | **GET** /accounts/self/archives/{fax_id} | Get a fax record
9 | [**listFaxes**](ArchivesApi.md#listFaxes) | **GET** /accounts/{user_id}/archives | Get fax records
10 | [**updateFax**](ArchivesApi.md#updateFax) | **PUT** /accounts/self/archives/{fax_id} | Modify fax record
11 |
12 |
13 | # **deleteFax**
14 | > object deleteFax($fax_id)
15 |
16 | Delete a fax
17 |
18 | Delete a specific fax record by providing its id
19 |
20 | ### Example
21 | ```php
22 | setAccessToken('YOUR_ACCESS_TOKEN');
27 |
28 | $apiInstance = new faxplus\Api\ArchivesApi(
29 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
30 | // This is optional, `GuzzleHttp\Client` will be used as default.
31 | new GuzzleHttp\Client(),
32 | $config
33 | );
34 | $fax_id = "fax_id_example"; // string |
35 |
36 | try {
37 | $result = $apiInstance->deleteFax($fax_id);
38 | print_r($result);
39 | } catch (Exception $e) {
40 | echo 'Exception when calling ArchivesApi->deleteFax: ', $e->getMessage(), PHP_EOL;
41 | }
42 | ?>
43 | ```
44 |
45 | ### Parameters
46 |
47 | Name | Type | Description | Notes
48 | ------------- | ------------- | ------------- | -------------
49 | **fax_id** | **string**| |
50 |
51 | ### Return type
52 |
53 | **object**
54 |
55 | ### Authorization
56 |
57 | [fax_oauth](../../README.md#fax_oauth)
58 |
59 | ### HTTP request headers
60 |
61 | - **Content-Type**: application/json
62 | - **Accept**: application/json
63 |
64 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
65 |
66 | # **getFax**
67 | > \faxplus\model\Fax getFax($fax_id)
68 |
69 | Get a fax record
70 |
71 | Get a specific fax record details like duration, pages etc.
72 |
73 | ### Example
74 | ```php
75 | setAccessToken('YOUR_ACCESS_TOKEN');
80 |
81 | $apiInstance = new faxplus\Api\ArchivesApi(
82 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
83 | // This is optional, `GuzzleHttp\Client` will be used as default.
84 | new GuzzleHttp\Client(),
85 | $config
86 | );
87 | $fax_id = "fax_id_example"; // string |
88 |
89 | try {
90 | $result = $apiInstance->getFax($fax_id);
91 | print_r($result);
92 | } catch (Exception $e) {
93 | echo 'Exception when calling ArchivesApi->getFax: ', $e->getMessage(), PHP_EOL;
94 | }
95 | ?>
96 | ```
97 |
98 | ### Parameters
99 |
100 | Name | Type | Description | Notes
101 | ------------- | ------------- | ------------- | -------------
102 | **fax_id** | **string**| |
103 |
104 | ### Return type
105 |
106 | [**\faxplus\model\Fax**](../Model/Fax.md)
107 |
108 | ### Authorization
109 |
110 | [fax_oauth](../../README.md#fax_oauth)
111 |
112 | ### HTTP request headers
113 |
114 | - **Content-Type**: application/json
115 | - **Accept**: application/json
116 |
117 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
118 |
119 | # **listFaxes**
120 | > \faxplus\model\ResponseArchive listFaxes($user_id, $category, $after, $before, $limit)
121 |
122 | Get fax records
123 |
124 | With this API call you will be able to retrieve a collection of faxes (either sent or received or spam based on the category selected). If you want to filter your archive please provide the `category` parameter
125 |
126 | ### Example
127 | ```php
128 | setAccessToken('YOUR_ACCESS_TOKEN');
133 |
134 | $apiInstance = new faxplus\Api\ArchivesApi(
135 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
136 | // This is optional, `GuzzleHttp\Client` will be used as default.
137 | new GuzzleHttp\Client(),
138 | $config
139 | );
140 | $user_id = "user_id_example"; // string | 'self' or user id of a corporate member
141 | $category = "category_example"; // string | Category parameter can be one of these values: **inbox**, **sent**, **spam**
142 | $after = "after_example"; // string | Start date to get records from that date
143 | $before = "before_example"; // string | End date to get records before that date
144 | $limit = 56; // int | Limit of fax records you want to get per request
145 |
146 | try {
147 | $result = $apiInstance->listFaxes($user_id, $category, $after, $before, $limit);
148 | print_r($result);
149 | } catch (Exception $e) {
150 | echo 'Exception when calling ArchivesApi->listFaxes: ', $e->getMessage(), PHP_EOL;
151 | }
152 | ?>
153 | ```
154 |
155 | ### Parameters
156 |
157 | Name | Type | Description | Notes
158 | ------------- | ------------- | ------------- | -------------
159 | **user_id** | **string**| 'self' or user id of a corporate member |
160 | **category** | **string**| Category parameter can be one of these values: **inbox**, **sent**, **spam** | [optional]
161 | **after** | **string**| Start date to get records from that date | [optional]
162 | **before** | **string**| End date to get records before that date | [optional]
163 | **limit** | **int**| Limit of fax records you want to get per request | [optional]
164 |
165 | ### Return type
166 |
167 | [**\faxplus\model\ResponseArchive**](../Model/ResponseArchive.md)
168 |
169 | ### Authorization
170 |
171 | [fax_oauth](../../README.md#fax_oauth)
172 |
173 | ### HTTP request headers
174 |
175 | - **Content-Type**: application/json
176 | - **Accept**: application/json
177 |
178 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
179 |
180 | # **updateFax**
181 | > updateFax($fax_id, $payload_fax_modification)
182 |
183 | Modify fax record
184 |
185 | You can modify a fax record's comment or mark it as read
186 |
187 | ### Example
188 | ```php
189 | setAccessToken('YOUR_ACCESS_TOKEN');
194 |
195 | $apiInstance = new faxplus\Api\ArchivesApi(
196 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
197 | // This is optional, `GuzzleHttp\Client` will be used as default.
198 | new GuzzleHttp\Client(),
199 | $config
200 | );
201 | $fax_id = "fax_id_example"; // string |
202 | $payload_fax_modification = new \faxplus\model\PayloadFaxModification(); // \faxplus\model\PayloadFaxModification |
203 |
204 | try {
205 | $apiInstance->updateFax($fax_id, $payload_fax_modification);
206 | } catch (Exception $e) {
207 | echo 'Exception when calling ArchivesApi->updateFax: ', $e->getMessage(), PHP_EOL;
208 | }
209 | ?>
210 | ```
211 |
212 | ### Parameters
213 |
214 | Name | Type | Description | Notes
215 | ------------- | ------------- | ------------- | -------------
216 | **fax_id** | **string**| |
217 | **payload_fax_modification** | [**\faxplus\model\PayloadFaxModification**](../Model/PayloadFaxModification.md)| |
218 |
219 | ### Return type
220 |
221 | void (empty response body)
222 |
223 | ### Authorization
224 |
225 | [fax_oauth](../../README.md#fax_oauth)
226 |
227 | ### HTTP request headers
228 |
229 | - **Content-Type**: application/json
230 | - **Accept**: application/json
231 |
232 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
233 |
234 |
--------------------------------------------------------------------------------
/lib/model/ResponseArchiveData.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | use \ArrayAccess;
33 | use \faxplus\ObjectSerializer;
34 |
35 | /**
36 | * ResponseArchiveData Class Doc Comment
37 | *
38 | * @category Class
39 | * @package faxplus
40 | * @author Swagger Codegen team
41 | * @link https://github.com/swagger-api/swagger-codegen
42 | */
43 | class ResponseArchiveData implements ModelInterface, ArrayAccess
44 | {
45 | const DISCRIMINATOR = null;
46 |
47 | /**
48 | * The original name of the model.
49 | *
50 | * @var string
51 | */
52 | protected static $swaggerModelName = 'response_Archive_data';
53 |
54 | /**
55 | * Array of property to type mappings. Used for (de)serialization
56 | *
57 | * @var string[]
58 | */
59 | protected static $swaggerTypes = [
60 | 'records' => '\faxplus\model\Fax[]'
61 | ];
62 |
63 | /**
64 | * Array of property to format mappings. Used for (de)serialization
65 | *
66 | * @var string[]
67 | */
68 | protected static $swaggerFormats = [
69 | 'records' => null
70 | ];
71 |
72 | /**
73 | * Array of property to type mappings. Used for (de)serialization
74 | *
75 | * @return array
76 | */
77 | public static function swaggerTypes()
78 | {
79 | return self::$swaggerTypes;
80 | }
81 |
82 | /**
83 | * Array of property to format mappings. Used for (de)serialization
84 | *
85 | * @return array
86 | */
87 | public static function swaggerFormats()
88 | {
89 | return self::$swaggerFormats;
90 | }
91 |
92 | /**
93 | * Array of attributes where the key is the local name,
94 | * and the value is the original name
95 | *
96 | * @var string[]
97 | */
98 | protected static $attributeMap = [
99 | 'records' => 'records'
100 | ];
101 |
102 | /**
103 | * Array of attributes to setter functions (for deserialization of responses)
104 | *
105 | * @var string[]
106 | */
107 | protected static $setters = [
108 | 'records' => 'setRecords'
109 | ];
110 |
111 | /**
112 | * Array of attributes to getter functions (for serialization of requests)
113 | *
114 | * @var string[]
115 | */
116 | protected static $getters = [
117 | 'records' => 'getRecords'
118 | ];
119 |
120 | /**
121 | * Array of attributes where the key is the local name,
122 | * and the value is the original name
123 | *
124 | * @return array
125 | */
126 | public static function attributeMap()
127 | {
128 | return self::$attributeMap;
129 | }
130 |
131 | /**
132 | * Array of attributes to setter functions (for deserialization of responses)
133 | *
134 | * @return array
135 | */
136 | public static function setters()
137 | {
138 | return self::$setters;
139 | }
140 |
141 | /**
142 | * Array of attributes to getter functions (for serialization of requests)
143 | *
144 | * @return array
145 | */
146 | public static function getters()
147 | {
148 | return self::$getters;
149 | }
150 |
151 | /**
152 | * The original name of the model.
153 | *
154 | * @return string
155 | */
156 | public function getModelName()
157 | {
158 | return self::$swaggerModelName;
159 | }
160 |
161 |
162 |
163 |
164 |
165 | /**
166 | * Associative array for storing property values
167 | *
168 | * @var mixed[]
169 | */
170 | protected $container = [];
171 |
172 | /**
173 | * Constructor
174 | *
175 | * @param mixed[] $data Associated array of property values
176 | * initializing the model
177 | */
178 | public function __construct(array $data = null)
179 | {
180 | $this->container['records'] = isset($data['records']) ? $data['records'] : null;
181 | }
182 |
183 | /**
184 | * Show all the invalid properties with reasons.
185 | *
186 | * @return array invalid properties with reasons
187 | */
188 | public function listInvalidProperties()
189 | {
190 | $invalidProperties = [];
191 |
192 | return $invalidProperties;
193 | }
194 |
195 | /**
196 | * Validate all the properties in the model
197 | * return true if all passed
198 | *
199 | * @return bool True if all properties are valid
200 | */
201 | public function valid()
202 | {
203 |
204 | return true;
205 | }
206 |
207 |
208 | /**
209 | * Gets records
210 | *
211 | * @return \faxplus\model\Fax[]
212 | */
213 | public function getRecords()
214 | {
215 | return $this->container['records'];
216 | }
217 |
218 | /**
219 | * Sets records
220 | *
221 | * @param \faxplus\model\Fax[] $records records
222 | *
223 | * @return $this
224 | */
225 | public function setRecords($records)
226 | {
227 | $this->container['records'] = $records;
228 |
229 | return $this;
230 | }
231 | /**
232 | * Returns true if offset exists. False otherwise.
233 | *
234 | * @param integer $offset Offset
235 | *
236 | * @return boolean
237 | */
238 | public function offsetExists($offset)
239 | {
240 | return isset($this->container[$offset]);
241 | }
242 |
243 | /**
244 | * Gets offset.
245 | *
246 | * @param integer $offset Offset
247 | *
248 | * @return mixed
249 | */
250 | public function offsetGet($offset)
251 | {
252 | return isset($this->container[$offset]) ? $this->container[$offset] : null;
253 | }
254 |
255 | /**
256 | * Sets value based on offset.
257 | *
258 | * @param integer $offset Offset
259 | * @param mixed $value Value to be set
260 | *
261 | * @return void
262 | */
263 | public function offsetSet($offset, $value)
264 | {
265 | if (is_null($offset)) {
266 | $this->container[] = $value;
267 | } else {
268 | $this->container[$offset] = $value;
269 | }
270 | }
271 |
272 | /**
273 | * Unsets offset.
274 | *
275 | * @param integer $offset Offset
276 | *
277 | * @return void
278 | */
279 | public function offsetUnset($offset)
280 | {
281 | unset($this->container[$offset]);
282 | }
283 |
284 | /**
285 | * Gets the string presentation of the object
286 | *
287 | * @return string
288 | */
289 | public function __toString()
290 | {
291 | if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
292 | return json_encode(
293 | ObjectSerializer::sanitizeForSerialization($this),
294 | JSON_PRETTY_PRINT
295 | );
296 | }
297 |
298 | return json_encode(ObjectSerializer::sanitizeForSerialization($this));
299 | }
300 | }
301 |
302 |
303 |
--------------------------------------------------------------------------------
/lib/model/ResponseArchive.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | use \ArrayAccess;
33 | use \faxplus\ObjectSerializer;
34 |
35 | /**
36 | * ResponseArchive Class Doc Comment
37 | *
38 | * @category Class
39 | * @description Response containing a list of faxes
40 | * @package faxplus
41 | * @author Swagger Codegen team
42 | * @link https://github.com/swagger-api/swagger-codegen
43 | */
44 | class ResponseArchive implements ModelInterface, ArrayAccess
45 | {
46 | const DISCRIMINATOR = null;
47 |
48 | /**
49 | * The original name of the model.
50 | *
51 | * @var string
52 | */
53 | protected static $swaggerModelName = 'response_Archive';
54 |
55 | /**
56 | * Array of property to type mappings. Used for (de)serialization
57 | *
58 | * @var string[]
59 | */
60 | protected static $swaggerTypes = [
61 | 'data' => '\faxplus\model\ResponseArchiveData'
62 | ];
63 |
64 | /**
65 | * Array of property to format mappings. Used for (de)serialization
66 | *
67 | * @var string[]
68 | */
69 | protected static $swaggerFormats = [
70 | 'data' => null
71 | ];
72 |
73 | /**
74 | * Array of property to type mappings. Used for (de)serialization
75 | *
76 | * @return array
77 | */
78 | public static function swaggerTypes()
79 | {
80 | return self::$swaggerTypes;
81 | }
82 |
83 | /**
84 | * Array of property to format mappings. Used for (de)serialization
85 | *
86 | * @return array
87 | */
88 | public static function swaggerFormats()
89 | {
90 | return self::$swaggerFormats;
91 | }
92 |
93 | /**
94 | * Array of attributes where the key is the local name,
95 | * and the value is the original name
96 | *
97 | * @var string[]
98 | */
99 | protected static $attributeMap = [
100 | 'data' => 'data'
101 | ];
102 |
103 | /**
104 | * Array of attributes to setter functions (for deserialization of responses)
105 | *
106 | * @var string[]
107 | */
108 | protected static $setters = [
109 | 'data' => 'setData'
110 | ];
111 |
112 | /**
113 | * Array of attributes to getter functions (for serialization of requests)
114 | *
115 | * @var string[]
116 | */
117 | protected static $getters = [
118 | 'data' => 'getData'
119 | ];
120 |
121 | /**
122 | * Array of attributes where the key is the local name,
123 | * and the value is the original name
124 | *
125 | * @return array
126 | */
127 | public static function attributeMap()
128 | {
129 | return self::$attributeMap;
130 | }
131 |
132 | /**
133 | * Array of attributes to setter functions (for deserialization of responses)
134 | *
135 | * @return array
136 | */
137 | public static function setters()
138 | {
139 | return self::$setters;
140 | }
141 |
142 | /**
143 | * Array of attributes to getter functions (for serialization of requests)
144 | *
145 | * @return array
146 | */
147 | public static function getters()
148 | {
149 | return self::$getters;
150 | }
151 |
152 | /**
153 | * The original name of the model.
154 | *
155 | * @return string
156 | */
157 | public function getModelName()
158 | {
159 | return self::$swaggerModelName;
160 | }
161 |
162 |
163 |
164 |
165 |
166 | /**
167 | * Associative array for storing property values
168 | *
169 | * @var mixed[]
170 | */
171 | protected $container = [];
172 |
173 | /**
174 | * Constructor
175 | *
176 | * @param mixed[] $data Associated array of property values
177 | * initializing the model
178 | */
179 | public function __construct(array $data = null)
180 | {
181 | $this->container['data'] = isset($data['data']) ? $data['data'] : null;
182 | }
183 |
184 | /**
185 | * Show all the invalid properties with reasons.
186 | *
187 | * @return array invalid properties with reasons
188 | */
189 | public function listInvalidProperties()
190 | {
191 | $invalidProperties = [];
192 |
193 | return $invalidProperties;
194 | }
195 |
196 | /**
197 | * Validate all the properties in the model
198 | * return true if all passed
199 | *
200 | * @return bool True if all properties are valid
201 | */
202 | public function valid()
203 | {
204 |
205 | return true;
206 | }
207 |
208 |
209 | /**
210 | * Gets data
211 | *
212 | * @return \faxplus\model\ResponseArchiveData
213 | */
214 | public function getData()
215 | {
216 | return $this->container['data'];
217 | }
218 |
219 | /**
220 | * Sets data
221 | *
222 | * @param \faxplus\model\ResponseArchiveData $data data
223 | *
224 | * @return $this
225 | */
226 | public function setData($data)
227 | {
228 | $this->container['data'] = $data;
229 |
230 | return $this;
231 | }
232 | /**
233 | * Returns true if offset exists. False otherwise.
234 | *
235 | * @param integer $offset Offset
236 | *
237 | * @return boolean
238 | */
239 | public function offsetExists($offset)
240 | {
241 | return isset($this->container[$offset]);
242 | }
243 |
244 | /**
245 | * Gets offset.
246 | *
247 | * @param integer $offset Offset
248 | *
249 | * @return mixed
250 | */
251 | public function offsetGet($offset)
252 | {
253 | return isset($this->container[$offset]) ? $this->container[$offset] : null;
254 | }
255 |
256 | /**
257 | * Sets value based on offset.
258 | *
259 | * @param integer $offset Offset
260 | * @param mixed $value Value to be set
261 | *
262 | * @return void
263 | */
264 | public function offsetSet($offset, $value)
265 | {
266 | if (is_null($offset)) {
267 | $this->container[] = $value;
268 | } else {
269 | $this->container[$offset] = $value;
270 | }
271 | }
272 |
273 | /**
274 | * Unsets offset.
275 | *
276 | * @param integer $offset Offset
277 | *
278 | * @return void
279 | */
280 | public function offsetUnset($offset)
281 | {
282 | unset($this->container[$offset]);
283 | }
284 |
285 | /**
286 | * Gets the string presentation of the object
287 | *
288 | * @return string
289 | */
290 | public function __toString()
291 | {
292 | if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
293 | return json_encode(
294 | ObjectSerializer::sanitizeForSerialization($this),
295 | JSON_PRETTY_PRINT
296 | );
297 | }
298 |
299 | return json_encode(ObjectSerializer::sanitizeForSerialization($this));
300 | }
301 | }
302 |
303 |
304 |
--------------------------------------------------------------------------------
/lib/model/AccountSettingsSendFax.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | use \ArrayAccess;
33 | use \faxplus\ObjectSerializer;
34 |
35 | /**
36 | * AccountSettingsSendFax Class Doc Comment
37 | *
38 | * @category Class
39 | * @package faxplus
40 | * @author Swagger Codegen team
41 | * @link https://github.com/swagger-api/swagger-codegen
42 | */
43 | class AccountSettingsSendFax implements ModelInterface, ArrayAccess
44 | {
45 | const DISCRIMINATOR = null;
46 |
47 | /**
48 | * The original name of the model.
49 | *
50 | * @var string
51 | */
52 | protected static $swaggerModelName = 'Account_settings_send_fax';
53 |
54 | /**
55 | * Array of property to type mappings. Used for (de)serialization
56 | *
57 | * @var string[]
58 | */
59 | protected static $swaggerTypes = [
60 | 'retry' => '\faxplus\model\AccountSettingsSendFaxRetry'
61 | ];
62 |
63 | /**
64 | * Array of property to format mappings. Used for (de)serialization
65 | *
66 | * @var string[]
67 | */
68 | protected static $swaggerFormats = [
69 | 'retry' => null
70 | ];
71 |
72 | /**
73 | * Array of property to type mappings. Used for (de)serialization
74 | *
75 | * @return array
76 | */
77 | public static function swaggerTypes()
78 | {
79 | return self::$swaggerTypes;
80 | }
81 |
82 | /**
83 | * Array of property to format mappings. Used for (de)serialization
84 | *
85 | * @return array
86 | */
87 | public static function swaggerFormats()
88 | {
89 | return self::$swaggerFormats;
90 | }
91 |
92 | /**
93 | * Array of attributes where the key is the local name,
94 | * and the value is the original name
95 | *
96 | * @var string[]
97 | */
98 | protected static $attributeMap = [
99 | 'retry' => 'retry'
100 | ];
101 |
102 | /**
103 | * Array of attributes to setter functions (for deserialization of responses)
104 | *
105 | * @var string[]
106 | */
107 | protected static $setters = [
108 | 'retry' => 'setRetry'
109 | ];
110 |
111 | /**
112 | * Array of attributes to getter functions (for serialization of requests)
113 | *
114 | * @var string[]
115 | */
116 | protected static $getters = [
117 | 'retry' => 'getRetry'
118 | ];
119 |
120 | /**
121 | * Array of attributes where the key is the local name,
122 | * and the value is the original name
123 | *
124 | * @return array
125 | */
126 | public static function attributeMap()
127 | {
128 | return self::$attributeMap;
129 | }
130 |
131 | /**
132 | * Array of attributes to setter functions (for deserialization of responses)
133 | *
134 | * @return array
135 | */
136 | public static function setters()
137 | {
138 | return self::$setters;
139 | }
140 |
141 | /**
142 | * Array of attributes to getter functions (for serialization of requests)
143 | *
144 | * @return array
145 | */
146 | public static function getters()
147 | {
148 | return self::$getters;
149 | }
150 |
151 | /**
152 | * The original name of the model.
153 | *
154 | * @return string
155 | */
156 | public function getModelName()
157 | {
158 | return self::$swaggerModelName;
159 | }
160 |
161 |
162 |
163 |
164 |
165 | /**
166 | * Associative array for storing property values
167 | *
168 | * @var mixed[]
169 | */
170 | protected $container = [];
171 |
172 | /**
173 | * Constructor
174 | *
175 | * @param mixed[] $data Associated array of property values
176 | * initializing the model
177 | */
178 | public function __construct(array $data = null)
179 | {
180 | $this->container['retry'] = isset($data['retry']) ? $data['retry'] : null;
181 | }
182 |
183 | /**
184 | * Show all the invalid properties with reasons.
185 | *
186 | * @return array invalid properties with reasons
187 | */
188 | public function listInvalidProperties()
189 | {
190 | $invalidProperties = [];
191 |
192 | return $invalidProperties;
193 | }
194 |
195 | /**
196 | * Validate all the properties in the model
197 | * return true if all passed
198 | *
199 | * @return bool True if all properties are valid
200 | */
201 | public function valid()
202 | {
203 |
204 | return true;
205 | }
206 |
207 |
208 | /**
209 | * Gets retry
210 | *
211 | * @return \faxplus\model\AccountSettingsSendFaxRetry
212 | */
213 | public function getRetry()
214 | {
215 | return $this->container['retry'];
216 | }
217 |
218 | /**
219 | * Sets retry
220 | *
221 | * @param \faxplus\model\AccountSettingsSendFaxRetry $retry retry
222 | *
223 | * @return $this
224 | */
225 | public function setRetry($retry)
226 | {
227 | $this->container['retry'] = $retry;
228 |
229 | return $this;
230 | }
231 | /**
232 | * Returns true if offset exists. False otherwise.
233 | *
234 | * @param integer $offset Offset
235 | *
236 | * @return boolean
237 | */
238 | public function offsetExists($offset)
239 | {
240 | return isset($this->container[$offset]);
241 | }
242 |
243 | /**
244 | * Gets offset.
245 | *
246 | * @param integer $offset Offset
247 | *
248 | * @return mixed
249 | */
250 | public function offsetGet($offset)
251 | {
252 | return isset($this->container[$offset]) ? $this->container[$offset] : null;
253 | }
254 |
255 | /**
256 | * Sets value based on offset.
257 | *
258 | * @param integer $offset Offset
259 | * @param mixed $value Value to be set
260 | *
261 | * @return void
262 | */
263 | public function offsetSet($offset, $value)
264 | {
265 | if (is_null($offset)) {
266 | $this->container[] = $value;
267 | } else {
268 | $this->container[$offset] = $value;
269 | }
270 | }
271 |
272 | /**
273 | * Unsets offset.
274 | *
275 | * @param integer $offset Offset
276 | *
277 | * @return void
278 | */
279 | public function offsetUnset($offset)
280 | {
281 | unset($this->container[$offset]);
282 | }
283 |
284 | /**
285 | * Gets the string presentation of the object
286 | *
287 | * @return string
288 | */
289 | public function __toString()
290 | {
291 | if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
292 | return json_encode(
293 | ObjectSerializer::sanitizeForSerialization($this),
294 | JSON_PRETTY_PRINT
295 | );
296 | }
297 |
298 | return json_encode(ObjectSerializer::sanitizeForSerialization($this));
299 | }
300 | }
301 |
302 |
303 |
--------------------------------------------------------------------------------
/lib/model/PayloadOutboxModification.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | use \ArrayAccess;
33 | use \faxplus\ObjectSerializer;
34 |
35 | /**
36 | * PayloadOutboxModification Class Doc Comment
37 | *
38 | * @category Class
39 | * @description Request object for making changes in an outbox object
40 | * @package faxplus
41 | * @author Swagger Codegen team
42 | * @link https://github.com/swagger-api/swagger-codegen
43 | */
44 | class PayloadOutboxModification implements ModelInterface, ArrayAccess
45 | {
46 | const DISCRIMINATOR = null;
47 |
48 | /**
49 | * The original name of the model.
50 | *
51 | * @var string
52 | */
53 | protected static $swaggerModelName = 'payload_OutboxModification';
54 |
55 | /**
56 | * Array of property to type mappings. Used for (de)serialization
57 | *
58 | * @var string[]
59 | */
60 | protected static $swaggerTypes = [
61 | 'comment' => 'string'
62 | ];
63 |
64 | /**
65 | * Array of property to format mappings. Used for (de)serialization
66 | *
67 | * @var string[]
68 | */
69 | protected static $swaggerFormats = [
70 | 'comment' => null
71 | ];
72 |
73 | /**
74 | * Array of property to type mappings. Used for (de)serialization
75 | *
76 | * @return array
77 | */
78 | public static function swaggerTypes()
79 | {
80 | return self::$swaggerTypes;
81 | }
82 |
83 | /**
84 | * Array of property to format mappings. Used for (de)serialization
85 | *
86 | * @return array
87 | */
88 | public static function swaggerFormats()
89 | {
90 | return self::$swaggerFormats;
91 | }
92 |
93 | /**
94 | * Array of attributes where the key is the local name,
95 | * and the value is the original name
96 | *
97 | * @var string[]
98 | */
99 | protected static $attributeMap = [
100 | 'comment' => 'comment'
101 | ];
102 |
103 | /**
104 | * Array of attributes to setter functions (for deserialization of responses)
105 | *
106 | * @var string[]
107 | */
108 | protected static $setters = [
109 | 'comment' => 'setComment'
110 | ];
111 |
112 | /**
113 | * Array of attributes to getter functions (for serialization of requests)
114 | *
115 | * @var string[]
116 | */
117 | protected static $getters = [
118 | 'comment' => 'getComment'
119 | ];
120 |
121 | /**
122 | * Array of attributes where the key is the local name,
123 | * and the value is the original name
124 | *
125 | * @return array
126 | */
127 | public static function attributeMap()
128 | {
129 | return self::$attributeMap;
130 | }
131 |
132 | /**
133 | * Array of attributes to setter functions (for deserialization of responses)
134 | *
135 | * @return array
136 | */
137 | public static function setters()
138 | {
139 | return self::$setters;
140 | }
141 |
142 | /**
143 | * Array of attributes to getter functions (for serialization of requests)
144 | *
145 | * @return array
146 | */
147 | public static function getters()
148 | {
149 | return self::$getters;
150 | }
151 |
152 | /**
153 | * The original name of the model.
154 | *
155 | * @return string
156 | */
157 | public function getModelName()
158 | {
159 | return self::$swaggerModelName;
160 | }
161 |
162 |
163 |
164 |
165 |
166 | /**
167 | * Associative array for storing property values
168 | *
169 | * @var mixed[]
170 | */
171 | protected $container = [];
172 |
173 | /**
174 | * Constructor
175 | *
176 | * @param mixed[] $data Associated array of property values
177 | * initializing the model
178 | */
179 | public function __construct(array $data = null)
180 | {
181 | $this->container['comment'] = isset($data['comment']) ? $data['comment'] : null;
182 | }
183 |
184 | /**
185 | * Show all the invalid properties with reasons.
186 | *
187 | * @return array invalid properties with reasons
188 | */
189 | public function listInvalidProperties()
190 | {
191 | $invalidProperties = [];
192 |
193 | return $invalidProperties;
194 | }
195 |
196 | /**
197 | * Validate all the properties in the model
198 | * return true if all passed
199 | *
200 | * @return bool True if all properties are valid
201 | */
202 | public function valid()
203 | {
204 |
205 | return true;
206 | }
207 |
208 |
209 | /**
210 | * Gets comment
211 | *
212 | * @return string
213 | */
214 | public function getComment()
215 | {
216 | return $this->container['comment'];
217 | }
218 |
219 | /**
220 | * Sets comment
221 | *
222 | * @param string $comment comment
223 | *
224 | * @return $this
225 | */
226 | public function setComment($comment)
227 | {
228 | $this->container['comment'] = $comment;
229 |
230 | return $this;
231 | }
232 | /**
233 | * Returns true if offset exists. False otherwise.
234 | *
235 | * @param integer $offset Offset
236 | *
237 | * @return boolean
238 | */
239 | public function offsetExists($offset)
240 | {
241 | return isset($this->container[$offset]);
242 | }
243 |
244 | /**
245 | * Gets offset.
246 | *
247 | * @param integer $offset Offset
248 | *
249 | * @return mixed
250 | */
251 | public function offsetGet($offset)
252 | {
253 | return isset($this->container[$offset]) ? $this->container[$offset] : null;
254 | }
255 |
256 | /**
257 | * Sets value based on offset.
258 | *
259 | * @param integer $offset Offset
260 | * @param mixed $value Value to be set
261 | *
262 | * @return void
263 | */
264 | public function offsetSet($offset, $value)
265 | {
266 | if (is_null($offset)) {
267 | $this->container[] = $value;
268 | } else {
269 | $this->container[$offset] = $value;
270 | }
271 | }
272 |
273 | /**
274 | * Unsets offset.
275 | *
276 | * @param integer $offset Offset
277 | *
278 | * @return void
279 | */
280 | public function offsetUnset($offset)
281 | {
282 | unset($this->container[$offset]);
283 | }
284 |
285 | /**
286 | * Gets the string presentation of the object
287 | *
288 | * @return string
289 | */
290 | public function __toString()
291 | {
292 | if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
293 | return json_encode(
294 | ObjectSerializer::sanitizeForSerialization($this),
295 | JSON_PRETTY_PRINT
296 | );
297 | }
298 |
299 | return json_encode(ObjectSerializer::sanitizeForSerialization($this));
300 | }
301 | }
302 |
303 |
304 |
--------------------------------------------------------------------------------
/lib/model/ResponseAccountList.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | use \ArrayAccess;
33 | use \faxplus\ObjectSerializer;
34 |
35 | /**
36 | * ResponseAccountList Class Doc Comment
37 | *
38 | * @category Class
39 | * @description Object containing account information
40 | * @package faxplus
41 | * @author Swagger Codegen team
42 | * @link https://github.com/swagger-api/swagger-codegen
43 | */
44 | class ResponseAccountList implements ModelInterface, ArrayAccess
45 | {
46 | const DISCRIMINATOR = null;
47 |
48 | /**
49 | * The original name of the model.
50 | *
51 | * @var string
52 | */
53 | protected static $swaggerModelName = 'response_AccountList';
54 |
55 | /**
56 | * Array of property to type mappings. Used for (de)serialization
57 | *
58 | * @var string[]
59 | */
60 | protected static $swaggerTypes = [
61 | 'members' => '\faxplus\model\Account[]'
62 | ];
63 |
64 | /**
65 | * Array of property to format mappings. Used for (de)serialization
66 | *
67 | * @var string[]
68 | */
69 | protected static $swaggerFormats = [
70 | 'members' => null
71 | ];
72 |
73 | /**
74 | * Array of property to type mappings. Used for (de)serialization
75 | *
76 | * @return array
77 | */
78 | public static function swaggerTypes()
79 | {
80 | return self::$swaggerTypes;
81 | }
82 |
83 | /**
84 | * Array of property to format mappings. Used for (de)serialization
85 | *
86 | * @return array
87 | */
88 | public static function swaggerFormats()
89 | {
90 | return self::$swaggerFormats;
91 | }
92 |
93 | /**
94 | * Array of attributes where the key is the local name,
95 | * and the value is the original name
96 | *
97 | * @var string[]
98 | */
99 | protected static $attributeMap = [
100 | 'members' => 'members'
101 | ];
102 |
103 | /**
104 | * Array of attributes to setter functions (for deserialization of responses)
105 | *
106 | * @var string[]
107 | */
108 | protected static $setters = [
109 | 'members' => 'setMembers'
110 | ];
111 |
112 | /**
113 | * Array of attributes to getter functions (for serialization of requests)
114 | *
115 | * @var string[]
116 | */
117 | protected static $getters = [
118 | 'members' => 'getMembers'
119 | ];
120 |
121 | /**
122 | * Array of attributes where the key is the local name,
123 | * and the value is the original name
124 | *
125 | * @return array
126 | */
127 | public static function attributeMap()
128 | {
129 | return self::$attributeMap;
130 | }
131 |
132 | /**
133 | * Array of attributes to setter functions (for deserialization of responses)
134 | *
135 | * @return array
136 | */
137 | public static function setters()
138 | {
139 | return self::$setters;
140 | }
141 |
142 | /**
143 | * Array of attributes to getter functions (for serialization of requests)
144 | *
145 | * @return array
146 | */
147 | public static function getters()
148 | {
149 | return self::$getters;
150 | }
151 |
152 | /**
153 | * The original name of the model.
154 | *
155 | * @return string
156 | */
157 | public function getModelName()
158 | {
159 | return self::$swaggerModelName;
160 | }
161 |
162 |
163 |
164 |
165 |
166 | /**
167 | * Associative array for storing property values
168 | *
169 | * @var mixed[]
170 | */
171 | protected $container = [];
172 |
173 | /**
174 | * Constructor
175 | *
176 | * @param mixed[] $data Associated array of property values
177 | * initializing the model
178 | */
179 | public function __construct(array $data = null)
180 | {
181 | $this->container['members'] = isset($data['members']) ? $data['members'] : null;
182 | }
183 |
184 | /**
185 | * Show all the invalid properties with reasons.
186 | *
187 | * @return array invalid properties with reasons
188 | */
189 | public function listInvalidProperties()
190 | {
191 | $invalidProperties = [];
192 |
193 | return $invalidProperties;
194 | }
195 |
196 | /**
197 | * Validate all the properties in the model
198 | * return true if all passed
199 | *
200 | * @return bool True if all properties are valid
201 | */
202 | public function valid()
203 | {
204 |
205 | return true;
206 | }
207 |
208 |
209 | /**
210 | * Gets members
211 | *
212 | * @return \faxplus\model\Account[]
213 | */
214 | public function getMembers()
215 | {
216 | return $this->container['members'];
217 | }
218 |
219 | /**
220 | * Sets members
221 | *
222 | * @param \faxplus\model\Account[] $members members
223 | *
224 | * @return $this
225 | */
226 | public function setMembers($members)
227 | {
228 | $this->container['members'] = $members;
229 |
230 | return $this;
231 | }
232 | /**
233 | * Returns true if offset exists. False otherwise.
234 | *
235 | * @param integer $offset Offset
236 | *
237 | * @return boolean
238 | */
239 | public function offsetExists($offset)
240 | {
241 | return isset($this->container[$offset]);
242 | }
243 |
244 | /**
245 | * Gets offset.
246 | *
247 | * @param integer $offset Offset
248 | *
249 | * @return mixed
250 | */
251 | public function offsetGet($offset)
252 | {
253 | return isset($this->container[$offset]) ? $this->container[$offset] : null;
254 | }
255 |
256 | /**
257 | * Sets value based on offset.
258 | *
259 | * @param integer $offset Offset
260 | * @param mixed $value Value to be set
261 | *
262 | * @return void
263 | */
264 | public function offsetSet($offset, $value)
265 | {
266 | if (is_null($offset)) {
267 | $this->container[] = $value;
268 | } else {
269 | $this->container[$offset] = $value;
270 | }
271 | }
272 |
273 | /**
274 | * Unsets offset.
275 | *
276 | * @param integer $offset Offset
277 | *
278 | * @return void
279 | */
280 | public function offsetUnset($offset)
281 | {
282 | unset($this->container[$offset]);
283 | }
284 |
285 | /**
286 | * Gets the string presentation of the object
287 | *
288 | * @return string
289 | */
290 | public function __toString()
291 | {
292 | if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
293 | return json_encode(
294 | ObjectSerializer::sanitizeForSerialization($this),
295 | JSON_PRETTY_PRINT
296 | );
297 | }
298 |
299 | return json_encode(ObjectSerializer::sanitizeForSerialization($this));
300 | }
301 | }
302 |
303 |
304 |
--------------------------------------------------------------------------------
/lib/model/ResponseNumberList.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | use \ArrayAccess;
33 | use \faxplus\ObjectSerializer;
34 |
35 | /**
36 | * ResponseNumberList Class Doc Comment
37 | *
38 | * @category Class
39 | * @description Response containing a list of number objects
40 | * @package faxplus
41 | * @author Swagger Codegen team
42 | * @link https://github.com/swagger-api/swagger-codegen
43 | */
44 | class ResponseNumberList implements ModelInterface, ArrayAccess
45 | {
46 | const DISCRIMINATOR = null;
47 |
48 | /**
49 | * The original name of the model.
50 | *
51 | * @var string
52 | */
53 | protected static $swaggerModelName = 'response_NumberList';
54 |
55 | /**
56 | * Array of property to type mappings. Used for (de)serialization
57 | *
58 | * @var string[]
59 | */
60 | protected static $swaggerTypes = [
61 | 'numbers' => '\faxplus\model\Number[]'
62 | ];
63 |
64 | /**
65 | * Array of property to format mappings. Used for (de)serialization
66 | *
67 | * @var string[]
68 | */
69 | protected static $swaggerFormats = [
70 | 'numbers' => null
71 | ];
72 |
73 | /**
74 | * Array of property to type mappings. Used for (de)serialization
75 | *
76 | * @return array
77 | */
78 | public static function swaggerTypes()
79 | {
80 | return self::$swaggerTypes;
81 | }
82 |
83 | /**
84 | * Array of property to format mappings. Used for (de)serialization
85 | *
86 | * @return array
87 | */
88 | public static function swaggerFormats()
89 | {
90 | return self::$swaggerFormats;
91 | }
92 |
93 | /**
94 | * Array of attributes where the key is the local name,
95 | * and the value is the original name
96 | *
97 | * @var string[]
98 | */
99 | protected static $attributeMap = [
100 | 'numbers' => 'numbers'
101 | ];
102 |
103 | /**
104 | * Array of attributes to setter functions (for deserialization of responses)
105 | *
106 | * @var string[]
107 | */
108 | protected static $setters = [
109 | 'numbers' => 'setNumbers'
110 | ];
111 |
112 | /**
113 | * Array of attributes to getter functions (for serialization of requests)
114 | *
115 | * @var string[]
116 | */
117 | protected static $getters = [
118 | 'numbers' => 'getNumbers'
119 | ];
120 |
121 | /**
122 | * Array of attributes where the key is the local name,
123 | * and the value is the original name
124 | *
125 | * @return array
126 | */
127 | public static function attributeMap()
128 | {
129 | return self::$attributeMap;
130 | }
131 |
132 | /**
133 | * Array of attributes to setter functions (for deserialization of responses)
134 | *
135 | * @return array
136 | */
137 | public static function setters()
138 | {
139 | return self::$setters;
140 | }
141 |
142 | /**
143 | * Array of attributes to getter functions (for serialization of requests)
144 | *
145 | * @return array
146 | */
147 | public static function getters()
148 | {
149 | return self::$getters;
150 | }
151 |
152 | /**
153 | * The original name of the model.
154 | *
155 | * @return string
156 | */
157 | public function getModelName()
158 | {
159 | return self::$swaggerModelName;
160 | }
161 |
162 |
163 |
164 |
165 |
166 | /**
167 | * Associative array for storing property values
168 | *
169 | * @var mixed[]
170 | */
171 | protected $container = [];
172 |
173 | /**
174 | * Constructor
175 | *
176 | * @param mixed[] $data Associated array of property values
177 | * initializing the model
178 | */
179 | public function __construct(array $data = null)
180 | {
181 | $this->container['numbers'] = isset($data['numbers']) ? $data['numbers'] : null;
182 | }
183 |
184 | /**
185 | * Show all the invalid properties with reasons.
186 | *
187 | * @return array invalid properties with reasons
188 | */
189 | public function listInvalidProperties()
190 | {
191 | $invalidProperties = [];
192 |
193 | return $invalidProperties;
194 | }
195 |
196 | /**
197 | * Validate all the properties in the model
198 | * return true if all passed
199 | *
200 | * @return bool True if all properties are valid
201 | */
202 | public function valid()
203 | {
204 |
205 | return true;
206 | }
207 |
208 |
209 | /**
210 | * Gets numbers
211 | *
212 | * @return \faxplus\model\Number[]
213 | */
214 | public function getNumbers()
215 | {
216 | return $this->container['numbers'];
217 | }
218 |
219 | /**
220 | * Sets numbers
221 | *
222 | * @param \faxplus\model\Number[] $numbers numbers
223 | *
224 | * @return $this
225 | */
226 | public function setNumbers($numbers)
227 | {
228 | $this->container['numbers'] = $numbers;
229 |
230 | return $this;
231 | }
232 | /**
233 | * Returns true if offset exists. False otherwise.
234 | *
235 | * @param integer $offset Offset
236 | *
237 | * @return boolean
238 | */
239 | public function offsetExists($offset)
240 | {
241 | return isset($this->container[$offset]);
242 | }
243 |
244 | /**
245 | * Gets offset.
246 | *
247 | * @param integer $offset Offset
248 | *
249 | * @return mixed
250 | */
251 | public function offsetGet($offset)
252 | {
253 | return isset($this->container[$offset]) ? $this->container[$offset] : null;
254 | }
255 |
256 | /**
257 | * Sets value based on offset.
258 | *
259 | * @param integer $offset Offset
260 | * @param mixed $value Value to be set
261 | *
262 | * @return void
263 | */
264 | public function offsetSet($offset, $value)
265 | {
266 | if (is_null($offset)) {
267 | $this->container[] = $value;
268 | } else {
269 | $this->container[$offset] = $value;
270 | }
271 | }
272 |
273 | /**
274 | * Unsets offset.
275 | *
276 | * @param integer $offset Offset
277 | *
278 | * @return void
279 | */
280 | public function offsetUnset($offset)
281 | {
282 | unset($this->container[$offset]);
283 | }
284 |
285 | /**
286 | * Gets the string presentation of the object
287 | *
288 | * @return string
289 | */
290 | public function __toString()
291 | {
292 | if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
293 | return json_encode(
294 | ObjectSerializer::sanitizeForSerialization($this),
295 | JSON_PRETTY_PRINT
296 | );
297 | }
298 |
299 | return json_encode(ObjectSerializer::sanitizeForSerialization($this));
300 | }
301 | }
302 |
303 |
304 |
--------------------------------------------------------------------------------
/lib/model/ResponseOutboxList.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | use \ArrayAccess;
33 | use \faxplus\ObjectSerializer;
34 |
35 | /**
36 | * ResponseOutboxList Class Doc Comment
37 | *
38 | * @category Class
39 | * @description Response containing a list of outbox objects
40 | * @package faxplus
41 | * @author Swagger Codegen team
42 | * @link https://github.com/swagger-api/swagger-codegen
43 | */
44 | class ResponseOutboxList implements ModelInterface, ArrayAccess
45 | {
46 | const DISCRIMINATOR = null;
47 |
48 | /**
49 | * The original name of the model.
50 | *
51 | * @var string
52 | */
53 | protected static $swaggerModelName = 'response_OutboxList';
54 |
55 | /**
56 | * Array of property to type mappings. Used for (de)serialization
57 | *
58 | * @var string[]
59 | */
60 | protected static $swaggerTypes = [
61 | 'records' => '\faxplus\model\Outbox[]'
62 | ];
63 |
64 | /**
65 | * Array of property to format mappings. Used for (de)serialization
66 | *
67 | * @var string[]
68 | */
69 | protected static $swaggerFormats = [
70 | 'records' => null
71 | ];
72 |
73 | /**
74 | * Array of property to type mappings. Used for (de)serialization
75 | *
76 | * @return array
77 | */
78 | public static function swaggerTypes()
79 | {
80 | return self::$swaggerTypes;
81 | }
82 |
83 | /**
84 | * Array of property to format mappings. Used for (de)serialization
85 | *
86 | * @return array
87 | */
88 | public static function swaggerFormats()
89 | {
90 | return self::$swaggerFormats;
91 | }
92 |
93 | /**
94 | * Array of attributes where the key is the local name,
95 | * and the value is the original name
96 | *
97 | * @var string[]
98 | */
99 | protected static $attributeMap = [
100 | 'records' => 'records'
101 | ];
102 |
103 | /**
104 | * Array of attributes to setter functions (for deserialization of responses)
105 | *
106 | * @var string[]
107 | */
108 | protected static $setters = [
109 | 'records' => 'setRecords'
110 | ];
111 |
112 | /**
113 | * Array of attributes to getter functions (for serialization of requests)
114 | *
115 | * @var string[]
116 | */
117 | protected static $getters = [
118 | 'records' => 'getRecords'
119 | ];
120 |
121 | /**
122 | * Array of attributes where the key is the local name,
123 | * and the value is the original name
124 | *
125 | * @return array
126 | */
127 | public static function attributeMap()
128 | {
129 | return self::$attributeMap;
130 | }
131 |
132 | /**
133 | * Array of attributes to setter functions (for deserialization of responses)
134 | *
135 | * @return array
136 | */
137 | public static function setters()
138 | {
139 | return self::$setters;
140 | }
141 |
142 | /**
143 | * Array of attributes to getter functions (for serialization of requests)
144 | *
145 | * @return array
146 | */
147 | public static function getters()
148 | {
149 | return self::$getters;
150 | }
151 |
152 | /**
153 | * The original name of the model.
154 | *
155 | * @return string
156 | */
157 | public function getModelName()
158 | {
159 | return self::$swaggerModelName;
160 | }
161 |
162 |
163 |
164 |
165 |
166 | /**
167 | * Associative array for storing property values
168 | *
169 | * @var mixed[]
170 | */
171 | protected $container = [];
172 |
173 | /**
174 | * Constructor
175 | *
176 | * @param mixed[] $data Associated array of property values
177 | * initializing the model
178 | */
179 | public function __construct(array $data = null)
180 | {
181 | $this->container['records'] = isset($data['records']) ? $data['records'] : null;
182 | }
183 |
184 | /**
185 | * Show all the invalid properties with reasons.
186 | *
187 | * @return array invalid properties with reasons
188 | */
189 | public function listInvalidProperties()
190 | {
191 | $invalidProperties = [];
192 |
193 | return $invalidProperties;
194 | }
195 |
196 | /**
197 | * Validate all the properties in the model
198 | * return true if all passed
199 | *
200 | * @return bool True if all properties are valid
201 | */
202 | public function valid()
203 | {
204 |
205 | return true;
206 | }
207 |
208 |
209 | /**
210 | * Gets records
211 | *
212 | * @return \faxplus\model\Outbox[]
213 | */
214 | public function getRecords()
215 | {
216 | return $this->container['records'];
217 | }
218 |
219 | /**
220 | * Sets records
221 | *
222 | * @param \faxplus\model\Outbox[] $records records
223 | *
224 | * @return $this
225 | */
226 | public function setRecords($records)
227 | {
228 | $this->container['records'] = $records;
229 |
230 | return $this;
231 | }
232 | /**
233 | * Returns true if offset exists. False otherwise.
234 | *
235 | * @param integer $offset Offset
236 | *
237 | * @return boolean
238 | */
239 | public function offsetExists($offset)
240 | {
241 | return isset($this->container[$offset]);
242 | }
243 |
244 | /**
245 | * Gets offset.
246 | *
247 | * @param integer $offset Offset
248 | *
249 | * @return mixed
250 | */
251 | public function offsetGet($offset)
252 | {
253 | return isset($this->container[$offset]) ? $this->container[$offset] : null;
254 | }
255 |
256 | /**
257 | * Sets value based on offset.
258 | *
259 | * @param integer $offset Offset
260 | * @param mixed $value Value to be set
261 | *
262 | * @return void
263 | */
264 | public function offsetSet($offset, $value)
265 | {
266 | if (is_null($offset)) {
267 | $this->container[] = $value;
268 | } else {
269 | $this->container[$offset] = $value;
270 | }
271 | }
272 |
273 | /**
274 | * Unsets offset.
275 | *
276 | * @param integer $offset Offset
277 | *
278 | * @return void
279 | */
280 | public function offsetUnset($offset)
281 | {
282 | unset($this->container[$offset]);
283 | }
284 |
285 | /**
286 | * Gets the string presentation of the object
287 | *
288 | * @return string
289 | */
290 | public function __toString()
291 | {
292 | if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
293 | return json_encode(
294 | ObjectSerializer::sanitizeForSerialization($this),
295 | JSON_PRETTY_PRINT
296 | );
297 | }
298 |
299 | return json_encode(ObjectSerializer::sanitizeForSerialization($this));
300 | }
301 | }
302 |
303 |
304 |
--------------------------------------------------------------------------------
/lib/model/PayloadNumberModification.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | use \ArrayAccess;
33 | use \faxplus\ObjectSerializer;
34 |
35 | /**
36 | * PayloadNumberModification Class Doc Comment
37 | *
38 | * @category Class
39 | * @description Request object for making changes in number object
40 | * @package faxplus
41 | * @author Swagger Codegen team
42 | * @link https://github.com/swagger-api/swagger-codegen
43 | */
44 | class PayloadNumberModification implements ModelInterface, ArrayAccess
45 | {
46 | const DISCRIMINATOR = null;
47 |
48 | /**
49 | * The original name of the model.
50 | *
51 | * @var string
52 | */
53 | protected static $swaggerModelName = 'payload_NumberModification';
54 |
55 | /**
56 | * Array of property to type mappings. Used for (de)serialization
57 | *
58 | * @var string[]
59 | */
60 | protected static $swaggerTypes = [
61 | 'assigned_to' => 'string'
62 | ];
63 |
64 | /**
65 | * Array of property to format mappings. Used for (de)serialization
66 | *
67 | * @var string[]
68 | */
69 | protected static $swaggerFormats = [
70 | 'assigned_to' => null
71 | ];
72 |
73 | /**
74 | * Array of property to type mappings. Used for (de)serialization
75 | *
76 | * @return array
77 | */
78 | public static function swaggerTypes()
79 | {
80 | return self::$swaggerTypes;
81 | }
82 |
83 | /**
84 | * Array of property to format mappings. Used for (de)serialization
85 | *
86 | * @return array
87 | */
88 | public static function swaggerFormats()
89 | {
90 | return self::$swaggerFormats;
91 | }
92 |
93 | /**
94 | * Array of attributes where the key is the local name,
95 | * and the value is the original name
96 | *
97 | * @var string[]
98 | */
99 | protected static $attributeMap = [
100 | 'assigned_to' => 'assigned_to'
101 | ];
102 |
103 | /**
104 | * Array of attributes to setter functions (for deserialization of responses)
105 | *
106 | * @var string[]
107 | */
108 | protected static $setters = [
109 | 'assigned_to' => 'setAssignedTo'
110 | ];
111 |
112 | /**
113 | * Array of attributes to getter functions (for serialization of requests)
114 | *
115 | * @var string[]
116 | */
117 | protected static $getters = [
118 | 'assigned_to' => 'getAssignedTo'
119 | ];
120 |
121 | /**
122 | * Array of attributes where the key is the local name,
123 | * and the value is the original name
124 | *
125 | * @return array
126 | */
127 | public static function attributeMap()
128 | {
129 | return self::$attributeMap;
130 | }
131 |
132 | /**
133 | * Array of attributes to setter functions (for deserialization of responses)
134 | *
135 | * @return array
136 | */
137 | public static function setters()
138 | {
139 | return self::$setters;
140 | }
141 |
142 | /**
143 | * Array of attributes to getter functions (for serialization of requests)
144 | *
145 | * @return array
146 | */
147 | public static function getters()
148 | {
149 | return self::$getters;
150 | }
151 |
152 | /**
153 | * The original name of the model.
154 | *
155 | * @return string
156 | */
157 | public function getModelName()
158 | {
159 | return self::$swaggerModelName;
160 | }
161 |
162 |
163 |
164 |
165 |
166 | /**
167 | * Associative array for storing property values
168 | *
169 | * @var mixed[]
170 | */
171 | protected $container = [];
172 |
173 | /**
174 | * Constructor
175 | *
176 | * @param mixed[] $data Associated array of property values
177 | * initializing the model
178 | */
179 | public function __construct(array $data = null)
180 | {
181 | $this->container['assigned_to'] = isset($data['assigned_to']) ? $data['assigned_to'] : null;
182 | }
183 |
184 | /**
185 | * Show all the invalid properties with reasons.
186 | *
187 | * @return array invalid properties with reasons
188 | */
189 | public function listInvalidProperties()
190 | {
191 | $invalidProperties = [];
192 |
193 | return $invalidProperties;
194 | }
195 |
196 | /**
197 | * Validate all the properties in the model
198 | * return true if all passed
199 | *
200 | * @return bool True if all properties are valid
201 | */
202 | public function valid()
203 | {
204 |
205 | return true;
206 | }
207 |
208 |
209 | /**
210 | * Gets assigned_to
211 | *
212 | * @return string
213 | */
214 | public function getAssignedTo()
215 | {
216 | return $this->container['assigned_to'];
217 | }
218 |
219 | /**
220 | * Sets assigned_to
221 | *
222 | * @param string $assigned_to assigned_to
223 | *
224 | * @return $this
225 | */
226 | public function setAssignedTo($assigned_to)
227 | {
228 | $this->container['assigned_to'] = $assigned_to;
229 |
230 | return $this;
231 | }
232 | /**
233 | * Returns true if offset exists. False otherwise.
234 | *
235 | * @param integer $offset Offset
236 | *
237 | * @return boolean
238 | */
239 | public function offsetExists($offset)
240 | {
241 | return isset($this->container[$offset]);
242 | }
243 |
244 | /**
245 | * Gets offset.
246 | *
247 | * @param integer $offset Offset
248 | *
249 | * @return mixed
250 | */
251 | public function offsetGet($offset)
252 | {
253 | return isset($this->container[$offset]) ? $this->container[$offset] : null;
254 | }
255 |
256 | /**
257 | * Sets value based on offset.
258 | *
259 | * @param integer $offset Offset
260 | * @param mixed $value Value to be set
261 | *
262 | * @return void
263 | */
264 | public function offsetSet($offset, $value)
265 | {
266 | if (is_null($offset)) {
267 | $this->container[] = $value;
268 | } else {
269 | $this->container[$offset] = $value;
270 | }
271 | }
272 |
273 | /**
274 | * Unsets offset.
275 | *
276 | * @param integer $offset Offset
277 | *
278 | * @return void
279 | */
280 | public function offsetUnset($offset)
281 | {
282 | unset($this->container[$offset]);
283 | }
284 |
285 | /**
286 | * Gets the string presentation of the object
287 | *
288 | * @return string
289 | */
290 | public function __toString()
291 | {
292 | if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
293 | return json_encode(
294 | ObjectSerializer::sanitizeForSerialization($this),
295 | JSON_PRETTY_PRINT
296 | );
297 | }
298 |
299 | return json_encode(ObjectSerializer::sanitizeForSerialization($this));
300 | }
301 | }
302 |
303 |
304 |
--------------------------------------------------------------------------------
/lib/model/OutboxStatusChanges.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | use \ArrayAccess;
33 | use \faxplus\ObjectSerializer;
34 |
35 | /**
36 | * OutboxStatusChanges Class Doc Comment
37 | *
38 | * @category Class
39 | * @package faxplus
40 | * @author Swagger Codegen team
41 | * @link https://github.com/swagger-api/swagger-codegen
42 | */
43 | class OutboxStatusChanges implements ModelInterface, ArrayAccess
44 | {
45 | const DISCRIMINATOR = null;
46 |
47 | /**
48 | * The original name of the model.
49 | *
50 | * @var string
51 | */
52 | protected static $swaggerModelName = 'Outbox_status_changes';
53 |
54 | /**
55 | * Array of property to type mappings. Used for (de)serialization
56 | *
57 | * @var string[]
58 | */
59 | protected static $swaggerTypes = [
60 | 'status' => 'string',
61 | 'at' => 'string'
62 | ];
63 |
64 | /**
65 | * Array of property to format mappings. Used for (de)serialization
66 | *
67 | * @var string[]
68 | */
69 | protected static $swaggerFormats = [
70 | 'status' => null,
71 | 'at' => null
72 | ];
73 |
74 | /**
75 | * Array of property to type mappings. Used for (de)serialization
76 | *
77 | * @return array
78 | */
79 | public static function swaggerTypes()
80 | {
81 | return self::$swaggerTypes;
82 | }
83 |
84 | /**
85 | * Array of property to format mappings. Used for (de)serialization
86 | *
87 | * @return array
88 | */
89 | public static function swaggerFormats()
90 | {
91 | return self::$swaggerFormats;
92 | }
93 |
94 | /**
95 | * Array of attributes where the key is the local name,
96 | * and the value is the original name
97 | *
98 | * @var string[]
99 | */
100 | protected static $attributeMap = [
101 | 'status' => 'status',
102 | 'at' => 'at'
103 | ];
104 |
105 | /**
106 | * Array of attributes to setter functions (for deserialization of responses)
107 | *
108 | * @var string[]
109 | */
110 | protected static $setters = [
111 | 'status' => 'setStatus',
112 | 'at' => 'setAt'
113 | ];
114 |
115 | /**
116 | * Array of attributes to getter functions (for serialization of requests)
117 | *
118 | * @var string[]
119 | */
120 | protected static $getters = [
121 | 'status' => 'getStatus',
122 | 'at' => 'getAt'
123 | ];
124 |
125 | /**
126 | * Array of attributes where the key is the local name,
127 | * and the value is the original name
128 | *
129 | * @return array
130 | */
131 | public static function attributeMap()
132 | {
133 | return self::$attributeMap;
134 | }
135 |
136 | /**
137 | * Array of attributes to setter functions (for deserialization of responses)
138 | *
139 | * @return array
140 | */
141 | public static function setters()
142 | {
143 | return self::$setters;
144 | }
145 |
146 | /**
147 | * Array of attributes to getter functions (for serialization of requests)
148 | *
149 | * @return array
150 | */
151 | public static function getters()
152 | {
153 | return self::$getters;
154 | }
155 |
156 | /**
157 | * The original name of the model.
158 | *
159 | * @return string
160 | */
161 | public function getModelName()
162 | {
163 | return self::$swaggerModelName;
164 | }
165 |
166 |
167 |
168 |
169 |
170 | /**
171 | * Associative array for storing property values
172 | *
173 | * @var mixed[]
174 | */
175 | protected $container = [];
176 |
177 | /**
178 | * Constructor
179 | *
180 | * @param mixed[] $data Associated array of property values
181 | * initializing the model
182 | */
183 | public function __construct(array $data = null)
184 | {
185 | $this->container['status'] = isset($data['status']) ? $data['status'] : null;
186 | $this->container['at'] = isset($data['at']) ? $data['at'] : null;
187 | }
188 |
189 | /**
190 | * Show all the invalid properties with reasons.
191 | *
192 | * @return array invalid properties with reasons
193 | */
194 | public function listInvalidProperties()
195 | {
196 | $invalidProperties = [];
197 |
198 | return $invalidProperties;
199 | }
200 |
201 | /**
202 | * Validate all the properties in the model
203 | * return true if all passed
204 | *
205 | * @return bool True if all properties are valid
206 | */
207 | public function valid()
208 | {
209 |
210 | return true;
211 | }
212 |
213 |
214 | /**
215 | * Gets status
216 | *
217 | * @return string
218 | */
219 | public function getStatus()
220 | {
221 | return $this->container['status'];
222 | }
223 |
224 | /**
225 | * Sets status
226 | *
227 | * @param string $status status
228 | *
229 | * @return $this
230 | */
231 | public function setStatus($status)
232 | {
233 | $this->container['status'] = $status;
234 |
235 | return $this;
236 | }
237 |
238 | /**
239 | * Gets at
240 | *
241 | * @return string
242 | */
243 | public function getAt()
244 | {
245 | return $this->container['at'];
246 | }
247 |
248 | /**
249 | * Sets at
250 | *
251 | * @param string $at at
252 | *
253 | * @return $this
254 | */
255 | public function setAt($at)
256 | {
257 | $this->container['at'] = $at;
258 |
259 | return $this;
260 | }
261 | /**
262 | * Returns true if offset exists. False otherwise.
263 | *
264 | * @param integer $offset Offset
265 | *
266 | * @return boolean
267 | */
268 | public function offsetExists($offset)
269 | {
270 | return isset($this->container[$offset]);
271 | }
272 |
273 | /**
274 | * Gets offset.
275 | *
276 | * @param integer $offset Offset
277 | *
278 | * @return mixed
279 | */
280 | public function offsetGet($offset)
281 | {
282 | return isset($this->container[$offset]) ? $this->container[$offset] : null;
283 | }
284 |
285 | /**
286 | * Sets value based on offset.
287 | *
288 | * @param integer $offset Offset
289 | * @param mixed $value Value to be set
290 | *
291 | * @return void
292 | */
293 | public function offsetSet($offset, $value)
294 | {
295 | if (is_null($offset)) {
296 | $this->container[] = $value;
297 | } else {
298 | $this->container[$offset] = $value;
299 | }
300 | }
301 |
302 | /**
303 | * Unsets offset.
304 | *
305 | * @param integer $offset Offset
306 | *
307 | * @return void
308 | */
309 | public function offsetUnset($offset)
310 | {
311 | unset($this->container[$offset]);
312 | }
313 |
314 | /**
315 | * Gets the string presentation of the object
316 | *
317 | * @return string
318 | */
319 | public function __toString()
320 | {
321 | if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
322 | return json_encode(
323 | ObjectSerializer::sanitizeForSerialization($this),
324 | JSON_PRETTY_PRINT
325 | );
326 | }
327 |
328 | return json_encode(ObjectSerializer::sanitizeForSerialization($this));
329 | }
330 | }
331 |
332 |
333 |
--------------------------------------------------------------------------------
/lib/model/PayloadOutboxComment.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | use \ArrayAccess;
33 | use \faxplus\ObjectSerializer;
34 |
35 | /**
36 | * PayloadOutboxComment Class Doc Comment
37 | *
38 | * @category Class
39 | * @package faxplus
40 | * @author Swagger Codegen team
41 | * @link https://github.com/swagger-api/swagger-codegen
42 | */
43 | class PayloadOutboxComment implements ModelInterface, ArrayAccess
44 | {
45 | const DISCRIMINATOR = null;
46 |
47 | /**
48 | * The original name of the model.
49 | *
50 | * @var string
51 | */
52 | protected static $swaggerModelName = 'payload_Outbox_comment';
53 |
54 | /**
55 | * Array of property to type mappings. Used for (de)serialization
56 | *
57 | * @var string[]
58 | */
59 | protected static $swaggerTypes = [
60 | 'text' => 'string',
61 | 'tags' => 'string[]'
62 | ];
63 |
64 | /**
65 | * Array of property to format mappings. Used for (de)serialization
66 | *
67 | * @var string[]
68 | */
69 | protected static $swaggerFormats = [
70 | 'text' => null,
71 | 'tags' => null
72 | ];
73 |
74 | /**
75 | * Array of property to type mappings. Used for (de)serialization
76 | *
77 | * @return array
78 | */
79 | public static function swaggerTypes()
80 | {
81 | return self::$swaggerTypes;
82 | }
83 |
84 | /**
85 | * Array of property to format mappings. Used for (de)serialization
86 | *
87 | * @return array
88 | */
89 | public static function swaggerFormats()
90 | {
91 | return self::$swaggerFormats;
92 | }
93 |
94 | /**
95 | * Array of attributes where the key is the local name,
96 | * and the value is the original name
97 | *
98 | * @var string[]
99 | */
100 | protected static $attributeMap = [
101 | 'text' => 'text',
102 | 'tags' => 'tags'
103 | ];
104 |
105 | /**
106 | * Array of attributes to setter functions (for deserialization of responses)
107 | *
108 | * @var string[]
109 | */
110 | protected static $setters = [
111 | 'text' => 'setText',
112 | 'tags' => 'setTags'
113 | ];
114 |
115 | /**
116 | * Array of attributes to getter functions (for serialization of requests)
117 | *
118 | * @var string[]
119 | */
120 | protected static $getters = [
121 | 'text' => 'getText',
122 | 'tags' => 'getTags'
123 | ];
124 |
125 | /**
126 | * Array of attributes where the key is the local name,
127 | * and the value is the original name
128 | *
129 | * @return array
130 | */
131 | public static function attributeMap()
132 | {
133 | return self::$attributeMap;
134 | }
135 |
136 | /**
137 | * Array of attributes to setter functions (for deserialization of responses)
138 | *
139 | * @return array
140 | */
141 | public static function setters()
142 | {
143 | return self::$setters;
144 | }
145 |
146 | /**
147 | * Array of attributes to getter functions (for serialization of requests)
148 | *
149 | * @return array
150 | */
151 | public static function getters()
152 | {
153 | return self::$getters;
154 | }
155 |
156 | /**
157 | * The original name of the model.
158 | *
159 | * @return string
160 | */
161 | public function getModelName()
162 | {
163 | return self::$swaggerModelName;
164 | }
165 |
166 |
167 |
168 |
169 |
170 | /**
171 | * Associative array for storing property values
172 | *
173 | * @var mixed[]
174 | */
175 | protected $container = [];
176 |
177 | /**
178 | * Constructor
179 | *
180 | * @param mixed[] $data Associated array of property values
181 | * initializing the model
182 | */
183 | public function __construct(array $data = null)
184 | {
185 | $this->container['text'] = isset($data['text']) ? $data['text'] : null;
186 | $this->container['tags'] = isset($data['tags']) ? $data['tags'] : null;
187 | }
188 |
189 | /**
190 | * Show all the invalid properties with reasons.
191 | *
192 | * @return array invalid properties with reasons
193 | */
194 | public function listInvalidProperties()
195 | {
196 | $invalidProperties = [];
197 |
198 | return $invalidProperties;
199 | }
200 |
201 | /**
202 | * Validate all the properties in the model
203 | * return true if all passed
204 | *
205 | * @return bool True if all properties are valid
206 | */
207 | public function valid()
208 | {
209 |
210 | return true;
211 | }
212 |
213 |
214 | /**
215 | * Gets text
216 | *
217 | * @return string
218 | */
219 | public function getText()
220 | {
221 | return $this->container['text'];
222 | }
223 |
224 | /**
225 | * Sets text
226 | *
227 | * @param string $text text
228 | *
229 | * @return $this
230 | */
231 | public function setText($text)
232 | {
233 | $this->container['text'] = $text;
234 |
235 | return $this;
236 | }
237 |
238 | /**
239 | * Gets tags
240 | *
241 | * @return string[]
242 | */
243 | public function getTags()
244 | {
245 | return $this->container['tags'];
246 | }
247 |
248 | /**
249 | * Sets tags
250 | *
251 | * @param string[] $tags tags
252 | *
253 | * @return $this
254 | */
255 | public function setTags($tags)
256 | {
257 | $this->container['tags'] = $tags;
258 |
259 | return $this;
260 | }
261 | /**
262 | * Returns true if offset exists. False otherwise.
263 | *
264 | * @param integer $offset Offset
265 | *
266 | * @return boolean
267 | */
268 | public function offsetExists($offset)
269 | {
270 | return isset($this->container[$offset]);
271 | }
272 |
273 | /**
274 | * Gets offset.
275 | *
276 | * @param integer $offset Offset
277 | *
278 | * @return mixed
279 | */
280 | public function offsetGet($offset)
281 | {
282 | return isset($this->container[$offset]) ? $this->container[$offset] : null;
283 | }
284 |
285 | /**
286 | * Sets value based on offset.
287 | *
288 | * @param integer $offset Offset
289 | * @param mixed $value Value to be set
290 | *
291 | * @return void
292 | */
293 | public function offsetSet($offset, $value)
294 | {
295 | if (is_null($offset)) {
296 | $this->container[] = $value;
297 | } else {
298 | $this->container[$offset] = $value;
299 | }
300 | }
301 |
302 | /**
303 | * Unsets offset.
304 | *
305 | * @param integer $offset Offset
306 | *
307 | * @return void
308 | */
309 | public function offsetUnset($offset)
310 | {
311 | unset($this->container[$offset]);
312 | }
313 |
314 | /**
315 | * Gets the string presentation of the object
316 | *
317 | * @return string
318 | */
319 | public function __toString()
320 | {
321 | if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
322 | return json_encode(
323 | ObjectSerializer::sanitizeForSerialization($this),
324 | JSON_PRETTY_PRINT
325 | );
326 | }
327 |
328 | return json_encode(ObjectSerializer::sanitizeForSerialization($this));
329 | }
330 | }
331 |
332 |
333 |
--------------------------------------------------------------------------------
/lib/model/OutboxFileChanges.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | use \ArrayAccess;
33 | use \faxplus\ObjectSerializer;
34 |
35 | /**
36 | * OutboxFileChanges Class Doc Comment
37 | *
38 | * @category Class
39 | * @package faxplus
40 | * @author Swagger Codegen team
41 | * @link https://github.com/swagger-api/swagger-codegen
42 | */
43 | class OutboxFileChanges implements ModelInterface, ArrayAccess
44 | {
45 | const DISCRIMINATOR = null;
46 |
47 | /**
48 | * The original name of the model.
49 | *
50 | * @var string
51 | */
52 | protected static $swaggerModelName = 'Outbox_file_changes';
53 |
54 | /**
55 | * Array of property to type mappings. Used for (de)serialization
56 | *
57 | * @var string[]
58 | */
59 | protected static $swaggerTypes = [
60 | 'files' => '\faxplus\model\OutboxFiles[]',
61 | 'at' => 'string'
62 | ];
63 |
64 | /**
65 | * Array of property to format mappings. Used for (de)serialization
66 | *
67 | * @var string[]
68 | */
69 | protected static $swaggerFormats = [
70 | 'files' => null,
71 | 'at' => null
72 | ];
73 |
74 | /**
75 | * Array of property to type mappings. Used for (de)serialization
76 | *
77 | * @return array
78 | */
79 | public static function swaggerTypes()
80 | {
81 | return self::$swaggerTypes;
82 | }
83 |
84 | /**
85 | * Array of property to format mappings. Used for (de)serialization
86 | *
87 | * @return array
88 | */
89 | public static function swaggerFormats()
90 | {
91 | return self::$swaggerFormats;
92 | }
93 |
94 | /**
95 | * Array of attributes where the key is the local name,
96 | * and the value is the original name
97 | *
98 | * @var string[]
99 | */
100 | protected static $attributeMap = [
101 | 'files' => 'files',
102 | 'at' => 'at'
103 | ];
104 |
105 | /**
106 | * Array of attributes to setter functions (for deserialization of responses)
107 | *
108 | * @var string[]
109 | */
110 | protected static $setters = [
111 | 'files' => 'setFiles',
112 | 'at' => 'setAt'
113 | ];
114 |
115 | /**
116 | * Array of attributes to getter functions (for serialization of requests)
117 | *
118 | * @var string[]
119 | */
120 | protected static $getters = [
121 | 'files' => 'getFiles',
122 | 'at' => 'getAt'
123 | ];
124 |
125 | /**
126 | * Array of attributes where the key is the local name,
127 | * and the value is the original name
128 | *
129 | * @return array
130 | */
131 | public static function attributeMap()
132 | {
133 | return self::$attributeMap;
134 | }
135 |
136 | /**
137 | * Array of attributes to setter functions (for deserialization of responses)
138 | *
139 | * @return array
140 | */
141 | public static function setters()
142 | {
143 | return self::$setters;
144 | }
145 |
146 | /**
147 | * Array of attributes to getter functions (for serialization of requests)
148 | *
149 | * @return array
150 | */
151 | public static function getters()
152 | {
153 | return self::$getters;
154 | }
155 |
156 | /**
157 | * The original name of the model.
158 | *
159 | * @return string
160 | */
161 | public function getModelName()
162 | {
163 | return self::$swaggerModelName;
164 | }
165 |
166 |
167 |
168 |
169 |
170 | /**
171 | * Associative array for storing property values
172 | *
173 | * @var mixed[]
174 | */
175 | protected $container = [];
176 |
177 | /**
178 | * Constructor
179 | *
180 | * @param mixed[] $data Associated array of property values
181 | * initializing the model
182 | */
183 | public function __construct(array $data = null)
184 | {
185 | $this->container['files'] = isset($data['files']) ? $data['files'] : null;
186 | $this->container['at'] = isset($data['at']) ? $data['at'] : null;
187 | }
188 |
189 | /**
190 | * Show all the invalid properties with reasons.
191 | *
192 | * @return array invalid properties with reasons
193 | */
194 | public function listInvalidProperties()
195 | {
196 | $invalidProperties = [];
197 |
198 | return $invalidProperties;
199 | }
200 |
201 | /**
202 | * Validate all the properties in the model
203 | * return true if all passed
204 | *
205 | * @return bool True if all properties are valid
206 | */
207 | public function valid()
208 | {
209 |
210 | return true;
211 | }
212 |
213 |
214 | /**
215 | * Gets files
216 | *
217 | * @return \faxplus\model\OutboxFiles[]
218 | */
219 | public function getFiles()
220 | {
221 | return $this->container['files'];
222 | }
223 |
224 | /**
225 | * Sets files
226 | *
227 | * @param \faxplus\model\OutboxFiles[] $files files
228 | *
229 | * @return $this
230 | */
231 | public function setFiles($files)
232 | {
233 | $this->container['files'] = $files;
234 |
235 | return $this;
236 | }
237 |
238 | /**
239 | * Gets at
240 | *
241 | * @return string
242 | */
243 | public function getAt()
244 | {
245 | return $this->container['at'];
246 | }
247 |
248 | /**
249 | * Sets at
250 | *
251 | * @param string $at at
252 | *
253 | * @return $this
254 | */
255 | public function setAt($at)
256 | {
257 | $this->container['at'] = $at;
258 |
259 | return $this;
260 | }
261 | /**
262 | * Returns true if offset exists. False otherwise.
263 | *
264 | * @param integer $offset Offset
265 | *
266 | * @return boolean
267 | */
268 | public function offsetExists($offset)
269 | {
270 | return isset($this->container[$offset]);
271 | }
272 |
273 | /**
274 | * Gets offset.
275 | *
276 | * @param integer $offset Offset
277 | *
278 | * @return mixed
279 | */
280 | public function offsetGet($offset)
281 | {
282 | return isset($this->container[$offset]) ? $this->container[$offset] : null;
283 | }
284 |
285 | /**
286 | * Sets value based on offset.
287 | *
288 | * @param integer $offset Offset
289 | * @param mixed $value Value to be set
290 | *
291 | * @return void
292 | */
293 | public function offsetSet($offset, $value)
294 | {
295 | if (is_null($offset)) {
296 | $this->container[] = $value;
297 | } else {
298 | $this->container[$offset] = $value;
299 | }
300 | }
301 |
302 | /**
303 | * Unsets offset.
304 | *
305 | * @param integer $offset Offset
306 | *
307 | * @return void
308 | */
309 | public function offsetUnset($offset)
310 | {
311 | unset($this->container[$offset]);
312 | }
313 |
314 | /**
315 | * Gets the string presentation of the object
316 | *
317 | * @return string
318 | */
319 | public function __toString()
320 | {
321 | if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
322 | return json_encode(
323 | ObjectSerializer::sanitizeForSerialization($this),
324 | JSON_PRETTY_PRINT
325 | );
326 | }
327 |
328 | return json_encode(ObjectSerializer::sanitizeForSerialization($this));
329 | }
330 | }
331 |
332 |
333 |
--------------------------------------------------------------------------------
/lib/model/MemberDetail.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | use \ArrayAccess;
33 | use \faxplus\ObjectSerializer;
34 |
35 | /**
36 | * MemberDetail Class Doc Comment
37 | *
38 | * @category Class
39 | * @package faxplus
40 | * @author Swagger Codegen team
41 | * @link https://github.com/swagger-api/swagger-codegen
42 | */
43 | class MemberDetail implements ModelInterface, ArrayAccess
44 | {
45 | const DISCRIMINATOR = null;
46 |
47 | /**
48 | * The original name of the model.
49 | *
50 | * @var string
51 | */
52 | protected static $swaggerModelName = 'MemberDetail';
53 |
54 | /**
55 | * Array of property to type mappings. Used for (de)serialization
56 | *
57 | * @var string[]
58 | */
59 | protected static $swaggerTypes = [
60 | 'quota' => 'int',
61 | 'role' => 'string'
62 | ];
63 |
64 | /**
65 | * Array of property to format mappings. Used for (de)serialization
66 | *
67 | * @var string[]
68 | */
69 | protected static $swaggerFormats = [
70 | 'quota' => null,
71 | 'role' => null
72 | ];
73 |
74 | /**
75 | * Array of property to type mappings. Used for (de)serialization
76 | *
77 | * @return array
78 | */
79 | public static function swaggerTypes()
80 | {
81 | return self::$swaggerTypes;
82 | }
83 |
84 | /**
85 | * Array of property to format mappings. Used for (de)serialization
86 | *
87 | * @return array
88 | */
89 | public static function swaggerFormats()
90 | {
91 | return self::$swaggerFormats;
92 | }
93 |
94 | /**
95 | * Array of attributes where the key is the local name,
96 | * and the value is the original name
97 | *
98 | * @var string[]
99 | */
100 | protected static $attributeMap = [
101 | 'quota' => 'quota',
102 | 'role' => 'role'
103 | ];
104 |
105 | /**
106 | * Array of attributes to setter functions (for deserialization of responses)
107 | *
108 | * @var string[]
109 | */
110 | protected static $setters = [
111 | 'quota' => 'setQuota',
112 | 'role' => 'setRole'
113 | ];
114 |
115 | /**
116 | * Array of attributes to getter functions (for serialization of requests)
117 | *
118 | * @var string[]
119 | */
120 | protected static $getters = [
121 | 'quota' => 'getQuota',
122 | 'role' => 'getRole'
123 | ];
124 |
125 | /**
126 | * Array of attributes where the key is the local name,
127 | * and the value is the original name
128 | *
129 | * @return array
130 | */
131 | public static function attributeMap()
132 | {
133 | return self::$attributeMap;
134 | }
135 |
136 | /**
137 | * Array of attributes to setter functions (for deserialization of responses)
138 | *
139 | * @return array
140 | */
141 | public static function setters()
142 | {
143 | return self::$setters;
144 | }
145 |
146 | /**
147 | * Array of attributes to getter functions (for serialization of requests)
148 | *
149 | * @return array
150 | */
151 | public static function getters()
152 | {
153 | return self::$getters;
154 | }
155 |
156 | /**
157 | * The original name of the model.
158 | *
159 | * @return string
160 | */
161 | public function getModelName()
162 | {
163 | return self::$swaggerModelName;
164 | }
165 |
166 |
167 |
168 |
169 |
170 | /**
171 | * Associative array for storing property values
172 | *
173 | * @var mixed[]
174 | */
175 | protected $container = [];
176 |
177 | /**
178 | * Constructor
179 | *
180 | * @param mixed[] $data Associated array of property values
181 | * initializing the model
182 | */
183 | public function __construct(array $data = null)
184 | {
185 | $this->container['quota'] = isset($data['quota']) ? $data['quota'] : null;
186 | $this->container['role'] = isset($data['role']) ? $data['role'] : null;
187 | }
188 |
189 | /**
190 | * Show all the invalid properties with reasons.
191 | *
192 | * @return array invalid properties with reasons
193 | */
194 | public function listInvalidProperties()
195 | {
196 | $invalidProperties = [];
197 |
198 | return $invalidProperties;
199 | }
200 |
201 | /**
202 | * Validate all the properties in the model
203 | * return true if all passed
204 | *
205 | * @return bool True if all properties are valid
206 | */
207 | public function valid()
208 | {
209 |
210 | return true;
211 | }
212 |
213 |
214 | /**
215 | * Gets quota
216 | *
217 | * @return int
218 | */
219 | public function getQuota()
220 | {
221 | return $this->container['quota'];
222 | }
223 |
224 | /**
225 | * Sets quota
226 | *
227 | * @param int $quota quota of member (number of pages member can send per month)
228 | *
229 | * @return $this
230 | */
231 | public function setQuota($quota)
232 | {
233 | $this->container['quota'] = $quota;
234 |
235 | return $this;
236 | }
237 |
238 | /**
239 | * Gets role
240 | *
241 | * @return string
242 | */
243 | public function getRole()
244 | {
245 | return $this->container['role'];
246 | }
247 |
248 | /**
249 | * Sets role
250 | *
251 | * @param string $role Role of member in your company
252 | *
253 | * @return $this
254 | */
255 | public function setRole($role)
256 | {
257 | $this->container['role'] = $role;
258 |
259 | return $this;
260 | }
261 | /**
262 | * Returns true if offset exists. False otherwise.
263 | *
264 | * @param integer $offset Offset
265 | *
266 | * @return boolean
267 | */
268 | public function offsetExists($offset)
269 | {
270 | return isset($this->container[$offset]);
271 | }
272 |
273 | /**
274 | * Gets offset.
275 | *
276 | * @param integer $offset Offset
277 | *
278 | * @return mixed
279 | */
280 | public function offsetGet($offset)
281 | {
282 | return isset($this->container[$offset]) ? $this->container[$offset] : null;
283 | }
284 |
285 | /**
286 | * Sets value based on offset.
287 | *
288 | * @param integer $offset Offset
289 | * @param mixed $value Value to be set
290 | *
291 | * @return void
292 | */
293 | public function offsetSet($offset, $value)
294 | {
295 | if (is_null($offset)) {
296 | $this->container[] = $value;
297 | } else {
298 | $this->container[$offset] = $value;
299 | }
300 | }
301 |
302 | /**
303 | * Unsets offset.
304 | *
305 | * @param integer $offset Offset
306 | *
307 | * @return void
308 | */
309 | public function offsetUnset($offset)
310 | {
311 | unset($this->container[$offset]);
312 | }
313 |
314 | /**
315 | * Gets the string presentation of the object
316 | *
317 | * @return string
318 | */
319 | public function __toString()
320 | {
321 | if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
322 | return json_encode(
323 | ObjectSerializer::sanitizeForSerialization($this),
324 | JSON_PRETTY_PRINT
325 | );
326 | }
327 |
328 | return json_encode(ObjectSerializer::sanitizeForSerialization($this));
329 | }
330 | }
331 |
332 |
333 |
--------------------------------------------------------------------------------
/lib/model/PayloadOutboxOptionsRetry.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | use \ArrayAccess;
33 | use \faxplus\ObjectSerializer;
34 |
35 | /**
36 | * PayloadOutboxOptionsRetry Class Doc Comment
37 | *
38 | * @category Class
39 | * @package faxplus
40 | * @author Swagger Codegen team
41 | * @link https://github.com/swagger-api/swagger-codegen
42 | */
43 | class PayloadOutboxOptionsRetry implements ModelInterface, ArrayAccess
44 | {
45 | const DISCRIMINATOR = null;
46 |
47 | /**
48 | * The original name of the model.
49 | *
50 | * @var string
51 | */
52 | protected static $swaggerModelName = 'payload_Outbox_options_retry';
53 |
54 | /**
55 | * Array of property to type mappings. Used for (de)serialization
56 | *
57 | * @var string[]
58 | */
59 | protected static $swaggerTypes = [
60 | 'delay' => 'int',
61 | 'count' => 'int'
62 | ];
63 |
64 | /**
65 | * Array of property to format mappings. Used for (de)serialization
66 | *
67 | * @var string[]
68 | */
69 | protected static $swaggerFormats = [
70 | 'delay' => null,
71 | 'count' => null
72 | ];
73 |
74 | /**
75 | * Array of property to type mappings. Used for (de)serialization
76 | *
77 | * @return array
78 | */
79 | public static function swaggerTypes()
80 | {
81 | return self::$swaggerTypes;
82 | }
83 |
84 | /**
85 | * Array of property to format mappings. Used for (de)serialization
86 | *
87 | * @return array
88 | */
89 | public static function swaggerFormats()
90 | {
91 | return self::$swaggerFormats;
92 | }
93 |
94 | /**
95 | * Array of attributes where the key is the local name,
96 | * and the value is the original name
97 | *
98 | * @var string[]
99 | */
100 | protected static $attributeMap = [
101 | 'delay' => 'delay',
102 | 'count' => 'count'
103 | ];
104 |
105 | /**
106 | * Array of attributes to setter functions (for deserialization of responses)
107 | *
108 | * @var string[]
109 | */
110 | protected static $setters = [
111 | 'delay' => 'setDelay',
112 | 'count' => 'setCount'
113 | ];
114 |
115 | /**
116 | * Array of attributes to getter functions (for serialization of requests)
117 | *
118 | * @var string[]
119 | */
120 | protected static $getters = [
121 | 'delay' => 'getDelay',
122 | 'count' => 'getCount'
123 | ];
124 |
125 | /**
126 | * Array of attributes where the key is the local name,
127 | * and the value is the original name
128 | *
129 | * @return array
130 | */
131 | public static function attributeMap()
132 | {
133 | return self::$attributeMap;
134 | }
135 |
136 | /**
137 | * Array of attributes to setter functions (for deserialization of responses)
138 | *
139 | * @return array
140 | */
141 | public static function setters()
142 | {
143 | return self::$setters;
144 | }
145 |
146 | /**
147 | * Array of attributes to getter functions (for serialization of requests)
148 | *
149 | * @return array
150 | */
151 | public static function getters()
152 | {
153 | return self::$getters;
154 | }
155 |
156 | /**
157 | * The original name of the model.
158 | *
159 | * @return string
160 | */
161 | public function getModelName()
162 | {
163 | return self::$swaggerModelName;
164 | }
165 |
166 |
167 |
168 |
169 |
170 | /**
171 | * Associative array for storing property values
172 | *
173 | * @var mixed[]
174 | */
175 | protected $container = [];
176 |
177 | /**
178 | * Constructor
179 | *
180 | * @param mixed[] $data Associated array of property values
181 | * initializing the model
182 | */
183 | public function __construct(array $data = null)
184 | {
185 | $this->container['delay'] = isset($data['delay']) ? $data['delay'] : null;
186 | $this->container['count'] = isset($data['count']) ? $data['count'] : null;
187 | }
188 |
189 | /**
190 | * Show all the invalid properties with reasons.
191 | *
192 | * @return array invalid properties with reasons
193 | */
194 | public function listInvalidProperties()
195 | {
196 | $invalidProperties = [];
197 |
198 | return $invalidProperties;
199 | }
200 |
201 | /**
202 | * Validate all the properties in the model
203 | * return true if all passed
204 | *
205 | * @return bool True if all properties are valid
206 | */
207 | public function valid()
208 | {
209 |
210 | return true;
211 | }
212 |
213 |
214 | /**
215 | * Gets delay
216 | *
217 | * @return int
218 | */
219 | public function getDelay()
220 | {
221 | return $this->container['delay'];
222 | }
223 |
224 | /**
225 | * Sets delay
226 | *
227 | * @param int $delay delay
228 | *
229 | * @return $this
230 | */
231 | public function setDelay($delay)
232 | {
233 | $this->container['delay'] = $delay;
234 |
235 | return $this;
236 | }
237 |
238 | /**
239 | * Gets count
240 | *
241 | * @return int
242 | */
243 | public function getCount()
244 | {
245 | return $this->container['count'];
246 | }
247 |
248 | /**
249 | * Sets count
250 | *
251 | * @param int $count count
252 | *
253 | * @return $this
254 | */
255 | public function setCount($count)
256 | {
257 | $this->container['count'] = $count;
258 |
259 | return $this;
260 | }
261 | /**
262 | * Returns true if offset exists. False otherwise.
263 | *
264 | * @param integer $offset Offset
265 | *
266 | * @return boolean
267 | */
268 | public function offsetExists($offset)
269 | {
270 | return isset($this->container[$offset]);
271 | }
272 |
273 | /**
274 | * Gets offset.
275 | *
276 | * @param integer $offset Offset
277 | *
278 | * @return mixed
279 | */
280 | public function offsetGet($offset)
281 | {
282 | return isset($this->container[$offset]) ? $this->container[$offset] : null;
283 | }
284 |
285 | /**
286 | * Sets value based on offset.
287 | *
288 | * @param integer $offset Offset
289 | * @param mixed $value Value to be set
290 | *
291 | * @return void
292 | */
293 | public function offsetSet($offset, $value)
294 | {
295 | if (is_null($offset)) {
296 | $this->container[] = $value;
297 | } else {
298 | $this->container[$offset] = $value;
299 | }
300 | }
301 |
302 | /**
303 | * Unsets offset.
304 | *
305 | * @param integer $offset Offset
306 | *
307 | * @return void
308 | */
309 | public function offsetUnset($offset)
310 | {
311 | unset($this->container[$offset]);
312 | }
313 |
314 | /**
315 | * Gets the string presentation of the object
316 | *
317 | * @return string
318 | */
319 | public function __toString()
320 | {
321 | if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
322 | return json_encode(
323 | ObjectSerializer::sanitizeForSerialization($this),
324 | JSON_PRETTY_PRINT
325 | );
326 | }
327 |
328 | return json_encode(ObjectSerializer::sanitizeForSerialization($this));
329 | }
330 | }
331 |
332 |
333 |
--------------------------------------------------------------------------------
/lib/model/OutboxInitiatedFrom.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | use \ArrayAccess;
33 | use \faxplus\ObjectSerializer;
34 |
35 | /**
36 | * OutboxInitiatedFrom Class Doc Comment
37 | *
38 | * @category Class
39 | * @package faxplus
40 | * @author Swagger Codegen team
41 | * @link https://github.com/swagger-api/swagger-codegen
42 | */
43 | class OutboxInitiatedFrom implements ModelInterface, ArrayAccess
44 | {
45 | const DISCRIMINATOR = null;
46 |
47 | /**
48 | * The original name of the model.
49 | *
50 | * @var string
51 | */
52 | protected static $swaggerModelName = 'Outbox_initiated_from';
53 |
54 | /**
55 | * Array of property to type mappings. Used for (de)serialization
56 | *
57 | * @var string[]
58 | */
59 | protected static $swaggerTypes = [
60 | 'type' => 'string',
61 | 'from_id' => 'string'
62 | ];
63 |
64 | /**
65 | * Array of property to format mappings. Used for (de)serialization
66 | *
67 | * @var string[]
68 | */
69 | protected static $swaggerFormats = [
70 | 'type' => null,
71 | 'from_id' => null
72 | ];
73 |
74 | /**
75 | * Array of property to type mappings. Used for (de)serialization
76 | *
77 | * @return array
78 | */
79 | public static function swaggerTypes()
80 | {
81 | return self::$swaggerTypes;
82 | }
83 |
84 | /**
85 | * Array of property to format mappings. Used for (de)serialization
86 | *
87 | * @return array
88 | */
89 | public static function swaggerFormats()
90 | {
91 | return self::$swaggerFormats;
92 | }
93 |
94 | /**
95 | * Array of attributes where the key is the local name,
96 | * and the value is the original name
97 | *
98 | * @var string[]
99 | */
100 | protected static $attributeMap = [
101 | 'type' => 'type',
102 | 'from_id' => 'from_id'
103 | ];
104 |
105 | /**
106 | * Array of attributes to setter functions (for deserialization of responses)
107 | *
108 | * @var string[]
109 | */
110 | protected static $setters = [
111 | 'type' => 'setType',
112 | 'from_id' => 'setFromId'
113 | ];
114 |
115 | /**
116 | * Array of attributes to getter functions (for serialization of requests)
117 | *
118 | * @var string[]
119 | */
120 | protected static $getters = [
121 | 'type' => 'getType',
122 | 'from_id' => 'getFromId'
123 | ];
124 |
125 | /**
126 | * Array of attributes where the key is the local name,
127 | * and the value is the original name
128 | *
129 | * @return array
130 | */
131 | public static function attributeMap()
132 | {
133 | return self::$attributeMap;
134 | }
135 |
136 | /**
137 | * Array of attributes to setter functions (for deserialization of responses)
138 | *
139 | * @return array
140 | */
141 | public static function setters()
142 | {
143 | return self::$setters;
144 | }
145 |
146 | /**
147 | * Array of attributes to getter functions (for serialization of requests)
148 | *
149 | * @return array
150 | */
151 | public static function getters()
152 | {
153 | return self::$getters;
154 | }
155 |
156 | /**
157 | * The original name of the model.
158 | *
159 | * @return string
160 | */
161 | public function getModelName()
162 | {
163 | return self::$swaggerModelName;
164 | }
165 |
166 |
167 |
168 |
169 |
170 | /**
171 | * Associative array for storing property values
172 | *
173 | * @var mixed[]
174 | */
175 | protected $container = [];
176 |
177 | /**
178 | * Constructor
179 | *
180 | * @param mixed[] $data Associated array of property values
181 | * initializing the model
182 | */
183 | public function __construct(array $data = null)
184 | {
185 | $this->container['type'] = isset($data['type']) ? $data['type'] : null;
186 | $this->container['from_id'] = isset($data['from_id']) ? $data['from_id'] : null;
187 | }
188 |
189 | /**
190 | * Show all the invalid properties with reasons.
191 | *
192 | * @return array invalid properties with reasons
193 | */
194 | public function listInvalidProperties()
195 | {
196 | $invalidProperties = [];
197 |
198 | return $invalidProperties;
199 | }
200 |
201 | /**
202 | * Validate all the properties in the model
203 | * return true if all passed
204 | *
205 | * @return bool True if all properties are valid
206 | */
207 | public function valid()
208 | {
209 |
210 | return true;
211 | }
212 |
213 |
214 | /**
215 | * Gets type
216 | *
217 | * @return string
218 | */
219 | public function getType()
220 | {
221 | return $this->container['type'];
222 | }
223 |
224 | /**
225 | * Sets type
226 | *
227 | * @param string $type type
228 | *
229 | * @return $this
230 | */
231 | public function setType($type)
232 | {
233 | $this->container['type'] = $type;
234 |
235 | return $this;
236 | }
237 |
238 | /**
239 | * Gets from_id
240 | *
241 | * @return string
242 | */
243 | public function getFromId()
244 | {
245 | return $this->container['from_id'];
246 | }
247 |
248 | /**
249 | * Sets from_id
250 | *
251 | * @param string $from_id from_id
252 | *
253 | * @return $this
254 | */
255 | public function setFromId($from_id)
256 | {
257 | $this->container['from_id'] = $from_id;
258 |
259 | return $this;
260 | }
261 | /**
262 | * Returns true if offset exists. False otherwise.
263 | *
264 | * @param integer $offset Offset
265 | *
266 | * @return boolean
267 | */
268 | public function offsetExists($offset)
269 | {
270 | return isset($this->container[$offset]);
271 | }
272 |
273 | /**
274 | * Gets offset.
275 | *
276 | * @param integer $offset Offset
277 | *
278 | * @return mixed
279 | */
280 | public function offsetGet($offset)
281 | {
282 | return isset($this->container[$offset]) ? $this->container[$offset] : null;
283 | }
284 |
285 | /**
286 | * Sets value based on offset.
287 | *
288 | * @param integer $offset Offset
289 | * @param mixed $value Value to be set
290 | *
291 | * @return void
292 | */
293 | public function offsetSet($offset, $value)
294 | {
295 | if (is_null($offset)) {
296 | $this->container[] = $value;
297 | } else {
298 | $this->container[$offset] = $value;
299 | }
300 | }
301 |
302 | /**
303 | * Unsets offset.
304 | *
305 | * @param integer $offset Offset
306 | *
307 | * @return void
308 | */
309 | public function offsetUnset($offset)
310 | {
311 | unset($this->container[$offset]);
312 | }
313 |
314 | /**
315 | * Gets the string presentation of the object
316 | *
317 | * @return string
318 | */
319 | public function __toString()
320 | {
321 | if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
322 | return json_encode(
323 | ObjectSerializer::sanitizeForSerialization($this),
324 | JSON_PRETTY_PRINT
325 | );
326 | }
327 |
328 | return json_encode(ObjectSerializer::sanitizeForSerialization($this));
329 | }
330 | }
331 |
332 |
333 |
--------------------------------------------------------------------------------
/lib/model/AccountSettingsSendFaxRetry.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | use \ArrayAccess;
33 | use \faxplus\ObjectSerializer;
34 |
35 | /**
36 | * AccountSettingsSendFaxRetry Class Doc Comment
37 | *
38 | * @category Class
39 | * @package faxplus
40 | * @author Swagger Codegen team
41 | * @link https://github.com/swagger-api/swagger-codegen
42 | */
43 | class AccountSettingsSendFaxRetry implements ModelInterface, ArrayAccess
44 | {
45 | const DISCRIMINATOR = null;
46 |
47 | /**
48 | * The original name of the model.
49 | *
50 | * @var string
51 | */
52 | protected static $swaggerModelName = 'Account_settings_send_fax_retry';
53 |
54 | /**
55 | * Array of property to type mappings. Used for (de)serialization
56 | *
57 | * @var string[]
58 | */
59 | protected static $swaggerTypes = [
60 | 'count' => 'int',
61 | 'delay' => 'int'
62 | ];
63 |
64 | /**
65 | * Array of property to format mappings. Used for (de)serialization
66 | *
67 | * @var string[]
68 | */
69 | protected static $swaggerFormats = [
70 | 'count' => null,
71 | 'delay' => null
72 | ];
73 |
74 | /**
75 | * Array of property to type mappings. Used for (de)serialization
76 | *
77 | * @return array
78 | */
79 | public static function swaggerTypes()
80 | {
81 | return self::$swaggerTypes;
82 | }
83 |
84 | /**
85 | * Array of property to format mappings. Used for (de)serialization
86 | *
87 | * @return array
88 | */
89 | public static function swaggerFormats()
90 | {
91 | return self::$swaggerFormats;
92 | }
93 |
94 | /**
95 | * Array of attributes where the key is the local name,
96 | * and the value is the original name
97 | *
98 | * @var string[]
99 | */
100 | protected static $attributeMap = [
101 | 'count' => 'count',
102 | 'delay' => 'delay'
103 | ];
104 |
105 | /**
106 | * Array of attributes to setter functions (for deserialization of responses)
107 | *
108 | * @var string[]
109 | */
110 | protected static $setters = [
111 | 'count' => 'setCount',
112 | 'delay' => 'setDelay'
113 | ];
114 |
115 | /**
116 | * Array of attributes to getter functions (for serialization of requests)
117 | *
118 | * @var string[]
119 | */
120 | protected static $getters = [
121 | 'count' => 'getCount',
122 | 'delay' => 'getDelay'
123 | ];
124 |
125 | /**
126 | * Array of attributes where the key is the local name,
127 | * and the value is the original name
128 | *
129 | * @return array
130 | */
131 | public static function attributeMap()
132 | {
133 | return self::$attributeMap;
134 | }
135 |
136 | /**
137 | * Array of attributes to setter functions (for deserialization of responses)
138 | *
139 | * @return array
140 | */
141 | public static function setters()
142 | {
143 | return self::$setters;
144 | }
145 |
146 | /**
147 | * Array of attributes to getter functions (for serialization of requests)
148 | *
149 | * @return array
150 | */
151 | public static function getters()
152 | {
153 | return self::$getters;
154 | }
155 |
156 | /**
157 | * The original name of the model.
158 | *
159 | * @return string
160 | */
161 | public function getModelName()
162 | {
163 | return self::$swaggerModelName;
164 | }
165 |
166 |
167 |
168 |
169 |
170 | /**
171 | * Associative array for storing property values
172 | *
173 | * @var mixed[]
174 | */
175 | protected $container = [];
176 |
177 | /**
178 | * Constructor
179 | *
180 | * @param mixed[] $data Associated array of property values
181 | * initializing the model
182 | */
183 | public function __construct(array $data = null)
184 | {
185 | $this->container['count'] = isset($data['count']) ? $data['count'] : null;
186 | $this->container['delay'] = isset($data['delay']) ? $data['delay'] : null;
187 | }
188 |
189 | /**
190 | * Show all the invalid properties with reasons.
191 | *
192 | * @return array invalid properties with reasons
193 | */
194 | public function listInvalidProperties()
195 | {
196 | $invalidProperties = [];
197 |
198 | return $invalidProperties;
199 | }
200 |
201 | /**
202 | * Validate all the properties in the model
203 | * return true if all passed
204 | *
205 | * @return bool True if all properties are valid
206 | */
207 | public function valid()
208 | {
209 |
210 | return true;
211 | }
212 |
213 |
214 | /**
215 | * Gets count
216 | *
217 | * @return int
218 | */
219 | public function getCount()
220 | {
221 | return $this->container['count'];
222 | }
223 |
224 | /**
225 | * Sets count
226 | *
227 | * @param int $count count
228 | *
229 | * @return $this
230 | */
231 | public function setCount($count)
232 | {
233 | $this->container['count'] = $count;
234 |
235 | return $this;
236 | }
237 |
238 | /**
239 | * Gets delay
240 | *
241 | * @return int
242 | */
243 | public function getDelay()
244 | {
245 | return $this->container['delay'];
246 | }
247 |
248 | /**
249 | * Sets delay
250 | *
251 | * @param int $delay delay
252 | *
253 | * @return $this
254 | */
255 | public function setDelay($delay)
256 | {
257 | $this->container['delay'] = $delay;
258 |
259 | return $this;
260 | }
261 | /**
262 | * Returns true if offset exists. False otherwise.
263 | *
264 | * @param integer $offset Offset
265 | *
266 | * @return boolean
267 | */
268 | public function offsetExists($offset)
269 | {
270 | return isset($this->container[$offset]);
271 | }
272 |
273 | /**
274 | * Gets offset.
275 | *
276 | * @param integer $offset Offset
277 | *
278 | * @return mixed
279 | */
280 | public function offsetGet($offset)
281 | {
282 | return isset($this->container[$offset]) ? $this->container[$offset] : null;
283 | }
284 |
285 | /**
286 | * Sets value based on offset.
287 | *
288 | * @param integer $offset Offset
289 | * @param mixed $value Value to be set
290 | *
291 | * @return void
292 | */
293 | public function offsetSet($offset, $value)
294 | {
295 | if (is_null($offset)) {
296 | $this->container[] = $value;
297 | } else {
298 | $this->container[$offset] = $value;
299 | }
300 | }
301 |
302 | /**
303 | * Unsets offset.
304 | *
305 | * @param integer $offset Offset
306 | *
307 | * @return void
308 | */
309 | public function offsetUnset($offset)
310 | {
311 | unset($this->container[$offset]);
312 | }
313 |
314 | /**
315 | * Gets the string presentation of the object
316 | *
317 | * @return string
318 | */
319 | public function __toString()
320 | {
321 | if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
322 | return json_encode(
323 | ObjectSerializer::sanitizeForSerialization($this),
324 | JSON_PRETTY_PRINT
325 | );
326 | }
327 |
328 | return json_encode(ObjectSerializer::sanitizeForSerialization($this));
329 | }
330 | }
331 |
332 |
333 |
--------------------------------------------------------------------------------
/lib/model/Error.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | use \ArrayAccess;
33 | use \faxplus\ObjectSerializer;
34 |
35 | /**
36 | * Error Class Doc Comment
37 | *
38 | * @category Class
39 | * @package faxplus
40 | * @author Swagger Codegen team
41 | * @link https://github.com/swagger-api/swagger-codegen
42 | */
43 | class Error implements ModelInterface, ArrayAccess
44 | {
45 | const DISCRIMINATOR = null;
46 |
47 | /**
48 | * The original name of the model.
49 | *
50 | * @var string
51 | */
52 | protected static $swaggerModelName = 'Error';
53 |
54 | /**
55 | * Array of property to type mappings. Used for (de)serialization
56 | *
57 | * @var string[]
58 | */
59 | protected static $swaggerTypes = [
60 | 'error' => 'string',
61 | 'description' => 'string'
62 | ];
63 |
64 | /**
65 | * Array of property to format mappings. Used for (de)serialization
66 | *
67 | * @var string[]
68 | */
69 | protected static $swaggerFormats = [
70 | 'error' => null,
71 | 'description' => null
72 | ];
73 |
74 | /**
75 | * Array of property to type mappings. Used for (de)serialization
76 | *
77 | * @return array
78 | */
79 | public static function swaggerTypes()
80 | {
81 | return self::$swaggerTypes;
82 | }
83 |
84 | /**
85 | * Array of property to format mappings. Used for (de)serialization
86 | *
87 | * @return array
88 | */
89 | public static function swaggerFormats()
90 | {
91 | return self::$swaggerFormats;
92 | }
93 |
94 | /**
95 | * Array of attributes where the key is the local name,
96 | * and the value is the original name
97 | *
98 | * @var string[]
99 | */
100 | protected static $attributeMap = [
101 | 'error' => 'error',
102 | 'description' => 'description'
103 | ];
104 |
105 | /**
106 | * Array of attributes to setter functions (for deserialization of responses)
107 | *
108 | * @var string[]
109 | */
110 | protected static $setters = [
111 | 'error' => 'setError',
112 | 'description' => 'setDescription'
113 | ];
114 |
115 | /**
116 | * Array of attributes to getter functions (for serialization of requests)
117 | *
118 | * @var string[]
119 | */
120 | protected static $getters = [
121 | 'error' => 'getError',
122 | 'description' => 'getDescription'
123 | ];
124 |
125 | /**
126 | * Array of attributes where the key is the local name,
127 | * and the value is the original name
128 | *
129 | * @return array
130 | */
131 | public static function attributeMap()
132 | {
133 | return self::$attributeMap;
134 | }
135 |
136 | /**
137 | * Array of attributes to setter functions (for deserialization of responses)
138 | *
139 | * @return array
140 | */
141 | public static function setters()
142 | {
143 | return self::$setters;
144 | }
145 |
146 | /**
147 | * Array of attributes to getter functions (for serialization of requests)
148 | *
149 | * @return array
150 | */
151 | public static function getters()
152 | {
153 | return self::$getters;
154 | }
155 |
156 | /**
157 | * The original name of the model.
158 | *
159 | * @return string
160 | */
161 | public function getModelName()
162 | {
163 | return self::$swaggerModelName;
164 | }
165 |
166 |
167 |
168 |
169 |
170 | /**
171 | * Associative array for storing property values
172 | *
173 | * @var mixed[]
174 | */
175 | protected $container = [];
176 |
177 | /**
178 | * Constructor
179 | *
180 | * @param mixed[] $data Associated array of property values
181 | * initializing the model
182 | */
183 | public function __construct(array $data = null)
184 | {
185 | $this->container['error'] = isset($data['error']) ? $data['error'] : null;
186 | $this->container['description'] = isset($data['description']) ? $data['description'] : null;
187 | }
188 |
189 | /**
190 | * Show all the invalid properties with reasons.
191 | *
192 | * @return array invalid properties with reasons
193 | */
194 | public function listInvalidProperties()
195 | {
196 | $invalidProperties = [];
197 |
198 | return $invalidProperties;
199 | }
200 |
201 | /**
202 | * Validate all the properties in the model
203 | * return true if all passed
204 | *
205 | * @return bool True if all properties are valid
206 | */
207 | public function valid()
208 | {
209 |
210 | return true;
211 | }
212 |
213 |
214 | /**
215 | * Gets error
216 | *
217 | * @return string
218 | */
219 | public function getError()
220 | {
221 | return $this->container['error'];
222 | }
223 |
224 | /**
225 | * Sets error
226 | *
227 | * @param string $error error
228 | *
229 | * @return $this
230 | */
231 | public function setError($error)
232 | {
233 | $this->container['error'] = $error;
234 |
235 | return $this;
236 | }
237 |
238 | /**
239 | * Gets description
240 | *
241 | * @return string
242 | */
243 | public function getDescription()
244 | {
245 | return $this->container['description'];
246 | }
247 |
248 | /**
249 | * Sets description
250 | *
251 | * @param string $description description
252 | *
253 | * @return $this
254 | */
255 | public function setDescription($description)
256 | {
257 | $this->container['description'] = $description;
258 |
259 | return $this;
260 | }
261 | /**
262 | * Returns true if offset exists. False otherwise.
263 | *
264 | * @param integer $offset Offset
265 | *
266 | * @return boolean
267 | */
268 | public function offsetExists($offset)
269 | {
270 | return isset($this->container[$offset]);
271 | }
272 |
273 | /**
274 | * Gets offset.
275 | *
276 | * @param integer $offset Offset
277 | *
278 | * @return mixed
279 | */
280 | public function offsetGet($offset)
281 | {
282 | return isset($this->container[$offset]) ? $this->container[$offset] : null;
283 | }
284 |
285 | /**
286 | * Sets value based on offset.
287 | *
288 | * @param integer $offset Offset
289 | * @param mixed $value Value to be set
290 | *
291 | * @return void
292 | */
293 | public function offsetSet($offset, $value)
294 | {
295 | if (is_null($offset)) {
296 | $this->container[] = $value;
297 | } else {
298 | $this->container[$offset] = $value;
299 | }
300 | }
301 |
302 | /**
303 | * Unsets offset.
304 | *
305 | * @param integer $offset Offset
306 | *
307 | * @return void
308 | */
309 | public function offsetUnset($offset)
310 | {
311 | unset($this->container[$offset]);
312 | }
313 |
314 | /**
315 | * Gets the string presentation of the object
316 | *
317 | * @return string
318 | */
319 | public function __toString()
320 | {
321 | if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
322 | return json_encode(
323 | ObjectSerializer::sanitizeForSerialization($this),
324 | JSON_PRETTY_PRINT
325 | );
326 | }
327 |
328 | return json_encode(ObjectSerializer::sanitizeForSerialization($this));
329 | }
330 | }
331 |
332 |
333 |
--------------------------------------------------------------------------------
/lib/model/PayloadFaxModification.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | use \ArrayAccess;
33 | use \faxplus\ObjectSerializer;
34 |
35 | /**
36 | * PayloadFaxModification Class Doc Comment
37 | *
38 | * @category Class
39 | * @description Request object for making changes in a fax object
40 | * @package faxplus
41 | * @author Swagger Codegen team
42 | * @link https://github.com/swagger-api/swagger-codegen
43 | */
44 | class PayloadFaxModification implements ModelInterface, ArrayAccess
45 | {
46 | const DISCRIMINATOR = null;
47 |
48 | /**
49 | * The original name of the model.
50 | *
51 | * @var string
52 | */
53 | protected static $swaggerModelName = 'payload_FaxModification';
54 |
55 | /**
56 | * Array of property to type mappings. Used for (de)serialization
57 | *
58 | * @var string[]
59 | */
60 | protected static $swaggerTypes = [
61 | 'is_read' => 'bool',
62 | 'comment' => 'string'
63 | ];
64 |
65 | /**
66 | * Array of property to format mappings. Used for (de)serialization
67 | *
68 | * @var string[]
69 | */
70 | protected static $swaggerFormats = [
71 | 'is_read' => null,
72 | 'comment' => null
73 | ];
74 |
75 | /**
76 | * Array of property to type mappings. Used for (de)serialization
77 | *
78 | * @return array
79 | */
80 | public static function swaggerTypes()
81 | {
82 | return self::$swaggerTypes;
83 | }
84 |
85 | /**
86 | * Array of property to format mappings. Used for (de)serialization
87 | *
88 | * @return array
89 | */
90 | public static function swaggerFormats()
91 | {
92 | return self::$swaggerFormats;
93 | }
94 |
95 | /**
96 | * Array of attributes where the key is the local name,
97 | * and the value is the original name
98 | *
99 | * @var string[]
100 | */
101 | protected static $attributeMap = [
102 | 'is_read' => 'is_read',
103 | 'comment' => 'comment'
104 | ];
105 |
106 | /**
107 | * Array of attributes to setter functions (for deserialization of responses)
108 | *
109 | * @var string[]
110 | */
111 | protected static $setters = [
112 | 'is_read' => 'setIsRead',
113 | 'comment' => 'setComment'
114 | ];
115 |
116 | /**
117 | * Array of attributes to getter functions (for serialization of requests)
118 | *
119 | * @var string[]
120 | */
121 | protected static $getters = [
122 | 'is_read' => 'getIsRead',
123 | 'comment' => 'getComment'
124 | ];
125 |
126 | /**
127 | * Array of attributes where the key is the local name,
128 | * and the value is the original name
129 | *
130 | * @return array
131 | */
132 | public static function attributeMap()
133 | {
134 | return self::$attributeMap;
135 | }
136 |
137 | /**
138 | * Array of attributes to setter functions (for deserialization of responses)
139 | *
140 | * @return array
141 | */
142 | public static function setters()
143 | {
144 | return self::$setters;
145 | }
146 |
147 | /**
148 | * Array of attributes to getter functions (for serialization of requests)
149 | *
150 | * @return array
151 | */
152 | public static function getters()
153 | {
154 | return self::$getters;
155 | }
156 |
157 | /**
158 | * The original name of the model.
159 | *
160 | * @return string
161 | */
162 | public function getModelName()
163 | {
164 | return self::$swaggerModelName;
165 | }
166 |
167 |
168 |
169 |
170 |
171 | /**
172 | * Associative array for storing property values
173 | *
174 | * @var mixed[]
175 | */
176 | protected $container = [];
177 |
178 | /**
179 | * Constructor
180 | *
181 | * @param mixed[] $data Associated array of property values
182 | * initializing the model
183 | */
184 | public function __construct(array $data = null)
185 | {
186 | $this->container['is_read'] = isset($data['is_read']) ? $data['is_read'] : null;
187 | $this->container['comment'] = isset($data['comment']) ? $data['comment'] : null;
188 | }
189 |
190 | /**
191 | * Show all the invalid properties with reasons.
192 | *
193 | * @return array invalid properties with reasons
194 | */
195 | public function listInvalidProperties()
196 | {
197 | $invalidProperties = [];
198 |
199 | return $invalidProperties;
200 | }
201 |
202 | /**
203 | * Validate all the properties in the model
204 | * return true if all passed
205 | *
206 | * @return bool True if all properties are valid
207 | */
208 | public function valid()
209 | {
210 |
211 | return true;
212 | }
213 |
214 |
215 | /**
216 | * Gets is_read
217 | *
218 | * @return bool
219 | */
220 | public function getIsRead()
221 | {
222 | return $this->container['is_read'];
223 | }
224 |
225 | /**
226 | * Sets is_read
227 | *
228 | * @param bool $is_read is_read
229 | *
230 | * @return $this
231 | */
232 | public function setIsRead($is_read)
233 | {
234 | $this->container['is_read'] = $is_read;
235 |
236 | return $this;
237 | }
238 |
239 | /**
240 | * Gets comment
241 | *
242 | * @return string
243 | */
244 | public function getComment()
245 | {
246 | return $this->container['comment'];
247 | }
248 |
249 | /**
250 | * Sets comment
251 | *
252 | * @param string $comment comment
253 | *
254 | * @return $this
255 | */
256 | public function setComment($comment)
257 | {
258 | $this->container['comment'] = $comment;
259 |
260 | return $this;
261 | }
262 | /**
263 | * Returns true if offset exists. False otherwise.
264 | *
265 | * @param integer $offset Offset
266 | *
267 | * @return boolean
268 | */
269 | public function offsetExists($offset)
270 | {
271 | return isset($this->container[$offset]);
272 | }
273 |
274 | /**
275 | * Gets offset.
276 | *
277 | * @param integer $offset Offset
278 | *
279 | * @return mixed
280 | */
281 | public function offsetGet($offset)
282 | {
283 | return isset($this->container[$offset]) ? $this->container[$offset] : null;
284 | }
285 |
286 | /**
287 | * Sets value based on offset.
288 | *
289 | * @param integer $offset Offset
290 | * @param mixed $value Value to be set
291 | *
292 | * @return void
293 | */
294 | public function offsetSet($offset, $value)
295 | {
296 | if (is_null($offset)) {
297 | $this->container[] = $value;
298 | } else {
299 | $this->container[$offset] = $value;
300 | }
301 | }
302 |
303 | /**
304 | * Unsets offset.
305 | *
306 | * @param integer $offset Offset
307 | *
308 | * @return void
309 | */
310 | public function offsetUnset($offset)
311 | {
312 | unset($this->container[$offset]);
313 | }
314 |
315 | /**
316 | * Gets the string presentation of the object
317 | *
318 | * @return string
319 | */
320 | public function __toString()
321 | {
322 | if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
323 | return json_encode(
324 | ObjectSerializer::sanitizeForSerialization($this),
325 | JSON_PRETTY_PRINT
326 | );
327 | }
328 |
329 | return json_encode(ObjectSerializer::sanitizeForSerialization($this));
330 | }
331 | }
332 |
333 |
334 |
--------------------------------------------------------------------------------
/lib/model/PayloadOutboxOptions.php:
--------------------------------------------------------------------------------
1 |
- This API assumes **_/accounts** as an entry point with the base url of **https://restapi.fax.plus/v1**.
- This API treats all date and times sent to it in requests as **UTC**. Also, all dates and times returned in responses are in **UTC**
- Once you have an access_token, you can easily send a request to the resource server with the base url of **https://restapi.fax.plus/v1** to access your permitted resources. As an example to get the user's profile info you would send a request to **https://restapi.fax.plus/v1/accounts/self** when **Authorization** header is set to \"Bearer YOUR_ACCESS_TOKEN\" and custom header of **x-fax-clientid** is set to YOUR_CLIENT_ID
17 | *
18 | * OpenAPI spec version: 1.1.0
19 | *
20 | * Generated by: https://github.com/swagger-api/swagger-codegen.git
21 | * Swagger Codegen version: 2.4.0-SNAPSHOT
22 | */
23 |
24 | /**
25 | * NOTE: This class is auto generated by the swagger code generator program.
26 | * https://github.com/swagger-api/swagger-codegen
27 | * Do not edit the class manually.
28 | */
29 |
30 | namespace faxplus\model;
31 |
32 | use \ArrayAccess;
33 | use \faxplus\ObjectSerializer;
34 |
35 | /**
36 | * PayloadOutboxOptions Class Doc Comment
37 | *
38 | * @category Class
39 | * @package faxplus
40 | * @author Swagger Codegen team
41 | * @link https://github.com/swagger-api/swagger-codegen
42 | */
43 | class PayloadOutboxOptions implements ModelInterface, ArrayAccess
44 | {
45 | const DISCRIMINATOR = null;
46 |
47 | /**
48 | * The original name of the model.
49 | *
50 | * @var string
51 | */
52 | protected static $swaggerModelName = 'payload_Outbox_options';
53 |
54 | /**
55 | * Array of property to type mappings. Used for (de)serialization
56 | *
57 | * @var string[]
58 | */
59 | protected static $swaggerTypes = [
60 | 'retry' => '\faxplus\model\PayloadOutboxOptionsRetry',
61 | 'enhancement' => 'bool'
62 | ];
63 |
64 | /**
65 | * Array of property to format mappings. Used for (de)serialization
66 | *
67 | * @var string[]
68 | */
69 | protected static $swaggerFormats = [
70 | 'retry' => null,
71 | 'enhancement' => null
72 | ];
73 |
74 | /**
75 | * Array of property to type mappings. Used for (de)serialization
76 | *
77 | * @return array
78 | */
79 | public static function swaggerTypes()
80 | {
81 | return self::$swaggerTypes;
82 | }
83 |
84 | /**
85 | * Array of property to format mappings. Used for (de)serialization
86 | *
87 | * @return array
88 | */
89 | public static function swaggerFormats()
90 | {
91 | return self::$swaggerFormats;
92 | }
93 |
94 | /**
95 | * Array of attributes where the key is the local name,
96 | * and the value is the original name
97 | *
98 | * @var string[]
99 | */
100 | protected static $attributeMap = [
101 | 'retry' => 'retry',
102 | 'enhancement' => 'enhancement'
103 | ];
104 |
105 | /**
106 | * Array of attributes to setter functions (for deserialization of responses)
107 | *
108 | * @var string[]
109 | */
110 | protected static $setters = [
111 | 'retry' => 'setRetry',
112 | 'enhancement' => 'setEnhancement'
113 | ];
114 |
115 | /**
116 | * Array of attributes to getter functions (for serialization of requests)
117 | *
118 | * @var string[]
119 | */
120 | protected static $getters = [
121 | 'retry' => 'getRetry',
122 | 'enhancement' => 'getEnhancement'
123 | ];
124 |
125 | /**
126 | * Array of attributes where the key is the local name,
127 | * and the value is the original name
128 | *
129 | * @return array
130 | */
131 | public static function attributeMap()
132 | {
133 | return self::$attributeMap;
134 | }
135 |
136 | /**
137 | * Array of attributes to setter functions (for deserialization of responses)
138 | *
139 | * @return array
140 | */
141 | public static function setters()
142 | {
143 | return self::$setters;
144 | }
145 |
146 | /**
147 | * Array of attributes to getter functions (for serialization of requests)
148 | *
149 | * @return array
150 | */
151 | public static function getters()
152 | {
153 | return self::$getters;
154 | }
155 |
156 | /**
157 | * The original name of the model.
158 | *
159 | * @return string
160 | */
161 | public function getModelName()
162 | {
163 | return self::$swaggerModelName;
164 | }
165 |
166 |
167 |
168 |
169 |
170 | /**
171 | * Associative array for storing property values
172 | *
173 | * @var mixed[]
174 | */
175 | protected $container = [];
176 |
177 | /**
178 | * Constructor
179 | *
180 | * @param mixed[] $data Associated array of property values
181 | * initializing the model
182 | */
183 | public function __construct(array $data = null)
184 | {
185 | $this->container['retry'] = isset($data['retry']) ? $data['retry'] : null;
186 | $this->container['enhancement'] = isset($data['enhancement']) ? $data['enhancement'] : null;
187 | }
188 |
189 | /**
190 | * Show all the invalid properties with reasons.
191 | *
192 | * @return array invalid properties with reasons
193 | */
194 | public function listInvalidProperties()
195 | {
196 | $invalidProperties = [];
197 |
198 | return $invalidProperties;
199 | }
200 |
201 | /**
202 | * Validate all the properties in the model
203 | * return true if all passed
204 | *
205 | * @return bool True if all properties are valid
206 | */
207 | public function valid()
208 | {
209 |
210 | return true;
211 | }
212 |
213 |
214 | /**
215 | * Gets retry
216 | *
217 | * @return \faxplus\model\PayloadOutboxOptionsRetry
218 | */
219 | public function getRetry()
220 | {
221 | return $this->container['retry'];
222 | }
223 |
224 | /**
225 | * Sets retry
226 | *
227 | * @param \faxplus\model\PayloadOutboxOptionsRetry $retry retry
228 | *
229 | * @return $this
230 | */
231 | public function setRetry($retry)
232 | {
233 | $this->container['retry'] = $retry;
234 |
235 | return $this;
236 | }
237 |
238 | /**
239 | * Gets enhancement
240 | *
241 | * @return bool
242 | */
243 | public function getEnhancement()
244 | {
245 | return $this->container['enhancement'];
246 | }
247 |
248 | /**
249 | * Sets enhancement
250 | *
251 | * @param bool $enhancement enhancement
252 | *
253 | * @return $this
254 | */
255 | public function setEnhancement($enhancement)
256 | {
257 | $this->container['enhancement'] = $enhancement;
258 |
259 | return $this;
260 | }
261 | /**
262 | * Returns true if offset exists. False otherwise.
263 | *
264 | * @param integer $offset Offset
265 | *
266 | * @return boolean
267 | */
268 | public function offsetExists($offset)
269 | {
270 | return isset($this->container[$offset]);
271 | }
272 |
273 | /**
274 | * Gets offset.
275 | *
276 | * @param integer $offset Offset
277 | *
278 | * @return mixed
279 | */
280 | public function offsetGet($offset)
281 | {
282 | return isset($this->container[$offset]) ? $this->container[$offset] : null;
283 | }
284 |
285 | /**
286 | * Sets value based on offset.
287 | *
288 | * @param integer $offset Offset
289 | * @param mixed $value Value to be set
290 | *
291 | * @return void
292 | */
293 | public function offsetSet($offset, $value)
294 | {
295 | if (is_null($offset)) {
296 | $this->container[] = $value;
297 | } else {
298 | $this->container[$offset] = $value;
299 | }
300 | }
301 |
302 | /**
303 | * Unsets offset.
304 | *
305 | * @param integer $offset Offset
306 | *
307 | * @return void
308 | */
309 | public function offsetUnset($offset)
310 | {
311 | unset($this->container[$offset]);
312 | }
313 |
314 | /**
315 | * Gets the string presentation of the object
316 | *
317 | * @return string
318 | */
319 | public function __toString()
320 | {
321 | if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
322 | return json_encode(
323 | ObjectSerializer::sanitizeForSerialization($this),
324 | JSON_PRETTY_PRINT
325 | );
326 | }
327 |
328 | return json_encode(ObjectSerializer::sanitizeForSerialization($this));
329 | }
330 | }
331 |
332 |
333 |
--------------------------------------------------------------------------------