ciaranmccormick / hootsweet Goto Github PK

View Code? Open in Web Editor NEW

2.0 2.0 0.0 109 KB

A Python API for Hootsuite

Python 100.00%

api-client hootsuite python

hootsweet's People

Contributors

Stargazers

Watchers

hootsweet's Issues

Get message review history

Details

documentation
endpoint: GET /v1/messages/{messageId}/history

Path Parameters

messageId required

Response

{
  "data": {
    "actions": [
      {
        "actorType": "MEMBER",
        "actorId": "12345678",
        "actionType": "CREATE",
        "timestamp": "2017-02-15T18:51:13.000Z"
      }
    ]
  }
}

delete_message API throws an error.

delete_message API doesn't return a 'data' attribute on success, hence the error.

"/Users/gghildyal/ito/projects/gitops/disruption_messaging/disruption_messaging/social/hootsuite.py", line 125, in schedule_message
    self.delete_message()
  File "/Users/gghildyal/ito/projects/gitops/disruption_messaging/disruption_messaging/social/hootsuite.py", line 144, in delete_message
    self.client.delete_message(self.message_id)
  File "/Users/gghildyal/ito/projects/gitops/disruption_messaging/venv/lib/python3.7/site-packages/hootsweet/api.py", line 243, in delete_message
    return self._make_request(resource, method="DELETE")
  File "/Users/gghildyal/ito/projects/gitops/disruption_messaging/venv/lib/python3.7/site-packages/hootsweet/api.py", line 107, in _make_request
    return response.json()["data"]
  File "/Users/gghildyal/ito/projects/gitops/disruption_messaging/venv/lib/python3.7/site-packages/requests/models.py", line 898, in json
    return complexjson.loads(self.text, **kwargs)
  File "/usr/local/opt/python/Frameworks/Python.framework/Versions/3.7/lib/python3.7/json/__init__.py", line 348, in loads
    return _default_decoder.decode(s)
  File "/usr/local/opt/python/Frameworks/Python.framework/Versions/3.7/lib/python3.7/json/decoder.py", line 337, in decode
    obj, end = self.raw_decode(s, idx=_w(s, 0).end())
  File "/usr/local/opt/python/Frameworks/Python.framework/Versions/3.7/lib/python3.7/json/decoder.py", line 355, in raw_decode
    raise JSONDecodeError("Expecting value", s, err.value) from None
json.decoder.JSONDecodeError: Expecting value: line 1 column 1 (char 0)

Retrieve the organization's social profiles that an organization member can access.

Details

documentation
endpoint: /v1/organizations/{organizationId}/members/{memberId}/socialProfiles
path params
- organisationId required

Response

{
  "data": [
    {
      "id": "115185509"
    }
  ]
}

Publish to PyPi using the github actions

When a new tag is pushed to the repository, test the build, build the package and automatically push to pypi.

Remove a member from an organization.

Details

endpoint: /v1/organizations/{organizationId}/members/{memberId}
path params:
- organisationId required
- memberId required

Response

{
  "data": {}
}

Retrieve an organization member’s permissions for a social profile.

Details

documentation
endpoint: /v1/organizations/{organizationId}/members/{memberId}/socialProfiles/{socialProfileId}/permissions
path params
- organisationId required

Response

{
  "data": {
    "permissions": [
      "BASIC_USAGE"
    ],
    "permissionPreset": "EDITOR"
  }
}

Reject comment

Details

documentation
endpoint: POST /v1/comments/{commentId}/reject

Path Parameters

commentId required

Query Parameters

parameter

Request Body

reason **required (string)
sequenceNumber required (integer)
reviewerType (string) EXTERNAL or MEMBER

{
  "reason": "Message contains profanity",
  "sequenceNumber": 11,
  "reviewerType": "EXTERNAL"
}

Response

Retrieve outbound messages

Details

documentation
endpoint: GET /v1/messages

Path Parameters

organisationId required

Query Parameters

