Skip to content

Commit

Permalink
Additional OpenAPI updates
Browse files Browse the repository at this point in the history
  • Loading branch information
mavrck committed May 29, 2024
1 parent 926e6a0 commit 6e02e33
Show file tree
Hide file tree
Showing 472 changed files with 2,685 additions and 2,685 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ $apiInstance = new OpenAPI\Client\Api\AccountServicesApi(
new GuzzleHttp\Client(),
$config
);
$body = new \OpenAPI\Client\Model\AccountEmailInput(); // \OpenAPI\Client\Model\AccountEmailInput | A JSON request payload containing the new email address you want to add to the Constant Contact account.
$body = new 'ConstantContact\Client\Model\AccountEmailInput(); // 'ConstantContact\Client\Model\AccountEmailInput | A JSON request payload containing the new email address you want to add to the Constant Contact account.

try {
$result = $apiInstance->addAccountEmailAddress($body);
Expand Down
20 changes: 10 additions & 10 deletions docs/Api/AccountServicesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ All URIs are relative to https://api.cc.email/v3, except if the operation define
## `addAccountEmailAddress()`

```php
addAccountEmailAddress($body): \OpenAPI\Client\Model\AccountEmailCreateResponse
addAccountEmailAddress($body): 'ConstantContact\Client\Model\AccountEmailCreateResponse
```

POST Add an Account Email Address
Expand Down Expand Up @@ -48,7 +48,7 @@ $apiInstance = new OpenAPI\Client\Api\AccountServicesApi(
new GuzzleHttp\Client(),
$config
);
$body = new \OpenAPI\Client\Model\AccountEmailInput(); // \OpenAPI\Client\Model\AccountEmailInput | A JSON request payload containing the new email address you want to add to the Constant Contact account.
$body = new 'ConstantContact\Client\Model\AccountEmailInput(); // 'ConstantContact\Client\Model\AccountEmailInput | A JSON request payload containing the new email address you want to add to the Constant Contact account.

try {
$result = $apiInstance->addAccountEmailAddress($body);
Expand Down Expand Up @@ -84,7 +84,7 @@ try {
## `getAccountById()`

```php
getAccountById($extra_fields): \OpenAPI\Client\Model\Customer
getAccountById($extra_fields): 'ConstantContact\Client\Model\Customer
```

GET a Summary of Account Details
Expand Down Expand Up @@ -152,7 +152,7 @@ try {
## `getPhysicalAddress()`

```php
getPhysicalAddress(): \OpenAPI\Client\Model\AccountPhysicalAddress
getPhysicalAddress(): 'ConstantContact\Client\Model\AccountPhysicalAddress
```

GET the Physical Address for the Account
Expand Down Expand Up @@ -217,7 +217,7 @@ This endpoint does not need any parameter.
## `getUserPrivileges()`

```php
getUserPrivileges(): \OpenAPI\Client\Model\UserPrivilegesResourceInner[]
getUserPrivileges(): 'ConstantContact\Client\Model\UserPrivilegesResourceInner[]
```

GET User Privileges
Expand Down Expand Up @@ -282,7 +282,7 @@ This endpoint does not need any parameter.
## `putCustomerById()`

```php
putCustomerById($body): \OpenAPI\Client\Model\CustomerPut
putCustomerById($body): 'ConstantContact\Client\Model\CustomerPut
```

PUT (update) Account Details
Expand Down Expand Up @@ -314,7 +314,7 @@ $apiInstance = new OpenAPI\Client\Api\AccountServicesApi(
new GuzzleHttp\Client(),
$config
);
$body = new \OpenAPI\Client\Model\CustomerPut(); // \OpenAPI\Client\Model\CustomerPut | In the request body, specify changes to account details by including and modifying all or select `CustomerPut` properties. Changes to read-only fields (`encoded_account_id`) are ignored.
$body = new 'ConstantContact\Client\Model\CustomerPut(); // 'ConstantContact\Client\Model\CustomerPut | In the request body, specify changes to account details by including and modifying all or select `CustomerPut` properties. Changes to read-only fields (`encoded_account_id`) are ignored.

try {
$result = $apiInstance->putCustomerById($body);
Expand Down Expand Up @@ -350,7 +350,7 @@ try {
## `putPhysicalAddress()`

```php
putPhysicalAddress($body): \OpenAPI\Client\Model\AccountPhysicalAddress
putPhysicalAddress($body): 'ConstantContact\Client\Model\AccountPhysicalAddress
```

PUT (update) the Physical Address for an Account
Expand Down Expand Up @@ -382,7 +382,7 @@ $apiInstance = new OpenAPI\Client\Api\AccountServicesApi(
new GuzzleHttp\Client(),
$config
);
$body = new \OpenAPI\Client\Model\AccountPhysicalAddress(); // \OpenAPI\Client\Model\AccountPhysicalAddress | Include all `AccountPhysicalAddress` properties required for the specified `country_code` and then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address.
$body = new 'ConstantContact\Client\Model\AccountPhysicalAddress(); // 'ConstantContact\Client\Model\AccountPhysicalAddress | Include all `AccountPhysicalAddress` properties required for the specified `country_code` and then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address.

try {
$result = $apiInstance->putPhysicalAddress($body);
Expand Down Expand Up @@ -418,7 +418,7 @@ try {
## `retrieveEmailAddresses()`

```php
retrieveEmailAddresses($confirm_status, $role_code, $email_address): \OpenAPI\Client\Model\AccountEmailsInner[]
retrieveEmailAddresses($confirm_status, $role_code, $email_address): 'ConstantContact\Client\Model\AccountEmailsInner[]
```

GET a Collection of Account Email Addresses
Expand Down
46 changes: 23 additions & 23 deletions docs/Api/BulkActivitiesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ All URIs are relative to https://api.cc.email/v3, except if the operation define
## `bulkImportContactsJSON()`

```php
bulkImportContactsJSON($body): \OpenAPI\Client\Model\ActivityImport
bulkImportContactsJSON($body): 'ConstantContact\Client\Model\ActivityImport
```

Import Contacts using a JSON Payload
Expand Down Expand Up @@ -55,7 +55,7 @@ $apiInstance = new OpenAPI\Client\Api\BulkActivitiesApi(
new GuzzleHttp\Client(),
$config
);
$body = new \OpenAPI\Client\Model\ContactsJsonImport(); // \OpenAPI\Client\Model\ContactsJsonImport | The JSON request payload that contains the contact data and contact lists for the import.
$body = new 'ConstantContact\Client\Model\ContactsJsonImport(); // 'ConstantContact\Client\Model\ContactsJsonImport | The JSON request payload that contains the contact data and contact lists for the import.

try {
$result = $apiInstance->bulkImportContactsJSON($body);
Expand Down Expand Up @@ -91,7 +91,7 @@ try {
## `contactsCSVImport()`

```php
contactsCSVImport($file, $list_ids): \OpenAPI\Client\Model\ActivityImport
contactsCSVImport($file, $list_ids): 'ConstantContact\Client\Model\ActivityImport
```

Import Contacts using a CSV File
Expand Down Expand Up @@ -161,7 +161,7 @@ try {
## `getActivity()`

```php
getActivity($activity_id): \OpenAPI\Client\Model\Activity
getActivity($activity_id): 'ConstantContact\Client\Model\Activity
```

GET an Activity Status
Expand Down Expand Up @@ -229,7 +229,7 @@ try {
## `getActivityStatusCollection()`

```php
getActivityStatusCollection($limit, $state): \OpenAPI\Client\Model\Activities
getActivityStatusCollection($limit, $state): 'ConstantContact\Client\Model\Activities
```

GET Activity Status Collection
Expand Down Expand Up @@ -367,7 +367,7 @@ try {
## `postContactDelete()`

```php
postContactDelete($body): \OpenAPI\Client\Model\ActivityDeleteStatus
postContactDelete($body): 'ConstantContact\Client\Model\ActivityDeleteStatus
```

Delete Contacts in Bulk
Expand Down Expand Up @@ -399,7 +399,7 @@ $apiInstance = new OpenAPI\Client\Api\BulkActivitiesApi(
new GuzzleHttp\Client(),
$config
);
$body = new \OpenAPI\Client\Model\ContactDelete(); // \OpenAPI\Client\Model\ContactDelete | The request body contains an array of contact_ids <em>or</em> list_ids. All contact_ids provided are deleted, or all members of each specified list_id are deleted.
$body = new 'ConstantContact\Client\Model\ContactDelete(); // 'ConstantContact\Client\Model\ContactDelete | The request body contains an array of contact_ids <em>or</em> list_ids. All contact_ids provided are deleted, or all members of each specified list_id are deleted.

try {
$result = $apiInstance->postContactDelete($body);
Expand Down Expand Up @@ -435,7 +435,7 @@ try {
## `postContactsExport()`

```php
postContactsExport($body): \OpenAPI\Client\Model\ActivityExportStatus
postContactsExport($body): 'ConstantContact\Client\Model\ActivityExportStatus
```

Export Contacts to a File
Expand Down Expand Up @@ -467,7 +467,7 @@ $apiInstance = new OpenAPI\Client\Api\BulkActivitiesApi(
new GuzzleHttp\Client(),
$config
);
$body = new \OpenAPI\Client\Model\ContactsExport(); // \OpenAPI\Client\Model\ContactsExport | A JSON payload that specifies the contacts (rows in the CSV file) and contact properties (columns in the CSV file) you want to export.
$body = new 'ConstantContact\Client\Model\ContactsExport(); // 'ConstantContact\Client\Model\ContactsExport | A JSON payload that specifies the contacts (rows in the CSV file) and contact properties (columns in the CSV file) you want to export.

try {
$result = $apiInstance->postContactsExport($body);
Expand Down Expand Up @@ -503,7 +503,7 @@ try {
## `postCustomFieldDelete()`

```php
postCustomFieldDelete($body): \OpenAPI\Client\Model\ActivityDeleteCustomFields
postCustomFieldDelete($body): 'ConstantContact\Client\Model\ActivityDeleteCustomFields
```

Delete Custom Fields
Expand All @@ -530,7 +530,7 @@ $apiInstance = new OpenAPI\Client\Api\BulkActivitiesApi(
new GuzzleHttp\Client(),
$config
);
$body = new \OpenAPI\Client\Model\CustomFieldId100(); // \OpenAPI\Client\Model\CustomFieldId100 | An array of `custom_field_id`'s to delete.
$body = new 'ConstantContact\Client\Model\CustomFieldId100(); // 'ConstantContact\Client\Model\CustomFieldId100 | An array of `custom_field_id`'s to delete.

try {
$result = $apiInstance->postCustomFieldDelete($body);
Expand Down Expand Up @@ -566,7 +566,7 @@ try {
## `postListAddContact()`

```php
postListAddContact($body): \OpenAPI\Client\Model\ActivityListsMembership
postListAddContact($body): 'ConstantContact\Client\Model\ActivityListsMembership
```

Add Contacts to Lists
Expand Down Expand Up @@ -598,7 +598,7 @@ $apiInstance = new OpenAPI\Client\Api\BulkActivitiesApi(
new GuzzleHttp\Client(),
$config
);
$body = new \OpenAPI\Client\Model\ListActivityAddContacts(); // \OpenAPI\Client\Model\ListActivityAddContacts | The JSON payload used to create the 'add contacts to lists' activity
$body = new 'ConstantContact\Client\Model\ListActivityAddContacts(); // 'ConstantContact\Client\Model\ListActivityAddContacts | The JSON payload used to create the 'add contacts to lists' activity

try {
$result = $apiInstance->postListAddContact($body);
Expand Down Expand Up @@ -634,7 +634,7 @@ try {
## `postListDelete()`

```php
postListDelete($body): \OpenAPI\Client\Model\ActivityDeleteListsResponse
postListDelete($body): 'ConstantContact\Client\Model\ActivityDeleteListsResponse
```

Delete Contact Lists
Expand Down Expand Up @@ -666,7 +666,7 @@ $apiInstance = new OpenAPI\Client\Api\BulkActivitiesApi(
new GuzzleHttp\Client(),
$config
);
$body = new \OpenAPI\Client\Model\ListIdList100(); // \OpenAPI\Client\Model\ListIdList100 | An array of `list_id`'s to delete.
$body = new 'ConstantContact\Client\Model\ListIdList100(); // 'ConstantContact\Client\Model\ListIdList100 | An array of `list_id`'s to delete.

try {
$result = $apiInstance->postListDelete($body);
Expand Down Expand Up @@ -702,7 +702,7 @@ try {
## `postListRemoveContact()`

```php
postListRemoveContact($body): \OpenAPI\Client\Model\ActivityListsMembership
postListRemoveContact($body): 'ConstantContact\Client\Model\ActivityListsMembership
```

Remove Contacts from Lists
Expand Down Expand Up @@ -734,7 +734,7 @@ $apiInstance = new OpenAPI\Client\Api\BulkActivitiesApi(
new GuzzleHttp\Client(),
$config
);
$body = new \OpenAPI\Client\Model\ListActivityRemoveContacts(); // \OpenAPI\Client\Model\ListActivityRemoveContacts | The JSON payload used to create the 'remove contacts from lists' activity
$body = new 'ConstantContact\Client\Model\ListActivityRemoveContacts(); // 'ConstantContact\Client\Model\ListActivityRemoveContacts | The JSON payload used to create the 'remove contacts from lists' activity

try {
$result = $apiInstance->postListRemoveContact($body);
Expand Down Expand Up @@ -770,7 +770,7 @@ try {
## `postTagAddContact()`

```php
postTagAddContact($body): \OpenAPI\Client\Model\ActivityTagging
postTagAddContact($body): 'ConstantContact\Client\Model\ActivityTagging
```

Add Tags to Contacts
Expand Down Expand Up @@ -802,7 +802,7 @@ $apiInstance = new OpenAPI\Client\Api\BulkActivitiesApi(
new GuzzleHttp\Client(),
$config
);
$body = new \OpenAPI\Client\Model\TagAddRemoveContacts(); // \OpenAPI\Client\Model\TagAddRemoveContacts | The JSON payload used to create an asynchronous activity that adds tags to contacts that meet your specified contact filtering criteria.
$body = new 'ConstantContact\Client\Model\TagAddRemoveContacts(); // 'ConstantContact\Client\Model\TagAddRemoveContacts | The JSON payload used to create an asynchronous activity that adds tags to contacts that meet your specified contact filtering criteria.

try {
$result = $apiInstance->postTagAddContact($body);
Expand Down Expand Up @@ -838,7 +838,7 @@ try {
## `postTagDelete()`

```php
postTagDelete($body): \OpenAPI\Client\Model\ActivityTagging
postTagDelete($body): 'ConstantContact\Client\Model\ActivityTagging
```

Delete Tags
Expand Down Expand Up @@ -870,7 +870,7 @@ $apiInstance = new OpenAPI\Client\Api\BulkActivitiesApi(
new GuzzleHttp\Client(),
$config
);
$body = new \OpenAPI\Client\Model\TagIdList500Limit(); // \OpenAPI\Client\Model\TagIdList500Limit | An array of string values (`tag_id`s) to delete.
$body = new 'ConstantContact\Client\Model\TagIdList500Limit(); // 'ConstantContact\Client\Model\TagIdList500Limit | An array of string values (`tag_id`s) to delete.

try {
$result = $apiInstance->postTagDelete($body);
Expand Down Expand Up @@ -906,7 +906,7 @@ try {
## `postTagRemoveContact()`

```php
postTagRemoveContact($body): \OpenAPI\Client\Model\ActivityTagging
postTagRemoveContact($body): 'ConstantContact\Client\Model\ActivityTagging
```

Remove Tags from Contacts
Expand Down Expand Up @@ -938,7 +938,7 @@ $apiInstance = new OpenAPI\Client\Api\BulkActivitiesApi(
new GuzzleHttp\Client(),
$config
);
$body = new \OpenAPI\Client\Model\TagAddRemoveContacts(); // \OpenAPI\Client\Model\TagAddRemoveContacts | The JSON payload used to create an asynchronous activity that removes tags from contacts meeting your specified contact filtering criteria.
$body = new 'ConstantContact\Client\Model\TagAddRemoveContacts(); // 'ConstantContact\Client\Model\TagAddRemoveContacts | The JSON payload used to create an asynchronous activity that removes tags from contacts meeting your specified contact filtering criteria.

try {
$result = $apiInstance->postTagRemoveContact($body);
Expand Down
16 changes: 8 additions & 8 deletions docs/Api/ContactListsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ All URIs are relative to https://api.cc.email/v3, except if the operation define
## `createList()`

```php
createList($body): \OpenAPI\Client\Model\ContactListPutPost
createList($body): 'ConstantContact\Client\Model\ContactListPutPost
```

POST (create) a List
Expand Down Expand Up @@ -47,7 +47,7 @@ $apiInstance = new OpenAPI\Client\Api\ContactListsApi(
new GuzzleHttp\Client(),
$config
);
$body = new \OpenAPI\Client\Model\ListInput(); // \OpenAPI\Client\Model\ListInput | JSON payload defining the new contact list
$body = new 'ConstantContact\Client\Model\ListInput(); // 'ConstantContact\Client\Model\ListInput | JSON payload defining the new contact list

try {
$result = $apiInstance->createList($body);
Expand Down Expand Up @@ -83,7 +83,7 @@ try {
## `deleteListActivity()`

```php
deleteListActivity($list_id): \OpenAPI\Client\Model\ActivityDeleteListResponse
deleteListActivity($list_id): 'ConstantContact\Client\Model\ActivityDeleteListResponse
```

DELETE a List
Expand Down Expand Up @@ -151,7 +151,7 @@ try {
## `getList()`

```php
getList($list_id, $include_membership_count): \OpenAPI\Client\Model\ContactList
getList($list_id, $include_membership_count): 'ConstantContact\Client\Model\ContactList
```

GET a List
Expand Down Expand Up @@ -221,7 +221,7 @@ try {
## `getListIdXrefs()`

```php
getListIdXrefs($sequence_ids): \OpenAPI\Client\Model\ListXrefs
getListIdXrefs($sequence_ids): 'ConstantContact\Client\Model\ListXrefs
```

GET a collection of V2 and V3 API List IDs
Expand Down Expand Up @@ -289,7 +289,7 @@ try {
## `getLists()`

```php
getLists($limit, $include_count, $include_membership_count, $name, $status): \OpenAPI\Client\Model\ContactListArray
getLists($limit, $include_count, $include_membership_count, $name, $status): 'ConstantContact\Client\Model\ContactListArray
```

GET Lists Collection
Expand Down Expand Up @@ -365,7 +365,7 @@ try {
## `putList()`

```php
putList($list_id, $json_put_body): \OpenAPI\Client\Model\ContactListPutPost
putList($list_id, $json_put_body): 'ConstantContact\Client\Model\ContactListPutPost
```

PUT (update) a List
Expand Down Expand Up @@ -398,7 +398,7 @@ $apiInstance = new OpenAPI\Client\Api\ContactListsApi(
$config
);
$list_id = cbc05bac-6a41-46fa-a063-79961763bf4b; // string | Unique ID of the contact list to update
$json_put_body = new \OpenAPI\Client\Model\ListInput(); // \OpenAPI\Client\Model\ListInput | JSON payload containing updates to the specified contact list
$json_put_body = new 'ConstantContact\Client\Model\ListInput(); // 'ConstantContact\Client\Model\ListInput | JSON payload containing updates to the specified contact list

try {
$result = $apiInstance->putList($list_id, $json_put_body);
Expand Down
Loading

0 comments on commit 6e02e33

Please sign in to comment.