startTime required (ISO-8601 format)
endTime required (ISO-8601 format)
state (string: PENDING_APPROVAL, REJECTED, SENT, SCHEDULED and SEND_FAILED_PERMANENTLY)
socialProfileIds (integer)
limit (integer) defaults to 50, maximum is 100
cursor (string) cursor to a specific page in the results, defaults to the first
`includeUnscheduledReviewMsgs (boolean)

Response

{
  "data": [
    {
      "id": "4138476039",
      "state": "SCHEDULED",
      "text": "5 trends that will change how we use social media this year http://owl.li/YuNr2",
      "socialProfile": {
        "id": "115185509",
        "externalURL": "https://www.linkedin.com/in/l-lhs-8654321"
      },
      "scheduledSendTime": "2018-10-25T10:35:00Z",
      "webhookUrls": [
        "https://myserver.com/inbound"
      ],
      "tags": [
        "test_tag"
      ],
      "targeting": {
        "facebookPage": {
          "ageMin": 45,
          "education": [
            "collegeGrad"
          ],
          "interestedIn": [
            "female"
          ],
          "relationshipStatus": [
            "single"
          ],
          "countries": [
            {
              "k": "Canada",
              "v": "CA"
            }
          ],
          "regions": [
            {
              "k": "British Columbia",
              "v": "2"
            }
          ],
          "cities": [
            {
              "k": "Burnaby, BC",
              "v": "292466"
            }
          ],
          "zips": [
            {
              "k": "K1S",
              "v": "CA:K1S"
            }
          ]
        },
        "linkedInCompany": {
          "companySize": [
            "51-200"
          ],
          "geography": [
            "as.jp"
          ],
          "industry": [
            "41"
          ],
          "jobFunction": [
            "qa"
          ],
          "seniority": [
            "en"
          ]
        }
      },
      "privacy": {
        "facebook": {
          "visibility": [
            "everyone"
          ]
        },
        "linkedIn": {
          "visibility": [
            "anyone"
          ]
        }
      },
      "location": {
        "latitude": 57.64911,
        "longitude": 10.40744
      },
      "emailNotification": true,
      "mediaUrls": [
        {
          "thumbnailUrl": "http://static.ow.ly/photos/thumb/cS5.jpg",
          "url": "http://static.ow.ly/photos/normal/cS5.jpg"
        }
      ],
      "media": [
        {
          "id": "aHR0cDovL2V4YW1wbGUub3Jn",
          "thumbnailId": "aHR0cDovL2V4YW1wbGUtMDAwMS5vcmc=",
          "videoOptions": {
            "facebook": {
              "title": "My Video",
              "category": "ENTERTAINMENT"
            }
          }
        }
      ],
      "extendedInfo": [
        {
          "socialProfileType": "PINTEREST",
          "socialProfileId": "123456789",
          "data": {
            "boardId": "123456789012345678",
            "destinationUrl": "https://www.hootsuite.com"
          }
        }
      ],
      "postId": "705207140236001282",
      "postUrl": "https://www.facebook.com/177463958820/posts/10155617296368821",
      "createdByMember": {
        "id": "1389211223"
      },
      "lastUpdatedByMember": {
        "id": "1389211222"
      },
      "sequenceNumber": 3
    }
  ],
  "metadata": {
    "cursor": {
      "next": "1577887200000:4138476039:0",
      "previous": "1577887200000:4138476039:1"
    }
  }
}

Create a contributing document

Retrieve the members in an organization

Details

endpoint: /v1/organizations/{organizationId}/members
path params
- organisationId required

Response

{
  "data": [
    {
      "id": "15240789"
    }
  ]
}

Create functions to retrieve members endpoints

https://platform.hootsuite.com/docs/api/index.html#operation/retrieveMember

Image Upload Sits in Queued

I'm having an issue whereby an image uploaded to URL sits in "QUEUED" and never reaches "READY".

I'm following the Messages with Media portion - https://github.com/ciaranmccormick/hootsweet#messages-with-media

Retrieve comment

Details

documentation
endpoint: GET /v1/comments/{commentId}

Path Parameters

commentId required

Response

{
  "data": {
    "comment": "This is an example comment.",
    "createdDate": "2019-01-24T00:51:33.000Z",
    "creatorId": "12345",
    "creatorName": "Joe Smith",
    "id": "4138476039",
    "parentId": "126123123_12314",
    "parentType": "POST",
    "reviewState": "COMPLETED",
    "sequenceNumber": 3,
    "socialProfileId": "12345"
  }
}

Reject a message.

Details

documentation
endpoint: POST /v1/messages/{messageId}/reject

Path Parameters

messageId required

Request Body

reason required (string)
sequenceNumber required (string)
reviewerType (string) one of EXTERNAL or MEMBER

Response

{
  "data": {}
}

Add automatic access token refresh if a refresh token is provided

`Add functions to interact with message endpoints

https://platform.hootsuite.com/docs/api/index.html#tag/Messages

Retrieve an organization member’s permissions for the organization.

Details

endpoint: /v1/organizations/{organizationId}/members/{memberId}/permissions
path params
- organisationId required
- memberId required

Response

{
  "data": {
    "permissions": [
      "ORG_MANAGE_MEMBER"
    ],
    "permissionPreset": "CUSTOM"
  }
}

Setup documentation build

Approve comment

Details

documentation
endpoint: POST /v1/comments/{commentId}/approve

Path Parameters

commentId required

Query Parameters

parameter

Request Body

sequenceNumber required (integer)
reviewerType (string) one of EXTERNAL or MEMBER

Response

{
  "data": {}
}

Retrieve a list of teams for a given organisation

Details

endpoint:: /v1/organizations/{organizationId}/teams
path params
- organizationId required

Response

{
  "data": [
    {
      "id": "359493",
      "name": "North America Support Team",
      "logoUrl": "http://ow.ly/i/logo.png",
      "createdDate": "2016-01-14T16:27:40Z",
      "createdByMember": {
        "id": "13892119232"
      },
      "modifiedDate": "2016-01-14T16:27:40Z",
      "modifiedByMember": {
        "id": "13892119232"
      }
    }
  ]
}

Retrieve the teams an organization member is in.

Details

documentation
endpoint: GET /v1/organizations/{organizationId}/members/{memberId}/teams
path params
- organisationId required
- memberId required

Response

{
  "data": [
    {
      "id": "359493"
    }
  ]
}

ciaranmccormick / hootsweet Goto Github PK

hootsweet's People

Contributors

Stargazers

Watchers

hootsweet's Issues

Details

Path Parameters

Response

Details

Response

Details

Response

Details

Response

Details

Path Parameters

Query Parameters

Request Body

Response

Details

Path Parameters

Query Parameters

Response

Details

Response

Details

Path Parameters

Response

Details

Path Parameters

Request Body

Response

Details

Response

Details

Path Parameters

Query Parameters

Request Body

Response

Details

Response

Details

Response

Recommend Projects

Recommend Topics

Recommend Org